PeopleCode Functions
From TekiWiki
This whole wiki has now moved to http://www.springboardsolutions.com/wiki
Go to this page PeopleCode Functions
(Created page with " {| class="wikitable" |- ! Command ! Description ! Usage |- |Abs |Returns absolute value of inNumber (without the + or - sign) |<nowiki>&number=Abs(&inNumber);</nowiki> |- ...") |
|||
| Line 1: | Line 1: | ||
| + | ==[[PeopleCode Functions]]== | ||
| + | |||
| + | |||
| + | |||
| + | Also take a quick look at our useful free [[Tools]] page. | ||
| + | |||
| + | ==List of [[PeopleCode]] Functions == | ||
| + | |||
{| class="wikitable" | {| class="wikitable" | ||
| Line 7: | Line 15: | ||
|- | |- | ||
| - | | | + | |Abs |
|Returns absolute value of inNumber (without the + or - sign) | |Returns absolute value of inNumber (without the + or - sign) | ||
|<nowiki>&number=Abs(&inNumber);</nowiki> | |<nowiki>&number=Abs(&inNumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |AccruableDays |
|Returns integer number of accrual days according to accounting conventions | |Returns integer number of accrual days according to accounting conventions | ||
|<nowiki>&integer=AccruableDays(&BeginDate, &EndDate, &AccrualConvention);</nowiki> | |<nowiki>&integer=AccruableDays(&BeginDate, &EndDate, &AccrualConvention);</nowiki> | ||
|- | |- | ||
| - | | | + | |AccrualFactor |
|Returns factor equal to number of years interest accrued between dates using acounting convention. | |Returns factor equal to number of years interest accrued between dates using acounting convention. | ||
|<nowiki>&number=AccrualFactor(&BeginDate, &EndDate, &AccrualConvention);</nowiki> | |<nowiki>&number=AccrualFactor(&BeginDate, &EndDate, &AccrualConvention);</nowiki> | ||
|- | |- | ||
| - | | | + | |Acos |
|Returns angle in radians (0 to pi) with specified cosine value (-1.0 to 1.0) | |Returns angle in radians (0 to pi) with specified cosine value (-1.0 to 1.0) | ||
|<nowiki>&radians=Acos(&cosine);</nowiki> | |<nowiki>&radians=Acos(&cosine);</nowiki> | ||
|- | |- | ||
| - | | | + | |ActiveRowCount |
|Returns number of non-deleted rows - use Rowset.ActiveRowCount | |Returns number of non-deleted rows - use Rowset.ActiveRowCount | ||
| - | |<nowiki>&integer=ActiveRowCount([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>&integer=ActiveRowCount([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName);</nowiki> |
|- | |- | ||
| - | | | + | |AddAttachment |
|Adds file attachment from browser onto server | |Adds file attachment from browser onto server | ||
|<nowiki>&errorCode=AddAttachment(&URLDestination, &DestinationAppendedPathFilename, &SuggestedFileExtension, &SourceFile, &MaximumKB [, &PreserveCaseBoolean]);</nowiki> | |<nowiki>&errorCode=AddAttachment(&URLDestination, &DestinationAppendedPathFilename, &SuggestedFileExtension, &SourceFile, &MaximumKB [, &PreserveCaseBoolean]);</nowiki> | ||
|- | |- | ||
| - | | | + | |AddEmailAddress |
|Add email address of current user - 1 per type | |Add email address of current user - 1 per type | ||
|<nowiki>AddEmailAddress(&EmailTypeName, &EmailAddress [,&PrimaryBoolean]);</nowiki> | |<nowiki>AddEmailAddress(&EmailTypeName, &EmailAddress [,&PrimaryBoolean]);</nowiki> | ||
|- | |- | ||
| - | | | + | |AddKeyListItem |
|Adds new key value to navigation list of keys for autocompletion of search dialogs | |Adds new key value to navigation list of keys for autocompletion of search dialogs | ||
|<nowiki>&isOK=AddKeyListItem(&FieldName, &Value);</nowiki> | |<nowiki>&isOK=AddKeyListItem(&FieldName, &Value);</nowiki> | ||
|- | |- | ||
| - | | | + | |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) | |Adds weekly system pause time for messages to/from day (0-6) to from time in seconds from midnight (0-24x60x60 or 86,400) | ||
|<nowiki>&isOK=AddSystemPauseTimes(&BeginWeekDayNumber, &BeginTimeSeconds, &EndWeekDayNumber, &EndTimeSeconds);</nowiki> | |<nowiki>&isOK=AddSystemPauseTimes(&BeginWeekDayNumber, &BeginTimeSeconds, &EndWeekDayNumber, &EndTimeSeconds);</nowiki> | ||
|- | |- | ||
| - | | | + | |AddToDateTime |
|Returns date time after numOfYears, Months, Days, Hours, Minutes, Seconds after (-ve means before) inDateTime | |Returns date time after numOfYears, Months, Days, Hours, Minutes, Seconds after (-ve means before) inDateTime | ||
|<nowiki>&dateTime=AddToDateTime(&inDateTime, &numOfYears, &numOfMonths, &numOfDays, &numOfHours, &numOfMinutes, &numOfSeconds);</nowiki> | |<nowiki>&dateTime=AddToDateTime(&inDateTime, &numOfYears, &numOfMonths, &numOfDays, &numOfHours, &numOfMinutes, &numOfSeconds);</nowiki> | ||
|- | |- | ||
| - | | | + | |AddToDate |
|Returns date time after numOfYears, Months, Days, Hours, Minutes, Seconds after (-ve means before) inDate | |Returns date time after numOfYears, Months, Days, Hours, Minutes, Seconds after (-ve means before) inDate | ||
|<nowiki>&date=AddToDate(&inDate, &numOfYears, &numOfMonths, &numOfDays);</nowiki> | |<nowiki>&date=AddToDate(&inDate, &numOfYears, &numOfMonths, &numOfDays);</nowiki> | ||
|- | |- | ||
| - | | | + | |AddToTime |
|Returns time after numOfHours, Minutes, Seconds after (-ve means before) inDate | |Returns time after numOfHours, Minutes, Seconds after (-ve means before) inDate | ||
|<nowiki>&time=AddToTime(&inTime, &numOfHours, &numOfMinutes, &numOfSeconds);</nowiki> | |<nowiki>&time=AddToTime(&inTime, &numOfHours, &numOfMinutes, &numOfSeconds);</nowiki> | ||
|- | |- | ||
| - | | | + | |AllOrNone |
|Checks if fields listed are all blank strings / non-zero OR all are not | |Checks if fields listed are all blank strings / non-zero OR all are not | ||
|<nowiki>&isConsistent=AllOrNone( [RecordName.]FieldName [, [RecordName2.]FieldName2] ... );</nowiki> | |<nowiki>&isConsistent=AllOrNone( [RecordName.]FieldName [, [RecordName2.]FieldName2] ... );</nowiki> | ||
|- | |- | ||
| - | | | + | |All |
|Checks if fields listed are all not blank strings / non-zero in numeric fields | |Checks if fields listed are all not blank strings / non-zero in numeric fields | ||
|<nowiki>&isNotBlank=All( [RecordName.]FieldName [, [RecordName2.]FieldName2] ... );</nowiki> | |<nowiki>&isNotBlank=All( [RecordName.]FieldName [, [RecordName2.]FieldName2] ... );</nowiki> | ||
|- | |- | ||
| - | | | + | |AllowEmplIdChg |
|Allows/Denies user to update their own data on record with EMPLID key = PSOPERDEFN.EMPLID | |Allows/Denies user to update their own data on record with EMPLID key = PSOPERDEFN.EMPLID | ||
|<nowiki>[&isOK=] AllowEmplidChg(&isAllowed);</nowiki> | |<nowiki>[&isOK=] AllowEmplidChg(&isAllowed);</nowiki> | ||
|- | |- | ||
| - | | | + | |Amortize |
|Calculates parts of loan payment, inPayment, (payment number inPaymentNumber) - interest (outToInterest) and pays off principal (outToPrincipal) and the remaining balance (outBalance) | |Calculates parts of loan payment, inPayment, (payment number inPaymentNumber) - interest (outToInterest) and pays off principal (outToPrincipal) and the remaining balance (outBalance) | ||
|<nowiki>Amortize(&inInterest, &inPrincipalBalance, &inPaymentAmount, &inPaymentInteger, &outToInterest, &outToPrincipal, &outBalance); </nowiki> | |<nowiki>Amortize(&inInterest, &inPrincipalBalance, &inPaymentAmount, &inPaymentInteger, &outToInterest, &outToPrincipal, &outBalance); </nowiki> | ||
|- | |- | ||
| - | | | + | |Asin |
|Returns angle in radians (-pi/2 to pi/2) with specified sine value (-1.0 to 1.0) | |Returns angle in radians (-pi/2 to pi/2) with specified sine value (-1.0 to 1.0) | ||
|<nowiki>&radians=Asin(&sine);</nowiki> | |<nowiki>&radians=Asin(&sine);</nowiki> | ||
|- | |- | ||
| - | | | + | |Atan |
|Returns angle in radians (-pi/2 to pi/2) with specified tangent number | |Returns angle in radians (-pi/2 to pi/2) with specified tangent number | ||
|<nowiki>&radians=Atan(&tangent);</nowiki> | |<nowiki>&radians=Atan(&tangent);</nowiki> | ||
|- | |- | ||
| - | | | + | |BlackScholesCall |
|Returns a number vaguely based on the numbers supplied | |Returns a number vaguely based on the numbers supplied | ||
|<nowiki>&equityCall=BlackScholesCall(&AssetPrice, &StrikePrice, &NoRiskInterestRate, &YearsToExpire, &Volatility);</nowiki> | |<nowiki>&equityCall=BlackScholesCall(&AssetPrice, &StrikePrice, &NoRiskInterestRate, &YearsToExpire, &Volatility);</nowiki> | ||
|- | |- | ||
| - | | | + | |BlackScholesPut |
|Black Scholes financial calculation. | |Black Scholes financial calculation. | ||
|<nowiki>&equityCall=BlackScholesPut(&AssetPrice, &StrikePrice, &NoRiskInterestRate, &YearsToExpire, &Volatility);</nowiki> | |<nowiki>&equityCall=BlackScholesPut(&AssetPrice, &StrikePrice, &NoRiskInterestRate, &YearsToExpire, &Volatility);</nowiki> | ||
|- | |- | ||
| - | | | + | |BootstrapYTMs |
|Does this make sense to anyone out there? | |Does this make sense to anyone out there? | ||
|<nowiki>&arrayOfNumberArrays=BootstrapYTMs(&TradingDate, &MarketInstrumentArrayOfNumberArrays, &AccrualConvention); </nowiki> | |<nowiki>&arrayOfNumberArrays=BootstrapYTMs(&TradingDate, &MarketInstrumentArrayOfNumberArrays, &AccrualConvention); </nowiki> | ||
|- | |- | ||
| - | | | + | |Break |
|Terminate loop or evaluate execution | |Terminate loop or evaluate execution | ||
|<nowiki>Break;</nowiki> | |<nowiki>Break;</nowiki> | ||
|- | |- | ||
| - | | | + | |BulkDeleteField |
|For PeopleSoft Adminstrator: Deletes FieldName from designed Pages and Records in ProjectName but not in ExcludeProjectName | |For PeopleSoft Adminstrator: Deletes FieldName from designed Pages and Records in ProjectName but not in ExcludeProjectName | ||
|<nowiki>&errorInteger=BulkDeleteField(&ProjectName, FieldName [, ExcludeProjectName] );</nowiki> | |<nowiki>&errorInteger=BulkDeleteField(&ProjectName, FieldName [, ExcludeProjectName] );</nowiki> | ||
|- | |- | ||
| - | | | + | |BulkInsertField |
|For PeopleSoft Adminstrator: Insert Field into all records and pages in ProjectName (but not in ExcludeProjectName) that contain ModelFieldName | |For PeopleSoft Adminstrator: Insert Field into all records and pages in ProjectName (but not in ExcludeProjectName) that contain ModelFieldName | ||
|<nowiki>&errorInteger=BulkInsertField(&ProjectName, FIELD.FieldName, &ModelName, &IsClonePCode, [, &ExcludeProjectName] );</nowiki> | |<nowiki>&errorInteger=BulkInsertField(&ProjectName, FIELD.FieldName, &ModelName, &IsClonePCode, [, &ExcludeProjectName] );</nowiki> | ||
|- | |- | ||
| - | | | + | |BulkModifyPageFieldOrder |
|For PeopleSoft Adminstrator: Reorder Fields in all records and pages in ProjectName (or PageNameArray) into FieldNamesArray order | |For PeopleSoft Adminstrator: Reorder Fields in all records and pages in ProjectName (or PageNameArray) into FieldNamesArray order | ||
|<nowiki>&errorInteger=BulkModifyPageFieldOrder(&ProjectName, &FieldNamesArray, &IsAllFieldsRequired, [&GridWidthsArray]);</nowiki> | |<nowiki>&errorInteger=BulkModifyPageFieldOrder(&ProjectName, &FieldNamesArray, &IsAllFieldsRequired, [&GridWidthsArray]);</nowiki> | ||
|- | |- | ||
| - | | | + | |BulkUpdateIndexes |
|For PeopleSoft Adminstrator: Updates index definitions for records that have the NotUsed setting changed. | |For PeopleSoft Adminstrator: Updates index definitions for records that have the NotUsed setting changed. | ||
|<nowiki>&errorInteger=BulkUpdateIndexes( [&FieldNameArray] );</nowiki> | |<nowiki>&errorInteger=BulkUpdateIndexes( [&FieldNameArray] );</nowiki> | ||
|- | |- | ||
| - | | | + | |CallAppEngine |
|Calls Application Engine from online or App Engine PeopleCode. State records can be either objects or record names. | |Calls Application Engine from online or App Engine PeopleCode. State records can be either objects or record names. | ||
|<nowiki>CallAppEngine(&AppEngineName [ , &StateRecord1... , &ProcessInstanceInteger ] );</nowiki> | |<nowiki>CallAppEngine(&AppEngineName [ , &StateRecord1... , &ProcessInstanceInteger ] );</nowiki> | ||
|- | |- | ||
| - | | | + | |CancelPubHeaderXmlDoc |
|Cancels a New, Error, Retry, Timeout, Edited message header/instance (before transformation) | |Cancels a New, Error, Retry, Timeout, Edited message header/instance (before transformation) | ||
|<nowiki>&isOK=CancelPubHeaderXmlDoc(&PublishID, &PublishNodeName, &ChannelName, &VersionName); </nowiki> | |<nowiki>&isOK=CancelPubHeaderXmlDoc(&PublishID, &PublishNodeName, &ChannelName, &VersionName); </nowiki> | ||
|- | |- | ||
| - | | | + | |CancelPubXmlDoc |
|Cancels a New, Error, Retry, Timeout, Edited message publication contract (after transformation) | |Cancels a New, Error, Retry, Timeout, Edited message publication contract (after transformation) | ||
|<nowiki>&isOK=CancelPubXmlDoc(&PublishID, &PublishNodeName, &ChannelName, &VersionName, &MessageName, &SubscribeNodeName); </nowiki> | |<nowiki>&isOK=CancelPubXmlDoc(&PublishID, &PublishNodeName, &ChannelName, &VersionName, &MessageName, &SubscribeNodeName); </nowiki> | ||
|- | |- | ||
| - | | | + | |CancelSubXmlDoc |
|Cancels a New, Error, Retry, Timeout, Edited message subsription contract | |Cancels a New, Error, Retry, Timeout, Edited message subsription contract | ||
|<nowiki>&isOK=CancelSubXmlDoc(&PublishID, &PublishNodeName, &ChannelName, &VersionName, &MessageName, &SubscribeNodeName); </nowiki> | |<nowiki>&isOK=CancelSubXmlDoc(&PublishID, &PublishNodeName, &ChannelName, &VersionName, &MessageName, &SubscribeNodeName); </nowiki> | ||
|- | |- | ||
| - | | | + | |Catch |
|Creates a block where statements can error and these are handled. | |Creates a block where statements can error and these are handled. | ||
|<nowiki>Try statementsSandbox; Catch exceptionSubClass &Exception errorHandlingStatements; End-Try;</nowiki> | |<nowiki>Try statementsSandbox; Catch exceptionSubClass &Exception errorHandlingStatements; End-Try;</nowiki> | ||
|- | |- | ||
| - | | | + | |ChDir |
|Changes current directory. Deprecated as of version 8. | |Changes current directory. Deprecated as of version 8. | ||
|<nowiki>ChDir(&Path);</nowiki> | |<nowiki>ChDir(&Path);</nowiki> | ||
|- | |- | ||
| - | | | + | |ChDrive |
|Changes drive (MS-DOS). &drive is a letter followed by a colon. Deprecated as of version 8. | |Changes drive (MS-DOS). &drive is a letter followed by a colon. Deprecated as of version 8. | ||
|<nowiki>ChDrive(&Drive);</nowiki> | |<nowiki>ChDrive(&Drive);</nowiki> | ||
|- | |- | ||
| - | | | + | |ChangeEmailAddress |
|Changes email address of type &EmailTypeName for current user | |Changes email address of type &EmailTypeName for current user | ||
|<nowiki>ChangeEmailAddress(&EmailTypeName, &EmailAddress);</nowiki> | |<nowiki>ChangeEmailAddress(&EmailTypeName, &EmailAddress);</nowiki> | ||
|- | |- | ||
| - | | | + | |CharType |
|Returns 1 (yes), 0 (no), -1 (unknown) whether 1st character of string in character group given by number &CharSetNumber | |Returns 1 (yes), 0 (no), -1 (unknown) whether 1st character of string in character group given by number &CharSetNumber | ||
|<nowiki>&returnInteger=CharType(&String, &CharSetNumber);</nowiki> | |<nowiki>&returnInteger=CharType(&String, &CharSetNumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |Char |
|Returns the UniCode character with the given number (0-65,535) | |Returns the UniCode character with the given number (0-65,535) | ||
|<nowiki>&UnicodeCharacter=char(&Integer);</nowiki> | |<nowiki>&UnicodeCharacter=char(&Integer);</nowiki> | ||
|- | |- | ||
| - | | | + | |CheckMenuItem |
|Puts a check by the menu name on Windows client. Deprecated for versions with no Windows client. | |Puts a check by the menu name on Windows client. Deprecated for versions with no Windows client. | ||
|<nowiki>CheckMenuItem(BARNAME.menuBar, ITEMNAME.menuItem);</nowiki> | |<nowiki>CheckMenuItem(BARNAME.menuBar, ITEMNAME.menuItem);</nowiki> | ||
|- | |- | ||
| - | | | + | |Clean |
|Returns &dodgyString without any non-printable characters | |Returns &dodgyString without any non-printable characters | ||
|<nowiki>&cleanString=Clean(&DodgyString);</nowiki> | |<nowiki>&cleanString=Clean(&DodgyString);</nowiki> | ||
|- | |- | ||
| - | | | + | |ClearKeyList |
|Clears current key list for navigation | |Clears current key list for navigation | ||
|<nowiki>[&isOK=] ClearKeyList();</nowiki> | |<nowiki>[&isOK=] ClearKeyList();</nowiki> | ||
|- | |- | ||
| - | | | + | |ClearSearchDefault |
|Removes default processing for specified field. SearchInit only. Use Field.SearchDefault now. | |Removes default processing for specified field. SearchInit only. Use Field.SearchDefault now. | ||
|<nowiki>[&isOK=] ClearSearchDefault( [recordname.]fieldname);</nowiki> | |<nowiki>[&isOK=] ClearSearchDefault( [recordname.]fieldname);</nowiki> | ||
|- | |- | ||
| - | | | + | |ClearSearchEdit |
|Stops record field edit properties being used in search dialogue for field. Use Field.SearchEdit now | |Stops record field edit properties being used in search dialogue for field. Use Field.SearchEdit now | ||
|<nowiki>[&isOK=] ClearSearchEdit( [recordname.]fieldname);</nowiki> | |<nowiki>[&isOK=] ClearSearchEdit( [recordname.]fieldname);</nowiki> | ||
|- | |- | ||
| - | | | + | |Code |
|Returns Unicode UTF-16 value (0-65,535) of first character/high surrogate in &String | |Returns Unicode UTF-16 value (0-65,535) of first character/high surrogate in &String | ||
|<nowiki>&number=Code(&String);</nowiki> | |<nowiki>&number=Code(&String);</nowiki> | ||
|- | |- | ||
| - | | | + | |Codeb |
|No longer supported - Ptools 8.46 | |No longer supported - Ptools 8.46 | ||
|<nowiki>&number=Codeb(&String);</nowiki> | |<nowiki>&number=Codeb(&String);</nowiki> | ||
|- | |- | ||
| - | | | + | |CollectGarbage |
|Cleans memory of unreferencable Application objects. | |Cleans memory of unreferencable Application objects. | ||
|<nowiki>CollectGarbage();</nowiki> | |<nowiki>CollectGarbage();</nowiki> | ||
|- | |- | ||
| - | | | + | |CommitWork |
|Explicitly commits to the database. Available in FCh, SPr, Message Subscription and AE PC | |Explicitly commits to the database. Available in FCh, SPr, Message Subscription and AE PC | ||
|<nowiki>[&isOK=] CommitWork();</nowiki> | |<nowiki>[&isOK=] CommitWork();</nowiki> | ||
|- | |- | ||
| - | | | + | |CompareLikeFields |
|Returns true if all similarly named fields have the same value in both To and From, else false | |Returns true if all similarly named fields have the same value in both To and From, else false | ||
|<nowiki>&isLikeFieldsSame=CompareLikeFields(&FromLevel, &FromScrollPath, &FromRow, &ToLevel, &ToScrollPath, &ToRow);</nowiki> | |<nowiki>&isLikeFieldsSame=CompareLikeFields(&FromLevel, &FromScrollPath, &FromRow, &ToLevel, &ToScrollPath, &ToRow);</nowiki> | ||
|- | |- | ||
| - | | | + | |ComponentChanged |
|Returns true if the component data has changed since the last save. | |Returns true if the component data has changed since the last save. | ||
|<nowiki>&isChanged=ComponentChanged();</nowiki> | |<nowiki>&isChanged=ComponentChanged();</nowiki> | ||
|- | |- | ||
| - | | | + | |Component |
|Declares variables with scope for the component lifetime | |Declares variables with scope for the component lifetime | ||
|<nowiki>Component datatype &declaration;</nowiki> | |<nowiki>Component datatype &declaration;</nowiki> | ||
|- | |- | ||
| - | | | + | |ConnectorRequestURL |
|Returns URL directly from the gateway | |Returns URL directly from the gateway | ||
|<nowiki>&URLString=ConnectorRequestURL(&ConnectorStringURL);</nowiki> | |<nowiki>&URLString=ConnectorRequestURL(&ConnectorStringURL);</nowiki> | ||
|- | |- | ||
| - | | | + | |ConnectorRequest |
|Sends message to connector assigned by properties of the message | |Sends message to connector assigned by properties of the message | ||
|<nowiki>&unstructuredMessage=ConnectorRequest(&Message);</nowiki> | |<nowiki>&unstructuredMessage=ConnectorRequest(&Message);</nowiki> | ||
|- | |- | ||
| - | | | + | |ContainsCharType |
|Returns 1 (yes), 0 (no), -1 (unknown) whether any character of string in character group given by number &CharSetNumber | |Returns 1 (yes), 0 (no), -1 (unknown) whether any character of string in character group given by number &CharSetNumber | ||
|<nowiki>&returnInteger=ContainsCharType(&String, &CharSetNumber);</nowiki> | |<nowiki>&returnInteger=ContainsCharType(&String, &CharSetNumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |ContainsOnlyCharType |
|Returns 1 (yes), 0 (no), -1 (unknown) whether all string only character groups given by numbers &CharSetNumber1 | |Returns 1 (yes), 0 (no), -1 (unknown) whether all string only character groups given by numbers &CharSetNumber1 | ||
|<nowiki>&returnInteger=ContainsOnlyCharType(&String, &CharSetNumber1 [, &CharSetNumber2 ...]);</nowiki> | |<nowiki>&returnInteger=ContainsOnlyCharType(&String, &CharSetNumber1 [, &CharSetNumber2 ...]);</nowiki> | ||
|- | |- | ||
| - | | | + | |Continue |
|In loops, skips processing to next iteration of loop | |In loops, skips processing to next iteration of loop | ||
|<nowiki>Continue;</nowiki> | |<nowiki>Continue;</nowiki> | ||
|- | |- | ||
| - | | | + | |ConvertChar |
|Returns 1 (success), 0 (no conversion), -1 (unknown), -2 (partial success) converts inString between (mainly) Asian/Japanese character sets outputs to outString | |Returns 1 (success), 0 (no conversion), -1 (unknown), -2 (partial success) converts inString between (mainly) Asian/Japanese character sets outputs to outString | ||
|<nowiki>&returnInteger=ConvertChar(&inString, &inCharCategoryNumber, &outString, &TargetCharSetNumber);</nowiki> | |<nowiki>&returnInteger=ConvertChar(&inString, &inCharCategoryNumber, &outString, &TargetCharSetNumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |ConvertCurrency |
|Converts currency, no exchange rate - uses 1 returns false, inErrorProcess (F/W/I) determines if user told | |Converts currency, no exchange rate - uses 1 returns false, inErrorProcess (F/W/I) determines if user told | ||
| - | |<nowiki>&isOK=ConvertCurrency(&inFromAmount, &inFromCurrencyCd, &inToCurrencyCd, &inRateType, &inEffdt, &outToAmount [, &inErrorProcess [, &isRounded] [, &inRateIndex | + | |<nowiki>&isOK=ConvertCurrency(&inFromAmount, &inFromCurrencyCd, &inToCurrencyCd, &inRateType, &inEffdt, &outToAmount [, &inErrorProcess [, &isRounded] [, &inRateIndex);</nowiki> |
|- | |- | ||
| - | | | + | |ConvertDatetimeToBase |
|Converts to PSOPTIONS base time zone FromTimeZone or Local or Base | |Converts to PSOPTIONS base time zone FromTimeZone or Local or Base | ||
|<nowiki>&dateTime=ConvertDatetimeToBase(&FromDateTimeString, &FromTimeZone);</nowiki> | |<nowiki>&dateTime=ConvertDatetimeToBase(&FromDateTimeString, &FromTimeZone);</nowiki> | ||
|- | |- | ||
| - | | | + | |ConvertRate |
|Returns rate converted by frequency 0 continuous, 1 daily, 2 monthly, 3 yearly | |Returns rate converted by frequency 0 continuous, 1 daily, 2 monthly, 3 yearly | ||
|<nowiki>&toRate=ConvertRate(&fromRate, &fromFrequencyNumber, &toFrequencyNumber);</nowiki> | |<nowiki>&toRate=ConvertRate(&fromRate, &fromFrequencyNumber, &toFrequencyNumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |ConvertTimeToBase |
|Converts to PSOPTIONS base time zone FromTimeZone or Local or Base | |Converts to PSOPTIONS base time zone FromTimeZone or Local or Base | ||
|<nowiki>&time=ConvertTimeToBase(&FromTimeString, &FromTimeZone);</nowiki> | |<nowiki>&time=ConvertTimeToBase(&FromTimeString, &FromTimeZone);</nowiki> | ||
|- | |- | ||
| - | | | + | |CopyAttachments |
|Copies files from one system to another, returns 0 on success, non zero error. | |Copies files from one system to another, returns 0 on success, non zero error. | ||
| - | |<nowiki>&returnInteger=CopyAttachments(&fromURL, &toURL [, &RecordNamesArray [, &isCasePreserved | + | |<nowiki>&returnInteger=CopyAttachments(&fromURL, &toURL [, &RecordNamesArray [, &isCasePreserved);</nowiki> |
|- | |- | ||
| - | | | + | |CopyFields |
|Copies like named fields from FromRow to ToRow in the page buffer | |Copies like named fields from FromRow to ToRow in the page buffer | ||
|<nowiki>[&isOK=] CopyFields(&FromLevel, &FromScrollPath, &FromRow, &ToLevel, &ToScrollPath, &ToRow);</nowiki> | |<nowiki>[&isOK=] CopyFields(&FromLevel, &FromScrollPath, &FromRow, &ToLevel, &ToScrollPath, &ToRow);</nowiki> | ||
|- | |- | ||
| - | | | + | |CopyFromJavaArray |
|Copies Java array to a PeopleCode Array, optionally confined to elements numbered in final array parameter | |Copies Java array to a PeopleCode Array, optionally confined to elements numbered in final array parameter | ||
|<nowiki>CopyFromJavaArray(&JavaArrayName, &PeopleCodeArray [, &ElementNumberArray]);</nowiki> | |<nowiki>CopyFromJavaArray(&JavaArrayName, &PeopleCodeArray [, &ElementNumberArray]);</nowiki> | ||
|- | |- | ||
| - | | | + | |CopyRow |
|Copies row, superceded by Row.CopyTo | |Copies row, superceded by Row.CopyTo | ||
|<nowiki>CopyRow(&ToRowNumber, &FromRowNumber);</nowiki> | |<nowiki>CopyRow(&ToRowNumber, &FromRowNumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |CopyToJavaArray |
|Copies PeopleCode array to a Java array, optionally confined to elements numbered in final array parameter | |Copies PeopleCode array to a Java array, optionally confined to elements numbered in final array parameter | ||
|<nowiki>CopyToJavaArray(&PeopleCodeArray, &JavaArrayName [, &ElementNumberArray]);</nowiki> | |<nowiki>CopyToJavaArray(&PeopleCodeArray, &JavaArrayName [, &ElementNumberArray]);</nowiki> | ||
|- | |- | ||
| - | | | + | |Cos |
|Returns cosine (-1.0 to 1.0) of angle in radians (normally 0 to pi) | |Returns cosine (-1.0 to 1.0) of angle in radians (normally 0 to pi) | ||
|<nowiki>&cosine=Cos(&radians);</nowiki> | |<nowiki>&cosine=Cos(&radians);</nowiki> | ||
|- | |- | ||
| - | | | + | |Cot |
|Returns cotangent of angle in radians (0 causes error) | |Returns cotangent of angle in radians (0 causes error) | ||
|<nowiki>&cotangent=Cot(&radians);</nowiki> | |<nowiki>&cotangent=Cot(&radians);</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateArrayAny |
|Returns reference to array created from elements elements can be of ANY type | |Returns reference to array created from elements elements can be of ANY type | ||
|<nowiki>&anyArray=CreateArrayAny([&element1 [, &element2 ]...]);</nowiki> | |<nowiki>&anyArray=CreateArrayAny([&element1 [, &element2 ]...]);</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateArrayRept |
|Returns reference to array (same type as Element) with Element repeated for NumberOfElements | |Returns reference to array (same type as Element) with Element repeated for NumberOfElements | ||
|<nowiki>&array=CreateArrayRept(&Element, &NumberOfElements);</nowiki> | |<nowiki>&array=CreateArrayRept(&Element, &NumberOfElements);</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateArray |
|Returns reference to array created from elements - no elements, empty array of ANY created | |Returns reference to array created from elements - no elements, empty array of ANY created | ||
|<nowiki>&array=CreateArray([&element1 [, &element2 ]...]);</nowiki> | |<nowiki>&array=CreateArray([&element1 [, &element2 ]...]);</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateDirectory |
|Creates directory specified by Path and PathType (%FilePath_Absolute/%FilePath_Relative) | |Creates directory specified by Path and PathType (%FilePath_Absolute/%FilePath_Relative) | ||
|<nowiki>CreateDirectory(&Path [, &PathTypeConst]);</nowiki> | |<nowiki>CreateDirectory(&Path [, &PathTypeConst]);</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateException |
|Returns reference to new exception created from message catalog substituting &Value1 for %1 etc. | |Returns reference to new exception created from message catalog substituting &Value1 for %1 etc. | ||
|<nowiki>&exception=CreateException(&MessageSetNumber, &MessageNumber, &DefaultString [, &Value1 [, &Value2 ]...] );</nowiki> | |<nowiki>&exception=CreateException(&MessageSetNumber, &MessageNumber, &DefaultString [, &Value1 [, &Value2 ]...] );</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateJavaArray |
|Returns reference to Java array | |Returns reference to Java array | ||
|<nowiki>&javaObjectArray=CreateJavaArray(&ElementClassName[], &NumberOfElements);</nowiki> | |<nowiki>&javaObjectArray=CreateJavaArray(&ElementClassName[], &NumberOfElements);</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateJavaObject |
|Returns reference to Java object | |Returns reference to Java object | ||
|<nowiki>&javaObject=CreateJavaObject(&ClassName [, &ConstructorParameter1 [, &ConstructorParameter2]... ]);</nowiki> | |<nowiki>&javaObject=CreateJavaObject(&ClassName [, &ConstructorParameter1 [, &ConstructorParameter2]... ]);</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateMCFIMInfo |
|Returns reference to new MCFIMInfo class instance for Network (AOL/Yahoo) | |Returns reference to new MCFIMInfo class instance for Network (AOL/Yahoo) | ||
|<nowiki>&mcfimInfoObject=CreateMCFIMInfo(&OprID, &Provider);</nowiki> | |<nowiki>&mcfimInfoObject=CreateMCFIMInfo(&OprID, &Provider);</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateMessage |
|Returns reference to new instance of message MessageName | |Returns reference to new instance of message MessageName | ||
|<nowiki>&message=CreateMessage(MESSAGE.MessageName);</nowiki> | |<nowiki>&message=CreateMessage(MESSAGE.MessageName);</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateObjectArray |
|Returns reference to new object but parameters to create object not known at design time | |Returns reference to new object but parameters to create object not known at design time | ||
|<nowiki>&object=CreateObjectArray(&ClassName, &ArgumentArray);</nowiki> | |<nowiki>&object=CreateObjectArray(&ClassName, &ArgumentArray);</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateObject |
|Returns reference to new object (OLE Automation or Application Class) | |Returns reference to new object (OLE Automation or Application Class) | ||
|<nowiki>&object=CreateObject(&ClassName);</nowiki> | |<nowiki>&object=CreateObject(&ClassName);</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateProcessRequest |
|Returns reference to new process request, blank or set up. Use &processRequest.Schedule(); after | |Returns reference to new process request, blank or set up. Use &processRequest.Schedule(); after | ||
|<nowiki>&processRequest=CreateProcessRequest( [&ProcessTypeString, &ProcessName] );</nowiki> | |<nowiki>&processRequest=CreateProcessRequest( [&ProcessTypeString, &ProcessName] );</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateRecord |
|Returns reference to new standalone record object | |Returns reference to new standalone record object | ||
|<nowiki>&record=CreateRecord( {RECORD.RecordName | @ &RecordRecName });</nowiki> | |<nowiki>&record=CreateRecord( {RECORD.RecordName | @ &RecordRecName });</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateRowsetCache |
|Returns reference to new RowSetCache object if one does not already exist with that name | |Returns reference to new RowSetCache object if one does not already exist with that name | ||
|<nowiki>&rowsetCache=CreateRowsetCache(&rowset, [ROWSET.]Name, Description);</nowiki> | |<nowiki>&rowsetCache=CreateRowsetCache(&rowset, [ROWSET.]Name, Description);</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateRowset |
|Returns reference to new standalone rowset. Can be populated by &rowset.Fill method. | |Returns reference to new standalone rowset. Can be populated by &rowset.Fill method. | ||
|<nowiki>&rowset=CreateRowset( {RECORD.RecordName | &inRowset1} [, {Field.FieldName, RECORD.RecordName | &inRowset2 } ] ... );</nowiki> | |<nowiki>&rowset=CreateRowset( {RECORD.RecordName | &inRowset1} [, {Field.FieldName, RECORD.RecordName | &inRowset2 } ] ... );</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateSOAPDoc |
| - | |Returns reference to new | + | |Returns reference to new SOAPDoc object |
|<nowiki>&soapDoc=CreateSOAPDoc();</nowiki> | |<nowiki>&soapDoc=CreateSOAPDoc();</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateSQL |
| - | |Returns reference to new | + | |Returns reference to new SQL object |
|<nowiki>&sql=CreateSQL( [ {&SQLString | SQL.SQLName} [, &bindVar1] ... ] );</nowiki> | |<nowiki>&sql=CreateSQL( [ {&SQLString | SQL.SQLName} [, &bindVar1] ... ] );</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateWSDLMessage |
|Returns true if channel and unstructured message created, use GetMessage/GetMessageXmlDoc to see message | |Returns true if channel and unstructured message created, use GetMessage/GetMessageXmlDoc to see message | ||
|<nowiki>&isOK=CreateWDSLMessage(&MessageName, &ChannelName);</nowiki> | |<nowiki>&isOK=CreateWDSLMessage(&MessageName, &ChannelName);</nowiki> | ||
|- | |- | ||
| - | | | + | |CreateXmlDoc |
|Returns reference to new XML Doc object. XML String can be blank. | |Returns reference to new XML Doc object. XML String can be blank. | ||
|<nowiki>&xmlDoc=CreateXmlDoc(&xmlString);</nowiki> | |<nowiki>&xmlDoc=CreateXmlDoc(&xmlString);</nowiki> | ||
|- | |- | ||
| - | | | + | |CubicSpline |
|Returns a cubic spline for set of at least 4 data points??? | |Returns a cubic spline for set of at least 4 data points??? | ||
|<nowiki>&numberArray=CubicSpline(&ArrayOfArraysOf6Numbers, &ControlNumber, &LeftPointConstraint, &RightPointConstraint); </nowiki> | |<nowiki>&numberArray=CubicSpline(&ArrayOfArraysOf6Numbers, &ControlNumber, &LeftPointConstraint, &RightPointConstraint); </nowiki> | ||
|- | |- | ||
| - | | | + | |CurrEffDt |
|Returns current effective Date value of scroll level specified (current if no parameter). Use &rowset.Effdt now. | |Returns current effective Date value of scroll level specified (current if no parameter). Use &rowset.Effdt now. | ||
|<nowiki>¤tEffDt=CurrEffDt( [&LevelNumber] );</nowiki> | |<nowiki>¤tEffDt=CurrEffDt( [&LevelNumber] );</nowiki> | ||
|- | |- | ||
| - | | | + | |CurrEffRowNum |
|Returns current row number of scroll level specified (current if no parameter). Use &row.RowNumber now. | |Returns current row number of scroll level specified (current if no parameter). Use &row.RowNumber now. | ||
|<nowiki>&rowNumber=CurrEffRowNum( [&LevelNumber] );</nowiki> | |<nowiki>&rowNumber=CurrEffRowNum( [&LevelNumber] );</nowiki> | ||
|- | |- | ||
| - | | | + | |CurrEffSeq |
|Returns current effective sequence number of scroll level specified (current if no parameter). Use &rowset.EffSeq now. | |Returns current effective sequence number of scroll level specified (current if no parameter). Use &rowset.EffSeq now. | ||
|<nowiki>&rowNumber=CurrEffSeq( [&LevelNumber] );</nowiki> | |<nowiki>&rowNumber=CurrEffSeq( [&LevelNumber] );</nowiki> | ||
|- | |- | ||
| - | | | + | |CurrentLevelNumber |
|Returns current scroll level number or zero if not in a scroll | |Returns current scroll level number or zero if not in a scroll | ||
|<nowiki>&levelNumber=CurrentLevelNumber();</nowiki> | |<nowiki>&levelNumber=CurrentLevelNumber();</nowiki> | ||
|- | |- | ||
| - | | | + | |CurrentRowNumber |
| - | |Returns current row number on this or higher level. Use &row. | + | |Returns current row number on this or higher level. Use &row.RowNumber now. |
|<nowiki>&rowNumber=CurrentRowNumber( [&LevelNumber] );</nowiki> | |<nowiki>&rowNumber=CurrentRowNumber( [&LevelNumber] );</nowiki> | ||
|- | |- | ||
| - | | | + | |DBCSTrim |
|Deprecated. Returns string without a lead byte at end of string | |Deprecated. Returns string without a lead byte at end of string | ||
|<nowiki>&string=DBCSTrim(&string);</nowiki> | |<nowiki>&string=DBCSTrim(&string);</nowiki> | ||
|- | |- | ||
| - | | | + | |DBPatternMatch |
|Determines if pattern found in string - using SQL wildcards % (any characters) _ (any single characters), \%, \_ escaped wildcards. | |Determines if pattern found in string - using SQL wildcards % (any characters) _ (any single characters), \%, \_ escaped wildcards. | ||
|<nowiki>&isMatch=DBPatternMatch(&string, &pattern, &isCaseSensitive);</nowiki> | |<nowiki>&isMatch=DBPatternMatch(&string, &pattern, &isCaseSensitive);</nowiki> | ||
|- | |- | ||
| - | | | + | |Date3 |
|Returns date object with value specified in years, months days. | |Returns date object with value specified in years, months days. | ||
|<nowiki>&date=Date3(&YYYYnumber, &MMnumber, &DDnumber);</nowiki> | |<nowiki>&date=Date3(&YYYYnumber, &MMnumber, &DDnumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |DatePart |
|Returns date part of a DateTime value | |Returns date part of a DateTime value | ||
|<nowiki>&date=DatePart(&dateTime);</nowiki> | |<nowiki>&date=DatePart(&dateTime);</nowiki> | ||
|- | |- | ||
| - | | | + | |DateTime6 |
|Returns DateTime value with value derived from numbers. | |Returns DateTime value with value derived from numbers. | ||
|<nowiki>&dateTime=DateTime6(&YYYYnumber, &MMnumber, &DDnumber, &HH24number, &MINnumber, &SSnumber);</nowiki> | |<nowiki>&dateTime=DateTime6(&YYYYnumber, &MMnumber, &DDnumber, &HH24number, &MINnumber, &SSnumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |DateTimeToHTTP |
|Returns string representing DateTime in HTTP format example Mon, 03 Sep 2007 09:00:00 GMT | |Returns string representing DateTime in HTTP format example Mon, 03 Sep 2007 09:00:00 GMT | ||
|<nowiki>&dateTimeString=DateTimeToHTTP(&DateTime);</nowiki> | |<nowiki>&dateTimeString=DateTimeToHTTP(&DateTime);</nowiki> | ||
|- | |- | ||
| - | | | + | |DateTimeToLocalizedString |
|Returns string representing DateTime (or just date) in specified format string. | |Returns string representing DateTime (or just date) in specified format string. | ||
|<nowiki>&dateTimeString=DateTimeToLocalizedString(&DateTime [, &format ] );</nowiki> | |<nowiki>&dateTimeString=DateTimeToLocalizedString(&DateTime [, &format ] );</nowiki> | ||
|- | |- | ||
| - | | | + | |DateTimeToTimeZone |
|Returns fromDateTime converted by time zone specified by 3 character string e.g. EST or Local or Base | |Returns fromDateTime converted by time zone specified by 3 character string e.g. EST or Local or Base | ||
|<nowiki>&dateTime=DateTimeToTimeZone(&fromDateTime, &fromTimeZone, &toTimeZone);</nowiki> | |<nowiki>&dateTime=DateTimeToTimeZone(&fromDateTime, &fromTimeZone, &toTimeZone);</nowiki> | ||
|- | |- | ||
| - | | | + | |DateTimeValue |
|Returns DateTime with value of string - in format - DD/MM/YY[YY] hh24:mi:ss.ssssss [{AM , PM}] | |Returns DateTime with value of string - in format - DD/MM/YY[YY] hh24:mi:ss.ssssss [{AM , PM}] | ||
|<nowiki>&dateTime=DateTimeValue(&dateTimeString);</nowiki> | |<nowiki>&dateTime=DateTimeValue(&dateTimeString);</nowiki> | ||
|- | |- | ||
| - | | | + | |DateValue |
|Returns Date with value of string - in format determined by personalised date settings | |Returns Date with value of string - in format determined by personalised date settings | ||
|<nowiki>&date=DateValue(&dateString);</nowiki> | |<nowiki>&date=DateValue(&dateString);</nowiki> | ||
|- | |- | ||
| - | | | + | |Date |
|Returns date object with value specified by number in YYYYMMDD format | |Returns date object with value specified by number in YYYYMMDD format | ||
|<nowiki>&date=Date(&YYYYMMDDnumber);</nowiki> | |<nowiki>&date=Date(&YYYYMMDDnumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |Day |
|Returns day number (1-31) of date | |Returns day number (1-31) of date | ||
|<nowiki>&dayNumber=Day(&date);</nowiki> | |<nowiki>&dayNumber=Day(&date);</nowiki> | ||
|- | |- | ||
| - | | | + | |Days360 |
|Returns number of days between 2 dates if using the 360 day calendar (12 months x 30 days) | |Returns number of days between 2 dates if using the 360 day calendar (12 months x 30 days) | ||
|<nowiki>&numberOfDays=Days360(&fromDate,&toDate);</nowiki> | |<nowiki>&numberOfDays=Days360(&fromDate,&toDate);</nowiki> | ||
|- | |- | ||
| - | | | + | |Days365 |
|Returns number of days between 2 dates if using the 365 day calendar | |Returns number of days between 2 dates if using the 365 day calendar | ||
|<nowiki>&numberOfDays=Days365(&fromDate,&toDate);</nowiki> | |<nowiki>&numberOfDays=Days365(&fromDate,&toDate);</nowiki> | ||
|- | |- | ||
| - | | | + | |Days |
|Returns the Julian date as a number | |Returns the Julian date as a number | ||
|<nowiki>&julianDayNumber=Days(&date);</nowiki> | |<nowiki>&julianDayNumber=Days(&date);</nowiki> | ||
|- | |- | ||
| - | | | + | |DeQueue |
|Removes completed task from MCF queue, returns 0 if successful, else message number from set 162. | |Removes completed task from MCF queue, returns 0 if successful, else message number from set 162. | ||
|<nowiki>&errorCode=DeQueue(&PhysicalQueueID, &TaskType, &TaskNumber, &AgentID);</nowiki> | |<nowiki>&errorCode=DeQueue(&PhysicalQueueID, &TaskType, &TaskNumber, &AgentID);</nowiki> | ||
|- | |- | ||
| - | | | + | |Declare Function |
|Declares PeopleCode or external function for use in the PeopleCode program | |Declares PeopleCode or external function for use in the PeopleCode program | ||
| - | |<nowiki>DECLARE FUNCTION functionName LIBRARY libName [ALIAS ModuleName ] [parameter1, [REF | VALUE] ]... [RETURNS ReturnType [AS PeopleCodeType | + | |<nowiki>DECLARE FUNCTION functionName LIBRARY libName [ALIAS ModuleName ] [parameter1, [REF | VALUE] ]... [RETURNS ReturnType [AS PeopleCodeType</nowiki> |
|- | |- | ||
| - | | | + | |Decrypt |
|Decrypts encryptedString if used Encrypt | |Decrypts encryptedString if used Encrypt | ||
|<nowiki>&plainText=Decrypt(&keyString, &encryptedString);</nowiki> | |<nowiki>&plainText=Decrypt(&keyString, &encryptedString);</nowiki> | ||
|- | |- | ||
| - | | | + | |Degrees |
|Returns angle in degrees from radians | |Returns angle in degrees from radians | ||
|<nowiki>°rees=Degrees(&radians);</nowiki> | |<nowiki>°rees=Degrees(&radians);</nowiki> | ||
|- | |- | ||
| - | | | + | |DeleteAttachment |
|Deletes specified attachment, returns 0 if successful. | |Deletes specified attachment, returns 0 if successful. | ||
|<nowiki>&errorCode=DeleteAttachment(&fromURL, &DestinationAppendedPathFilename [, &PreserveCaseBoolean]);</nowiki> | |<nowiki>&errorCode=DeleteAttachment(&fromURL, &DestinationAppendedPathFilename [, &PreserveCaseBoolean]);</nowiki> | ||
|- | |- | ||
| - | | | + | |DeleteEmailAddress |
|Deletes email address of type (BB , BUS , HOME , OTH , WORK) | |Deletes email address of type (BB , BUS , HOME , OTH , WORK) | ||
|<nowiki>DeleteEmailAddress(&EmailTypeString);</nowiki> | |<nowiki>DeleteEmailAddress(&EmailTypeString);</nowiki> | ||
|- | |- | ||
| - | | | + | |DeleteImage |
|Deletes specified image | |Deletes specified image | ||
|<nowiki>&isOK=DeleteImage( [SCROLL.RecordNameLevel1, RowNumberLevel1, ]... SCROLL.RecordName, &RowNumber, [RecordName.]FieldName);</nowiki> | |<nowiki>&isOK=DeleteImage( [SCROLL.RecordNameLevel1, RowNumberLevel1, ]... SCROLL.RecordName, &RowNumber, [RecordName.]FieldName);</nowiki> | ||
|- | |- | ||
| - | | | + | |DeleteRecord |
|Deletes level zero row from database and any dependent rows on the page. Use &record.delete now. | |Deletes level zero row from database and any dependent rows on the page. Use &record.delete now. | ||
|<nowiki>[&isOK=] DeleteRecord(RecordName.FieldName);</nowiki> | |<nowiki>[&isOK=] DeleteRecord(RecordName.FieldName);</nowiki> | ||
|- | |- | ||
| - | | | + | |DeleteRow |
|Deletes a level 1+ row, causes RowDelete to fire, renumbers rows after delete done. Use &RowSet.DeleteRow now. | |Deletes a level 1+ row, causes RowDelete to fire, renumbers rows after delete done. Use &RowSet.DeleteRow now. | ||
| - | |<nowiki>[&isOK=] DeleteRow([RECORD.RecordNameLevel1, &rowNumberLevel1 [,RECORD.RecordNameLevel2, &rowNumberLevel2 | + | |<nowiki>[&isOK=] DeleteRow([RECORD.RecordNameLevel1, &rowNumberLevel1 [,RECORD.RecordNameLevel2, &rowNumberLevel2, &rowNumber );</nowiki> |
|- | |- | ||
| - | | | + | |DeleteSQL |
|Deletes an Application Designer SQL definition. DBType is APPSRV, DB2ODBC, DB2UNIX, INFORMIX, MICROSFT, ORACLE, SYBASE - defaults to %DbName | |Deletes an Application Designer SQL definition. DBType is APPSRV, DB2ODBC, DB2UNIX, INFORMIX, MICROSFT, ORACLE, SYBASE - defaults to %DbName | ||
| - | |<nowiki>&isOK=DeleteSQL([SQL.]SQLName [, &dbType [, &EffectiveDate | + | |<nowiki>&isOK=DeleteSQL([SQL.]SQLName [, &dbType [, &EffectiveDate);</nowiki> |
|- | |- | ||
| - | | | + | |DeleteSystemPauseTimes |
|Deletes specified system pause time | |Deletes specified system pause time | ||
|<nowiki>&isOK=DeleteSystemPauseTimes(&BeginWeekDayNumber, &BeginTimeSeconds, &EndWeekDayNumber, &EndTimeSeconds);</nowiki> | |<nowiki>&isOK=DeleteSystemPauseTimes(&BeginWeekDayNumber, &BeginTimeSeconds, &EndWeekDayNumber, &EndTimeSeconds);</nowiki> | ||
|- | |- | ||
| - | | | + | |DetachAttachment |
|Copies file attachment from server to browsing system | |Copies file attachment from server to browsing system | ||
|<nowiki>&errorCode=DetachAttachment(&FromURL, &FromAppendedPathFilename, &SuggestedFileExtension, &ToFile [, &PreserveCaseBoolean]);</nowiki> | |<nowiki>&errorCode=DetachAttachment(&FromURL, &FromAppendedPathFilename, &SuggestedFileExtension, &ToFile [, &PreserveCaseBoolean]);</nowiki> | ||
|- | |- | ||
| - | | | + | |DisableMenuItem |
|Disables (pop up) menu item name. Ignored by Component Interface. | |Disables (pop up) menu item name. Ignored by Component Interface. | ||
|<nowiki>DisableMenuItem(BARNAME.MenuBarName, ITEMNAME.ItemName);</nowiki> | |<nowiki>DisableMenuItem(BARNAME.MenuBarName, ITEMNAME.ItemName);</nowiki> | ||
|- | |- | ||
| - | | | + | |DiscardRow |
|Does not show the selected row on the page. Only called in RowSelect. | |Does not show the selected row on the page. Only called in RowSelect. | ||
|<nowiki>DiscardRow();</nowiki> | |<nowiki>DiscardRow();</nowiki> | ||
|- | |- | ||
| - | | | + | |DoCancel |
|Cancels current page or menu. Does not stop SaveEdit, SavePreChange, SavePostChange | |Cancels current page or menu. Does not stop SaveEdit, SavePreChange, SavePostChange | ||
|<nowiki>DoCancel();</nowiki> | |<nowiki>DoCancel();</nowiki> | ||
|- | |- | ||
| - | | | + | |DoModalComponent |
|Displays secondary component in action mode A/U/L(Upddisp all)/C/E (Data Entry)/P (Prompt), returns 1 (OK) or 0 (cancelled) | |Displays secondary component in action mode A/U/L(Upddisp all)/C/E (Data Entry)/P (Prompt), returns 1 (OK) or 0 (cancelled) | ||
|<nowiki>&OKCancel=DoModalComponent(MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.LandingPageName, &Action, &RECORD.SharedRecordName [, RecordName.Field ]... );</nowiki> | |<nowiki>&OKCancel=DoModalComponent(MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.LandingPageName, &Action, &RECORD.SharedRecordName [, RecordName.Field ]... );</nowiki> | ||
|- | |- | ||
| - | | | + | |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. | |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. | ||
|<nowiki>&OKCancel=DoModalPanelGoup(MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PANEL.LandingPageName, &Action, &RECORD.SharedRecordName);</nowiki> | |<nowiki>&OKCancel=DoModalPanelGoup(MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PANEL.LandingPageName, &Action, &RECORD.SharedRecordName);</nowiki> | ||
|- | |- | ||
| - | | | + | |DoModal |
|Displays secondary page, returns 1 (OK) or 0 (cancelled) | |Displays secondary page, returns 1 (OK) or 0 (cancelled) | ||
|<nowiki>&OKCancel=DoModal(PAGE.PageName, &WindowTitle, &xPosition, &yPosition [, &LevelNumber, [RECORD.RecordNameLevel1, RowNumberLevel1]..., &RowNumber]);</nowiki> | |<nowiki>&OKCancel=DoModal(PAGE.PageName, &WindowTitle, &xPosition, &yPosition [, &LevelNumber, [RECORD.RecordNameLevel1, RowNumberLevel1]..., &RowNumber]);</nowiki> | ||
|- | |- | ||
| - | | | + | |DoSaveNow |
|Saves immediately, executing the save PeopleCode. Useful if calling a remote call program that accesses the page data direct. | |Saves immediately, executing the save PeopleCode. Useful if calling a remote call program that accesses the page data direct. | ||
|<nowiki>DoSaveNow();</nowiki> | |<nowiki>DoSaveNow();</nowiki> | ||
|- | |- | ||
| - | | | + | |DoSave |
|Saves at end of current PeopleCode event, executes PeopleCode associated with save. Only usable in FEd, FCh, MenuItemSelected. | |Saves at end of current PeopleCode event, executes PeopleCode associated with save. Only usable in FEd, FCh, MenuItemSelected. | ||
|<nowiki>DoSave();</nowiki> | |<nowiki>DoSave();</nowiki> | ||
|- | |- | ||
| - | | | + | |Else |
|Executes statements depending on condition | |Executes statements depending on condition | ||
| - | |<nowiki>If conditions Then [statements] [Else [statements | + | |<nowiki>If conditions Then [statements] [Else [statements End-If;</nowiki> |
|- | |- | ||
| - | | | + | |EnQueue |
|Adds task to MCF queue, returns 0 if successful, else message number from set 162. | |Adds task to MCF queue, returns 0 if successful, else message number from set 162. | ||
|<nowiki>&errorCode=EnQueue(&PhysicalQueueID, &TaskType, &LaunchPageURL, &LanguageCode [, &Subject [, &AgentID [, &MinsToOverflow [, &MinsToEscalation [, &CostNumber [, &PriorityNumber [, &MinSkillNumber]--]);</nowiki> | |<nowiki>&errorCode=EnQueue(&PhysicalQueueID, &TaskType, &LaunchPageURL, &LanguageCode [, &Subject [, &AgentID [, &MinsToOverflow [, &MinsToEscalation [, &CostNumber [, &PriorityNumber [, &MinSkillNumber]--]);</nowiki> | ||
|- | |- | ||
| - | | | + | |EnableMenuItem |
|Enables a (PopUp) menu item for selection. For pop up menu place in PrePopUp of field. | |Enables a (PopUp) menu item for selection. For pop up menu place in PrePopUp of field. | ||
|<nowiki>EnableMenuItem(BARNAME.BarName, ITEMNAME.ItemName);</nowiki> | |<nowiki>EnableMenuItem(BARNAME.BarName, ITEMNAME.ItemName);</nowiki> | ||
|- | |- | ||
| - | | | + | |EncodeURLForQueryString |
|Returns a string encoded according to the W3C encoding rules. Does not encode ()*-._ | |Returns a string encoded according to the W3C encoding rules. Does not encode ()*-._ | ||
|<nowiki>&encodedString=EncodeURLForQuery(&URLString);</nowiki> | |<nowiki>&encodedString=EncodeURLForQuery(&URLString);</nowiki> | ||
|- | |- | ||
| - | | | + | |EncodeURL |
|Returns a string encoded according to the W3C encoding rules. Does not encode !#$&()*+,-./:;=?_ | |Returns a string encoded according to the W3C encoding rules. Does not encode !#$&()*+,-./:;=?_ | ||
|<nowiki>&encodedString=EncodeURL(&URLString);</nowiki> | |<nowiki>&encodedString=EncodeURL(&URLString);</nowiki> | ||
|- | |- | ||
| - | | | + | |EncryptNodePswd |
|Returns an encrypted Integration Broker node password | |Returns an encrypted Integration Broker node password | ||
|<nowiki>&encryptedNodePassword=EncryptNodePswd(&PlainText);</nowiki> | |<nowiki>&encryptedNodePassword=EncryptNodePswd(&PlainText);</nowiki> | ||
|- | |- | ||
| - | | | + | |Encrypt |
|Returns an encrypted string | |Returns an encrypted string | ||
|<nowiki>&encryptedString=Encrypt(&KeyString, &PlainText);</nowiki> | |<nowiki>&encryptedString=Encrypt(&KeyString, &PlainText);</nowiki> | ||
|- | |- | ||
| - | | | + | |End-Evaluate |
|Evaluate branches depending on conditions on Value | |Evaluate branches depending on conditions on Value | ||
|<nowiki>Evaluate &Value When ... End-evaluate</nowiki> | |<nowiki>Evaluate &Value When ... End-evaluate</nowiki> | ||
|- | |- | ||
| - | | | + | |End-For |
|Ends for loop | |Ends for loop | ||
|<nowiki>End-For;</nowiki> | |<nowiki>End-For;</nowiki> | ||
|- | |- | ||
| - | | | + | |End-Function |
|Ends function definition | |Ends function definition | ||
|<nowiki>End-Function</nowiki> | |<nowiki>End-Function</nowiki> | ||
|- | |- | ||
| - | | | + | |End-If |
|Executes statements depending on condition | |Executes statements depending on condition | ||
| - | |<nowiki>If conditions Then [statements] [Else [statements | + | |<nowiki>If conditions Then [statements] [Else [statements End-If;</nowiki> |
|- | |- | ||
| - | | | + | |End-Try |
|Creates a block where statements can error and these are handled. | |Creates a block where statements can error and these are handled. | ||
|<nowiki>Try statementsSandbox; Catch exceptionSubClass &Exception errorHandlingStatements; End-Try;</nowiki> | |<nowiki>Try statementsSandbox; Catch exceptionSubClass &Exception errorHandlingStatements; End-Try;</nowiki> | ||
|- | |- | ||
| - | | | + | |End-While |
|Repeats Statements while Boolean is true. | |Repeats Statements while Boolean is true. | ||
|<nowiki>While (&Boolean) Statements; End-While;</nowiki> | |<nowiki>While (&Boolean) Statements; End-While;</nowiki> | ||
|- | |- | ||
| - | | | + | |EndMessage |
|Shows a message and ends SPo PeopleCode at time of commit only in SPo. Use MessageBox now. | |Shows a message and ends SPo PeopleCode at time of commit only in SPo. Use MessageBox now. | ||
|<nowiki>EndMessage(&Message, &MessageTitle);</nowiki> | |<nowiki>EndMessage(&Message, &MessageTitle);</nowiki> | ||
|- | |- | ||
| - | | | + | |EndModalComponent |
|Closes current modal secondary component (not in CI), &OKNumber=0 - no values returned to main page, >1 - values returned | |Closes current modal secondary component (not in CI), &OKNumber=0 - no values returned to main page, >1 - values returned | ||
|<nowiki>EndModalComponent(&OKNumber):</nowiki> | |<nowiki>EndModalComponent(&OKNumber):</nowiki> | ||
|- | |- | ||
| - | | | + | |EndModal |
|Closes current modal secondary page (not in CI), &OKNumber=0 - no values returned to main page, >1 - values returned | |Closes current modal secondary page (not in CI), &OKNumber=0 - no values returned to main page, >1 - values returned | ||
|<nowiki>EndModal(&OKNumber):</nowiki> | |<nowiki>EndModal(&OKNumber):</nowiki> | ||
|- | |- | ||
| - | | | + | |Error |
|FEd, SEd, RDe: Displays error message and stops PeopleCode and save; RSe: Make current row the last to be added to buffer | |FEd, SEd, RDe: Displays error message and stops PeopleCode and save; RSe: Make current row the last to be added to buffer | ||
|<nowiki>Error &ErrorMessage;</nowiki> | |<nowiki>Error &ErrorMessage;</nowiki> | ||
|- | |- | ||
| - | | | + | |EscapeHTML |
|Returns text with HTML characters escaped (e.g. < becomes <) | |Returns text with HTML characters escaped (e.g. < becomes <) | ||
|<nowiki>&escapedText=EscapeHTML(&Text);</nowiki> | |<nowiki>&escapedText=EscapeHTML(&Text);</nowiki> | ||
|- | |- | ||
| - | | | + | |EscapeJavascriptString |
|Returns text for use in JavaScript - changes ' " NL CR \\ | |Returns text for use in JavaScript - changes ' " NL CR \\ | ||
|<nowiki>&escapedText=EscapeJavascriptString(&Text);</nowiki> | |<nowiki>&escapedText=EscapeJavascriptString(&Text);</nowiki> | ||
|- | |- | ||
| - | | | + | |EscapeWML |
|Returns text for use in WML - changes ' " <>$& | |Returns text for use in WML - changes ' " <>$& | ||
|<nowiki>&escapedText=EscapeWML(&Text);</nowiki> | |<nowiki>&escapedText=EscapeWML(&Text);</nowiki> | ||
|- | |- | ||
| - | | | + | |Evaluate |
|Evaluate branches depending on conditions on Value | |Evaluate branches depending on conditions on Value | ||
|<nowiki>Evaluate &Value When ... End-evaluate</nowiki> | |<nowiki>Evaluate &Value When ... End-evaluate</nowiki> | ||
|- | |- | ||
| - | | | + | |Exact |
|Returns true if strings exactly match | |Returns true if strings exactly match | ||
|<nowiki>&isSame=Exact(&String1, &String2);</nowiki> | |<nowiki>&isSame=Exact(&String1, &String2);</nowiki> | ||
|- | |- | ||
| - | | | + | |Exec(2) |
|Starts operating system command and waits to return the process exit code | |Starts operating system command and waits to return the process exit code | ||
|<nowiki>&exitNumber=Exec(&CommandString, %Exec_Synchronous+%FilePath_Absolute);</nowiki> | |<nowiki>&exitNumber=Exec(&CommandString, %Exec_Synchronous+%FilePath_Absolute);</nowiki> | ||
|- | |- | ||
| - | | | + | |Exec |
|Starts operating system command and returns process ID | |Starts operating system command and returns process ID | ||
|<nowiki>&processNumber=Exec(&CommandString, &isSynchronous);</nowiki> | |<nowiki>&processNumber=Exec(&CommandString, &isSynchronous);</nowiki> | ||
|- | |- | ||
| - | | | + | |ExecuteRolePeopleCode |
|Returns array of users currently in the Dynamic Role. | |Returns array of users currently in the Dynamic Role. | ||
|<nowiki>&userIDArray=ExecuteRolePeopleCode(&DynamicRoleName);</nowiki> | |<nowiki>&userIDArray=ExecuteRolePeopleCode(&DynamicRoleName);</nowiki> | ||
|- | |- | ||
| - | | | + | |ExecuteRoleQuery |
|Returns array of users currently in the Query Role using the bind string parameters | |Returns array of users currently in the Query Role using the bind string parameters | ||
|<nowiki>&userIDArray=ExecuteRoleQuery(&QueryRoleName, &BindString1 [, BindString2]... );</nowiki> | |<nowiki>&userIDArray=ExecuteRoleQuery(&QueryRoleName, &BindString1 [, BindString2]... );</nowiki> | ||
|- | |- | ||
| - | | | + | |ExecuteRoleWorkflowQuery |
|Returns array of users currently in the Workflow Query Role using the bind string parameters | |Returns array of users currently in the Workflow Query Role using the bind string parameters | ||
|<nowiki>&userIDArray=ExecuteRoleWorkflowQuery(&WorkflowQueryRoleName, &BindString1 [, BindString2]... );</nowiki> | |<nowiki>&userIDArray=ExecuteRoleWorkflowQuery(&WorkflowQueryRoleName, &BindString1 [, BindString2]... );</nowiki> | ||
|- | |- | ||
| - | | | + | |Exit |
|Immediately leave PeopleCode program, if &number is 1 then rollback. | |Immediately leave PeopleCode program, if &number is 1 then rollback. | ||
|<nowiki>Exit [ (&number) ] ;</nowiki> | |<nowiki>Exit [ (&number) ] ;</nowiki> | ||
|- | |- | ||
| - | | | + | |Exp |
|Returns e (2.7182818?) to the power of Natural Logarithm | |Returns e (2.7182818?) to the power of Natural Logarithm | ||
|<nowiki>&number=Exp(&NaturalLogarithm);</nowiki> | |<nowiki>&number=Exp(&NaturalLogarithm);</nowiki> | ||
|- | |- | ||
| - | | | + | |ExpandBindVar |
|Returns string replacing :RecordName.FieldName with appropriate values | |Returns string replacing :RecordName.FieldName with appropriate values | ||
|<nowiki>&expandedString=ExpandBindVar(&string);</nowiki> | |<nowiki>&expandedString=ExpandBindVar(&string);</nowiki> | ||
|- | |- | ||
| - | | | + | |ExpandEnvVar |
|Returns string replacing operating system environment variable names with their values | |Returns string replacing operating system environment variable names with their values | ||
|<nowiki>&expandedString=ExpandEnvVar(&string);</nowiki> | |<nowiki>&expandedString=ExpandEnvVar(&string);</nowiki> | ||
|- | |- | ||
| - | | | + | |ExpandSqlBinds |
|Returns string replacing :1... with values from the BindValue list | |Returns string replacing :1... with values from the BindValue list | ||
|<nowiki>&expandedString=ExpandSQLBinds(&string [, &bindValue1]... );</nowiki> | |<nowiki>&expandedString=ExpandSQLBinds(&string [, &bindValue1]... );</nowiki> | ||
|- | |- | ||
| - | | | + | |Fact |
|Returns factorial of truncated Number (1 x 2 x ? x Number) | |Returns factorial of truncated Number (1 x 2 x ? x Number) | ||
|<nowiki>&factorial=Fact(&Number);</nowiki> | |<nowiki>&factorial=Fact(&Number);</nowiki> | ||
|- | |- | ||
| - | | | + | |FetchSQL |
|Returns Application Designer SQL string with name according to DBType is APPSRV, DB2ODBC, DB2UNIX, INFORMIX, MICROSFT, ORACLE, SYBASE - defaults to %DbName | |Returns Application Designer SQL string with name according to DBType is APPSRV, DB2ODBC, DB2UNIX, INFORMIX, MICROSFT, ORACLE, SYBASE - defaults to %DbName | ||
|<nowiki>&sql=FetchSQL( [SQL.]SQLName [, &DBType [, &EffectiveDate] ] );</nowiki> | |<nowiki>&sql=FetchSQL( [SQL.]SQLName [, &DBType [, &EffectiveDate] ] );</nowiki> | ||
|- | |- | ||
| - | | | + | |FetchValue |
|Returns value from buffer fields (outside current context). Use &Field.Value now. | |Returns value from buffer fields (outside current context). Use &Field.Value now. | ||
|<nowiki>&value=FetchValue( [RECORD.RecordName1, &RowLevel1 , [ RECORD.RecordName2, &RowLevel2, ]... &TargetRowNumber, [RecordName.]FieldName);</nowiki> | |<nowiki>&value=FetchValue( [RECORD.RecordName1, &RowLevel1 , [ RECORD.RecordName2, &RowLevel2, ]... &TargetRowNumber, [RecordName.]FieldName);</nowiki> | ||
|- | |- | ||
| - | | | + | |FieldChanged |
|Returns if field has been changed from database by PeopleCode or user | |Returns if field has been changed from database by PeopleCode or user | ||
| - | |<nowiki>&isChanged=FieldChange( | + | |<nowiki>&isChanged=FieldChange( RECORD.RecordName1, &RowLevel1 , [ RECORD.RecordName2, &RowLevel2, ]...&TargetRowNumber, [RecordName.]FieldName);</nowiki> |
|- | |- | ||
| - | | | + | |FileExists |
|Returns if file exists (on Server). File Path Type is either %FilePath_Relative or %FilePath_Absolute | |Returns if file exists (on Server). File Path Type is either %FilePath_Relative or %FilePath_Absolute | ||
|<nowiki>&isThere=FileExists(&FileNameString, &FilePathType);</nowiki> | |<nowiki>&isThere=FileExists(&FileNameString, &FilePathType);</nowiki> | ||
|- | |- | ||
| - | | | + | |FindCodeSetValues |
|Returns list of code set name-pair values as part of data value translations in Integration Broker | |Returns list of code set name-pair values as part of data value translations in Integration Broker | ||
|<nowiki>&nameValuePairArray=FindCodeSetValues(&CodeSetName, &inNameValuePairArray, &FromNodeName, &ToNodeName);</nowiki> | |<nowiki>&nameValuePairArray=FindCodeSetValues(&CodeSetName, &inNameValuePairArray, &FromNodeName, &ToNodeName);</nowiki> | ||
|- | |- | ||
| - | | | + | |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 | |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 | ||
|<nowiki>&FileNameArray=FindFiles(&FileNamePattern [ , &PathType]);</nowiki> | |<nowiki>&FileNameArray=FindFiles(&FileNamePattern [ , &PathType]);</nowiki> | ||
|- | |- | ||
| - | | | + | |Find |
|Returns position of left most SubString in Text (0 if not found), starting at StartPosition | |Returns position of left most SubString in Text (0 if not found), starting at StartPosition | ||
|<nowiki>&positionNumber=Find(&SubString, &Text [, &StartPosition]); </nowiki> | |<nowiki>&positionNumber=Find(&SubString, &Text [, &StartPosition]); </nowiki> | ||
|- | |- | ||
| - | | | + | |Findb |
|DEPRECATED. Returns position of left most SubString (bytes) in Text (0 if not found), starting at StartPosition | |DEPRECATED. Returns position of left most SubString (bytes) in Text (0 if not found), starting at StartPosition | ||
|<nowiki>&positionNumber=Findb(&SubString, &Text [, &StartPosition]); </nowiki> | |<nowiki>&positionNumber=Findb(&SubString, &Text [, &StartPosition]); </nowiki> | ||
|- | |- | ||
| - | | | + | |FlushBulkInserts |
|Moves bulk inserted rows held in buffer to database, Inserts but does not Commit. | |Moves bulk inserted rows held in buffer to database, Inserts but does not Commit. | ||
|<nowiki>FlushBulkInserts();</nowiki> | |<nowiki>FlushBulkInserts();</nowiki> | ||
|- | |- | ||
| - | | | + | |For |
|For loop ended with end-for | |For loop ended with end-for | ||
|<nowiki>for index = &number1 to number2 [step &increment];</nowiki> | |<nowiki>for index = &number1 to number2 [step &increment];</nowiki> | ||
|- | |- | ||
| - | | | + | |FormatDateTime |
|Returns formatted DateTime converted to time zone specified by 3 character string e.g. EST or Local or Base | |Returns formatted DateTime converted to time zone specified by 3 character string e.g. EST or Local or Base | ||
|<nowiki>&dateString=FormatDateTime(&DateTime, &TimeZone, &isWithTimeZone);</nowiki> | |<nowiki>&dateString=FormatDateTime(&DateTime, &TimeZone, &isWithTimeZone);</nowiki> | ||
|- | |- | ||
| - | | | + | |Forward |
|Transfers MCF task from one queue/agent to another, returns 0 if successful, else message number from set 162. | |Transfers MCF task from one queue/agent to another, returns 0 if successful, else message number from set 162. | ||
|<nowiki>&errorCode=Forward(&FromPhysicalQueueID, &FromAgentID, &TaskNumber, &TaskType, &ToLogicalQueueID [, &ToAgentID]);</nowiki> | |<nowiki>&errorCode=Forward(&FromPhysicalQueueID, &FromAgentID, &TaskNumber, &TaskType, &ToLogicalQueueID [, &ToAgentID]);</nowiki> | ||
|- | |- | ||
| - | | | + | |Function |
|Starts function definition | |Starts function definition | ||
|<nowiki>Function FunctionName [ ( {¶meter1 [As DataType1]}...) ] [ Returns DataType ]</nowiki> | |<nowiki>Function FunctionName [ ( {¶meter1 [As DataType1]}...) ] [ Returns DataType ]</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateActGuideContentUrl |
|Returns Activity Guide content URL | |Returns Activity Guide content URL | ||
|<nowiki>&URLString=GenerateActGuideContentURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, &Market, COMPONENT.ComponentName, &ActivityGuide);</nowiki> | |<nowiki>&URLString=GenerateActGuideContentURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, &Market, COMPONENT.ComponentName, &ActivityGuide);</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateActGuidePortalUrl |
|Returns Activity Guide portal URL | |Returns Activity Guide portal URL | ||
|<nowiki>&URLString=GenerateActGuidePortalURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, &Market, COMPONENT.ComponentName, &ActivityGuide);</nowiki> | |<nowiki>&URLString=GenerateActGuidePortalURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, &Market, COMPONENT.ComponentName, &ActivityGuide);</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateActGuideRelativeUrl |
|Returns Activity Guide relative URL | |Returns Activity Guide relative URL | ||
|<nowiki>&URLString=GenerateActGuideRelativeURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, &Market, COMPONENT.ComponentName, &ActivityGuide);</nowiki> | |<nowiki>&URLString=GenerateActGuideRelativeURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, &Market, COMPONENT.ComponentName, &ActivityGuide);</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateComponentContentRelURL |
|Returns Component Content relative URL | |Returns Component Content relative URL | ||
|<nowiki>&URLString=GenerateComponentContentRelURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, COMPONENT.ComponentName, PAGE.PageName, &Action [, &KeyRecord1 ]...);</nowiki> | |<nowiki>&URLString=GenerateComponentContentRelURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, COMPONENT.ComponentName, PAGE.PageName, &Action [, &KeyRecord1 ]...);</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateComponentContentURL |
|Returns Component Content absolute URL | |Returns Component Content absolute URL | ||
|<nowiki>&URLString=GenerateComponentContentURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, COMPONENT.ComponentName, PAGE.PageName, &Action [, &KeyRecord1 ]...);</nowiki> | |<nowiki>&URLString=GenerateComponentContentURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, COMPONENT.ComponentName, PAGE.PageName, &Action [, &KeyRecord1 ]...);</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateComponentPortalRelURL |
|Returns Component Portal relative URL | |Returns Component Portal relative URL | ||
|<nowiki>&URLString=GenerateComponentPortalRelURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, COMPONENT.ComponentName, PAGE.PageName, &Action [, &KeyRecord1 ]...);</nowiki> | |<nowiki>&URLString=GenerateComponentPortalRelURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, COMPONENT.ComponentName, PAGE.PageName, &Action [, &KeyRecord1 ]...);</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateComponentPortalURL |
|Returns Component Portal absolute URL | |Returns Component Portal absolute URL | ||
|<nowiki>&URLString=GenerateComponentPortalURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, COMPONENT.ComponentName, PAGE.PageName, &Action [, &KeyRecord1 ]...);</nowiki> | |<nowiki>&URLString=GenerateComponentPortalURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, COMPONENT.ComponentName, PAGE.PageName, &Action [, &KeyRecord1 ]...);</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateComponentRelativeURL |
|Returns Component relative URL | |Returns Component relative URL | ||
|<nowiki>&URLString=GenerateComponentRelativeURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, COMPONENT.ComponentName, PAGE.PageName, &Action [, &KeyRecord1 ]...);</nowiki> | |<nowiki>&URLString=GenerateComponentRelativeURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, COMPONENT.ComponentName, PAGE.PageName, &Action [, &KeyRecord1 ]...);</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateExternalPortalURL |
|Returns URL of external content on the portal servlet | |Returns URL of external content on the portal servlet | ||
|<nowiki>&URLString=GenerateExternalPortalURL(PORTAL.PortalName, NODE.NodeName, &URLString);</nowiki> | |<nowiki>&URLString=GenerateExternalPortalURL(PORTAL.PortalName, NODE.NodeName, &URLString);</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateExternalRelativeURL |
|Returns relative URL of external content on the portal servlet | |Returns relative URL of external content on the portal servlet | ||
|<nowiki>&URLString=GenerateExternalRelativeURL(PORTAL.PortalName, NODE.NodeName, &EncodedURLString);</nowiki> | |<nowiki>&URLString=GenerateExternalRelativeURL(PORTAL.PortalName, NODE.NodeName, &EncodedURLString);</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateHomepagePortalURL |
|Returns URL of specified Tab (or default if "") on the HomePage | |Returns URL of specified Tab (or default if "") on the HomePage | ||
|<nowiki>&URLString=GenerateHomepagePortalURL(PORTAL.PortalName, NODE.NodeName, &TabName);</nowiki> | |<nowiki>&URLString=GenerateHomepagePortalURL(PORTAL.PortalName, NODE.NodeName, &TabName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateHomepageRelativeURL |
|Returns relative URL of specified Tab (or default if "") on the HomePage | |Returns relative URL of specified Tab (or default if "") on the HomePage | ||
|<nowiki>&URLString=GenerateHomepageRelativeURL(PORTAL.PortalName, NODE.NodeName, &TabName);</nowiki> | |<nowiki>&URLString=GenerateHomepageRelativeURL(PORTAL.PortalName, NODE.NodeName, &TabName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateMobileTree |
|Returns HTML of a tree representing a populated CI | |Returns HTML of a tree representing a populated CI | ||
|<nowiki>&treeHTML=GenerateMobileTree(&CI [,&CIProperty ] );</nowiki> | |<nowiki>&treeHTML=GenerateMobileTree(&CI [,&CIProperty ] );</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateQueryContentURL |
|Returns content URL of specified quey | |Returns content URL of specified quey | ||
|<nowiki>&URLString=GenerateQueryContentURL(PORTAL.PortalName, NODE.NodeName, &QueryName, &isPublicQuery [, &isInNewWindow] );</nowiki> | |<nowiki>&URLString=GenerateQueryContentURL(PORTAL.PortalName, NODE.NodeName, &QueryName, &isPublicQuery [, &isInNewWindow] );</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateQueryPortalURL |
|Returns portal URL of specified quey | |Returns portal URL of specified quey | ||
|<nowiki>&URLString=GenerateQueryPortalURL(PORTAL.PortalName, NODE.NodeName, &QueryName, &isPublicQuery [, &isInNewWindow] );</nowiki> | |<nowiki>&URLString=GenerateQueryPortalURL(PORTAL.PortalName, NODE.NodeName, &QueryName, &isPublicQuery [, &isInNewWindow] );</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateQueryRelativeURL |
|Returns relative URL of specified quey | |Returns relative URL of specified quey | ||
|<nowiki>&URLString=GenerateQueryRelativeURL(PORTAL.PortalName, NODE.NodeName, &QueryName, &isPublicQuery [, &isInNewWindow] );</nowiki> | |<nowiki>&URLString=GenerateQueryRelativeURL(PORTAL.PortalName, NODE.NodeName, &QueryName, &isPublicQuery [, &isInNewWindow] );</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateScriptContentRelURL |
|Returns relative URL to specified iScript. | |Returns relative URL to specified iScript. | ||
|<nowiki>&URLString=GenerateScriptContentRelURL(PORTAL.PortalName, NODE.NodeName, RECORD.RecordName, Field.FieldName, &iScriptEventName, &iScriptFunctionName [, &Field1]... );</nowiki> | |<nowiki>&URLString=GenerateScriptContentRelURL(PORTAL.PortalName, NODE.NodeName, RECORD.RecordName, Field.FieldName, &iScriptEventName, &iScriptFunctionName [, &Field1]... );</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateScriptContentURL |
|Returns content URL to specified iScript. | |Returns content URL to specified iScript. | ||
|<nowiki>&URLString=GenerateScriptContentURL(PORTAL.PortalName, NODE.NodeName, RECORD.RecordName, Field.FieldName, &iScriptEventName, &iScriptFunctionName [, &Field1]... );</nowiki> | |<nowiki>&URLString=GenerateScriptContentURL(PORTAL.PortalName, NODE.NodeName, RECORD.RecordName, Field.FieldName, &iScriptEventName, &iScriptFunctionName [, &Field1]... );</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateScriptPortalRelURL |
|Returns relative portal URL to specified iScript. | |Returns relative portal URL to specified iScript. | ||
|<nowiki>&URLString=GenerateScriptPortalRelURL(PORTAL.PortalName, NODE.NodeName, RECORD.RecordName, Field.FieldName, &iScriptEventName, &iScriptFunctionName [, &Field1]... );</nowiki> | |<nowiki>&URLString=GenerateScriptPortalRelURL(PORTAL.PortalName, NODE.NodeName, RECORD.RecordName, Field.FieldName, &iScriptEventName, &iScriptFunctionName [, &Field1]... );</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateScriptPortalURL |
|Returns portal URL to specified iScript. | |Returns portal URL to specified iScript. | ||
|<nowiki>&URLString=GenerateScriptPortalRelURL(PORTAL.PortalName, NODE.NodeName, RECORD.RecordName, Field.FieldName, &iScriptEventName, &iScriptFunctionName [, &Field1]... );</nowiki> | |<nowiki>&URLString=GenerateScriptPortalRelURL(PORTAL.PortalName, NODE.NodeName, RECORD.RecordName, Field.FieldName, &iScriptEventName, &iScriptFunctionName [, &Field1]... );</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateScriptRelativeURL |
|Returns relative URL to specified iScript. | |Returns relative URL to specified iScript. | ||
|<nowiki>&URLString=GenerateScriptPortalRelURL(PORTAL.PortalName, NODE.NodeName, RECORD.RecordName, Field.FieldName, &iScriptEventName, &iScriptFunctionName [, &Field1]... );</nowiki> | |<nowiki>&URLString=GenerateScriptPortalRelURL(PORTAL.PortalName, NODE.NodeName, RECORD.RecordName, Field.FieldName, &iScriptEventName, &iScriptFunctionName [, &Field1]... );</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateTree |
|Returns HTML of a tree representing the specified rowset | |Returns HTML of a tree representing the specified rowset | ||
|<nowiki>&treeHTML=GenerateTree(&RowSet [,TreeEventFieldName ] );</nowiki> | |<nowiki>&treeHTML=GenerateTree(&RowSet [,TreeEventFieldName ] );</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateWorklistPortalURL |
|Returns portal URL to specified worklist. | |Returns portal URL to specified worklist. | ||
|<nowiki>&URLString=GenerateWorklistPortalURL(PORTAL.PortalName, NODE.NodeName, &BusinessProcess, &Activity, &Event, &Worklist, &Instance);</nowiki> | |<nowiki>&URLString=GenerateWorklistPortalURL(PORTAL.PortalName, NODE.NodeName, &BusinessProcess, &Activity, &Event, &Worklist, &Instance);</nowiki> | ||
|- | |- | ||
| - | | | + | |GenerateWorklistRelativeURL |
|Returns relative URL to specified worklist. | |Returns relative URL to specified worklist. | ||
|<nowiki>&URLString=GenerateWorklistRelativeURL(PORTAL.PortalName, NODE.NodeName, &BusinessProcess, &Activity, &Event, &Worklist, &Instance);</nowiki> | |<nowiki>&URLString=GenerateWorklistRelativeURL(PORTAL.PortalName, NODE.NodeName, &BusinessProcess, &Activity, &Event, &Worklist, &Instance);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetAESection |
|Returns AE section object with base section, if Section does not exist, then it is created. | |Returns AE section object with base section, if Section does not exist, then it is created. | ||
|<nowiki>&AESection=GetAESection(&ApplicationID, &SectionName [, &EffDt ] );</nowiki> | |<nowiki>&AESection=GetAESection(&ApplicationID, &SectionName [, &EffDt ] );</nowiki> | ||
|- | |- | ||
| - | | | + | |GetArchPubHeaderXmlDoc |
|Returns reference to archived message header from queue | |Returns reference to archived message header from queue | ||
|<nowiki>&xmlDocument=GetArchPubHeaderXmlDoc(&MessagePubID, &PublishNode, &ChannelName, &VersionName);</nowiki> | |<nowiki>&xmlDocument=GetArchPubHeaderXmlDoc(&MessagePubID, &PublishNode, &ChannelName, &VersionName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetArchPubXmlDoc |
|Returns reference to archived message from queue | |Returns reference to archived message from queue | ||
|<nowiki>&xmlDocument=GetArchPubXmlDoc(&MessagePubID, &PublishNode, &ChannelName, &VersionName);</nowiki> | |<nowiki>&xmlDocument=GetArchPubXmlDoc(&MessagePubID, &PublishNode, &ChannelName, &VersionName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetArchSubXmlDoc |
|Returns reference to archived message from queue | |Returns reference to archived message from queue | ||
|<nowiki>&xmlDocument=GetArchSubXmlDoc(&MessagePubID, &PublishNode, &ChannelName, &VersionName);</nowiki> | |<nowiki>&xmlDocument=GetArchSubXmlDoc(&MessagePubID, &PublishNode, &ChannelName, &VersionName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetAttachment |
|Copies file from FTP server to Application Server. Return 0 for success, 1 for failure. | |Copies file from FTP server to Application Server. Return 0 for success, 1 for failure. | ||
| - | |<nowiki>&errorCode=GetAttachment(&FromURL, &FromAppendedPathFilename, &ToFile [, &ToDirEnvironmentVariable [, &PreserveCaseBoolean | + | |<nowiki>&errorCode=GetAttachment(&FromURL, &FromAppendedPathFilename, &ToFile [, &ToDirEnvironmentVariable [, &PreserveCaseBoolean);</nowiki> |
|- | |- | ||
| - | | | + | |GetBiDoc |
|Creates a BiDocs structure populated with the XML String (this string can be empty) | |Creates a BiDocs structure populated with the XML String (this string can be empty) | ||
|<nowiki>&biDocObject=GetBiDoc(&XmlString);</nowiki> | |<nowiki>&biDocObject=GetBiDoc(&XmlString);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetCalendarDate |
|Returns date from PS_PAY_CALENDAR.CalendarFieldName +/- Periods +/- PeriodEndAdjustment (if period end) from InDate. | |Returns date from PS_PAY_CALENDAR.CalendarFieldName +/- Periods +/- PeriodEndAdjustment (if period end) from InDate. | ||
|<nowiki>&date=GetCalendarDate(&InDate, &NumOfPeriods, &PeriodEndAdjustmentNumber, &CalendarFieldName, &Company, &PayGroup);</nowiki> | |<nowiki>&date=GetCalendarDate(&InDate, &NumOfPeriods, &PeriodEndAdjustmentNumber, &CalendarFieldName, &Company, &PayGroup);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetChartURL |
|Returns the URL String of the specified Chart object | |Returns the URL String of the specified Chart object | ||
|<nowiki>&URLString=GetChartURL(&Chart);</nowiki> | |<nowiki>&URLString=GetChartURL(&Chart);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetChart |
|Returns a reference to the chart object associated with the Record.Field in PeopleSoft Application Designer | |Returns a reference to the chart object associated with the Record.Field in PeopleSoft Application Designer | ||
|<nowiki>&chartObject=GetChart(RecordName.FieldName);</nowiki> | |<nowiki>&chartObject=GetChart(RecordName.FieldName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetCwd |
|Returns a string of the current working directory (on the server) | |Returns a string of the current working directory (on the server) | ||
|<nowiki>&pathString=GetCwd();</nowiki> | |<nowiki>&pathString=GetCwd();</nowiki> | ||
|- | |- | ||
| - | | | + | |GetEnv |
|Returns value of the server environment variable (without $ or % signs) | |Returns value of the server environment variable (without $ or % signs) | ||
|<nowiki>&variableValue=GetEnv(&VariableName);</nowiki> | |<nowiki>&variableValue=GetEnv(&VariableName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetField |
|Returns reference to the field object specified (or current one if none specified) | |Returns reference to the field object specified (or current one if none specified) | ||
|<nowiki>&field=GetField([RecordName.FieldName]);</nowiki> | |<nowiki>&field=GetField([RecordName.FieldName]);</nowiki> | ||
|- | |- | ||
| - | | | + | |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) | |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) | ||
|<nowiki>&file=GetFile(&FileName, &OpenMode [, &CharacterSetName] [, &PathType]);</nowiki> | |<nowiki>&file=GetFile(&FileName, &OpenMode [, &CharacterSetName] [, &PathType]);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetGrid |
|Returns a reference to a grid object from page specified | |Returns a reference to a grid object from page specified | ||
|<nowiki>&grid=GetGrid(Page.PageName, &GridName [, &OccursNumber]);</nowiki> | |<nowiki>&grid=GetGrid(Page.PageName, &GridName [, &OccursNumber]);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetHTMLText |
|Returns a string containing the text of an HTML object with param1 etc. substituted for each of the %BIND(:1) variables. | |Returns a string containing the text of an HTML object with param1 etc. substituted for each of the %BIND(:1) variables. | ||
|<nowiki>&HTMLstring=GetHTMLText(HTML.HTMLName [, ¶m1...]);</nowiki> | |<nowiki>&HTMLstring=GetHTMLText(HTML.HTMLName [, ¶m1...]);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetImageExtents |
|Returns an array: arrayImageSize(1)=image height and arrayImageSize(2)=image width | |Returns an array: arrayImageSize(1)=image height and arrayImageSize(2)=image width | ||
|<nowiki>&arrayImageSize=GetImageExtents(IMAGE.ImageName);</nowiki> | |<nowiki>&arrayImageSize=GetImageExtents(IMAGE.ImageName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetInterlink |
|Returns a BI object based on named App Designer BI object. | |Returns a BI object based on named App Designer BI object. | ||
|<nowiki>&businessInterlink=GetInterlink(Interlink.BIName);</nowiki> | |<nowiki>&businessInterlink=GetInterlink(Interlink.BIName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetJavaClass |
|Returns a reference to a Java class - used to get access to static methods on Java classes | |Returns a reference to a Java class - used to get access to static methods on Java classes | ||
|<nowiki>&refJavaClass=GetJavaClass(&JavaClassName);</nowiki> | |<nowiki>&refJavaClass=GetJavaClass(&JavaClassName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetLevel0 |
|Returns the rowset at level 0 of the page/state record/message base rowset | |Returns the rowset at level 0 of the page/state record/message base rowset | ||
|<nowiki>&rowset=GetLevel0();</nowiki> | |<nowiki>&rowset=GetLevel0();</nowiki> | ||
|- | |- | ||
| - | | | + | |GetMessageInstance |
|DEPRECATED. Returns a message from the message queue | |DEPRECATED. Returns a message from the message queue | ||
|<nowiki>&message=GetMessageInstance(&PublishId, &PublishNodeName, &ChannelName);</nowiki> | |<nowiki>&message=GetMessageInstance(&PublishId, &PublishNodeName, &ChannelName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetMessageXmlDoc |
|Returns reference to XML doc from async message queue or sync from memory | |Returns reference to XML doc from async message queue or sync from memory | ||
|<nowiki>&xmlDoc=GetMessageXmlDoc();</nowiki> | |<nowiki>&xmlDoc=GetMessageXmlDoc();</nowiki> | ||
|- | |- | ||
| - | | | + | |GetMessage |
|Returns a message from the current message queue being processed without data | |Returns a message from the current message queue being processed without data | ||
|<nowiki>&emptyMessage=GetMessage();</nowiki> | |<nowiki>&emptyMessage=GetMessage();</nowiki> | ||
|- | |- | ||
| - | | | + | |GetMethodNames |
|Returns array of method names for ObjectName of specified Type ("WebLib" , "CompIntfc") | |Returns array of method names for ObjectName of specified Type ("WebLib" , "CompIntfc") | ||
|<nowiki>&arrayMethodNames=GetMethodNames(&TypeString, &ObjectName);</nowiki> | |<nowiki>&arrayMethodNames=GetMethodNames(&TypeString, &ObjectName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetNRXmlDoc |
|Returns XML message for NonRepudiationId for the signer EntityName (for PS this is NodeName) | |Returns XML message for NonRepudiationId for the signer EntityName (for PS this is NodeName) | ||
|<nowiki>&xmlDoc=GetNRXmlDoc(&NonRepudiationId, &EntityName);</nowiki> | |<nowiki>&xmlDoc=GetNRXmlDoc(&NonRepudiationId, &EntityName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetNextNumberWithGapsCommit |
|Returns highest value in Field (subject to WhereClause) plus Step or negative if error. Commits immediately via second database connection. | |Returns highest value in Field (subject to WhereClause) plus Step or negative if error. Commits immediately via second database connection. | ||
|<nowiki>&number=GetNextNumberWithGapsCommit(Record.Field, &MaxNumber, &Step, [&WhereClause [, &Param1...] ]);</nowiki> | |<nowiki>&number=GetNextNumberWithGapsCommit(Record.Field, &MaxNumber, &Step, [&WhereClause [, &Param1...] ]);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetNextNumberWithGaps |
|DEPRECATED. SPr, WFl only. Returns highest value in Field (subject to WhereClause) plus Step. Use GetNextNumberWithGapsCommit | |DEPRECATED. SPr, WFl only. Returns highest value in Field (subject to WhereClause) plus Step. Use GetNextNumberWithGapsCommit | ||
|<nowiki>&number=GetNextNumberWithGaps(Record.Field, &MaxNumber, &Step, [&WhereClause [, &Param1...] ]);</nowiki> | |<nowiki>&number=GetNextNumberWithGaps(Record.Field, &MaxNumber, &Step, [&WhereClause [, &Param1...] ]);</nowiki> | ||
|- | |- | ||
| - | | | + | |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) | |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) | ||
|<nowiki>&number=GetNextNumber({Record.Field | &RecordName, &FieldName} , &MaxNumber);</nowiki> | |<nowiki>&number=GetNextNumber({Record.Field | &RecordName, &FieldName} , &MaxNumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetNextProcessInstance |
|Retreives next available process instance and commits, unless WillCommit is set to 0. | |Retreives next available process instance and commits, unless WillCommit is set to 0. | ||
|<nowiki>&returnNumber=GetNextProcessInstance([&WillCommit]);</nowiki> | |<nowiki>&returnNumber=GetNextProcessInstance([&WillCommit]);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetPage |
|Returns reference to the specified page object. Page must have been loaded - PostBuild or Activate. | |Returns reference to the specified page object. Page must have been loaded - PostBuild or Activate. | ||
|<nowiki>&page=GetPage(PAGE.PageName);</nowiki> | |<nowiki>&page=GetPage(PAGE.PageName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetPubContractInstance |
|DEPRECATED. Use GetPubXmlDoc. | |DEPRECATED. Use GetPubXmlDoc. | ||
|<nowiki>&contractInstance=GetPubContractInstance(&PublishId, &PublishNodeName, &ChannelName, &SubscribeNodeName);</nowiki> | |<nowiki>&contractInstance=GetPubContractInstance(&PublishId, &PublishNodeName, &ChannelName, &SubscribeNodeName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetPubHeaderXmlDoc |
|Returns XML message before transformation (the header) for specified message. Use in error processing. | |Returns XML message before transformation (the header) for specified message. Use in error processing. | ||
|<nowiki>&xmlDoc=GetPubHeaderXmlDoc(&PublishId, &PublishNodeName, &ChannelName, &VersionName);</nowiki> | |<nowiki>&xmlDoc=GetPubHeaderXmlDoc(&PublishId, &PublishNodeName, &ChannelName, &VersionName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetPubXmlDoc |
|Returns XML message after transformation for specified message. Use in error processing. | |Returns XML message after transformation for specified message. Use in error processing. | ||
|<nowiki>&xmlDoc=GetPubXmlDoc(&PublishId, &PublishNodeName, &ChannelName, &VersionName);</nowiki> | |<nowiki>&xmlDoc=GetPubXmlDoc(&PublishId, &PublishNodeName, &ChannelName, &VersionName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetRecord |
|Returns reference to record in current buffer. Default record is the record PeopleCode is on. | |Returns reference to record in current buffer. Default record is the record PeopleCode is on. | ||
|<nowiki>&record=GetRecord( [{RECORD.RecordName | @ &RecordRecName }] );</nowiki> | |<nowiki>&record=GetRecord( [{RECORD.RecordName | @ &RecordRecName }] );</nowiki> | ||
|- | |- | ||
| - | | | + | |GetRelField |
|DEPRECATED. Returns related value displayed. Use &Field.GetRelated. | |DEPRECATED. Returns related value displayed. Use &Field.GetRelated. | ||
|<nowiki>&relatedValue=GetRelField(&ControlField, &RelatedField);</nowiki> | |<nowiki>&relatedValue=GetRelField(&ControlField, &RelatedField);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetRow |
|Returns reference to current row. | |Returns reference to current row. | ||
|<nowiki>&row=GetRow();</nowiki> | |<nowiki>&row=GetRow();</nowiki> | ||
|- | |- | ||
| - | | | + | |GetRowsetCache |
|Returns a rowset cache object populated with the rowset cache indicated | |Returns a rowset cache object populated with the rowset cache indicated | ||
|<nowiki>&rowsetCache=GetRowsetCache(&rowset, [ROWSET.]Name);</nowiki> | |<nowiki>&rowsetCache=GetRowsetCache(&rowset, [ROWSET.]Name);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetRowset |
|Returns reference to rowset in current context. | |Returns reference to rowset in current context. | ||
|<nowiki>&rowset=GetRowset([SCROLL.ScrollName]);</nowiki> | |<nowiki>&rowset=GetRowset([SCROLL.ScrollName]);</nowiki> | ||
|- | |- | ||
| - | | | + | |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. | |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. | ||
|<nowiki>&sql=GetSQL(SQL.SqlName [, param1]...);</nowiki> | |<nowiki>&sql=GetSQL(SQL.SqlName [, param1]...);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetSelectedTreeNode |
|DEPRECATED. Use GenerateTree | |DEPRECATED. Use GenerateTree | ||
|<nowiki>GetSelectedTreeNode(RECORD.RecordName);</nowiki> | |<nowiki>GetSelectedTreeNode(RECORD.RecordName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetSession |
|Returns PeopleSoft Session object - you need to connect too. See %Session | |Returns PeopleSoft Session object - you need to connect too. See %Session | ||
|<nowiki>&session=GetSession();</nowiki> | |<nowiki>&session=GetSession();</nowiki> | ||
|- | |- | ||
| - | | | + | |GetSetId |
|Returns set ID name for these parameters. Leave TreeName blank if not required. | |Returns set ID name for these parameters. Leave TreeName blank if not required. | ||
|<nowiki>&setid=GetSetId(&FieldName, &SetControlValue, &RecordName, &TreeName);</nowiki> | |<nowiki>&setid=GetSetId(&FieldName, &SetControlValue, &RecordName, &TreeName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetStoredFormat |
|Returns the stored custom format name for the specified field. | |Returns the stored custom format name for the specified field. | ||
| - | |<nowiki>&storedFormatName=GetStoredFormat([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>&storedFormatName=GetStoredFormat([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.]FieldName);</nowiki> |
|- | |- | ||
| - | | | + | |GetSubContractInstance |
|DEPRECATED. Use GetSubXmlDoc | |DEPRECATED. Use GetSubXmlDoc | ||
|<nowiki>GetSubContractInstance(pub_id, pub_nodename, channelname, messagename, sub_name)</nowiki> | |<nowiki>GetSubContractInstance(pub_id, pub_nodename, channelname, messagename, sub_name)</nowiki> | ||
|- | |- | ||
| - | | | + | |GetSubXmlDoc |
|Returns a reference to XML Doc messge from message queue. Use for error processing or debugging. | |Returns a reference to XML Doc messge from message queue. Use for error processing or debugging. | ||
|<nowiki>&xmlDoc=GetSubXmlDoc(&PublishId, &PublishNodeName, &ChannelName, &VersionName, &MessageName);</nowiki> | |<nowiki>&xmlDoc=GetSubXmlDoc(&PublishId, &PublishNodeName, &ChannelName, &VersionName, &MessageName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetSyncLogData |
|Returns XML string of synchronised message log of Log Type (1 original request, 2 transformed request, 3 original response, 4 transformed response) | |Returns XML string of synchronised message log of Log Type (1 original request, 2 transformed request, 3 original response, 4 transformed response) | ||
|<nowiki>&xmlLogString=GetSyncLogData(&GUID, &PublishNodeName, &ChannelName, &MessageName, &LogTypeNumber, &VersionName);</nowiki> | |<nowiki>&xmlLogString=GetSyncLogData(&GUID, &PublishNodeName, &ChannelName, &MessageName, &LogTypeNumber, &VersionName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetTreeNodeParent |
|DEPRECATED. Use GenerateTree | |DEPRECATED. Use GenerateTree | ||
|<nowiki>GetTreeNodeParent(&Node);</nowiki> | |<nowiki>GetTreeNodeParent(&Node);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetTreeNodeRecordName |
|DEPRECATED. Use GenerateTree | |DEPRECATED. Use GenerateTree | ||
|<nowiki>GetTreeNodeRecordName(&Node);</nowiki> | |<nowiki>GetTreeNodeRecordName(&Node);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetTreeNodeValue |
|DEPRECATED. Use GenerateTree | |DEPRECATED. Use GenerateTree | ||
|<nowiki>GetTreeNodeValue(&Node [, RecordName.]FieldName);</nowiki> | |<nowiki>GetTreeNodeValue(&Node [, RecordName.]FieldName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetURL |
|Returns the URL String of the specified URLName in the users language. Maintained under PeopleTools Utilities | |Returns the URL String of the specified URLName in the users language. Maintained under PeopleTools Utilities | ||
|<nowiki>&urlString=GetURL(URL.URLName);</nowiki> | |<nowiki>&urlString=GetURL(URL.URLName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetUserOption |
|Returns the default value for the option and level. | |Returns the default value for the option and level. | ||
|<nowiki>&value=GetUserOption(&OptionCategoryLevelString,&OptionName);</nowiki> | |<nowiki>&value=GetUserOption(&OptionCategoryLevelString,&OptionName);</nowiki> | ||
|- | |- | ||
| - | | | + | |GetWLFieldValue |
|Returns the value of the field in the application worklist. Check if called from worklist using %WLName system variable. | |Returns the value of the field in the application worklist. Check if called from worklist using %WLName system variable. | ||
|<nowiki>&value=GetWLFieldValue(&FieldName);</nowiki> | |<nowiki>&value=GetWLFieldValue(&FieldName);</nowiki> | ||
|- | |- | ||
| - | | | + | |Global |
|Creates a global PeopleCode variable that is constant for that session | |Creates a global PeopleCode variable that is constant for that session | ||
|<nowiki>Global DataType &variable</nowiki> | |<nowiki>Global DataType &variable</nowiki> | ||
|- | |- | ||
| - | | | + | |GrayMenuItem |
|DEPRECATED. Use DisableMenuItem | |DEPRECATED. Use DisableMenuItem | ||
|<nowiki>[&isOK=]GrayMenuItem(BARNAME.BarName, ITEMNAME.ItemName);</nowiki> | |<nowiki>[&isOK=]GrayMenuItem(BARNAME.BarName, ITEMNAME.ItemName);</nowiki> | ||
|- | |- | ||
| - | | | + | |Gray |
|Switches the field to not be changeable on the page. | |Switches the field to not be changeable on the page. | ||
| - | |<nowiki>[&isOK=]Gray( | + | |<nowiki>[&isOK=]Gray(RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.FieldName);</nowiki> |
|- | |- | ||
| - | | | + | |Hash |
|Returns 28 character hash of input, but some data is lost to make reversal difficult/impossible. | |Returns 28 character hash of input, but some data is lost to make reversal difficult/impossible. | ||
|<nowiki>&hashedString=Hash(&PlainText);</nowiki> | |<nowiki>&hashedString=Hash(&PlainText);</nowiki> | ||
|- | |- | ||
| - | | | + | |HermiteCubic |
|Calculates Hermitian Cubic to mimic hand drawn curve - number array element - (inX,inY,outX0Coefficient,outX1Coefficient,outX2Coefficient,outX3Coefficient) | |Calculates Hermitian Cubic to mimic hand drawn curve - number array element - (inX,inY,outX0Coefficient,outX1Coefficient,outX2Coefficient,outX3Coefficient) | ||
|<nowiki>HermiteCubic(&inOutArrayOfDataPointArray);</nowiki> | |<nowiki>HermiteCubic(&inOutArrayOfDataPointArray);</nowiki> | ||
|- | |- | ||
| - | | | + | |HideMenuItem |
|Hides Menu Item - use PrePopup for pop up menus. Ignored by CI. | |Hides Menu Item - use PrePopup for pop up menus. Ignored by CI. | ||
|<nowiki>HideMenuItem(BARNAME.BarName, ITEMNAME.ItemName);</nowiki> | |<nowiki>HideMenuItem(BARNAME.BarName, ITEMNAME.ItemName);</nowiki> | ||
|- | |- | ||
| - | | | + | |HideRow |
|Hides row and related rows in lower scroll levels. Use &Row.Visible | |Hides row and related rows in lower scroll levels. Use &Row.Visible | ||
| - | |<nowiki>[&isOK=]HideRow([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>[&isOK=]HideRow([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.]FieldName [, &TargetRowNumber] );</nowiki> |
|- | |- | ||
| - | | | + | |HideScroll |
|Hides entire scroll bar and data inside. Use &Rowset.HideAllRows | |Hides entire scroll bar and data inside. Use &Rowset.HideAllRows | ||
| - | |<nowiki>[&isOK=]HideScroll([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>[&isOK=]HideScroll([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.]FieldName);</nowiki> |
|- | |- | ||
| - | | | + | |Hide |
|Makes specified field invisible - normally Row Init or FCh | |Makes specified field invisible - normally Row Init or FCh | ||
| - | |<nowiki>[&isOK=]Hide( | + | |<nowiki>[&isOK=]Hide(RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.FieldName);</nowiki> |
|- | |- | ||
| - | | | + | |HistVolatility |
|Returns the Historical Volatility of market traded instrument. | |Returns the Historical Volatility of market traded instrument. | ||
|<nowiki>&historicalVolatilityNumber=HistVolatility(&ClosingPriceArray, &TradingDaysPerYear);</nowiki> | |<nowiki>&historicalVolatilityNumber=HistVolatility(&ClosingPriceArray, &TradingDaysPerYear);</nowiki> | ||
|- | |- | ||
| - | | | + | |Hour |
|Returns the hour (0-23) of a Time or DateTime | |Returns the hour (0-23) of a Time or DateTime | ||
|<nowiki>&hour24=Hour(&TimeValue);</nowiki> | |<nowiki>&hour24=Hour(&TimeValue);</nowiki> | ||
|- | |- | ||
| - | | | + | |Idiv |
|Returns the Integer Division result of BigInteger divided by DivisorInteger | |Returns the Integer Division result of BigInteger divided by DivisorInteger | ||
|<nowiki>&integer=IDiv(&BigInteger, &DivisorInteger);</nowiki> | |<nowiki>&integer=IDiv(&BigInteger, &DivisorInteger);</nowiki> | ||
|- | |- | ||
| - | | | + | |If |
|Executes statements depending on condition | |Executes statements depending on condition | ||
| - | |<nowiki>If conditions Then [statements] [Else [statements | + | |<nowiki>If conditions Then [statements] [Else [statements End-If;</nowiki> |
|- | |- | ||
| - | | | + | |InboundPublishXmlDoc |
|Simulates receiving the message from another node, but is sent from this node | |Simulates receiving the message from another node, but is sent from this node | ||
|<nowiki>&isPublished=InboundPublishXmlDoc(&XmlDoc, MESSAGE.MessageName, NODE.PublishNodeName [, &IsEnqueued]);</nowiki> | |<nowiki>&isPublished=InboundPublishXmlDoc(&XmlDoc, MESSAGE.MessageName, NODE.PublishNodeName [, &IsEnqueued]);</nowiki> | ||
|- | |- | ||
| - | | | + | |InitChat |
|Starts MCF chat between customer and agent | |Starts MCF chat between customer and agent | ||
|<nowiki>&chatIDNumber=InitChat(&LogicalQueueID, &ApplicationURL, &CustomerUserName, [&ChatSubject][, &ChatQuestion][, &WizardURL][, &Priority][, &SkillLevelNumber][, &CostNumber]);</nowiki> | |<nowiki>&chatIDNumber=InitChat(&LogicalQueueID, &ApplicationURL, &CustomerUserName, [&ChatSubject][, &ChatQuestion][, &WizardURL][, &Priority][, &SkillLevelNumber][, &CostNumber]);</nowiki> | ||
|- | |- | ||
| - | | | + | |InsertImage |
|Returns 0 if JPEG/BMP/DIB image file user selects from dialogue is inserted into record field OK | |Returns 0 if JPEG/BMP/DIB image file user selects from dialogue is inserted into record field OK | ||
| - | |<nowiki>&errorNum=InsertImage( | + | |<nowiki>&errorNum=InsertImage(RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNum, [RecordName.]FieldName);</nowiki> |
|- | |- | ||
| - | | | + | |InsertRow |
|DEPRECATED Inserts row in scroll and executes RowInsert. If Is Turbo default processing only for this row. Use RowSet.InsertRow | |DEPRECATED Inserts row in scroll and executes RowInsert. If Is Turbo default processing only for this row. Use RowSet.InsertRow | ||
| - | |<nowiki>[&isOK=]=InsertRow( | + | |<nowiki>[&isOK=]=InsertRow(RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNum [, &IsTurbo]);</nowiki> |
|- | |- | ||
| - | | | + | |Int |
|Returns whole integer from truncated floating point Decimal | |Returns whole integer from truncated floating point Decimal | ||
|<nowiki>&integer=Int(&Decimal);</nowiki> | |<nowiki>&integer=Int(&Decimal);</nowiki> | ||
|- | |- | ||
| - | | | + | |Integer |
|Returns whole integer from truncated 32 bit twos-complement Decimal (-2,147,483,648 to 2,147,483,647) | |Returns whole integer from truncated 32 bit twos-complement Decimal (-2,147,483,648 to 2,147,483,647) | ||
|<nowiki>&integer=Integer(&Decimal);</nowiki> | |<nowiki>&integer=Integer(&Decimal);</nowiki> | ||
|- | |- | ||
| - | | | + | |IsAlphaNumeric |
|Returns true if only alphabetic or textual characters, false if any punctuation. | |Returns true if only alphabetic or textual characters, false if any punctuation. | ||
|<nowiki>&isAlphaNumeric=IsAlphaNumeric(&string);</nowiki> | |<nowiki>&isAlphaNumeric=IsAlphaNumeric(&string);</nowiki> | ||
|- | |- | ||
| - | | | + | |IsAlpha |
|Returns true if only alphabetic, textual or numeric characters, false if any numbers or punctuation. | |Returns true if only alphabetic, textual or numeric characters, false if any numbers or punctuation. | ||
|<nowiki>&isAlpha=IsAlpha(&string);</nowiki> | |<nowiki>&isAlpha=IsAlpha(&string);</nowiki> | ||
|- | |- | ||
| - | | | + | |IsDateTime |
|Returns true if String is date time YYYY-MM-DD HH24:MI:SS.msmsms | |Returns true if String is date time YYYY-MM-DD HH24:MI:SS.msmsms | ||
|<nowiki>&isDateTime=IsDateTime(&String);</nowiki> | |<nowiki>&isDateTime=IsDateTime(&String);</nowiki> | ||
|- | |- | ||
| - | | | + | |IsDate |
|Returns true if Value is string YYYY-MM-DD or number YYYYMMDD | |Returns true if Value is string YYYY-MM-DD or number YYYYMMDD | ||
|<nowiki>&isDate=IsDate(&Value);</nowiki> | |<nowiki>&isDate=IsDate(&Value);</nowiki> | ||
|- | |- | ||
| - | | | + | |IsDaylightSavings |
|Returns true if DateTime in daylight savings for time zone specified by 3 character string e.g. EST or Local or Base | |Returns true if DateTime in daylight savings for time zone specified by 3 character string e.g. EST or Local or Base | ||
|<nowiki>&isDaylightSavings=IsDaylightSavings(&DateTime, &TimeZone);</nowiki> | |<nowiki>&isDaylightSavings=IsDaylightSavings(&DateTime, &TimeZone);</nowiki> | ||
|- | |- | ||
| - | | | + | |IsDigits |
|Returns true if string only contains the numbers 0-9 (decimal point and signs not included) | |Returns true if string only contains the numbers 0-9 (decimal point and signs not included) | ||
|<nowiki>&isDigits=IsDigits(&String);</nowiki> | |<nowiki>&isDigits=IsDigits(&String);</nowiki> | ||
|- | |- | ||
| - | | | + | |IsHidden |
|DEPRECATED Returns true if row specified is hidden. Use Row.Visible | |DEPRECATED Returns true if row specified is hidden. Use Row.Visible | ||
| - | |<nowiki>&isHidden=IsHidden( | + | |<nowiki>&isHidden=IsHidden(RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNum);</nowiki> |
|- | |- | ||
| - | | | + | |IsMenuItemAuthorized |
|Returns true if user is able to access menu item or page specified in action mode (e.g. %Action_Add) specified. | |Returns true if user is able to access menu item or page specified in action mode (e.g. %Action_Add) specified. | ||
|<nowiki>&isUserAuthorized=IsMenuItemAuthorized(MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName [,&Action]);</nowiki> | |<nowiki>&isUserAuthorized=IsMenuItemAuthorized(MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName [,&Action]);</nowiki> | ||
|- | |- | ||
| - | | | + | |IsMessageActive |
|Returns true if XmlDoc message is active in Application Designer | |Returns true if XmlDoc message is active in Application Designer | ||
|<nowiki>&isActive=IsMessageActive(MESSAGE.MessageName);</nowiki> | |<nowiki>&isActive=IsMessageActive(MESSAGE.MessageName);</nowiki> | ||
|- | |- | ||
| - | | | + | |IsModalComponent |
|Returns true if run from modal component. No effect in CI. | |Returns true if run from modal component. No effect in CI. | ||
|<nowiki>&isModalComponent=IsModalComponent();</nowiki> | |<nowiki>&isModalComponent=IsModalComponent();</nowiki> | ||
|- | |- | ||
| - | | | + | |IsModalPanelGroup |
|DEPRECATED Returns true if run from modal component. Use IsModalComponent | |DEPRECATED Returns true if run from modal component. Use IsModalComponent | ||
|<nowiki>&isModalComponent=IsModalPanelGroup();</nowiki> | |<nowiki>&isModalComponent=IsModalPanelGroup();</nowiki> | ||
|- | |- | ||
| - | | | + | |IsModal |
|Returns true if run from modal secondary page. | |Returns true if run from modal secondary page. | ||
|<nowiki>&isCurrentModal=IsModal();</nowiki> | |<nowiki>&isCurrentModal=IsModal();</nowiki> | ||
|- | |- | ||
| - | | | + | |IsNumber |
|Returns true if String is a valid numeric value (including signs and decimal points or commas) | |Returns true if String is a valid numeric value (including signs and decimal points or commas) | ||
|<nowiki>&isNumber=IsNumber(&String);</nowiki> | |<nowiki>&isNumber=IsNumber(&String);</nowiki> | ||
|- | |- | ||
| - | | | + | |IsOperatorInClass |
|DEPRECATED Returns true if operator in any of the classes. Use IsUserInPermissionList | |DEPRECATED Returns true if operator in any of the classes. Use IsUserInPermissionList | ||
|<nowiki>&isInClass=IsOperatorInClass(&OpClassName1 [, &OpClassName2]...); </nowiki> | |<nowiki>&isInClass=IsOperatorInClass(&OpClassName1 [, &OpClassName2]...); </nowiki> | ||
|- | |- | ||
| - | | | + | |IsSearchDialog |
|Returns true if executed from a search, add or data entry dialogue box | |Returns true if executed from a search, add or data entry dialogue box | ||
|<nowiki>&isSearchDialog=IsSearchDialog();</nowiki> | |<nowiki>&isSearchDialog=IsSearchDialog();</nowiki> | ||
|- | |- | ||
| - | | | + | |IsTime |
|Returns true if Value is valid time string or number. Format? | |Returns true if Value is valid time string or number. Format? | ||
|<nowiki>&isTime=IsTime(&Value);</nowiki> | |<nowiki>&isTime=IsTime(&Value);</nowiki> | ||
|- | |- | ||
| - | | | + | |IsUserInPermissionList |
|Returns true if current user is in one or more of the permission lists | |Returns true if current user is in one or more of the permission lists | ||
|<nowiki>&isUserInPL=IsUserInPermissionList(&PermissionList1 [, &PermissionList2]...);</nowiki> | |<nowiki>&isUserInPL=IsUserInPermissionList(&PermissionList1 [, &PermissionList2]...);</nowiki> | ||
|- | |- | ||
| - | | | + | |IsUserInRole |
|Returns true if current user is in one or more of the roles | |Returns true if current user is in one or more of the roles | ||
|<nowiki>&isUserInRole=IsUserInRole(&RoleName1 [, &RoleName2]...);</nowiki> | |<nowiki>&isUserInRole=IsUserInRole(&RoleName1 [, &RoleName2]...);</nowiki> | ||
|- | |- | ||
| - | | | + | |LTrim |
|Returns String with RemoveCharacters removed from the beginning (or blanks if not specified) | |Returns String with RemoveCharacters removed from the beginning (or blanks if not specified) | ||
|<nowiki>&trimmedString=Ltrim(&String [, &RemoveCharacters]);</nowiki> | |<nowiki>&trimmedString=Ltrim(&String [, &RemoveCharacters]);</nowiki> | ||
|- | |- | ||
| - | | | + | |Left |
|Returns leftmost Number of Characters from String. Unicode surrogate pairs treated as pairs of characters | |Returns leftmost Number of Characters from String. Unicode surrogate pairs treated as pairs of characters | ||
|<nowiki>&start=Left(&String, &NumCharacters);</nowiki> | |<nowiki>&start=Left(&String, &NumCharacters);</nowiki> | ||
|- | |- | ||
| - | | | + | |Len |
|Returns length of string. Unicode surrogate pairs treated as two characters | |Returns length of string. Unicode surrogate pairs treated as two characters | ||
|<nowiki>&length=Len(&String);</nowiki> | |<nowiki>&length=Len(&String);</nowiki> | ||
|- | |- | ||
| - | | | + | |Lenb |
|DEPRECATED. No longer supported | |DEPRECATED. No longer supported | ||
|<nowiki>&length=Lenb(&String);</nowiki> | |<nowiki>&length=Lenb(&String);</nowiki> | ||
|- | |- | ||
| - | | | + | |LinearInterp |
|Calculates Linear Interpolation of a set of 2+ points - number array element - (inX,inY,outX0Coefficient,outX1Coefficient,outX2Coefficient,outX3Coefficient) | |Calculates Linear Interpolation of a set of 2+ points - number array element - (inX,inY,outX0Coefficient,outX1Coefficient,outX2Coefficient,outX3Coefficient) | ||
|<nowiki>LinearInterp(&inOutArrayOfDataPointArray);</nowiki> | |<nowiki>LinearInterp(&inOutArrayOfDataPointArray);</nowiki> | ||
|- | |- | ||
| - | | | + | |Ln |
|Returns the natural logarithm of Number (based on e - approximately 2.71828182845904?) | |Returns the natural logarithm of Number (based on e - approximately 2.71828182845904?) | ||
|<nowiki>&naturalLog=Ln(&Number);</nowiki> | |<nowiki>&naturalLog=Ln(&Number);</nowiki> | ||
|- | |- | ||
| - | | | + | |Local |
|Declaration of local variable only having scope in this PeopleCode program | |Declaration of local variable only having scope in this PeopleCode program | ||
|<nowiki>Local DataType &Variable [= expression];</nowiki> | |<nowiki>Local DataType &Variable [= expression];</nowiki> | ||
|- | |- | ||
| - | | | + | |Log10 |
|Returns the base 10 logarithm of Number | |Returns the base 10 logarithm of Number | ||
|<nowiki>&log=Log10(&Number);</nowiki> | |<nowiki>&log=Log10(&Number);</nowiki> | ||
|- | |- | ||
| - | | | + | |LogObjectUse |
|Writes list of all PeopleCode objects with current count to the system log | |Writes list of all PeopleCode objects with current count to the system log | ||
|<nowiki>LogObjectUse([&HeadingString]);</nowiki> | |<nowiki>LogObjectUse([&HeadingString]);</nowiki> | ||
|- | |- | ||
| - | | | + | |Lower |
|Returns MixedCaseString in lower case | |Returns MixedCaseString in lower case | ||
|<nowiki>&lowerCaseString=Lower(&MixedCaseString);</nowiki> | |<nowiki>&lowerCaseString=Lower(&MixedCaseString);</nowiki> | ||
|- | |- | ||
| - | | | + | |MarkPrimaryEmailAddress |
|Marks the specified email address type (BB,BUS,HOME,OTH,WORK) as the primary email address for the current user | |Marks the specified email address type (BB,BUS,HOME,OTH,WORK) as the primary email address for the current user | ||
|<nowiki>MarkPrimaryEmailAddress(&EmailType);</nowiki> | |<nowiki>MarkPrimaryEmailAddress(&EmailType);</nowiki> | ||
|- | |- | ||
| - | | | + | |MarkWLItemWorked |
|Marks the current worklist item as worked.(WFl only). | |Marks the current worklist item as worked.(WFl only). | ||
|<nowiki>&isOK=MarkWLItemWorked();</nowiki> | |<nowiki>&isOK=MarkWLItemWorked();</nowiki> | ||
|- | |- | ||
| - | | | + | |Max |
|Returns the highest value - string or number (converted to type of Value1) | |Returns the highest value - string or number (converted to type of Value1) | ||
|<nowiki>&highest=Max(&Value1, &Value2 [, &Value3]...);</nowiki> | |<nowiki>&highest=Max(&Value1, &Value2 [, &Value3]...);</nowiki> | ||
|- | |- | ||
| - | | | + | |MessageBox |
|Returns pressed key constant after displaying MessageBox with Catalogued Message or Alternative Text | |Returns pressed key constant after displaying MessageBox with Catalogued Message or Alternative Text | ||
|<nowiki>[&responseCode=MessageBox(&Style, &Title, &MessageSet, &MessageNumber, &AltText [, &Param1 [,&Param2]...]);</nowiki> | |<nowiki>[&responseCode=MessageBox(&Style, &Title, &MessageSet, &MessageNumber, &AltText [, &Param1 [,&Param2]...]);</nowiki> | ||
|- | |- | ||
| - | | | + | |Min |
|Returns the lowest value - string or number (converted to type of Value1) | |Returns the lowest value - string or number (converted to type of Value1) | ||
|<nowiki>&lowest=Min(&Value1, &Value2 [, &Value3]...);</nowiki> | |<nowiki>&lowest=Min(&Value1, &Value2 [, &Value3]...);</nowiki> | ||
|- | |- | ||
| - | | | + | |Minute |
|Returns the minute (0-59) from the Time value. | |Returns the minute (0-59) from the Time value. | ||
|<nowiki>&minute=Minute(&Time);</nowiki> | |<nowiki>&minute=Minute(&Time);</nowiki> | ||
|- | |- | ||
| - | | | + | |Mod |
|Returns the remainder after the division of Number by Divisor | |Returns the remainder after the division of Number by Divisor | ||
|<nowiki>&remainder=Mod(&Number, &Divisor);</nowiki> | |<nowiki>&remainder=Mod(&Number, &Divisor);</nowiki> | ||
|- | |- | ||
| - | | | + | |Month |
|Returns the month (1-12) of Date (or DateTime) | |Returns the month (1-12) of Date (or DateTime) | ||
|<nowiki>&month=Month(&Date);</nowiki> | |<nowiki>&month=Month(&Date);</nowiki> | ||
|- | |- | ||
| - | | | + | |MsgGetExplainText |
|Returns the message explain text from MessageSet, MessageNumber after Param substitution, AltText if no message found. | |Returns the message explain text from MessageSet, MessageNumber after Param substitution, AltText if no message found. | ||
|<nowiki>&messageExplainText=MsgGetExplainText(&MessageSet, &MessageNumber, &AltText [, &Param1 [,&Param2]...]);</nowiki> | |<nowiki>&messageExplainText=MsgGetExplainText(&MessageSet, &MessageNumber, &AltText [, &Param1 [,&Param2]...]);</nowiki> | ||
|- | |- | ||
| - | | | + | |MsgGetText |
|Returns the message text from MessageSet, MessageNumber after Param substitution, AltText if no message found. | |Returns the message text from MessageSet, MessageNumber after Param substitution, AltText if no message found. | ||
|<nowiki>&messageText=MsgGetText(&MessageSet, &MessageNumber, &AltText [, &Param1 [,&Param2]...]);</nowiki> | |<nowiki>&messageText=MsgGetText(&MessageSet, &MessageNumber, &AltText [, &Param1 [,&Param2]...]);</nowiki> | ||
|- | |- | ||
| - | | | + | |MsgGet |
|Returns the message text from MessageSet, MessageNumber after Param substitution, AltText if no message found. | |Returns the message text from MessageSet, MessageNumber after Param substitution, AltText if no message found. | ||
|<nowiki>&messageText=MsgGet(&MessageSet, &MessageNumber, &AltText [, &Param1 [,&Param2]...]);</nowiki> | |<nowiki>&messageText=MsgGet(&MessageSet, &MessageNumber, &AltText [, &Param1 [,&Param2]...]);</nowiki> | ||
|- | |- | ||
| - | | | + | |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. | |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. | ||
|<nowiki>&fieldValue=NextEffDt(Field);</nowiki> | |<nowiki>&fieldValue=NextEffDt(Field);</nowiki> | ||
|- | |- | ||
| - | | | + | |NextRelEffDt |
|??? Returns the value of the Return Field in the next related effective dated row in this record, if no more recent record exists will "continue" if in loop. | |??? Returns the value of the Return Field in the next related effective dated row in this record, if no more recent record exists will "continue" if in loop. | ||
|<nowiki>&fieldValue=NextRelEffDt(SearchField, ReturnField,.........);</nowiki> | |<nowiki>&fieldValue=NextRelEffDt(SearchField, ReturnField,.........);</nowiki> | ||
|- | |- | ||
| - | | | + | |NodeDelete |
|Deletes Integration Broker node. Best in SPr. | |Deletes Integration Broker node. Best in SPr. | ||
|<nowiki>&isOK=NodeDelete(&NodeName);</nowiki> | |<nowiki>&isOK=NodeDelete(&NodeName);</nowiki> | ||
|- | |- | ||
| - | | | + | |NodeRename |
|Renames Integration Broker node. Best in SPr. | |Renames Integration Broker node. Best in SPr. | ||
|<nowiki>&isOK=NodeRename(&OldNodeName, &NewNodeName);</nowiki> | |<nowiki>&isOK=NodeRename(&OldNodeName, &NewNodeName);</nowiki> | ||
|- | |- | ||
| - | | | + | |NodeSaveAs |
|Creates a copy of Integration Broker node. Best in SPr. | |Creates a copy of Integration Broker node. Best in SPr. | ||
|<nowiki>&isOK=NodeSaveAs(&OldNodeName, &NewNodeName);</nowiki> | |<nowiki>&isOK=NodeSaveAs(&OldNodeName, &NewNodeName);</nowiki> | ||
|- | |- | ||
| - | | | + | |NodeTranDelete |
|Deletes an Integration Broker node transaction and any transaction modifier using the transaction. Date format is YYYY-MM-DD | |Deletes an Integration Broker node transaction and any transaction modifier using the transaction. Date format is YYYY-MM-DD | ||
|<nowiki>&isOK=NodeTranDelete(&NodeName, &EffectiveDateString, &TransactionType, &RequestMessageName, &RequestMessageVersion);</nowiki> | |<nowiki>&isOK=NodeTranDelete(&NodeName, &EffectiveDateString, &TransactionType, &RequestMessageName, &RequestMessageVersion);</nowiki> | ||
|- | |- | ||
| - | | | + | |None |
|Returns true if no fields/variables in list contain a value. Ie are all null, blank strings or 0 in numeric fields | |Returns true if no fields/variables in list contain a value. Ie are all null, blank strings or 0 in numeric fields | ||
|<nowiki>&isNoValue=None([RecordName1.]FieldName1 [, [RecordName2.]FieldName2]...);</nowiki> | |<nowiki>&isNoValue=None([RecordName1.]FieldName1 [, [RecordName2.]FieldName2]...);</nowiki> | ||
|- | |- | ||
| - | | | + | |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. | |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. | ||
|<nowiki>&errorCode=NotifyQ(&LogicalQueueID, &TaskType);</nowiki> | |<nowiki>&errorCode=NotifyQ(&LogicalQueueID, &TaskType);</nowiki> | ||
|- | |- | ||
| - | | | + | |NumberToDisplayString |
|Returns Number formatted as a string - Format of the form %[flags][width][.precision][R , T] [type] | |Returns Number formatted as a string - Format of the form %[flags][width][.precision][R , T] [type] | ||
| - | |<nowiki>&numberString=NumberToDisplayString(&FormatString, &Number [, &Width [, &Precision | + | |<nowiki>&numberString=NumberToDisplayString(&FormatString, &Number [, &Width [, &Precision );</nowiki> |
|- | |- | ||
| - | | | + | |NumberToString |
|Returns Number formatted as a string - Format of the form %[flags][width][.precision][R , T] [type] | |Returns Number formatted as a string - Format of the form %[flags][width][.precision][R , T] [type] | ||
| - | |<nowiki>&numberString=NumberToString(&FormatString, &Number [, &Width [, &Precision | + | |<nowiki>&numberString=NumberToString(&FormatString, &Number [, &Width [, &Precision );</nowiki> |
|- | |- | ||
| - | | | + | |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) | |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) | ||
|<nowiki>[&returnValue=]ObjectDoMethodArray(&ObjectReference, &MethodName, &ParameterArray);</nowiki> | |<nowiki>[&returnValue=]ObjectDoMethodArray(&ObjectReference, &MethodName, &ParameterArray);</nowiki> | ||
|- | |- | ||
| - | | | + | |ObjectDoMethod |
|Executes ObjectReference.MethodName for Component Interfaces, Application Classes, OLE Automation Objects | |Executes ObjectReference.MethodName for Component Interfaces, Application Classes, OLE Automation Objects | ||
|<nowiki>ObjectDoMethod(&ObjectReference, &MethodName [, &Param1]... );</nowiki> | |<nowiki>ObjectDoMethod(&ObjectReference, &MethodName [, &Param1]... );</nowiki> | ||
|- | |- | ||
| - | | | + | |ObjectGetProperty |
|Returns ObjectReference.PropertyName value | |Returns ObjectReference.PropertyName value | ||
|<nowiki>[&returnValue=]ObjectGetProperty(&ObjectReference, &PropertyName [, &OleIndexList] );</nowiki> | |<nowiki>[&returnValue=]ObjectGetProperty(&ObjectReference, &PropertyName [, &OleIndexList] );</nowiki> | ||
|- | |- | ||
| - | | | + | |ObjectSetProperty |
|Sets ObjectReference.PropertyName to Value | |Sets ObjectReference.PropertyName to Value | ||
|<nowiki>ObjectSetProperty(&ObjectReference, &PropertyName, &Value [, &OleIndexList] );</nowiki> | |<nowiki>ObjectSetProperty(&ObjectReference, &PropertyName, &Value [, &OleIndexList] );</nowiki> | ||
|- | |- | ||
| - | | | + | |OnlyOneOrNone |
|Checks if only one or none of the fields listed are not blank strings / non-zero in numeric fields | |Checks if only one or none of the fields listed are not blank strings / non-zero in numeric fields | ||
|<nowiki>&isNoMoreThanOneSet=OnlyOneOrNone( [RecordName.]FieldName [, [RecordName2.]FieldName2] ... );</nowiki> | |<nowiki>&isNoMoreThanOneSet=OnlyOneOrNone( [RecordName.]FieldName [, [RecordName2.]FieldName2] ... );</nowiki> | ||
|- | |- | ||
| - | | | + | |OnlyOne |
|Returns true if only one of the fields listed are not blank strings / non-zero in numeric fields | |Returns true if only one of the fields listed are not blank strings / non-zero in numeric fields | ||
|<nowiki>&isOneSet=OnlyOne( [RecordName.]FieldName [, [RecordName2.]FieldName2] ... );</nowiki> | |<nowiki>&isOneSet=OnlyOne( [RecordName.]FieldName [, [RecordName2.]FieldName2] ... );</nowiki> | ||
|- | |- | ||
| - | | | + | |PanelGroupChanged |
|DEPRECATED Returns true if the component (panel group) data has changed since the last save. Use ComponentChanged | |DEPRECATED Returns true if the component (panel group) data has changed since the last save. Use ComponentChanged | ||
|<nowiki>&isChanged=PanelGroupChanged();</nowiki> | |<nowiki>&isChanged=PanelGroupChanged();</nowiki> | ||
|- | |- | ||
| - | | | + | |PingNode |
|Returns an XML Doc with a node "status" with info about Node Name pinged. | |Returns an XML Doc with a node "status" with info about Node Name pinged. | ||
|<nowiki>&statusXmlDoc=PingNode(&NodeName);</nowiki> | |<nowiki>&statusXmlDoc=PingNode(&NodeName);</nowiki> | ||
|- | |- | ||
| - | | | + | |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. | |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. | ||
|<nowiki>&fieldValue=PriorEffDt(Field);</nowiki> | |<nowiki>&fieldValue=PriorEffDt(Field);</nowiki> | ||
|- | |- | ||
| - | | | + | |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. | |??? 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. | ||
|<nowiki>&fieldValue=PriorRelEffDt(SearchField, ReturnField,.........);</nowiki> | |<nowiki>&fieldValue=PriorRelEffDt(SearchField, ReturnField,.........);</nowiki> | ||
|- | |- | ||
| - | | | + | |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. | |FCh, Fed of Field ONLY: Returns value in field before field was changed by user. If used in other PeopleCode programs, returns current value. | ||
|<nowiki>&value=PriorValue(Field);</nowiki> | |<nowiki>&value=PriorValue(Field);</nowiki> | ||
|- | |- | ||
| - | | | + | |Product |
|Returns product of numbers multiplied together. Equivalent to &product=&Number1*&Number2; etc. | |Returns product of numbers multiplied together. Equivalent to &product=&Number1*&Number2; etc. | ||
|<nowiki>&product=Product(&Number1 [, &Number2]...);</nowiki> | |<nowiki>&product=Product(&Number1 [, &Number2]...);</nowiki> | ||
|- | |- | ||
| - | | | + | |Prompt |
|Prompts the user for vales that either populate the record or a group of variables. Often used for Query prompt values. | |Prompts the user for vales that either populate the record or a group of variables. Often used for Query prompt values. | ||
| - | |<nowiki>[&isOKClicked=]Prompt(&Title, &Heading {, &Record | , Field1 [, &Label1 [, &ResponseVar1 | + | |<nowiki>[&isOKClicked=]Prompt(&Title, &Heading {, &Record | , Field1 [, &Label1 [, &ResponseVar1...);</nowiki> |
|- | |- | ||
| - | | | + | |Proper |
|Returns String with first letter of each word capitalised. Similar to Oracle SQL InitCap | |Returns String with first letter of each word capitalised. Similar to Oracle SQL InitCap | ||
|<nowiki>&initialCapitals=Proper(&String);</nowiki> | |<nowiki>&initialCapitals=Proper(&String);</nowiki> | ||
|- | |- | ||
| - | | | + | |PublishXmlDoc |
|Returns true if XML Doc is published as MessageName to NodeName successfully. | |Returns true if XML Doc is published as MessageName to NodeName successfully. | ||
|<nowiki>&isOK=PublishXmlDoc(&XmlDoc, MESSAGE.MessageName [, NODE.NodeName] );</nowiki> | |<nowiki>&isOK=PublishXmlDoc(&XmlDoc, MESSAGE.MessageName [, NODE.NodeName] );</nowiki> | ||
|- | |- | ||
| - | | | + | |PutAttachment |
|Puts file attachment from Application Server to File Server (specified in URL Destination) | |Puts file attachment from Application Server to File Server (specified in URL Destination) | ||
| - | |<nowiki>&errorCode=AddAttachment(&URLDestination, &DestinationAppendedPathFilename [, &SourceFile [, &PreserveCaseBoolean | + | |<nowiki>&errorCode=AddAttachment(&URLDestination, &DestinationAppendedPathFilename [, &SourceFile [, &PreserveCaseBoolean );</nowiki> |
|- | |- | ||
| - | | | + | |Quote |
|Returns String as a quoted SQL string - single quotes replaced with two single quotes, surrounded by single quotes | |Returns String as a quoted SQL string - single quotes replaced with two single quotes, surrounded by single quotes | ||
|<nowiki>"edString=Quote(&String);</nowiki> | |<nowiki>"edString=Quote(&String);</nowiki> | ||
|- | |- | ||
| - | | | + | |RTrim |
|Returns String with RemoveCharacters removed from the end (or blanks if not specified) | |Returns String with RemoveCharacters removed from the end (or blanks if not specified) | ||
|<nowiki>&trimmedString=Rtrim(&String [, &RemoveCharacters]);</nowiki> | |<nowiki>&trimmedString=Rtrim(&String [, &RemoveCharacters]);</nowiki> | ||
|- | |- | ||
| - | | | + | |Radians |
|Returns angle in radians from degrees | |Returns angle in radians from degrees | ||
|<nowiki>&radians=Radians(°rees);</nowiki> | |<nowiki>&radians=Radians(°rees);</nowiki> | ||
|- | |- | ||
| - | | | + | |Rand |
|Returns a random number 0 <= Random Number < 1 | |Returns a random number 0 <= Random Number < 1 | ||
|<nowiki>&randomNumber=Rand();</nowiki> | |<nowiki>&randomNumber=Rand();</nowiki> | ||
|- | |- | ||
| - | | | + | |ReSubmitPubHeaderXmlDoc |
|Returns true if the untransformed message is resubmitted OK | |Returns true if the untransformed message is resubmitted OK | ||
|<nowiki>&isOK=ReSubmitPubHeaderXmlDoc(&PublisherID, &PublishNode, &ChannelName, &VersionName);</nowiki> | |<nowiki>&isOK=ReSubmitPubHeaderXmlDoc(&PublisherID, &PublishNode, &ChannelName, &VersionName);</nowiki> | ||
|- | |- | ||
| - | | | + | |ReSubmitPubXmlDoc |
|Returns true if the transformed message is resubmitted OK | |Returns true if the transformed message is resubmitted OK | ||
|<nowiki>&isOK=ReSubmitPubXmlDoc(&PublisherID, &PublishNode, &ChannelName, &VersionName, &MessageName, &SubscriptionNode);</nowiki> | |<nowiki>&isOK=ReSubmitPubXmlDoc(&PublisherID, &PublishNode, &ChannelName, &VersionName, &MessageName, &SubscriptionNode);</nowiki> | ||
|- | |- | ||
| - | | | + | |ReSubmitSubXmlDoc |
|Returns true if the subscribed message is resubmitted OK. Subscription PeopleCode is rerun. | |Returns true if the subscribed message is resubmitted OK. Subscription PeopleCode is rerun. | ||
|<nowiki>&isOK=ReSubmitSubXmlDoc(&PublisherID, &PublishNode, &ChannelName, &VersionName, &MessageName, &SubscriptionName);</nowiki> | |<nowiki>&isOK=ReSubmitSubXmlDoc(&PublisherID, &PublishNode, &ChannelName, &VersionName, &MessageName, &SubscriptionName);</nowiki> | ||
|- | |- | ||
| - | | | + | |ReValidateNRXmlDoc |
|Revalidates a non-repudiation message signed by EntityName (in PS this is NodeName), returns true if validation successful | |Revalidates a non-repudiation message signed by EntityName (in PS this is NodeName), returns true if validation successful | ||
|<nowiki>&isOK=ReValidateNRXmlDoc(&MessageID, &EntityName);</nowiki> | |<nowiki>&isOK=ReValidateNRXmlDoc(&MessageID, &EntityName);</nowiki> | ||
|- | |- | ||
| - | | | + | |RecordChanged |
|DEPRECATED Returns true if any data in the specified row has changed. Use &Row.IsChanged | |DEPRECATED Returns true if any data in the specified row has changed. Use &Row.IsChanged | ||
| - | |<nowiki>&isChanged=RecordChanged({RECORD.RecordName | RecordName.FieldName | [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>&isChanged=RecordChanged({RECORD.RecordName | RecordName.FieldName | [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber} );</nowiki> |
|- | |- | ||
| - | | | + | |RecordDeleted |
|DEPRECATED Returns true if the specified row has been deleted. Use &Row.IsDeleted | |DEPRECATED Returns true if the specified row has been deleted. Use &Row.IsDeleted | ||
| - | |<nowiki>&isDeleted=RecordDeleted({RECORD.RecordName | RecordName.FieldName | [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>&isDeleted=RecordDeleted({RECORD.RecordName | RecordName.FieldName | [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber} );</nowiki> |
|- | |- | ||
| - | | | + | |RecordNew |
|DEPRECATED Returns true if the specified row has been inserted. Use &Row.IsNew | |DEPRECATED Returns true if the specified row has been inserted. Use &Row.IsNew | ||
| - | |<nowiki>&isNew=RecordNew({RECORD.RecordName | RecordName.FieldName | [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>&isNew=RecordNew({RECORD.RecordName | RecordName.FieldName | [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber} );</nowiki> |
|- | |- | ||
| - | | | + | |RefreshTree |
|DEPRECATED Updates a dynamic tree. Use GenerateTree or Tree Viewer | |DEPRECATED Updates a dynamic tree. Use GenerateTree or Tree Viewer | ||
|<nowiki>RefreshTree(RECORD.RecordName);</nowiki> | |<nowiki>RefreshTree(RECORD.RecordName);</nowiki> | ||
|- | |- | ||
| - | | | + | |RelNodeTranDelete |
|Returns true if transaction modifier deleted OK. | |Returns true if transaction modifier deleted OK. | ||
|<nowiki>&isOK=RelNodeTranDelete(&RelationshipId , &SourceTransactionType, &SourceNode, &SourceRequestMessageName, &SourceRequestMessageVersion, &TargetNode, &TargetRequestMessageName, &TargetRequestMessageName, &TargetRequestMessageVersion);</nowiki> | |<nowiki>&isOK=RelNodeTranDelete(&RelationshipId , &SourceTransactionType, &SourceNode, &SourceRequestMessageName, &SourceRequestMessageVersion, &TargetNode, &TargetRequestMessageName, &TargetRequestMessageName, &TargetRequestMessageVersion);</nowiki> | ||
|- | |- | ||
| - | | | + | |RemoteCall |
|Calls Tuxedo service normally for COBOL. COBOL DispatcherName is PSRCCBL.Parameter PSCOBOLPROG gives name of COBOL program. | |Calls Tuxedo service normally for COBOL. COBOL DispatcherName is PSRCCBL.Parameter PSCOBOLPROG gives name of COBOL program. | ||
|<nowiki>RemoteCall(&DispatcherName [, &ServiceVariable1, &ServiceValue1]... [, &UserVariable1, &UserValue1]... );</nowiki> | |<nowiki>RemoteCall(&DispatcherName [, &ServiceVariable1, &ServiceValue1]... [, &UserVariable1, &UserValue1]... );</nowiki> | ||
|- | |- | ||
| - | | | + | |RemoveDirectory |
|Removes directory. PathType (%FilePath_Relative , %FilePath_Absolute) add on %Remove_Subtree or %Remove_Directory | |Removes directory. PathType (%FilePath_Relative , %FilePath_Absolute) add on %Remove_Subtree or %Remove_Directory | ||
| - | |<nowiki>RemoveDirectory(&Path [, &PathType [+ &SubtreeRemoval | + | |<nowiki>RemoveDirectory(&Path [, &PathType [+ &SubtreeRemoval);</nowiki> |
|- | |- | ||
| - | | | + | |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) | |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) | ||
|<nowiki>&errorCode=RenameDBField(FIELD.NewFieldName, FIELD.OldFieldName [, &isReferencesOnly] );</nowiki> | |<nowiki>&errorCode=RenameDBField(FIELD.NewFieldName, FIELD.OldFieldName [, &isReferencesOnly] );</nowiki> | ||
|- | |- | ||
| - | | | + | |RenamePage |
|Returns %MDA_Success if renames page OK (as per App Designer rename). | |Returns %MDA_Success if renames page OK (as per App Designer rename). | ||
|<nowiki>&errorCode=RenamePage(PAGE.NewPageName, PAGE.OldPageName);</nowiki> | |<nowiki>&errorCode=RenamePage(PAGE.NewPageName, PAGE.OldPageName);</nowiki> | ||
|- | |- | ||
| - | | | + | |RenameRecord |
|Returns %MDA_Success if renames page OK (as per App Designer rename). | |Returns %MDA_Success if renames page OK (as per App Designer rename). | ||
|<nowiki>&errorCode=RenameRecord(RECORD.NewRecordName, RECORD.OldRecordName);</nowiki> | |<nowiki>&errorCode=RenameRecord(RECORD.NewRecordName, RECORD.OldRecordName);</nowiki> | ||
|- | |- | ||
| - | | | + | |Repeat |
|Statements are executed at least once. BooleanExpression is evaluated and if false, statements are executed until the expression gives true | |Statements are executed at least once. BooleanExpression is evaluated and if false, statements are executed until the expression gives true | ||
|<nowiki>Repeat statements; until &BooleanExpression;</nowiki> | |<nowiki>Repeat statements; until &BooleanExpression;</nowiki> | ||
|- | |- | ||
| - | | | + | |Replace |
|Returns replaced characters in String from Start Position for Number Characters with New Text | |Returns replaced characters in String from Start Position for Number Characters with New Text | ||
|<nowiki>&changedString=Replace(&String, &StartPosition, &NumberCharacters, &NewString);</nowiki> | |<nowiki>&changedString=Replace(&String, &StartPosition, &NumberCharacters, &NewString);</nowiki> | ||
|- | |- | ||
| - | | | + | |Rept |
|Returns String repeated Repeat Number of times. | |Returns String repeated Repeat Number of times. | ||
|<nowiki>&repeatedString=Rept(&String, &RepeatNumber);</nowiki> | |<nowiki>&repeatedString=Rept(&String, &RepeatNumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |ReturnToServer |
|Responds to server all nodes published or subscribed, no nodes, nodes in node array or XmlDoc/Message response | |Responds to server all nodes published or subscribed, no nodes, nodes in node array or XmlDoc/Message response | ||
|<nowiki>ReturnToServer( {&isAllNodesReturned | &NodeArray | &XmlDoc | &Message} );</nowiki> | |<nowiki>ReturnToServer( {&isAllNodesReturned | &NodeArray | &XmlDoc | &Message} );</nowiki> | ||
|- | |- | ||
| - | | | + | |Return |
|This returns from a function. Value is returned value of function. | |This returns from a function. Value is returned value of function. | ||
|<nowiki>Return [&Value];</nowiki> | |<nowiki>Return [&Value];</nowiki> | ||
|- | |- | ||
| - | | | + | |RevalidatePassword |
|Returns 0 if password is entered in window is user's correct password. Think Time Function | |Returns 0 if password is entered in window is user's correct password. Think Time Function | ||
|<nowiki>&errorCode=RevalidatePassword();</nowiki> | |<nowiki>&errorCode=RevalidatePassword();</nowiki> | ||
|- | |- | ||
| - | | | + | |Right |
|Returns the last Number Characters (or the last character if number omitted) of String. Unicode surrogate pairs treated as pairs of characters | |Returns the last Number Characters (or the last character if number omitted) of String. Unicode surrogate pairs treated as pairs of characters | ||
|<nowiki>&endString=(&String [, &NumberCharacters] );</nowiki> | |<nowiki>&endString=(&String [, &NumberCharacters] );</nowiki> | ||
|- | |- | ||
| - | | | + | |RoundCurrency |
|Returns Amount rounded as per PS_CURRENCY_CD_TBL on that Effective Date | |Returns Amount rounded as per PS_CURRENCY_CD_TBL on that Effective Date | ||
|<nowiki>&roundedAmount=RoundCurrency(&Amount, &CurrencyCd, &Effdt);</nowiki> | |<nowiki>&roundedAmount=RoundCurrency(&Amount, &CurrencyCd, &Effdt);</nowiki> | ||
|- | |- | ||
| - | | | + | |Round |
|Returns Number rounded to Decimal Places | |Returns Number rounded to Decimal Places | ||
|<nowiki>&roundedNumber=Round(&Number, &DecimalPlaces);</nowiki> | |<nowiki>&roundedNumber=Round(&Number, &DecimalPlaces);</nowiki> | ||
|- | |- | ||
| - | | | + | |RowFlush |
|DEPRECATED Removes a specific row from a page scroll and component buffer not database. Use RowSet.FlushRow | |DEPRECATED Removes a specific row from a page scroll and component buffer not database. Use RowSet.FlushRow | ||
| - | |<nowiki>RowFlush([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>RowFlush([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber);</nowiki> |
|- | |- | ||
| - | | | + | |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 | |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 | ||
| - | |<nowiki>[&numberRows=]RowScrollSelectNew(&LevelNumber, [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>[&numberRows=]RowScrollSelectNew(&LevelNumber, [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, RECORD.RecordName [, &WhereOrderString [, &BindVariable1 ]... ] [, &isTurbo]);</nowiki> |
|- | |- | ||
| - | | | + | |RowScrollSelect |
|DEPRECATED Loads specified scroll from database applying where clause and ordering under single parent row. Use RowSet.Select | |DEPRECATED Loads specified scroll from database applying where clause and ordering under single parent row. Use RowSet.Select | ||
| - | |<nowiki>[&numberRows=]RowScrollSelect(&LevelNumber, [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>[&numberRows=]RowScrollSelect(&LevelNumber, [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, RECORD.RecordName [, &WhereOrderString [, &BindVariable1 ]... ] [, &isTurbo]);</nowiki> |
|- | |- | ||
| - | | | + | |SQLExec |
|Executes SQL statement, if select returns only 1 row, bind variables marked :1, :2 etc. in SQL Statement. SPr, WFl, Spo, FCh Only | |Executes SQL statement, if select returns only 1 row, bind variables marked :1, :2 etc. in SQL Statement. SPr, WFl, Spo, FCh Only | ||
|<nowiki>[&isOK=]SQLExec({&SQLStatement | SQL.SqlName} [, &BindVariable1]... [, SelectedValue1]...);</nowiki> | |<nowiki>[&isOK=]SQLExec({&SQLStatement | SQL.SqlName} [, &BindVariable1]... [, SelectedValue1]...);</nowiki> | ||
|- | |- | ||
| - | | | + | |ScheduleProcess |
|DESUPPORTED Schedules process | |DESUPPORTED Schedules process | ||
|<nowiki>ScheduleProcess(&ProcessType, &ProcessName [, &RunLocation] [, &RunCntlID] [, &ProcessInstance] [, &RunDateTime] [, &RecurName] [, &ProcessServerName]);</nowiki> | |<nowiki>ScheduleProcess(&ProcessType, &ProcessName [, &RunLocation] [, &RunCntlID] [, &ProcessInstance] [, &RunDateTime] [, &RecurName] [, &ProcessServerName]);</nowiki> | ||
|- | |- | ||
| - | | | + | |ScrollFlush |
|DEPRECATED Removes all rows from a page scroll and component buffer not database. Use RowSet.Flush | |DEPRECATED Removes all rows from a page scroll and component buffer not database. Use RowSet.Flush | ||
| - | |<nowiki>ScrollFlush([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>ScrollFlush([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName);</nowiki> |
|- | |- | ||
| - | | | + | |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 | |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 | ||
| - | |<nowiki>[&numberRows=]ScrollSelectNew(&LevelNumber, [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>[&numberRows=]ScrollSelectNew(&LevelNumber, [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, RECORD.RecordName [, &WhereOrderString [, &BindVariable1 ]... ] [, &isTurbo]);</nowiki> |
|- | |- | ||
| - | | | + | |ScrollSelect |
|DEPRECATED Loads specified scroll from database applying where clause and ordering under single parent row. Use RowSet.Select | |DEPRECATED Loads specified scroll from database applying where clause and ordering under single parent row. Use RowSet.Select | ||
| - | |<nowiki>[&numberRows=]ScrollSelect(&LevelNumber, [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>[&numberRows=]ScrollSelect(&LevelNumber, [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, RECORD.RecordName [, &WhereOrderString [, &BindVariable1 ]... ] [, &isTurbo]);</nowiki> |
|- | |- | ||
| - | | | + | |Second |
|Returns seconds (0-59) part of time value | |Returns seconds (0-59) part of time value | ||
|<nowiki>&seconds=Second(&Time);</nowiki> | |<nowiki>&seconds=Second(&Time);</nowiki> | ||
|- | |- | ||
| - | | | + | |SendMail |
|Returns 0 if email successfully sent | |Returns 0 if email successfully sent | ||
|<nowiki>&errorCode=SendMail(&PlatformFlags, &To, &Cc, &Bcc, &Subject, &Text[, &AttachmentFilenames][, &AttachmentTitles][, &From][, &ToSeparator][, &ContentType][, &ReplyTo][, &Sender]);</nowiki> | |<nowiki>&errorCode=SendMail(&PlatformFlags, &To, &Cc, &Bcc, &Subject, &Text[, &AttachmentFilenames][, &AttachmentTitles][, &From][, &ToSeparator][, &ContentType][, &ReplyTo][, &Sender]);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetAuthenticationResult |
|In Sign On PeopleCode, sets if logon successful and if password warning/expiry messages should be shown to user | |In Sign On PeopleCode, sets if logon successful and if password warning/expiry messages should be shown to user | ||
|<nowiki>&isOK=SetAuthenticationResult(&AuthenticationResult [, &OperatorId] [,&ResultDocument] [,&isPasswordExpired] [&DaysBeforeExpiryWarn]);</nowiki> | |<nowiki>&isOK=SetAuthenticationResult(&AuthenticationResult [, &OperatorId] [,&ResultDocument] [,&isPasswordExpired] [&DaysBeforeExpiryWarn]);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetChannelStatus |
|Sets an integration broker channel status (1=Run, 2=Pause) | |Sets an integration broker channel status (1=Run, 2=Pause) | ||
|<nowiki>&isOK=SetChannelStatus(&ChannelName, &StatusNumber);</nowiki> | |<nowiki>&isOK=SetChannelStatus(&ChannelName, &StatusNumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetComponentChanged |
|Sets the component changed flag, so Save processing is triggered. This is automatically set if a field is changed. | |Sets the component changed flag, so Save processing is triggered. This is automatically set if a field is changed. | ||
|<nowiki>SetComponentChanged();</nowiki> | |<nowiki>SetComponentChanged();</nowiki> | ||
|- | |- | ||
| - | | | + | |SetControlValue |
|Puts specified value into the GUI control instead of value from buffer. Used for specialised validation. Does not run in CI. | |Puts specified value into the GUI control instead of value from buffer. Used for specialised validation. Does not run in CI. | ||
|<nowiki>SetControlValue(&Value, &PageName, &PageFieldName [, &RowNumber][, &FieldObject]);</nowiki> | |<nowiki>SetControlValue(&Value, &PageName, &PageFieldName [, &RowNumber][, &FieldObject]);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetCursorPos |
|Puts cursor in specified field | |Puts cursor in specified field | ||
| - | |<nowiki>SetCursorPos({PAGE.PageName | %Page}, | + | |<nowiki>SetCursorPos({PAGE.PageName | %Page}, RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName], [&RecordName.]&FieldName, &TargetRowNumber);</nowiki> |
|- | |- | ||
| - | | | + | |SetDBFieldAuxFlag |
|Returns %MDA_Success if AuxMaskFlagNumber (1-32) on Field is changed successfully to True or False accordingly. | |Returns %MDA_Success if AuxMaskFlagNumber (1-32) on Field is changed successfully to True or False accordingly. | ||
|<nowiki>&errorCode=SetDBFieldAuxFlag(FIELD.FieldName, &AuxMaskFlagNumber, &setToTrue);</nowiki> | |<nowiki>&errorCode=SetDBFieldAuxFlag(FIELD.FieldName, &AuxMaskFlagNumber, &setToTrue);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetDBFieldCharDefn |
|Returns %MDA_Success if field format is changed. FormatFamilyNumber example: %FormatFamilyType_SSN | |Returns %MDA_Success if field format is changed. FormatFamilyNumber example: %FormatFamilyType_SSN | ||
|<nowiki>&errorCode=SetDBFieldCharDefn(FIELD.FieldName, &LengthNumber [,&FormatFamilyNumber]);</nowiki> | |<nowiki>&errorCode=SetDBFieldCharDefn(FIELD.FieldName, &LengthNumber [,&FormatFamilyNumber]);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetDBFieldFormatLength |
|Returns %MDA_Success if character field format length is changed to LengthNumber characters. Does not require rebuild. | |Returns %MDA_Success if character field format length is changed to LengthNumber characters. Does not require rebuild. | ||
|<nowiki>&errorCode=SetDBFieldFormatLength(FIELD.FieldName, &LengthNumber);</nowiki> | |<nowiki>&errorCode=SetDBFieldFormatLength(FIELD.FieldName, &LengthNumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetDBFieldFormat |
|Returns %MDA_Success if character field with LengthNumber characters. FormatFamilyNumber example: %FormatFamilyType_MixedCase | |Returns %MDA_Success if character field with LengthNumber characters. FormatFamilyNumber example: %FormatFamilyType_MixedCase | ||
|<nowiki>&errorCode=SetDBFieldFormat(FIELD.FieldName ,&FormatFamilyNumber [,&FamilyName, &DisplayName]);</nowiki> | |<nowiki>&errorCode=SetDBFieldFormat(FIELD.FieldName ,&FormatFamilyNumber [,&FamilyName, &DisplayName]);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetDBFieldLabel |
|Returns %MDA_Success if character field label is changed or inserted. | |Returns %MDA_Success if character field label is changed or inserted. | ||
|<nowiki>&errorCode=SetDBFieldLabel(FIELD.FieldName, &LabelId, &LongLabel, &ShortLabel, &Default [, &LanguageCode]);</nowiki> | |<nowiki>&errorCode=SetDBFieldLabel(FIELD.FieldName, &LabelId, &LongLabel, &ShortLabel, &Default [, &LanguageCode]);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetDBFieldLength |
|Returns %MDA_Success if character length is changed to LengthNumber characters. Requires table rebuild. | |Returns %MDA_Success if character length is changed to LengthNumber characters. Requires table rebuild. | ||
|<nowiki>&errorCode=SetDBFieldLength(FIELD.FieldName, &LengthNumber);</nowiki> | |<nowiki>&errorCode=SetDBFieldLength(FIELD.FieldName, &LengthNumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetDBFieldNotUsed |
|Returns %MDA_Success if field is changed to not used - not put in indexes, nVision or Query | |Returns %MDA_Success if field is changed to not used - not put in indexes, nVision or Query | ||
|<nowiki>&errorCode=SetDBFieldNotUsed(FIELD.FieldName, &isNotUsed);</nowiki> | |<nowiki>&errorCode=SetDBFieldNotUsed(FIELD.FieldName, &isNotUsed);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetDefaultAll |
|Returns true if sets all instances of the field in the scroll to null value which will cause default processing, when next checked. | |Returns true if sets all instances of the field in the scroll to null value which will cause default processing, when next checked. | ||
|<nowiki>[&isOK=]SetDefaultAll([RecordName.]FieldName);</nowiki> | |<nowiki>[&isOK=]SetDefaultAll([RecordName.]FieldName);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetDefaultNextRel |
|Sets related, defaulted field on the next effective dated control field to null value which will cause default processing, when next checked. | |Sets related, defaulted field on the next effective dated control field to null value which will cause default processing, when next checked. | ||
|<nowiki>SetDefaultNextRel(ControlFieldName,DefaultedFieldName);</nowiki> | |<nowiki>SetDefaultNextRel(ControlFieldName,DefaultedFieldName);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetDefaultNext |
|Sets next effective dated field to null value which will cause default processing, when next checked. | |Sets next effective dated field to null value which will cause default processing, when next checked. | ||
|<nowiki>SetDefaultNext([RecordName.]FieldName);</nowiki> | |<nowiki>SetDefaultNext([RecordName.]FieldName);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetDefaultPriorRel |
|Sets related, defaulted field on the previous effective dated control field to null value which will cause default processing, when next checked. | |Sets related, defaulted field on the previous effective dated control field to null value which will cause default processing, when next checked. | ||
|<nowiki>SetDefaultPriorRel(ControlFieldName,DefaultedFieldName);</nowiki> | |<nowiki>SetDefaultPriorRel(ControlFieldName,DefaultedFieldName);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetDefaultPrior |
|Sets previous effective dated field to null value which will cause default processing, when next checked. | |Sets previous effective dated field to null value which will cause default processing, when next checked. | ||
|<nowiki>SetDefaultPrior([RecordName.]FieldName);</nowiki> | |<nowiki>SetDefaultPrior([RecordName.]FieldName);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetDefault |
|Returns true if sets field to null value which will cause default processing, when next checked. | |Returns true if sets field to null value which will cause default processing, when next checked. | ||
|<nowiki>[&isOK=]SetDefault([RecordName.]FieldName);</nowiki> | |<nowiki>[&isOK=]SetDefault([RecordName.]FieldName);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetDisplayFormat |
|DEPRECATED Changes the custom defined display field format. Use Field.DisplayFormat | |DEPRECATED Changes the custom defined display field format. Use Field.DisplayFormat | ||
| - | |<nowiki>&isOK=SetDisplayFormat([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>&isOK=SetDisplayFormat([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.]FieldName, &DisplayFormatName);</nowiki> |
|- | |- | ||
| - | | | + | |SetLabel |
|DEPRECATED Changes the label for the field. Use Field.Label | |DEPRECATED Changes the label for the field. Use Field.Label | ||
| - | |<nowiki>[&isOK=]SetLabel([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>[&isOK=]SetLabel([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.]FieldName, &LabelText);</nowiki> |
|- | |- | ||
| - | | | + | |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 | |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 | ||
|<nowiki>[&isOK=]SetLanguage(&LanguageCd);</nowiki> | |<nowiki>[&isOK=]SetLanguage(&LanguageCd);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetMessageStatus |
|Sets message status to %IB_Status_Active or %IB_Status_InActive | |Sets message status to %IB_Status_Active or %IB_Status_InActive | ||
|<nowiki>&isOK=SetMessageStatus(MESSAGE.MessageName, &StatusNumber);</nowiki> | |<nowiki>&isOK=SetMessageStatus(MESSAGE.MessageName, &StatusNumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetNextPage |
|Returns true if next page (F6/TransferPage) is set to Page | |Returns true if next page (F6/TransferPage) is set to Page | ||
|<nowiki>[&isOK=]SetNextPage(&PageName);</nowiki> | |<nowiki>[&isOK=]SetNextPage(&PageName);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetNextPanel |
|DEPRECATED Returns true if next page (F6/TransferPage) is set to Page. Use SetNextPage | |DEPRECATED Returns true if next page (F6/TransferPage) is set to Page. Use SetNextPage | ||
|<nowiki>[&isOK=]SetNextPanel(&PageName);</nowiki> | |<nowiki>[&isOK=]SetNextPanel(&PageName);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetPageFieldPageFieldName |
|Returns %MDA_Success if PageFieldName is set successfully. | |Returns %MDA_Success if PageFieldName is set successfully. | ||
|<nowiki>&errorCode=SetPageFieldPageFieldName(PAGE.PageName, RECORD.RecordName, FIELD.FieldName, &PageFieldName);</nowiki> | |<nowiki>&errorCode=SetPageFieldPageFieldName(PAGE.PageName, RECORD.RecordName, FIELD.FieldName, &PageFieldName);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetPasswordExpired |
|Returns old value of password expired and sets to new Is Password Expired boolean value | |Returns old value of password expired and sets to new Is Password Expired boolean value | ||
|<nowiki>&isOK=SetPasswordExpired(&isPasswordExpired);</nowiki> | |<nowiki>&isOK=SetPasswordExpired(&isPasswordExpired);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetPostReport |
|Returns a reference to a PostReport object for posting files to the Report Repository using postReport.Put | |Returns a reference to a PostReport object for posting files to the Report Repository using postReport.Put | ||
|<nowiki>&postReport=SetPostReport();</nowiki> | |<nowiki>&postReport=SetPostReport();</nowiki> | ||
|- | |- | ||
| - | | | + | |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. | |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. | ||
|<nowiki>SetReEdit(&isReEdit);</nowiki> | |<nowiki>SetReEdit(&isReEdit);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetRecFieldEditTable |
|Returns %MDA_Success if Record Field edits are changed to EditTable and EditType (e.g. %EditTableType_Prompt) successfully. | |Returns %MDA_Success if Record Field edits are changed to EditTable and EditType (e.g. %EditTableType_Prompt) successfully. | ||
|<nowiki>&errorCode=SetRecFieldEditTable(RECORD.RecordName, FIELD.FieldName, &EditTableName [, &EditTypeNumber]);</nowiki> | |<nowiki>&errorCode=SetRecFieldEditTable(RECORD.RecordName, FIELD.FieldName, &EditTableName [, &EditTypeNumber]);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetRecFieldKey |
|Returns %MDA_Success if Record Field is changed to being a key successfully. | |Returns %MDA_Success if Record Field is changed to being a key successfully. | ||
|<nowiki>&errorCode=SetRecFieldKey(RECORD.RecordName, FIELD.FieldName, &isKey);</nowiki> | |<nowiki>&errorCode=SetRecFieldKey(RECORD.RecordName, FIELD.FieldName, &isKey);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetSearchDefault |
|Populates search dialog box field with Application Designer default, but does not run FDe | |Populates search dialog box field with Application Designer default, but does not run FDe | ||
|<nowiki>SetSearchDefault([RecordName.]FieldName);</nowiki> | |<nowiki>SetSearchDefault([RecordName.]FieldName);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetSearchDialogBehavior |
|SIn: Makes search dialog either skip if possible (Force Number=0) or force dialog display (1) | |SIn: Makes search dialog either skip if possible (Force Number=0) or force dialog display (1) | ||
|<nowiki>SetSearchDialogBehavior(&ForceNumber);</nowiki> | |<nowiki>SetSearchDialogBehavior(&ForceNumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetSearchEdit |
|DEPRECATED Sets edits on for a search dialog field. Use Field.SearchEdit | |DEPRECATED Sets edits on for a search dialog field. Use Field.SearchEdit | ||
|<nowiki>&isOK=SetSearchEdit([RecordName.]FieldName);</nowiki> | |<nowiki>&isOK=SetSearchEdit([RecordName.]FieldName);</nowiki> | ||
|- | |- | ||
| - | | | + | |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. | |Sets the temporary table default instance number and returns the previous one (for resetting later). Used by %Table and SQL functions on Temporary Tables. | ||
|<nowiki>&oldTableInstanceNumber=SetTempTableInstance(&NewTableInstanceNumber);</nowiki> | |<nowiki>&oldTableInstanceNumber=SetTempTableInstance(&NewTableInstanceNumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetTracePC |
|Sets PeopleCode trace to number specifed e.g. %TracePC_EachStmt (2048) | |Sets PeopleCode trace to number specifed e.g. %TracePC_EachStmt (2048) | ||
|<nowiki>SetTracePC(&TraceSettingNumber);</nowiki> | |<nowiki>SetTracePC(&TraceSettingNumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetTraceSQL |
|Sets SQL trace to number specified e.g. %TraceSQL_Statements + %TraceSQL_Variables | |Sets SQL trace to number specified e.g. %TraceSQL_Statements + %TraceSQL_Variables | ||
|<nowiki>SetTraceSQL(&TraceSettingNumber);</nowiki> | |<nowiki>SetTraceSQL(&TraceSettingNumber);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetUserOption |
|Returns true if specified user option default is set to new value | |Returns true if specified user option default is set to new value | ||
|<nowiki>&isOK=SetUserOption(&OptionCategoryLevel, &OptionName, &DefaultValue);</nowiki> | |<nowiki>&isOK=SetUserOption(&OptionCategoryLevel, &OptionName, &DefaultValue);</nowiki> | ||
|- | |- | ||
| - | | | + | |SetupScheduleDefnItem |
|Returns a new process request object for a Scheduled JobSet | |Returns a new process request object for a Scheduled JobSet | ||
|<nowiki>&processRequest=SetupScheduleDefnItem(&ProcessTypeName, &JobName);</nowiki> | |<nowiki>&processRequest=SetupScheduleDefnItem(&ProcessTypeName, &JobName);</nowiki> | ||
|- | |- | ||
| - | | | + | |Sign |
|Returns 1 if number positive, -1 if negative and zero if number is zero | |Returns 1 if number positive, -1 if negative and zero if number is zero | ||
|<nowiki>&signNumber=Sign(&Number);</nowiki> | |<nowiki>&signNumber=Sign(&Number);</nowiki> | ||
|- | |- | ||
| - | | | + | |Sin |
|Returns the sine (-1 to +1) of the angle Radians | |Returns the sine (-1 to +1) of the angle Radians | ||
|<nowiki>&sine=Sin(&Radians);</nowiki> | |<nowiki>&sine=Sin(&Radians);</nowiki> | ||
|- | |- | ||
| - | | | + | |SinglePaymentPV |
|Returns future value of monetary unit after Number Of Periods at Interest Rate | |Returns future value of monetary unit after Number Of Periods at Interest Rate | ||
|<nowiki>&unitValue=SinglePaymentPV(&InterestRate, &NumberOfPeriods);</nowiki> | |<nowiki>&unitValue=SinglePaymentPV(&InterestRate, &NumberOfPeriods);</nowiki> | ||
|- | |- | ||
| - | | | + | |SortScroll |
|DEPECATED Sorts the scroll by list of fields in order (A , D) provided. Use RowSet.Sort | |DEPECATED Sorts the scroll by list of fields in order (A , D) provided. Use RowSet.Sort | ||
| - | |<nowiki>[&isOK=]SortScroll(&LevelNumber, [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>[&isOK=]SortScroll(&LevelNumber, [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, [SortRecordName.]SortFieldName1, &Order1 [, [SortRecordName.]SortFieldName2, &Order2]...);</nowiki> |
|- | |- | ||
| - | | | + | |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 | |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 | ||
|<nowiki>&stringArray=Split(&BigString [, &Separator]);</nowiki> | |<nowiki>&stringArray=Split(&BigString [, &Separator]);</nowiki> | ||
|- | |- | ||
| - | | | + | |Sqrt |
|Returns the square root of Number. If Number negative, displays error. | |Returns the square root of Number. If Number negative, displays error. | ||
|<nowiki>&squareRoot=sqrt(&Number);</nowiki> | |<nowiki>&squareRoot=sqrt(&Number);</nowiki> | ||
|- | |- | ||
| - | | | + | |StartWork |
|Starts a transaction in which no updates are saved until a CommitWork | |Starts a transaction in which no updates are saved until a CommitWork | ||
|<nowiki>StartWork();</nowiki> | |<nowiki>StartWork();</nowiki> | ||
|- | |- | ||
| - | | | + | |StopFetching |
|RSe only. Makes this the last row to be added to the database buffer and stops any further fetches from DB | |RSe only. Makes this the last row to be added to the database buffer and stops any further fetches from DB | ||
|<nowiki>StopFetching();</nowiki> | |<nowiki>StopFetching();</nowiki> | ||
|- | |- | ||
| - | | | + | |StoreSQL |
|Stores SQL (like App Designer) with DB Type (AppServer , DB2 , DB2Unix , Informix , Microsoft , Oracle , Sybase) and EffDt (Date type) and 4 char Owner | |Stores SQL (like App Designer) with DB Type (AppServer , DB2 , DB2Unix , Informix , Microsoft , Oracle , Sybase) and EffDt (Date type) and 4 char Owner | ||
| - | |<nowiki>StoreSQL(&SqlStatement, SQL.SqlName [,&DBType [,&EffDt [,&Owner [,&Description | + | |<nowiki>StoreSQL(&SqlStatement, SQL.SqlName [,&DBType [,&EffDt [,&Owner [,&Description);</nowiki> |
|- | |- | ||
| - | | | + | |String |
| - | |Converts number to string. Numbers | + | |Converts number to string. Numbers maybe represented differently across platforms. If you want to be fussy, use NumberToString |
|<nowiki>&string=String(&Value);</nowiki> | |<nowiki>&string=String(&Value);</nowiki> | ||
|- | |- | ||
| - | | | + | |Subrecords |
| | | | ||
|<nowiki>.........</nowiki> | |<nowiki>.........</nowiki> | ||
|- | |- | ||
| - | | | + | |Substitute |
|Replaces every occurrence of OldSubString with NewSubString. Tilde (~) means one or more spaces. | |Replaces every occurrence of OldSubString with NewSubString. Tilde (~) means one or more spaces. | ||
|<nowiki>&resultString=Substitute(&String, &OldSubString, &NewSubString);</nowiki> | |<nowiki>&resultString=Substitute(&String, &OldSubString, &NewSubString);</nowiki> | ||
|- | |- | ||
| - | | | + | |Substring |
|Returns Partial String by taking Number Of Characters from Start Position of String. Unicode character pairs could get split. | |Returns Partial String by taking Number Of Characters from Start Position of String. Unicode character pairs could get split. | ||
|<nowiki>&partialString=Substring(&String, &StartPosition, &NumberOfCharacters);</nowiki> | |<nowiki>&partialString=Substring(&String, &StartPosition, &NumberOfCharacters);</nowiki> | ||
|- | |- | ||
| - | | | + | |Substringb |
|DEPRECATED Use SubString | |DEPRECATED Use SubString | ||
|<nowiki>&partialString=Substringb(&String, &StartPosition, &NumberOfCharacters);</nowiki> | |<nowiki>&partialString=Substringb(&String, &StartPosition, &NumberOfCharacters);</nowiki> | ||
|- | |- | ||
| - | | | + | |SwitchUser |
|Switches user by User/Pass or by Authentication Token. Calls SignOn PeopleCode. | |Switches user by User/Pass or by Authentication Token. Calls SignOn PeopleCode. | ||
|<nowiki>&isOK=SwitchUser(&User, &Password, &AuthenticationToken, &Base64ExternalAuthentication);</nowiki> | |<nowiki>&isOK=SwitchUser(&User, &Password, &AuthenticationToken, &Base64ExternalAuthentication);</nowiki> | ||
|- | |- | ||
| - | | | + | |SyncRequestXmlDoc |
|Returns Response when command sends unstructured XmlDocument synchronously | |Returns Response when command sends unstructured XmlDocument synchronously | ||
|<nowiki>&ResponseXmlDocument=SyncRequestXmlDoc(&XmlDocument, MESSAGE.MessageName[, NODE.NodeName]);</nowiki> | |<nowiki>&ResponseXmlDocument=SyncRequestXmlDoc(&XmlDocument, MESSAGE.MessageName[, NODE.NodeName]);</nowiki> | ||
|- | |- | ||
| - | | | + | |Tan |
|Returns the tangent value (0-lots) of the angle in Radians | |Returns the tangent value (0-lots) of the angle in Radians | ||
|<nowiki>&tangent=Tan(&Radians);</nowiki> | |<nowiki>&tangent=Tan(&Radians);</nowiki> | ||
|- | |- | ||
| - | | | + | |Then |
|Executes statements depending on condition | |Executes statements depending on condition | ||
| - | |<nowiki>If conditions Then [statements] [Else [statements | + | |<nowiki>If conditions Then [statements] [Else [statements End-If;</nowiki> |
|- | |- | ||
| - | | | + | |Throw |
|Throws an exception using the specified Exception object | |Throws an exception using the specified Exception object | ||
|<nowiki>Throw &ExceptionObject;</nowiki> | |<nowiki>Throw &ExceptionObject;</nowiki> | ||
|- | |- | ||
| - | | | + | |Time3 |
|Creates a Time value from Hour (0-23), Minutes (0-59), Seconds (0-59.999999) | |Creates a Time value from Hour (0-23), Minutes (0-59), Seconds (0-59.999999) | ||
|<nowiki>&timeValue=Time3(&Hours, &Minutes, &Seconds);</nowiki> | |<nowiki>&timeValue=Time3(&Hours, &Minutes, &Seconds);</nowiki> | ||
|- | |- | ||
| - | | | + | |TimePart |
|Returns the Time value from a DateTime | |Returns the Time value from a DateTime | ||
|<nowiki>&timeValue=TimePart(&DateTimeValue);</nowiki> | |<nowiki>&timeValue=TimePart(&DateTimeValue);</nowiki> | ||
|- | |- | ||
| - | | | + | |TimeToTimeZone |
|Returns fromTime converted by time zone specified by 3 character string e.g. EST or Local or Base | |Returns fromTime converted by time zone specified by 3 character string e.g. EST or Local or Base | ||
|<nowiki>&dateTime=TimeToTimeZone(&fromTime, &fromTimeZone, &toTimeZone);</nowiki> | |<nowiki>&dateTime=TimeToTimeZone(&fromTime, &fromTimeZone, &toTimeZone);</nowiki> | ||
|- | |- | ||
| - | | | + | |TimeValue |
|Creates a Time value from String in format HH:MM:SS[:SSSSSS] | |Creates a Time value from String in format HH:MM:SS[:SSSSSS] | ||
|<nowiki>&timeValue=TimeValue(&String);</nowiki> | |<nowiki>&timeValue=TimeValue(&String);</nowiki> | ||
|- | |- | ||
| - | | | + | |TimeZoneOffset |
|Returns the offset (+/-hh:mm) of Date Time from GMT. TimeZone can be a TZ value or Local or Base | |Returns the offset (+/-hh:mm) of Date Time from GMT. TimeZone can be a TZ value or Local or Base | ||
|<nowiki>&offsetString=TimeZoneOffset(&DateTime [,&TimeZone] );</nowiki> | |<nowiki>&offsetString=TimeZoneOffset(&DateTime [,&TimeZone] );</nowiki> | ||
|- | |- | ||
| - | | | + | |TimeZone |
| | | | ||
|<nowiki>.........</nowiki> | |<nowiki>.........</nowiki> | ||
|- | |- | ||
| - | | | + | |Time |
|Creates a Time value from Number in format HHMMSS[.SSSSSS] | |Creates a Time value from Number in format HHMMSS[.SSSSSS] | ||
|<nowiki>&timeValue=Time(&Number);</nowiki> | |<nowiki>&timeValue=Time(&Number);</nowiki> | ||
|- | |- | ||
| - | | | + | |TotalRowCount |
|Returns the total number of rows in the scroll including deleted rows | |Returns the total number of rows in the scroll including deleted rows | ||
| - | |<nowiki>&numberRows=TotalRowCount([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>&numberRows=TotalRowCount([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName);</nowiki> |
|- | |- | ||
| - | | | + | |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 | |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 | ||
|<nowiki>TransferExact(&IsNewWindow, MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName, &Action [, [RecordName1.]KeyFieldName1...] [, &IsAutoSearch] );</nowiki> | |<nowiki>TransferExact(&IsNewWindow, MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName, &Action [, [RecordName1.]KeyFieldName1...] [, &IsAutoSearch] );</nowiki> | ||
|- | |- | ||
| - | | | + | |TransferMobilePage |
|Transfers to the specified Mobile Page Detail View. | |Transfers to the specified Mobile Page Detail View. | ||
|<nowiki>TransferMobilePage( [MOBILEPAGE.]PageName, &TabNumber, &CiObject);</nowiki> | |<nowiki>TransferMobilePage( [MOBILEPAGE.]PageName, &TabNumber, &CiObject);</nowiki> | ||
|- | |- | ||
| - | | | + | |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 | |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 | ||
|<nowiki>[&isOK=]TransferNode(&IsNewWindow, NODE.NodeName, MENU.MenuName, MARKET.MarketName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName, &Action [, [RecordName1.]KeyFieldName1...]);</nowiki> | |<nowiki>[&isOK=]TransferNode(&IsNewWindow, NODE.NodeName, MENU.MenuName, MARKET.MarketName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName, &Action [, [RecordName1.]KeyFieldName1...]);</nowiki> | ||
|- | |- | ||
| - | | | + | |TransferPage |
|Terminates current PeopleCode and transfers to page within current component (if none specified uses one set by SetNextpage). Ignored in CI. | |Terminates current PeopleCode and transfers to page within current component (if none specified uses one set by SetNextpage). Ignored in CI. | ||
|<nowiki>[&isOK=]TransferPage([PAGE.PageName]);</nowiki> | |<nowiki>[&isOK=]TransferPage([PAGE.PageName]);</nowiki> | ||
|- | |- | ||
| - | | | + | |TransferPanel |
|DEPRECATED. Use TransferPage | |DEPRECATED. Use TransferPage | ||
|<nowiki>[&isOK=]TransferPanel([PANEL.PageName]);</nowiki> | |<nowiki>[&isOK=]TransferPanel([PANEL.PageName]);</nowiki> | ||
|- | |- | ||
| - | | | + | |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 | |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 | ||
|<nowiki>[&isOK=]TransferPortal(&IsNewWindow, PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName, &Action [, [RecordName1.]KeyFieldName1...]);</nowiki> | |<nowiki>[&isOK=]TransferPortal(&IsNewWindow, PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName, &Action [, [RecordName1.]KeyFieldName1...]);</nowiki> | ||
|- | |- | ||
| - | | | + | |Transfer |
| - | |Transfers to 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 | + | |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 |
|<nowiki>Transfer(&IsNewWindow, MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName, &Action [, [RecordName1.]KeyFieldName1...] [, &IsAutoSearch] );</nowiki> | |<nowiki>Transfer(&IsNewWindow, MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName, &Action [, [RecordName1.]KeyFieldName1...] [, &IsAutoSearch] );</nowiki> | ||
|- | |- | ||
| - | | | + | |TransformExCache |
|Returns the well-formed XML Doc transformed by the XSLT File (which is cached for speedy multiple calls) - never null | |Returns the well-formed XML Doc transformed by the XSLT File (which is cached for speedy multiple calls) - never null | ||
|<nowiki>&resultXmlString=TransformExCache(&XmlDoc, &XsltFileName, &XsltCacheKey);</nowiki> | |<nowiki>&resultXmlString=TransformExCache(&XmlDoc, &XsltFileName, &XsltCacheKey);</nowiki> | ||
|- | |- | ||
| - | | | + | |TransformEx |
|Returns the well-formed XML String transformed by the XSLT String - null if unsuccessful | |Returns the well-formed XML String transformed by the XSLT String - null if unsuccessful | ||
|<nowiki>&resultXmlString=TransformEx(&XmlString, &XsltString);</nowiki> | |<nowiki>&resultXmlString=TransformEx(&XmlString, &XsltString);</nowiki> | ||
|- | |- | ||
| - | | | + | |Transform |
|Returns XML Document transformed by AE program, never Null. | |Returns XML Document transformed by AE program, never Null. | ||
|<nowiki>&resultXmlDoc=Transform({&XmlString | &XmlDoc}, AEProgram, &StartNodeName, &StartMessageName, &StartMessageVersion, &ResultNodeName, &ResultMessageName, &ResultMessageVersion);</nowiki> | |<nowiki>&resultXmlDoc=Transform({&XmlString | &XmlDoc}, AEProgram, &StartNodeName, &StartMessageName, &StartMessageVersion, &ResultNodeName, &ResultMessageName, &ResultMessageVersion);</nowiki> | ||
|- | |- | ||
| - | | | + | |TreeDetailInNode |
|Not PIA??? Checks if value in FieldName is under the HighLevelNodeName in the specified tree | |Not PIA??? Checks if value in FieldName is under the HighLevelNodeName in the specified tree | ||
|<nowiki>&isDescendant=TreeDetailInNode(&TreeSetID, &TreeName, &TreeEffdt, RecordName.FieldName, &HighLevelNodeName);</nowiki> | |<nowiki>&isDescendant=TreeDetailInNode(&TreeSetID, &TreeName, &TreeEffdt, RecordName.FieldName, &HighLevelNodeName);</nowiki> | ||
|- | |- | ||
| - | | | + | |TriggerBusinessEvent |
|Triggers workflow on the business event. If unsuccessful, will rollback errors up to trigger, but updates after will be commited if not stopped! | |Triggers workflow on the business event. If unsuccessful, will rollback errors up to trigger, but updates after will be commited if not stopped! | ||
|<nowiki>&isOK=TriggerBusinessEvent(BUSPROCESS.BusinessProcessName, BUSACTIVITY.ActivityName, BUSEVENT.BusinessEventName);</nowiki> | |<nowiki>&isOK=TriggerBusinessEvent(BUSPROCESS.BusinessProcessName, BUSACTIVITY.ActivityName, BUSEVENT.BusinessEventName);</nowiki> | ||
|- | |- | ||
| - | | | + | |Truncate |
|Returns Number truncated to Number Of Digits after the decimal point | |Returns Number truncated to Number Of Digits after the decimal point | ||
|<nowiki>&truncatedNumber=Truncate(&Number, &NumberofDigits);</nowiki> | |<nowiki>&truncatedNumber=Truncate(&Number, &NumberofDigits);</nowiki> | ||
|- | |- | ||
| - | | | + | |Try |
|Creates a block where statements can error and these are handled. | |Creates a block where statements can error and these are handled. | ||
|<nowiki>Try statementsSandbox; Catch exceptionSubClass &Exception errorHandlingStatements; End-Try;</nowiki> | |<nowiki>Try statementsSandbox; Catch exceptionSubClass &Exception errorHandlingStatements; End-Try;</nowiki> | ||
|- | |- | ||
| - | | | + | |UnCheckMenuItem |
|DEPRECATED Unchecks the Windows client menu item | |DEPRECATED Unchecks the Windows client menu item | ||
|<nowiki>UnCheckMenuItem(BARNAME.MenuBarName, ITEMNAME.MenuItemName);</nowiki> | |<nowiki>UnCheckMenuItem(BARNAME.MenuBarName, ITEMNAME.MenuItemName);</nowiki> | ||
|- | |- | ||
| - | | | + | |Unencode |
|Returns decoded URL String from encoded string according to W3C rules with HTTP %xx | |Returns decoded URL String from encoded string according to W3C rules with HTTP %xx | ||
|<nowiki>&plainUrlString=Unencode(&EncodedUrlString);</nowiki> | |<nowiki>&plainUrlString=Unencode(&EncodedUrlString);</nowiki> | ||
|- | |- | ||
| - | | | + | |Ungray |
|Switches the field to be changeable on the page. | |Switches the field to be changeable on the page. | ||
| - | |<nowiki>[&isOK=]Ungray( | + | |<nowiki>[&isOK=]Ungray(RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.FieldName);</nowiki> |
|- | |- | ||
| - | | | + | |UnhideRow |
|Shows row and related rows in lower scroll levels. Use &Row.Visible | |Shows row and related rows in lower scroll levels. Use &Row.Visible | ||
| - | |<nowiki>[&isOK=]UnhideRow([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>[&isOK=]UnhideRow([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.]FieldName [, &TargetRowNumber] );</nowiki> |
|- | |- | ||
| - | | | + | |UnhideScroll |
|Shows entire scroll bar and data inside. Use &Rowset.Visible | |Shows entire scroll bar and data inside. Use &Rowset.Visible | ||
| - | |<nowiki>[&isOK=]UnhideScroll([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>[&isOK=]UnhideScroll([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.]FieldName);</nowiki> |
|- | |- | ||
| - | | | + | |Unhide |
|Makes specified field visible - normally Row Init or FCh | |Makes specified field visible - normally Row Init or FCh | ||
| - | |<nowiki>[&isOK=]Unhide( | + | |<nowiki>[&isOK=]Unhide(RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.FieldName);</nowiki> |
|- | |- | ||
| - | | | + | |UniformSeriesPV |
|Returns value of single unit after uniform series of payments at Interest Rate | |Returns value of single unit after uniform series of payments at Interest Rate | ||
|<nowiki>&unitValue=UniformSeriesPV(&InterestRate, &NumberOfPeriods);</nowiki> | |<nowiki>&unitValue=UniformSeriesPV(&InterestRate, &NumberOfPeriods);</nowiki> | ||
|- | |- | ||
| - | | | + | |Until |
|Statements are executed at least once. BooleanExpression is evaluated and if false, statements are executed until the expression gives true | |Statements are executed at least once. BooleanExpression is evaluated and if false, statements are executed until the expression gives true | ||
|<nowiki>Repeat statements; until &BooleanExpression;</nowiki> | |<nowiki>Repeat statements; until &BooleanExpression;</nowiki> | ||
|- | |- | ||
| - | | | + | |UpdateSysVersion |
|PeopleTools Only. Returns version number for co ordinating changes to system tables e.g. Message Catalogue | |PeopleTools Only. Returns version number for co ordinating changes to system tables e.g. Message Catalogue | ||
|<nowiki>&versionNumber=UpdateSysVersion();</nowiki> | |<nowiki>&versionNumber=UpdateSysVersion();</nowiki> | ||
|- | |- | ||
| - | | | + | |UpdateValue |
|Updates specified Field with Value. Use Field.Value | |Updates specified Field with Value. Use Field.Value | ||
| - | |<nowiki>UpdateValue([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, | + | |<nowiki>UpdateValue([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, &Value);</nowiki> |
|- | |- | ||
| - | | | + | |UpdateXmlDoc |
|Updates message in queue with specified version | |Updates message in queue with specified version | ||
| - | |<nowiki>&isOK=UpdateXmlDoc(&XmlDocument, &PublishId, &PublishNodeName, &ChannelName, &VersionName[, &MessageName[, &SubNode | + | |<nowiki>&isOK=UpdateXmlDoc(&XmlDocument, &PublishId, &PublishNodeName, &ChannelName, &VersionName[, &MessageName[, &SubNode);</nowiki> |
|- | |- | ||
| - | | | + | |Upper |
|Returns the Mixed Case String in Upper Case | |Returns the Mixed Case String in Upper Case | ||
|<nowiki>&uppercaseString=Upper(&MixedCaseString);</nowiki> | |<nowiki>&uppercaseString=Upper(&MixedCaseString);</nowiki> | ||
|- | |- | ||
| - | | | + | |Value |
|Returns String converted to a number | |Returns String converted to a number | ||
|<nowiki>&number=Value(&String);</nowiki> | |<nowiki>&number=Value(&String);</nowiki> | ||
|- | |- | ||
| - | | | + | |ViewAttachment |
|Returns 0 if attachment successfully shown | |Returns 0 if attachment successfully shown | ||
| - | |<nowiki>&errorCode=ViewAttachment({&fromURL | URL.UrlName}, &DestinationAppendedPathFilename, &ClientFile [, &IsNewWindow [, &PreserveCaseBoolean | + | |<nowiki>&errorCode=ViewAttachment({&fromURL | URL.UrlName}, &DestinationAppendedPathFilename, &ClientFile [, &IsNewWindow [, &PreserveCaseBoolean);</nowiki> |
|- | |- | ||
| - | | | + | |ViewContentURL |
|Creates new browser window showing URL specified | |Creates new browser window showing URL specified | ||
|<nowiki>ViewContentURL({&UrlString | URL.UrlName});</nowiki> | |<nowiki>ViewContentURL({&UrlString | URL.UrlName});</nowiki> | ||
|- | |- | ||
| - | | | + | |ViewURL |
|Views URL in current browser window or launches default browser to view | |Views URL in current browser window or launches default browser to view | ||
|<nowiki>ViewURL({&UrlString | URL.UrlName} [, &IsNewWindow]);</nowiki> | |<nowiki>ViewURL({&UrlString | URL.UrlName} [, &IsNewWindow]);</nowiki> | ||
|- | |- | ||
| - | | | + | |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 | |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 | ||
|<nowiki>Warning &String;</nowiki> | |<nowiki>Warning &String;</nowiki> | ||
|- | |- | ||
| - | | | + | |Weekday |
|Returns number (1=Sunday, 7=Saturday) of the day of the week for Date | |Returns number (1=Sunday, 7=Saturday) of the day of the week for Date | ||
|<nowiki>&dayNumber=Weekday(&date);</nowiki> | |<nowiki>&dayNumber=Weekday(&date);</nowiki> | ||
|- | |- | ||
| - | | | + | |When-Others |
|Evaluate branches depending on conditions on Value | |Evaluate branches depending on conditions on Value | ||
|<nowiki>Evaluate &Value When ... End-evaluate</nowiki> | |<nowiki>Evaluate &Value When ... End-evaluate</nowiki> | ||
|- | |- | ||
| - | | | + | |When |
|Evaluate branches depending on conditions on Value | |Evaluate branches depending on conditions on Value | ||
|<nowiki>Evaluate &Value When ... End-evaluate</nowiki> | |<nowiki>Evaluate &Value When ... End-evaluate</nowiki> | ||
|- | |- | ||
| - | | | + | |While |
|Repeats Statements while Boolean is true. | |Repeats Statements while Boolean is true. | ||
|<nowiki>While (&Boolean) Statements; End-While;</nowiki> | |<nowiki>While (&Boolean) Statements; End-While;</nowiki> | ||
|- | |- | ||
| - | | | + | |WinEscape |
|DEPRECATED/NOT SUPPORTED Cancels panel. | |DEPRECATED/NOT SUPPORTED Cancels panel. | ||
|<nowiki>WinEscape();</nowiki> | |<nowiki>WinEscape();</nowiki> | ||
|- | |- | ||
| - | | | + | |WinExec |
|DEPRECATED/NOT SUPPORTED Executes command on Windows client machine | |DEPRECATED/NOT SUPPORTED Executes command on Windows client machine | ||
|<nowiki>[&returnCode=]WinExec(&Command, &Option [, &IsSynchonised]);</nowiki> | |<nowiki>[&returnCode=]WinExec(&Command, &Option [, &IsSynchonised]);</nowiki> | ||
|- | |- | ||
| - | | | + | |WinMessage |
|DEPRECATED Displays message with buttons. Use MessageBox | |DEPRECATED Displays message with buttons. Use MessageBox | ||
|<nowiki>[&buttonPressedNumber=]WinMessage(&Message [,&StyleNumber] [, &Title]);</nowiki> | |<nowiki>[&buttonPressedNumber=]WinMessage(&Message [,&StyleNumber] [, &Title]);</nowiki> | ||
|- | |- | ||
| - | | | + | |WriteToLog |
|Writes message to the Application Server log file if Severity is less than Log Fence set | |Writes message to the Application Server log file if Severity is less than Log Fence set | ||
|<nowiki>WriteToLog(&SeverityNumber, &Message);</nowiki> | |<nowiki>WriteToLog(&SeverityNumber, &Message);</nowiki> | ||
|- | |- | ||
| - | | | + | |Year |
|Returns the year (1900 - 2078) from the Date value | |Returns the year (1900 - 2078) from the Date value | ||
|<nowiki>&yearNumber=Year(&Date);</nowiki> | |<nowiki>&yearNumber=Year(&Date);</nowiki> | ||
| + | |||
| + | |} | ||
| + | |||
| + | '''Our eBooks''' | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | |[[File:UsingFunctionsInPeopleSoftQuerySmall.jpg|90px|link=http://www.amazon.co.uk/gp/product/B013ZRND0I/ref=as_li_tl?ie=UTF8&camp=1634&creative=6738&creativeASIN=B013ZRND0I&linkCode=as2&tag=springboardso-21]] | ||
| + | |||
| + | | | ||
| + | [http://www.amazon.co.uk/gp/product/B013ZRND0I/ref=as_li_tl?ie=UTF8&camp=1634&creative=6738&creativeASIN=B013ZRND0I&linkCode=as2&tag=springboardso-21 Using Functions in PeopleSoft Query] | ||
| + | |||
| + | [[PeopleSoft Query]] | ||
| + | |||
| + | |[[File:PeopleSoftUserCompanion.jpg|90px|link=http://www.amazon.co.uk/gp/product/B00S74S9MM/ref=as_li_tl?ie=UTF8&camp=1634&creative=6738&creativeASIN=B00S74S9MM&linkCode=as2&tag=springboardso-21&linkId=X4GHKEBKKMKPCO24]] | ||
| + | |||
| + | | | ||
| + | [http://www.amazon.co.uk/gp/product/B00S74S9MM/ref=as_li_tl?ie=UTF8&camp=1634&creative=6738&creativeASIN=B00S74S9MM&linkCode=as2&tag=springboardso-21&linkId=X4GHKEBKKMKPCO24 PeopleSoft Users Companion] | ||
| + | |||
| + | [[PeopleSoft Users Companion Extras]] | ||
|} | |} | ||