## PeopleCode Built-in Functions

This chapter provides a reference to PeopleCode built-in functions and language constructs and discusses:

• Functions by category

• PeopleCode built-in functions and language constructs

### Functions by Category

The following topics subdivide the PeopleCode built-in functions by functional category and provide links from within each category to the reference entries.

XML.

### PeopleCode Built-in Functions and Language Constructs

The following are the PeopleCode Built-In functions.

#### Abs

Syntax

Abs(x)

Description

Use the Abs function to return a decimal value equal to the absolute value of a number x.

Parameters

 x Specify the number you want the decimal value for.

Example

The example returns the absolute value of the difference between &NUM_1 and &NUM_2:

&RESULT = Abs(&NUM_1 - &NUM_2);

Sign, %Abs.

#### AccruableDays

Syntax

AccruableDays(StartDate, EndDate, Accrual_Conv)

Description

Use the AccruableDays function to return the number of days during which interest can accrue in a given range of time according to the Accrual_Conv parameter.

Parameters

 StartDate The beginning of the time period for determining the accrual. This parameter takes a date value. EndDate The end of the time period for determining the accrual. This parameter takes a date value. Accrual_Conv The accrual convention. This parameter takes either a number or a constant value. Values for this parameter are:

 Numeric Value Constant Value Description 0 %Accrual_30DPM 30/360: all months 30 days long according to NASD rules for date truncation 1 %Accrual_30DPME 30E/360: all months 30 days long according to European rules for date truncation 2 N/A 30N/360: all months but February are 30 days long according to SIA rules 3 %Accrual_Fixed360 Act/360: months have variable number of days, but years have fixed 360 days 4 %Accrual_Fixed365 Act/365: months have variable number of days, buy years have fixed 365 days 5 %Accrual_ActualDPY Act/Act: months and years have a variable number of days

Returns

An integer representing a number of days.

#### AccrualFactor

Syntax

AccrualFactor(StartDate, EndDate, Accrual_Conv)

Description

Use the AccrualFactor function to compute a factor that's equal to the number of years of interest accrued during a date range, according to Accrual_Conv parameter.

Parameters

 StartDate The beginning of the time period for determining the accrual. This parameter takes a date value. EndDate The end of the time period for determining the accrual. This parameter takes a date value. Accrual_Conv The accrual convention. This parameter takes either a number or constant value. Values for this parameter are:

 Numeric Value Constant Value Description 0 %Accrual_30DPM 30/360: all months 30 days long according to NASD rules for date truncation 1 %Accrual_30DPME 30E/360: all months 30 days long according to European rules for date truncation 2 N/A 30N/360: all months but February are 30 days long according to SIA rules 3 %Accrual_Fixed360 Act/360: months have variable number of days, but years have fixed 360 days 4 %Accrual_Fixed365 Act/365: months have variable number of days, buy years have fixed 365 days 5 %Accrual_ActualDPY Act/Act: months and years have a variable number of days

Returns

A floating point number representing a number of years.

#### Acos

Syntax

Acos(value)

Description

Use the Acos function to calculate the arccosine of the given value, that is, the size of the angle whose cosine is that value.

Parameters

 value Any real number between -1.00 and 1.00 inclusive, the range of valid cosine values. If the input value is outside this range, an error message appears at runtime ("Decimal arithmetic error occurred. (2,110)"). Adjust your code to provide a valid input value.

Returns

A value in radians between 0 and pi.

Example

The following example returns the size in radians of the angle whose cosine is 0.5:

&MY_ANGLE = Acos(0.5);

#### ActiveRowCount

Syntax

ActiveRowCount(Scrollpath)

Where scrollpath is:

[RECORD.level1_recname, level1_row, [RECORD.level2_recname, level2_row, ]] RECORD.target_recname

To prevent ambiguous references, you can use SCROLL. scrollname, where scrollname is the same as the scroll level’s primary record name.

Description

Use the ActiveRowCount function to return the number of active (non-deleted) rows for a specified scroll area in the active page.

Note. This function remains for backward compatibility only. Use the ActiveRowCount Rowset class property instead.

ActiveRowCount is often used to get a limiting value for a For statement. This enables you to loop through the active rows of a scroll area, performing an operation on each active row. Rows that have been marked as deleted are not affected in a For loop delimited by ActiveRowCount. If you want to loop through all the rows of a scroll area, including deleted rows, use TotalRowCount.

Use ActiveRowCount with CurrentRowNumber to determine whether the user is on the last row of a record.

Parameters

 scrollpath A construction that specifies a scroll level in the component buffer.

Returns

Returns a Number value equal to the total active (non-deleted) rows in the specified scroll area in the active page.

Example

In this example ActiveRowCount is used to delimit a For loop through a level-one scroll:

&CURRENT_L1 = CurrentRowNumber(1); &ACTIVE_L2 = ActiveRowCount(RECORD.ASSIGNMENT, &CURRENT_L1, RECORD.ASGN_HOME_HOST); &HOME_HOST = FetchValue(RECORD.ASSIGNMENT, &CURRENT_L1, ASGN_HOME_HOST.HOME_HOST, 1); If All(&HOME_HOST) Then For &I = 1 To &ACTIVE_L2 DeleteRow(RECORD.ASSIGNMENT, &CURRENT_L1, RECORD.ASGN_HOME_HOST, 1); End-For; End-If;

Syntax

Description

Use the AddAttachment function to upload one file from an end-user machine to a specified storage location. To upload more than one file with a single function call, use the MAddAttachment function.

Important! It is the responsibility of the calling PeopleCode program to store the returned file name for further use.

If a file exists at a particular place on a storage location and then another file with the same name is uploaded to that same place on that same storage location, the original file will be silently overwritten by the new file. If that is not the behavior you desire, it is recommended that you implement PeopleCode to guarantee the ultimate uniqueness of either the name of the file at its place on the storage location or the name of its place (the subdirectory) on the storage location.

You cannot use a relative path to specify the file that is to be uploaded; you must use a full path. If end users experience problems in uploading files, ensure that they browse to the file they wish to upload rather than attempting to manually enter the full path name of the file. This problem can manifest itself differently depending on the browser used. For example, with some browser versions, the PeopleSoft page appears to be in an infinite “Processing” state. Information is available on working with different browsers.

See My Oracle Support, “Troubleshooting Browser Limitations”

Additional information that is important to the use of AddAttachment can be found in the PeopleTools 8.52: PeopleCode Developer's Guide PeopleBook:

• PeopleTools supports multiple types of storage locations.

• Certain characters are illegal in file names; other characters in file names are converted during file transfer.

• Non-ASCII file names are supported by the PeopleCode file attachment functions.

• The PeopleCode file attachment functions do not provide text file conversions when files are attached or viewed.

• Because AddAttachment is interactive, it is known as a “think-time” function, and is restricted from use in certain PeopleCode events.

• Virus scanning can be performed on all files uploaded with the AddAttachment function.

Parameters

Returns

You can check for either an integer or a constant value:

Example

&retcode = AddAttachment(URL.MYFTP, ATTACHSYSFILENAME, "", ATTACHUSERFILE, 0);

An example of the AddAttachment function is provided in the demonstration application delivered in the FILE_ATTACH_WRK derived/work record. This demonstration application is shown on the PeopleTools Test Utilities page.

Syntax

Description

Parameters

 Type Specify the type of email address being added. This parameter takes a string value. The valid values are:

 Address Specify the email address that you want to add as a string. Primary Specify whether this email address is the primary address for the user. This parameter takes a Boolean value: True, this email address is the primary email address, False otherwise. If not specified, the default is False.

Returns

None.

Syntax

Description

Use the AddKeyListItem to add a new key field and its value to the current list of keys. It enables PeopleCode to help users navigate through related pages without being prompted for key values. A common use of AddKeyListItem is to add a field to a key list and then transfer to a page which uses that field as a key.

Parameters

 field The field to add to the key list. value The value of the added key field used in the search.

Returns

Returns a Boolean value indicating whether it completed successfully.

Example

The following example creates a key list using AddKeyListItem and transfers the user to a page named VOUCHER_INQUIRY_FS.

Syntax

Description

Use the AddSystemPauseTimes function to set when pause times occur on your system by adding a row to the system pause-times tables.

This function is used in the PeopleCode for the Message Monitor. Pause times are set up in the Message Monitor.

Parameters

 StartDay Specify a number from 0-6. Values are:

 Value Description 0 Sunday 1 Monday 2 Tuesday 3 Wednesday 4 Thursday 5 Friday 6 Saturday

 StartTime Specify a time, in seconds, since midnight. EndDay Specify a number from 0-6. Values are:

 Value Description 0 Sunday 1 Monday 2 Tuesday 3 Wednesday 4 Thursday 5 Friday 6 Saturday

 EndTime Specify a time, in seconds, since midnight.

Returns

A Boolean value: True if the system pause time specified was added, False otherwise.

Example

Declare Function SetTime PeopleCode REFRESH_BTN FieldFormula; Component Boolean &spt_changed; Function GetSecond(&time) Returns number ; Return Hour(&time) * 3600 + Minute(&time) * 60 + Second(&time); End-Function; /* initialize; */ STARTDAY = "0"; AMM_STARTTIME = SetTime(0); ENDDAY = "0"; AMM_ENDTIME = SetTime(0); If DoModal(Panel.AMM_ADD_SPTIMES, MsgGetText(117, 13, ""), - 1, - 1) = 1 Then If AddSystemPauseTimes(Value(STARTDAY), GetSecond(AMM_STARTTIME), Value⇒ (ENDDAY), GetSecond(AMM_ENDTIME)) Then &spt_changed = True; DoSave(); Else MessageBox(16, MsgGetText(117, 13, ""), 117, 14, ""); End-If; End-If;

Syntax

Description

Use the AddToDate function to add the specified number of years, months, and days to the date provided.

Suppose, for example, that you want to find a date six years from now. You could not just multiply 6 times 365 and add the result to today’s date, because of leap years. And, depending on the current year, there may be one or two leap years in the next six years. AddToDate takes care of this for you.

You can subtract from dates by passing the function negative numbers.

When you are adding one month to the date provided, and the date provided is the last day of a month, and the next month is shorter, the returned result is the last day of the next month.

For example, in the following, &NewDate is 29/02/2004:

&NewDate = AddToDate("31/01/2004", 0, 1, 0);

When you are adding one month to the date provided, and the date provided is the last day of a month, and the next month is longer, the returned result is not the last day of the next month.

For example, in the following, &NewDate is 29/03/2004.

&NewDate = AddToDate("29/02/2004", 0, 1, 0)

Parameters

 date The input date to be adjusted. num_years The number of years by which to adjust the specified date. num_years can be a negative number. num_months The number of months by which to adjust the specified date. This parameter can be a negative number. num_days The number of days by which to adjust the specified date. This parameter can be a negative number.

Returns

Returns a Date value equal to the original date plus the number of years, months, and days passed to the function.

Example

The following example finds the date one year, three months, and 16 days after a field called BEGIN_DT:

This example finds the date two months ago prior to BEGIN_DT:

Syntax

AddToDateTime(datetime, years, months, days, hours, minutes, seconds)

Description

Use the AddToDateTime function to add the specified number of years, months, days, hours, seconds, and minutes to the datetime provided. You can subtract from datetimes by passing the function negative numbers.

Parameters

 datetime The initial Datetime value. years An integer representing the number of years to add to datetime. months An integer representing the number of months to add to datetime. days An integer representing the number of days to add to datetime. hours An integer representing the number of hours to add to datetime. minutes An integer representing the number of minutes to add to datetime. seconds An integer representing the number of seconds to add to datetime.

Returns

A Datetime value equal to the original date plus the number of years, months, days, hours, minutes, and seconds passed to the function.

Example

The following example postpones an interview scheduled in the INTRTime field by two days and two hours:

INTRTIME = AddToDateTime(INTRTIME, 0, 0, 2, 2, 0, 0);

Syntax

Description

Use the AddToTime function to add hours, minutes, and seconds to time. This function returns the result as a Time value. To subtract from time, use negative numbers for hours, minutes, and seconds. The resulting value is always adjusted such that it represents an hour less than 24 (a valid time of day.)

Parameters

 time A time value that you want to subtract from or add to. hours An integer representing the number of hours to add to time. minutes An integer representing the number of minutes to add to time. seconds An integer representing the number of seconds to add to time.

Returns

A Time value equal to time increased by the number of hours, minutes, and seconds passed to the function.

Example

Assume that a time, &BREAKTime, is 0:15:00. The following moves the time &BREAKTime back by one hour, resulting in 23:15:00:

&BREAKTime = AddToTime(&BREAKTime, -1, 0, 0);

#### All

Syntax

All(fieldlist)

Where fieldlist is an arbitrary-length list of field names in the form:

[recordname.]fieldname1 [, [recordname.]fieldname2] ...

Description

Use the All function to verify if a field contains a value, or if all the fields in a list of fields contain values. If any of the fields are Null, then All returns False.

A blank character field, or a zero (0) numeric value in a required numeric field is considered a null value.

Related Functions

 None Checks that a field or list of fields have no value. AllOrNone Checks if either all the field parameters have values, or none of them have values. Use this in examples where if the user fills in one field, she must fill in all the other related values. OnlyOne Checks if exactly one field in the set has a value. Use this when the user must fill in only one of a set of mutually exclusive fields. OnlyOneOrNone Checks if no more than one field in the set has a value. Use this in examples when a set of fields is both optional and mutually exclusive; that is, if the user can put a value into one field in a set of fields, or leave them all empty.

Returns

Returns a Boolean value based on the values in fieldlist. The All function returns True if all of the specified fields have a value; it returns False if any one of the fields does not contain a value.

Example

The All function is commonly used in SaveEdit PeopleCode to ensure that a group of related fields are all entered. For example:

If All(RETURN_DT, BEGIN_DT) and 8 * (RETURN_DT - BEGIN_DT) (DURATION_DAYS * 8 + DURATION_HOURS) Then Warning MsgGet(1000, 1, "Duration of absence exceeds standard hours for number⇒ of days absent."); End-if;

#### AllOrNone

Syntax

AllOrNone(fieldlist)

Where fieldlist is an arbitrary-length list of field references in the form:

[recordname.]fieldname1 [, [recordname.]fieldname2] ...

Description

The AllOrNone function takes a list of fields and returns True if either of these conditions is true:

• All of the fields have values (that is, are not Null).

• None of the fields has a value.

For example, if field1 = 5, field2 = "Mary", and field3 = null, AllOrNone returns False.

This function is useful, for example, where you have a set of page fields, and if any one of the fields contains a value, then all of the other fields are required also.

A blank character field, or a zero (0) numeric value in a required numeric field is considered a null value.

Related Functions

 All Checks to see if a field contains a value, or if all the fields in a list of fields contain values. If any of the fields is Null, then All returns False. None Checks that a field or list of fields have no value. None is the opposite of All. OnlyOne Checks if exactly one field in the set has a value. Use this when the user must fill in only one of a set of mutually exclusive fields. OnlyOneOrNone Checks if no more than one field in the set has a value. Use this in cases when a set of fields is both optional and mutually exclusive; that is, if the user can put a value into one field in a set of fields, or leave them all empty.

Returns

Returns a Boolean value: True if all of the fields in fieldlist or none of the fields in fieldlist has a value, False otherwise.

Example

You could use AllOrNone as follows:

If Not AllOrNone(STREET1, CITY, STATE) Then WinMessage("Address should consist of at least Street (Line 1), City, State,⇒ and Country."); End-if;

#### AllowEmplIdChg

Syntax

AllowEmplIdChg(is_allowed)

Description

By default, the Component Processor does not allow an user to make any changes to a record if a record contains an EMPLID key field, EMPLID is a required field, and its value matches the value of the user’s EMPLID. In some situations, though, such changes are warranted. For example, you would want employees to be able to change information about themselves when entering time sheet data.

The AllowEmplIdChg function enables the user to change records whose key matches the user’s own EMPLID, or prevents the user from changing these records. The function takes a single Boolean parameter that when set to True allows the employee to update their own data. When the parameter is set to False, the employee is prevented from updating this data.

After permission is granted, it stays through the life of the component, not the page. After a user switches to another component, the default value (not being able to make changes) is reapplied.

Parameters

 is_allowed A Boolean value indicating whether the user is permitted to change the user's own data.

Returns

Optionally returns a Boolean value: True if the function executed successfully, False otherwise.

Example

If Substring (%Page, 1, 9) = Substring(PAGE.TimeSHEET_PNL_A, 1, 9) Then AllowEmplIdChg(true); End-if;

#### Amortize

Syntax

Amortize(intr, pb, pmt, pmtnbr, payintr, payprin, balance)

Description

Use the Amortize function to compute the amount of a loan payment applied towards interest (payintr), the amount of the payment applied towards principal (payprin), and the remaining balance balance, based on the principal balance (pb) at the beginning of the loan term, the amount of one payment pmt, the interest rate charged during one payment period (intr), and the payment number pmtnbr.

Parameters

Note that payintr, payprin, and balance are “outvars”: you must pass variables in these parameters, which the Amortize function then fills with values. The remaining parameters are “invars” containing data the function needs to perform its calculation.

 intr Number indicating the percent of interest charged per payment period. pb Principal balance at the beginning of the loan term (generally speaking, the amount of the loan). pmt The amount of one loan payment. pmtnbr The number of the payment. payintr The amount of the payment paid toward interest. payprin The amount of the payment paid toward principal. balance The remaining balance after the payment.

Returns

None.

Example

Suppose you want to calculate the principal, interest, and remaining balance after the 24th payment on a loan of $15,000, at an interest rate of 1% per loan payment period, and a payment amount of$290.

&INTRST_RT=1; &LOAN_AMT=15000; &PYMNT_AMNT=290; &PYMNT_NBR=24; Amortize(&INTRST_RT, &LOAN_AMT, &PYMNT_AMNT, &PYMNT_NBR, &PYMNT_INTRST, &PYMNT_⇒ PRIN, &BAL); &RESULT = "Int=" | String(&PYMNT_INTRST) | " Prin=" | String(&PYMNT_PRIN) | " ⇒ Bal=" | String(&BAL);

This example sets &RESULT equal to "Int=114 Prin=176 Bal=11223.72".

#### Asin

Syntax

Asin(value)

Description

Use the Asin function to calculate the arcsine of the given value, that is, the size of the angle whose sine is that value.

Parameters

 value Any real number between -1.00 and 1.00 inclusive, the range of valid sine values. If the input value is outside this range, an error message appears at runtime ("Decimal arithmetic error occurred. (2,110)"). Adjust your code to provide a valid input value.

Returns

A value in radians between -pi/2 and pi/2.

Example

The following example returns the size in radians of the angle whose sine is 0.5:

&MY_ANGLE = Asin(0.5);

#### Atan

Syntax

Atan(value)

Description

Use the Atan function to calculate the arctangent of the given value, that is, the size of the angle whose tangent is that value.

Parameters

 value Any real number.

Returns

A value in radians between -pi/2 and pi/2.

Example

The following example returns the size in radians of the angle whose tangent is 0.5:

&MY_ANGLE = Atan(0.5);

#### BlackScholesCall

Syntax

BlackScholesCall(Asset_Price, Strike_Price, Interest_Rate, Years, Volatility)

Description

Use the BlackScholesCall function to return the value of a call against an equity underlying according to the Black-Scholes equations.

Parameters

 Asset_Price The asset price. This parameter takes a decimal value. Strike_Price The strike price. This parameter takes a decimal value. Interest_Rate The risk-free interest rate. This parameter takes a decimal value. Years The number of years to option expiration. This parameter takes a number value (decimal). Volatility The volatility of underlying. This parameter takes a decimal value.

Returns

A number representing the value of a call against an equity.

#### BlackScholesPut

Syntax

BlackScholesPut(Asset_Price, Strike_Price, Interest_Rate, Years, Volatility)

Description

Use the BlackScholesPut function to return the value of a put against an equity underlying according to the Black-Scholes equations.

Parameters

 Asset_Price The asset price. This parameter takes a decimal value. Strike_Price The strike price. This parameter takes a decimal value. Interest_Rate The risk-free interest rate. This parameter takes a decimal value. Years The number of years to option expiration. This parameter takes a number (decimal) value. Volatility The volatility of underlying. This parameter takes a decimal value.

Returns

A number representing the value of a call against an equity.

#### BootstrapYTMs

Syntax

BootstrapYTMs(Date, MktInst, Accrual_Conv)

Description

Use the BootstrapYTMs function to create a zero-arbitrage implied zero-coupon curve from a yield-to-maturity curve using the integrated discount factor method, based on the Accrual_­Conv.

Parameters

 Date The trading date of the set of market issues. This parameter takes a date value. MktInst The market instrument properties. This parameter takes an array of array of number. The elements in the array specify the following:

 Elements Description 1 tenor in days 2 yield in percent 3 price per 100 par 4 coupon rate (zero for spot instruments) 5 frequency of coupon payments 6 unit of measure for coupon frequency, 0 for days, 1 for months, and 2 for years 7 coefficient a of a curve interpolating the dataset 8,9,10 coefficients b, c, and d of a curve interpolating the dataset

Returns

An array of array of number. The elements in the array have the same type as the elements in the array for the MktInst parameter.

#### Break

Syntax

Break

Description

Use the Break statement to terminate execution of a loop or an Evaluate function. The program resumes execution immediately after the end of the statement. If the loop or Evaluate is nested in another statement, only the innermost statement is terminated.

Parameters

None.

Example

In the following example, Break is used to terminate the Evaluate statement, while staying within the outermost If statement:

If CURRENCY_CD = PriorEffdt(CURRENCY_CD) Then Evaluate ACTION When = "PAY" If ANNUAL_RT = PriorEffdt(ANNUAL_RT) Then Warning MsgGet(1000, 27, "Pay Rate Change action is chosen and Pay⇒ Rate has not been changed."); End-if; Break; When = "DEM" If ANNUAL_RT >= PriorEffdt(ANNUAL_RT) Then Warning MsgGet(1000, 29, "Demotion Action is chosen and Pay Rate has⇒ not been decreased."); End-if; Break; When-other End-evaluate; WinMessage("This message appears after executing either of the BREAK⇒ statements or after all WHEN statements are false"); End-if;

#### BulkDeleteField

Syntax

BulkDeleteField(ProjectName, Field.FieldName [, ExclProj])

Description

Use the BulkDeleteField function to delete fields from records and pages, as well as the associated PeopleCode programs and modify the SQL either on the record, or, if the record is a subrecord, on the parent records.

Note. You must have the role Peoplesoft Administrator assigned to your UserId in order to use this function.

If you specify a project that contains objects such as fields which have an upgrade action of delete, those objects are ignored.

The field is removed from the page regardless of where the field exists on the page, whether on a grid or not.

If the field is in the SELECT clause of the SQL, the removal is straightforward. However, if the field is also used in a WHERE clause, or if the field is the only item in the SELECT clause, the record isn't modified and is instead inserted into a project called BLK_FieldName. The record should be examined and any additional changes made as necessary.

Deleting fields from records and pages does not remove the field definition itself and it does not remove the field from other areas, such as Projects, Crystal Reports, or message definitions.

In addition, this function does not delete the references to the field in the PeopleCode. You must manually remove the references to the deleted field. Use the Find In. . . tool to search for the field name you deleted.

Note. Because performing this operation changes records, you must subsequently rebuild the project (alter tables).

Using the Log File

Information about this operation is stored in a log field. The directory where the log file is placed depends on where the function is run from:

• If the function is run in two-tier, the log file is located at PS_CFG_HOME /BulkOps.txt. This is also the default location if the system cannot find the other paths.

• If the function is run from an application server, the log file is located at:

PS_CFG_HOME /APPSERV/Domain_Name/LOGS/BulkOps.txt

• If the function is run from an Application Engine program, the log file is written to the process' output log directory, that is:

PS_CFG_HOME /APPSERV/prcs/Domain_Name/log_output/Process_Name_Instance/BulkOps.txt

Considerations Using this Function

This function is intended for use during configuration time only, before active runtime usage is initiated. Using this function during active runtime is not supported. Changes to data definitions are not recognized on a currently loaded component. In general, changes aren't recognized until the component is reloaded.

Bulk operations are time consuming, therefore, referencing the log file to see the progress of an operation is recommended. These operations accommodate errors and continue processing, logging the overall progress of the operation.

Warning! These operations take place in a separate transaction from the page's save status: the initiation of any of these operations immediately changes the definitions, even if the page is subsequently cancelled.

Considerations Using the Exclusion Project

If you specify ExclProj, the following items that are both in ProjectName and ExclProj are not changed, that is, the field specified is not removed from these items:

• pages

• records

• associated SQL with records of type View

• any PeopleCode associated with those items.

Individual SQL or PeopleCode items are not ignored by themselves, only as associated with records or pages.

Parameters

 ProjectName The name of a project that is the source of records and pages to use. Note. When passing the project name as a parameter, if the project contains definitions with an upgrade action of delete, the system ignores those definitions. FieldName The name of the field to be deleted. This name must be prefixed with the reserved word Field. ExclProj The name of a project that has pages that should be ignored by this function.

Returns

A constant value. The values are:

 Value Description %MDA_Success Bulk operation completed successfully. %MDA_Failure Bulk operation did not complete successfully.

Example

&pjm = "MYPROJ"; &ret = BulkDeleteField(&pjm, Field.OrgId, "EXCLPROJ"); If (&ret = %MDA_Success) Then MessageBox(0, "Metadata Fn Status", 0, 0, "BulkDeleteField succeeded"); Else MessageBox(0, "Metadata Fn Status", 0, 0, "BulkDeleteField failed"); End-If;

#### BulkInsertField

Syntax

BulkInsertField(ProjectName, Field.FieldName, ModelName, ClonePCode [, ExclProj])

Description

Use the BulkInsertField function to insert a source field into records and pages in a project if and only if the model field specified by ModelName exists on those records and pages.

If you specify a project that contains objects such as fields which have an upgrade action of delete, those objects are ignored.

Note. You must have the role Peoplesoft Administrator assigned to your UserId in order to use this function.

Using the Log File

Information about this operation is stored in a log field. The directory where the log file is placed depends on where the function is run from:

• If the function is run in two-tier, the log file is located at PS_HOME/BulkOps.txt. This is also the default location if the system cannot find the other paths.

• If the function is run from an application server, the log file is located here:

PS_CFG_HOME /APPSERV/Domain_Name/LOGS/BulkOps.txt

• If the function is run from an Application Engine program, the log file is written to the process' output log directory, that is:

PS_CFG_HOME /APPSERV/prcs/Domain_Name/log_output/Process_Name_Instance/BulkOps.txt

Considerations Inserting Fields into Records

In records, the source field is assigned the same record field properties as the model field on each record, and is inserted directly after the model field.

If the model field has a prompt table, a prompt table is created for the source field using the name of the source field with TBL appended to it.

If the record is either a SQL View or Dynamic View type, the associated SQL is modified by having the SELECT clause expanded to include the new field.

If the record is a subrecord, the parent records of type SQL View or Dynamic View that contain this subrecord are updated.

If the SQL contains the model field in the WHERE clause, or the SQL is complex, the associated record is inserted into a project called BLK_FieldName. You should examine this record and make any necessary changes.

If the model field has PeopleCode associated with it on the record or in a component, and ClonePCode has been set to True, this PeopleCode is cloned to the new field, with all references to the model field changed to refer to the new field.

Note. Because using this function changes records that are used to build application tables, you must rebuild (alter) the specified project before these changes can be used.

Considerations Inserting Fields into Pages

If the model field is in a grid, the system inserts the new field into the grid next to the model field and assigns it the same page field properties.

If the model field is not in a grid, the system inserts the new field onto the page to the right of the model field (in the first open space) and assigns it the same page field properties. If the system detects a questionable field position, it inserts the page into a project called BLK_FieldName. The page will work as-is, however, the GUI layout may not be optimal, so you should examine these pages by hand.

The page field name property isn't cloned if it exists on the model field. Instead, the field name of the new field is used, since the page field name should be a unique identifier for page elements.

Note. If the project you specified only contained pages and not records, you do not need to rebuild the project after using this function. The changes take affect when the component containing the page is reloaded.

Considerations Using this Function

This function is intended for use during configuration time only, before active runtime usage is initiated. Using this function during active runtime is not supported. Changes to data definitions are not recognized on currently loaded component. In general, changes aren't recognized until the component is reloaded.

Bulk operations are time consuming, therefore, referencing the log file to see the progress of an operation is recommended. These operations accommodate errors and continue processing, logging the overall progress of the operation.

Warning! These operations take place in a separate transaction from the page's save status: the initiation of any of these operations immediately changes the definitions, even if the page is subsequently cancelled.

Considerations Using the Exclusion Project

If you specify ExclProj, the following items that are both in ProjectName and ExclProj are not changed, that is, the field specified is not inserted to these items:

• pages

• records

• associated SQL with records of type View

• any PeopleCode associated with those items.

Individual SQL or PeopleCode items are not ignored by themselves, only as associated with records or pages.

Parameters

 ProjectName The name of a project that is the source of records and pages to use. Note. When passing the project name as a parameter, if the project contains definitions with an upgrade action of delete, the system ignores those definitions. FieldName The name of the field to be inserted. This name must be prefixed with the reserved word Field. ModelName The name of a field on which to model the inserted field. Attributes are cloned from it for records and pages, PeopleCode is modified, and SQL inserted. ClonePCode Specify whether to clone the PeopleCode from the model to this field. This parameter takes a Boolean value: True, clone the PeopleCode programs, False, do not. ExclProj The name of a project that has pages that should be ignored by this function.

Returns

A constant value. The values are:

 Value Description %MDA_Success Bulk operation completed successfully. %MDA_Failure Bulk operation did not complete successfully.

Example

&pjm = "MYPROJ"; &ret = ​BulkInsertField(&pjm, Field.OrgId, Field.DeptId, True, "EXCLPROJ"); If (&ret = %MDA_Success) Then MessageBox(0, "Metadata Fn Status", 0, 0, "BulkInsertField succeeded"); Else MessageBox(0, "Metadata Fn Status", 0, 0, "BulkInsertField failed"); End-If;

#### BulkModifyPageFieldOrder

Syntax

BulkModifyPageFieldOrder({ProjectName | PageList}, ColNames, RequireAll, [ColWidths])

Description

Use the BulkModifyPageFieldOrder function to reorder the grid columns as specified by ColNames. If ColWidths is specified, the columns are also resized. This can also be used to modify a single columns width.

Note. You must have the role Peoplesoft Administrator assigned to your UserId in order to use this function.

If you specify a project name as a parameter, and if that project contains objects such as fields which have an upgrade action of delete, those objects are ignored.

The reordering algorithm “bunches” these fields together at the first instance of any of these fields in a target page grid, and forces the remaining fields into the order specified.

This function only reorders fields inside a grid.

If the fields occur twice or more in a grid, from two or more records, such as work records, the fields are bunched together in record groupings before being sorted into the order specified. For example, the two records ABS_HIST and PERSONAL_HISTORY both contain the fields DURATION_DAYS and DURATION_HOURS. The following is an example of how the records are fields would be bunched together first:

• ABS_HIST, DURATION_DAYS

• ABS_HIST, DURATION_HOURS

• PERSONAL_HISTORY, DURATION_DAYS

• PERSONAL_HISTORY, DURATION_HOURS

Note. These changes take affect after components are reloaded.

Using the Log File

Information about this operation is stored in a log field. The directory where the log file is placed depends on where the function is run from:

• If the function is run in two-tier, the log file is located at PS_CFG_HOME /BulkOps.txt. This is also the default location if the system cannot find the other paths.

• If the function is run from an application server, the log file is located here:

PS_CFG_HOME /APPSERV/Domain_Name/LOGS/BulkOps.txt

• If the function is run from an Application Engine program, the log file is written to the process' output log directory, that is:

PS_CFG_HOME /APPSERV/prcs/Domain_Name/log_output/Process_Name_Instance/BulkOps.txt

Considerations Using this Function

This function is intended for use during configuration time only, before active runtime usage is initiated. Using this function during active runtime is not supported. Changes to data definitions are not recognized on currently loaded component. In general, changes aren't recognized until the component is reloaded.

Bulk operations are time consuming, therefore, referencing the log file to see the progress of an operation is recommended. These operations accommodate errors and continue processing, logging the overall progress of the operation.

Warning! These operations take place in a separate transaction from the page's save status: the initiation of any of these operations immediately changes the definitions, even if the page is subsequently cancelled.

Parameters

 ProjectName | PageList Specify either the name of a project that is the source of pages to use or an array of page names. Note. When passing the project name as a parameter, if the project contains definitions with an upgrade action of delete, the system ignores those definitions. ColNames Specify an array of string that indicate which fields and the desired order of those fields. RequireAll Specify whether all the fields in ColNames must be present before changes are made or not. This parameter takes a Boolean value: True, all fields must be present. ColWidths Specify an array of number that gives the pixel widths of the grid columns. Use a -1 to indicate that the width of a column shouldn't change.

Returns

A constant value. The values are:

 Value Description %MDA_Success Bulk operation completed successfully. %MDA_Failure Bulk operation did not complete successfully.

Example

Local Array of String &ColOrder; Local Array of Number &ColWidth; Local String &pjm, &ret; &pjm = "MYPROJ"; &ColWidth = CreateArray(50, 100, -1); &ColOrder = CreateArray("DEPTID", "ORGID", "PROJECT"); &ret = ​BulkModifyPageFieldOrder(&pjm, &ColOrder, True, &ColWidth); If (&ret = %MDA_Success) Then MessageBox(0, "Metadata Fn Status", 0, 0, "BulkModifyPageFieldOrder⇒ succeeded"); Else MessageBox(0, "Metadata Fn Status", 0, 0, "BulkModifyPageFieldOrder⇒ failed"); End-If;

#### BulkUpdateIndexes

Syntax

BulkUpdateIndexes([StringFieldArray])

Description

Use BulkUpdateIndexes to update indexes (PSINDEXDEFN table) for records that contain a field whose NotUsed setting has changed.

A field whose NotUsed flag has been set to True does not show up in indexes. The only way to modify a field's NotUsed setting is through an API call such as in the following example:

SetDBFieldNotUsed(FIELD.OrgId, True);

The indexes of records that contain this field need to be updated to reflect the new settings.

Information about this operation can be logged by turning on PeopleCode tracing of internal functions (value 256.)

Considerations Using this Function

Do not invoke this function from runtime pages, as it modifies all records, including the records used to support the page it is invoked from. This function should be invoked from a Application Engine program.

Note. If you do call this function from a page the operation completes successfully, but the page returns an error message. Switching to a new component clears up this error, however, any changes not saved to the database are lost.

This function is intended for use during configuration time only, before active runtime usage is initiated. Using this function during active runtime is not supported. Changes to data definitions are not recognized on currently loaded component. In general, changes aren't recognized until the component is reloaded.

Bulk operations are time consuming, therefore, referencing the log file to see the progress of an operation is recommended. These operations accommodate errors and continue processing, logging the overall progress of the operation.

Calling this function without any parameter rebuilds the indexes for all records, an operation that may take hours. By indicating a list of fields whose NotUsed flag has changed, only the affected records have their indexes updated, reducing the time required to run this function.

Warning! These operations take place in a separate transaction from the page's save status: the initiation of any of these operations immediately changes the definitions, even if the page is subsequently cancelled.

Parameters

 StringFieldArray Specify an array of field names (as strings), such as DEPTID, representing the fields whose NotUsed flag has been modified. Only the records containing these fields are updated. If you do not specify a value for this parameter, the indexes for all records are rebuilt.

Returns

A constant value. The values are:

 Value Description %MDA_Success Bulk operation completed successfully. %MDA_Failure Bulk operation did not complete successfully.

Example

The following example uses the function without the optional array of field names:

&ret = BulkUpdateIndexes(); If (&ret = %MDA_Success) Then MessageBox(0, "MetaData Fn Status", 0, 0, "BulkUpdateIndexes succeeded"); Else MessageBox(0, "MetaData Fn Status", 0, 0, "BulkUpdateIndexes failed"); End-If;

The following example uses the function with an array of two field names passed to it:

&ret = BulkUpdateIndexes(CreateArray("DEPTID","PROJECT")); If (&ret = %MDA_success) Then MessageBox(0, "MetaData Fn Status", 0, 0, "BulkUpdateIndexes succeeded"); Else MessageBox(0, "MetaData Fn Status", 0, 0, "BulkUpdateIndexes failed"); End-If;

#### CallAppEngine

Syntax

CallAppEngine(applid [, statereclist, processinstance ]);

Where statereclist is list of record objects in the form:

&staterecord1 [, &staterecord2] . . .

There can be only as many record objects in statereclist as there are state records for the Application Engine program. Additional record objects are ignored.

Description

Use the CallAppEngine function to start the Application Engine program named applid. This is how to start your Application Engine programs synchronously from a page. (Prior to PeopleTools 8, you could do only this using the RemoteCall function.) Normally, you won’t run Application Engine programs from PeopleCode in this manner. Rather, the bulk of your Application Engine execution will be run using the Process Scheduler, and the exception would be done using CallAppEngine.

The staterecord can be the hard-coded name of a record, but generally you use a record object to pass in values to seed particular state fields. The record name must match the state record name exactly.

The processinstance allows you to specify the process instance used by the Application Engine runtime. In your PeopleCode program this parameter must be declared of type integer since that is the only way the runtime can tell whether the last parameter is to be interpreted as a process instance. For more details see the Application Engine documentation.

Note. If you use this function, you shouldn't use the %TruncateTable or %Execute meta-SQL statement in any of your Application Engine steps. This is because on some platforms an implicit commit occurs after these statements, and all online processing should be done as a single logical unit of work.

After you use CallAppEngine, you may want to refresh your page. The Refresh method, on a rowset object, reloads the rowset (scroll) using the current page keys. This causes the page to be redrawn. GetLevel0().Refresh() refreshes the entire page. If you want only a particular scroll to be redrawn, you can refresh just that part.

Note. If you supply a non-zero process instance, all message logging is done under the process instance. You must build your own PeopleSoft Pure Internet Architecture page to access or delete the messages, since there is no Process Monitor entry for the process instance you used.

PeopleCode Event Considerations

You must include the CallAppEngine PeopleCode function within events that allow database updates because generally, if you’re calling Application Engine, you’re intending to perform database updates. This includes the following PeopleCode events:

• SavePreChange (Page)

• SavePostChange (Page)

• Workflow

• FieldChange

If CallAppEngine results in a failure, all database updates is rolled back. All information the user entered into the component is lost, as if the user pressed ESC.

Application Engine Considerations

You can use the CallAppEngine function in a Application Engine program, either directly (in a PeopleCode action) or indirectly (using a Component Interface). This functionality must be used carefully, and you should only do this once you have a clear understanding of the following rules and restrictions.

• Dedicated cursors are not supported inside a "nested application engine instance" (meaning an application engine program invoked using CallAppEngine from within another application engine program). If a nested application engine instance has any SQL actions with ReUse set to Yes or Bulk Insert, those settings are ignored.

• As in any other type of PeopleCode event, no commits are performed within the called application engine program. This is an important consideration. If a batch application engine program called another program using CallAppEngine, and that child program updated many rows of data, the unit-of-work might become too large, resulting in contention with other processes. A batch application engine program should invoke such child programs using a Call Section action, not CallAppEngine.

• Temp tables are not shared between a batch application engine program and child program invoked using CallAppEngine. Instead, the child program is assigned an "online" temporary table instance, which is used for all temp tables in that program. In addition, if that child program invokes another program using CallAppEngine, that grandchild shares the online temp instance with the caller. In other words, only one online temp instance is allocated to a process at any one time, no matter how many nested CallAppEngine's there might be.

• The lock on an online temp instance persists until the next commit. If the processing time of the called program is significant (greater than a few seconds), this would be unacceptable. As a general rule, application engine programs that make use of temp tables and have a significant processing time should be called from other application engine programs using a Call Section action, not CallAppEngine.

Save Events Considerations

To execute the Application Engine program based on an end user Save, use the CallAppEngine function within a Save event. When you use CallAppEngine, you should keep the following items in mind:

• No commits occur during the entire program run.

• During SavePreChange, any modified rows in the page have not been written to the database.

• During SavePostChange, the modified rows have been written to the database. The Page Process issues one commit at the end of the Save cycle.

FieldChange Considerations

If you don’t want the CallAppEngine call to depend on a Save event, you can also initiate CallAppEngine from a FieldChange event. When having a FieldChange event initiate CallAppEngine, keep the following items in mind:

• No commits occur within the program called by CallAppEngine. The called program remains a synchronous execution in the same unit of work.

• The Component Processor commits all updates done in a FieldChange at the end of the event, which frees any locks that the Application Engine program might have acquired.

• Do not include a DoSave function in the same FieldChange event. Not only is this not allowed, but it also indicates that you should be including the CallAppEngine within a Save event.

• You can use the DoSaveNow function in the same FieldChange event, but it must be called prior to the first CallAppEngine function, but not afterward.

Parameters

 applid Specify the name of the Application Engine program you want to start. statereclist Specify an optional record object that provides initial values for a state record. processinstance Specify the process instance used by the Application Engine runtime.

Returns

None.

Example

The following calls the Application Engine program named MYAPPID, and passes initialization values.

&REC = CreateRecord(RECORD.INIT_VALUES); &REC.FIELD1.Value = "XYZ"; /* set the initial value for INIT_VALUES.FIELD1 */ CallAppEngine("MYAPPID", &REC);

Syntax

Description

Use the CancelPubHeaderXmlDoc function to programmatically cancel the message header of a publication contract, much the same as you can do in the message monitor.

Note. This function has been deprecated and remains for backward compatibility only. Use the IntBroker class Cancel method instead.

The message header, also known as the message instance, is the published message before the system performs any transformations.

The function is only available when the message has one of the following statuses:

• Error

• New

• Retry

• Timeout

• Edited

Parameters

 PubID Specify the PubID of the message. PubNode Specify the Pub Node Name of the message. ChannelName Specify the channel name of the message. VersionName Specify the version name of the message.

Returns

A Boolean value: True if the function completed successfully, False otherwise.

#### CancelPubXmlDoc

Syntax

CancelPubXmlDoc(PubID, PubNode, ChannelName, VersionName, MessageName, SubNode[, Segment])

Description

Use the CancelPubXmlDoc function to programmatically cancel a message publication contract, much the same as you can do in the message monitor.

Note. This function has been deprecated and remains for backward compatibility only. Use the IntBroker class Cancel method instead.

This is the publication contract that exists after any transformations have been preformed.

The function is only available when the message has one of the following statuses:

• Error

• New

• Retry

• Timeout

• Edited

Parameters

 PubID Specify the PubID of the message. PubNode Specify the Pub Node Name of the message. ChannelName Specify the channel name of the message. VersionName Specify the version name of the message. MessageName Specify the name of the message. SubNode Specify the subnode of the message. Segment Specify an integer representing which segment you want to access. The default value is one, which means that if you do not specify a segment, the first segment is accessed.

Returns

A Boolean value: True if the function completed successfully, False otherwise.

#### CancelSubXmlDoc

Syntax

CancelSubXmlDoc(PubID, PubNode, ChannelName, VersionName, MessageName, SubscriptionName[, Segment])

Description

Use the CancelSubXmlDoc function to programmatically cancel a message subscription contract, much the same as you can do in the message monitor.

Note. This function has been deprecated and remains for backward compatibility only. Use the IntBroker class Cancel method instead.

The function is only available when the message has one of the following statuses:

• Error

• New

• Retry

• Timeout

• Edited

Parameters

 PubID Specify the PubID as a string. PubNode Specify the Pub Node name as a string. ChannelName Specify the Channel name as a string. VersionName Specify the version name as a string. MessageName Specify the message name as a string. SubscriptionName Specify the subscription name as a string. Segment Specify an integer representing which segment you want to access. The default value is one, which means that if you do not specify a segment, the first segment is accessed.

Returns

A Boolean value: True if function completed successfully, False otherwise.

Syntax

Description

Use the ChangeEmailAddress function to change the type of an email address that you've already added for the current user. You can only have one email address of a specific type for a user. If you try to use a type that already has an email address associated with it, you receive an error.

Parameters

 Type Specify the type that you want to change the email address to. This parameter takes a string value. The valid values are:

Returns

None.

#### Char

Syntax

Char(n)

Description

Use the Char function to convert a decimal numeric value n to the corresponding Unicode character.

Parameters

 n The numeric value to be expressed as a decimal Unicode value.

Returns

Returns a string representing the Unicode character corresponding to the number n.

Example

This example sets three strings:

&STRING1 = Char(80) | Char(83); &STRING2 = Char(26085) | Char(26412); &STRING3 = Char(55362) | Char(56697);

The following table shows the Unicode hexadecimal code points and the string equivalents for these calls to the Char function:

 Variable Char (Decimal) Unicode Code Points String &STRING1 Char(80) | Char(83) U+0050, U+0053 PS &STRING2 Char(26085) | Char(26412) U+65E5, U+672C 日本 &STRING3* Char(55362) | Char(56697) U+D842 U+DD79

* The single character in &STRING3 signifies a non-BMP, UTF-32 character (U+20979), which is represented by the UTF-16 surrogate pair (U+D842 U+DD79). Unless your system is configured to display supplementary characters and has a supporting font, &STRING3 will appear as an empty box in the String column in the preceding table.

For reference, Unicode character charts are available from The Unicode Consortium.

#### CharType

Syntax

CharType(source_str, char_code)

Description

Use the CharType function to determine whether the first character in source_str is of type char_code . The char_code parameter is a numeric value representing a character type (see the following Parameters section for details). Most character types supported by this function equate to specific Unicode character blocks or are based on Unicode character properties.

Parameters

 source_str A String, the first character of which will be tested. char_code A Number representing the character type to be tested for.

The following table shows valid values for char_code. You can specify either a Character Code or a Constant:

 Numeric Value Constant Character Set 0 %CharType_AlphaNumeric Basic Latin — Alphanumeric (printable range of 7-bit US-ASCII), Unicode characters in the range U+0020 — U+007E 1 %CharType_ExtendedLatin1 Extended Latin-1 characters (ISO 8859-1 accents for Western European languages), Unicode characters in the range U+00BF — U+07E 2 %CharType_HankakuKatakana Hankaku Katakana (half-width Japanese Katakana) 3 %CharType_ZenkakuKatakana Zenkaku Katakana (full-width Japanese Katakana) 4 %CharType_Hiragana Hiragana (Japanese) 5 %CharType_Kanji Chinese, Japanese and Korean ideographic characters. Includes Japanese Kanji, Chinese Hanzi and Korean Hancha. 6 %CharType_DBAlphaNumeric Full-width Latin Alphanumeric characters, primarily used for Japanese. Excludes 7 None Korean Hangul syllables, excluding Hangul Jamo. 8,9 None Reserved for future use. 10 %CharType_JapanesePunctuation Full- and half-width punctuation, including space (U+0020) and Fullwidth / Ideographic Space (U+3000). 11 None Greek 12 None Cyrillic 13 None Armenian 14 None Hebrew 15 None Arabic 16 None Devanagari 17 None Bengali 18 None Gurmukhi 19 None Gujarati 20 None Oriya 21 None Tamil 22 None Telugu 23 None Kannada 24 None Malayalam 25 None Thai 26 None Lao 27 None Tibetan 28 None Georgian 29 None Bopomofo

Returns

CharType returns one of the following Number values. You can check for the constant values instead of the numeric values if you prefer:

 Numeric Value Constant Value Description 1 %CharType_Matched Character is of type char_code. 0 %CharType_NotMatched Character is not of type char_code. -1 %CharType_Unknown UNKNOWN: unable to determine whether character is of set char_code. This occurs if the character being checked is an unallocated Unicode codepoint, or was added in a version of Unicode greater than that supported by PeopleTools.

Example

This example tests to see if a character is Hiragana:

&ISHIRAGANA = CharType(&STRTOTEST, %CharType_Hiragana); If &ISHIRAGANA = 1 Then WinMessage("Character type is Hiragana"); Else If &ISHIRAGANA = 0 Then WinMessage("Character type is not Hiragana"); Else WinMessage("Character type is UNKNOWN"); End-If; End-If;

#### ChDir

Syntax

ChDir(path)

Description

Use the ChDir function to change the current directory on a drive. This is similar to the DOS ChDir command. The drive and the directory are both specified in a path string.

Note. This function has been deprecated.

#### ChDrive

Syntax

ChDrive(str_dr)

Description

Use the ChDrive function to change the current disk drive to the drive specified by str_dr, which is a string consisting of a valid drive letter followed by a colon, for example "C:".

Note. This function has been deprecated.

Syntax

Description

Use the CheckMenuItem function to change the menu state by placing a check mark beside the menu item.

Note. This function has been deprecated.

#### ChunkText

Syntax

ChunkText(string, delimiter [, chunk_size])

Description

Use the ChunkText function to break a long text string into chunks that can be more readily managed by a storage system, such as a database text field. You must specify a string delimiter; the chunk size is optional.

Parameters

 string Specify the text to be split into chunks as a string. delimiter Specify a single character as a text delimiter. chunk_size Specify the chunk size in characters as a number. If you specify no value, 0, or a number greater than 14000, the default value of 14000 is used.

Returns

An array of string.

Example

Local array of string &chunkList; &STRINGTOCHUNK = "NewYorkNewYorkNewYorkNewYorkNewYorkNewYorkNewYorkNewYorkNewYork⇒ NewYorkNewYorkNewYorkNewYorkNewYorkNewYorkNewYork"; &DELIM = "r"; &CHUNKSIZE = 8; &chunkList = ChunkText(&STRINGTOCHUNK, &DELIM, &CHUNKSIZE);

The preceding example produces the following 16 chunks:

[NewYor][kNewYor][kNewYor][kNewYor][kNewYor][kNewYor][kNewYor][kNewYor][kNewYor]⇒ [kNewYor][kNewYor][kNewYor][kNewYor][kNewYor][kNewYor][kNewYork]

#### Clean

Syntax

Clean(string)

Description

Use the Clean function to remove all non-printable characters, such as control codes, end of line marks, and unpaired Unicode combining marks, from a text string and returns the result as a String value. It is intended for use on text imported from other applications that contains characters that may not be printable. Frequently, low-level characters appear at the beginning and end of each line of imported data, and they cannot be printed.

Parameters

 string Specifies the text to be cleaned as a string.

Returns

Returns a String value purged of non-printable characters.

Example

Because Char(7) (U+0007) is a non-printable character, the following Clean function returns a null string:

&CLEANSTR = Clean(Char(7));

#### CleanAttachments

Syntax

CleanAttachments(([PreserveCaseHint])

Description

Use the CleanAttachments function to delete all unreferenced files from database tables serving as file storage locations.

Note. CleanAttachments operates only on database tables that have been used as file attachment storage locations, and not on FTP sites or HTTP repositories.

Warning! There is no way to roll back changes made by the CleanAttachments function. Oracle recommends that you perform a database backup before invoking this function.

It is important that you understand how the system determines that a file is unreferenced, and how it determines which tables contain file attachments.

CleanAttachments compiles two lists:

• List 1: A list of file references that is constructed by finding all the distinct values in the ATTACHSYSFILENAME column in each table containing the FILE_ATTACH_SBR subrecord (at any level). Any file not in this list is considered not referenced (orphaned).

• List 2: A list of actual stored files that is constructed by finding the distinct values in the ATTACHSYSFILENAME column in each table containing the FILE_ATTDET_SBR subrecord at the top level.

The system deletes any file that appears in the second list, but not in the first, after having determined the effect of the optional PreserveCaseHint parameter.

Note. A table is only considered to contain file references if its associated record contains the FILE_ATTACH_SBR subrecord (at any level). If an application has stored file references in tables that do not contain the FILE_ATTACH_SBR subrecord, and you invoke the CleanAttachments function, then all the files uploaded to the database through that application will be deleted because the files will not be found in list 1 and the system therefore regards them as unreferenced (orphaned).

Similarly, the FILE_ATTDET_SBR subrecord must be at the top level of the table that contains the actual attachments or the table will be ignored by CleanAttachments. In this case, CleanAttachments does not find any files to delete and does nothing at all.

To schedule a regular job to clean up orphaned file attachments, you can use the CLEANATT84 Application Engine program.

The Copy File Attachments page is provided as a way to launch a CopyAttachments operation (select PeopleTools, Utilities, Administration, Copy File Attachments). The CleanAttachments function is also available from this page.

Parameters

 PreserveCaseHint An optional integer parameter that provides the CleanAttachments function with a hint about how the PreserveCase parameter was used when the files were originally uploaded—that is, whether the PreserveCase parameter was True, False, or a mix of the two.

For PreserveCaseHint, specify one of the following constant values:

 Numeric Value Constant Value Description 1 %CleanAttach_PreserveCase Indicates that the comparison is to be performed as if PreserveCase were True when all the files were uploaded to this database. Therefore, the comparison between list 1 and list 2 requires an exact match of the file name including its file extension. Any files in list 2 (actual stored files) that do not have an exact match in list 1 (names of referenced files) are deleted. 2 %CleanAttach_NoPreserveCase Indicates that the comparison is to be performed as if PreserveCase were False when all the files were uploaded to this database. Therefore, the comparison between list 1 and list 2 will be performed only after the file extension of each file in list 1 is lowercased. Any files in list 2 (actual stored files) that do not have an exact match in list 1 (names of referenced files) after lowercasing the file extension in list 1 are deleted. 0 %CleanAttach_Default Indicates that the comparison is to be performed as if PreserveCase were True when some of the files were uploaded to this database and False for others. Therefore, a file in list 2 (actual stored files) is retained if it would have been retained had PreserveCaseHint been specified as either %CleanAttach_PreserveCase or %CleanAttach_NoPreserveCase. Otherwise, the file is considered an orphan and is deleted.

The following table summarizes the action of CleanAttachments on five different stored files depending on the values found in the file reference table and depending on the value of the optional PreserveCaseHint parameter:

 List 1: File Names in File Reference Table(s) List 2: File Names in File Storage Table(s) %CleanAttach_ PreserveCase %CleanAttach_ NoPreserveCase %CleanAttach_ Default file1.txt file1.txt retain retain retain file2.TXT file2.txt delete retain retain file3.TXT file3.TXT retain delete retain file4.TXT and file4.txt file4.TxT delete delete delete none found file5.txt delete delete delete

Returns

An integer value. You can check for either an integer or a constant value:

 Numeric Value Constant Value Description 0 %Attachment_Success Files were deleted successfully. 1 %Attachment_Failed Files were not deleted successfully. The following are some possible situations where %Attachment_Failed could be returned: Failed to initialize the process due to some internal error. Failed due to unexpected/bad reply from server. Failed to allocate memory due to some internal error. Failed due to timeout. Failed due to non-availability of space on FTP server. Failed to close SSL connection. Failed due to an unspecified error on the HTTP repository. If the HTTP repository resides on a PeopleSoft web server, then you can configure tracing on the web server to report additional error details.

Example

&retcode = CleanAttachments(%CleanAttach_PreserveCase);

#### ClearKeyList

Syntax

ClearKeyList()

Description

Use the ClearKeyList function to clear the current key list. This function is useful for programmatically setting up keys before transferring to another component.

Returns

Optionally returns a Boolean value indicating whether the function succeeded.

Example

The following example sets up a key list and then transfers the user to a page named PAGE_2.

#### ClearSearchDefault

Syntax

ClearSearchDefault([recordname.]fieldname)

Description

Use the ClearSearchDefault function to disable default processing for the specified field, reversing the effects of a previous call to the SetSearchDefault function.

Note. This function remains for backward compatibility only. Use the SearchDefault Field class property instead.

If search default processing is cleared for a record field, the default value specified in the record field properties for that field will not be assigned when the field appears in a search dialog box. This function is effective only when used in SearchInit PeopleCode.

Parameters

 [recordname .]fieldname The name of the target field, which is a search key or alternate search key that is about to appear in a search dialog box. You must supply the recordname only if the record field and your PeopleCode program are in different locations.

Returns

Optionally returns a Boolean value indicating whether the function succeeded.

#### ClearSearchEdit

Syntax

ClearSearchEdit([recordname.]fieldname)

Description

Use the ClearSearchEdit function to reverse the effects of a previous call to the SetSearchEdit function. If ClearSearchEdit is called for a specific field, the edits specified in the record field properties will not be applied to the field when it occurs in a search dialog.

Note. This function remains for backward compatibility only. Use the SearchEdit Field class property instead.

Parameters

 [recordname .]fieldname The name of the target field, which is a search key or alternate search key about to appear in a search dialog box. The recordname prefix is not required if the program that calls ClearSearchEdit is on the recordname record definition.

Returns

Optionally returns a Boolean value indicating whether the function succeeded.

#### Code

Syntax

Code(str)

Description

Use the Code function to return the numerical Unicode UTF-16 value for the first character in the string str. (Normally you would pass this function a single character.) If the string starts with a non-BMP Unicode character, the value returned will be that of the Unicode high surrogate of the character (the first value of the surrogate pair).

Returns

Returns a Number value equal to the character code for the first character in str.

#### Codeb

Syntax

Codeb(str)

Description

Note. This function has been deprecated and is no longer supported.

Code.

#### CollectGarbage

Syntax

CollectGarbage()

Description

Use the CollectGarbage function to remove any unreachable application objects created by the Application Classes.

Sometimes there may be unrecoverable application objects that are can no longer be referenced from PeopleCode, but which have not been reclaimed and so are still taking up computer memory. Generally this situation arises only if you have application objects that form into loops of references.

This function is automatically invoked by the application server as part of its end-of-service processing, so generally you do not need to call it for online applications. However, in Application Engine (batch), it is possible that a long-running batch job could grow in memory usage over time as these unreferencable Application Objects accumulate. The solution to such a problem is to call CollectGarbage periodically to reclaim these objects.

Parameters

None.

Returns

None.

#### CommitWork

Syntax

CommitWork()

Description

Use the CommitWork function to commit pending changes (inserts, updates, and deletes) to the database.

Considerations for Using CommitWork

The following are the considerations for using CommitWork.

• This function is available in Application Engine PeopleCode, the FieldChange and SavePreChange events. If you use it anywhere else, you'll receive a runtime error.

• When used with an Application Engine program, this function only applies to those Application Engine programs that run in batch (not online). If the program is invoked using the CallAppEngine function, the CommitWork call is ignored. The same is true for commit settings at the section or step level.

• This function can only be used in an Application Engine program that has restart disabled. If you try to use this function in a program that doesn't have restart disabled, you'll receive a runtime error.

• Component interfaces that rely on CommitWork to save data cannot be used in the Excel to Component Interface utility.

• When CommitWork is called in the context of a component interface (such as, during a SavePreChange PeopleCode program that's associated with the component), if the caller of the component interface already has an open cursor (such as an active SQL object) the Commit does not take effect immediately, but only when the last cursor is closed.

See CallAppEngine.

FieldChange and SavePreChange Considerations

The following are the FieldChange and SavePreChange considerations:

• All updates done in FieldChange (including those using CallAppEngine) should be considered a single database transaction. This is a fundamental change: previously, a single transaction was represented by a page or a component.

• A consequence of this is that a message requiring a reply, or any other think-time action, causes a fatal error if located in FieldChange after a database update that has not been committed to the database using the CommitWork function. So it is possible for an application to update the database in FieldChange, then do a think-time action, by preceding the think-time action with a call to CommitWork.

• CommitWork commits the updates and closes the database transaction (that is, the unit of work). The consequence of using CommitWork is that because it closes the database transaction, any subsequent rollback calls will not rollback the committed updates.

• Just as any database updates in FieldChange required careful application design to ensure that the transaction model is appropriate, so too does the use of CommitWork.

• When using CommitWork in the Component Processor environment (as opposed to using it in an Application Engine program) CommitWork produces an error if there are any open cursors, such as any open PeopleCode SQL objects.

Application Engine Considerations

The CommitWork function is useful only when you are doing row-at-a-time SQL processing in a single PeopleCode program, and you must commit without exiting the program. In a typical Application Engine program, SQL commands are split between multiple Application Engine actions that fetch, insert, update, or delete application data. Therefore, you would use the section or step level commit settings to manage the commits. This is the recommended approach.

However, with some types of Application Engine programs that are PeopleCode intensive, it can be difficult to exit the PeopleCode in order to perform a commit. This is the only time when the CommitWork function should be used.

Restart Considerations

Disabling restart on a particular program means that the application itself is intrinsically self-restartable: it can be re-run from the start after an abend, and it performs any initialization, cleanup, and filtering of input data to ensure that everything gets processed once and only once, and that upon successful completion, the database is in the same state it would have been if no abend occurred.

Set-based applications should always use Application Engine's restart. Only row-by-row applications that have restart built into them can benefit from disabling Application Engine's restart.

Consider the following points to managing restarts in a self-restarting program:

• Locking input transactions (optional).

If the input data can change, and if it's important not to pick up new data during a restart, there should be logic to lock transactions at the start of the initial run (such as updating rows with current Process Instance). The program should first check whether any rows have the current Process Instance (that is, is the process being restarted from the top after an abend?). If no rows found, do the update.

In some cases it is acceptable for a restarted process to pick up new rows, so that locking is not necessary. It depends on your application.

Also, if you do not lock transactions, you must provide some other way to manage concurrent processing of the same program. You do not want two simultaneous runs of the same program to use the same data, so you must have some strategy for dividing up the data such that there is no overlap.

• Filtering input transactions (required).

After an input transaction is processed, the row should be updated accordingly (that is, setting a "processed" flag). The SELECT statement that drives the main processing loop should include a WHERE condition to filter out rows that have already been processed.

Returns

A Boolean value, True if data was successfully committed, False otherwise.

Example

The following example fetches rows and processes them one at a time, committing every 100 iterations. Because restart is disabled, you must have a marker indicating which rows have been processed, and use it in a conditional clause that filters out those rows.

Local SQL &SQL; Local Record &REC; Local Number &COUNT; &REC = CreateRecord(RECORD.TRANS_TBL); &SQL = CreateSQL("%SelectAll(:1) WHERE PROCESSED <> 'Y'"); &COUNT = 0; &SQL.Execute(&REC); While &SQL.Fetch(&REC) If (&COUNT > 99) Then &COUNT = 0; CommitWork(); /* commit work once per 100 iterations */ End-if; &COUNT = &COUNT + 1; /* do processing */ ... /* update transaction as "processed" */ &REC.PROCESSED.Value = 'Y'; &REC.Update(); End-While;

#### CompareLikeFields

Syntax

CompareLikeFields(from, to)

where from and to are constructions that reference rows of data on specific source and target records in the component buffer; each have the following syntax:

level, scrollpath, target_row

and where scrollpath is:

[RECORD.level1_recname, level1_row, [RECORD.level2_recname, level2_row, ]] RECORD.target_recname

To prevent ambiguous references, you can use SCROLL. scrollname, where scrollname is the same as the scroll level’s primary record name.

Description

Use the CompareLikeFields function to compare fields in a row on a specified source record to similarly named fields on a specified target record.

Note. This function remains for backward compatibility only. Use the CompareFields record class method instead.

If all of the like-named fields have the same data value, CompareLikeFields returns True; otherwise it returns False.

Parameters

 from A placeholder for a construction (level, scrollpath, target_row) that references the first row in the comparison. to A placeholder for a construction (level, scrollpath, target_row) that references the second row in the comparison. level Specifies the scroll level for the target level scroll. scrollpath A construction that specifies a scroll level in the component buffer. target_row Specifies the row number of each target row on its scroll level.

Returns

Returns a Boolean value indicating whether all of the like-named fields in the two records have the same data value.

Example

The following example compares the like-named fields in two rows on levels 1 (&L1_ROW) and 2 (&L2_ROW) and returns True if all of the like-named fields in the two rows have the same value.

&L1_ROW = 1; &L2_ROW = 1; if CompareLikeFields(1, RECORD.BUS_EXPENSE_PER, &L1_ROW, 2, RECORD.BUS_EXPENSE_⇒ PER, 1, RECORD.BUS_EXPENSE_DTL, &L2_ROW) then WinMessage("The fields match."); end-if;

#### CompareStrings

Syntax

CompareStrings(new_text, old_text [, content_type [, delimiter]])

Description

Use the CompareStrings function to compare the content of new_text with the content of old_text and return an XML-formatted text string detailing the differences between the two strings.

The XML string indicates the type of change for each line or text segment, based on the delimiter, as shown in the following table:

 Notation Description None Both lines are the same Insert A line is present in new_text that is not in old_text. Delete A line is absent in new_text that is present in old_text. Change A change in a line shows as an Insert in new_text and a Delete in old_text.

Parameters

 new_text Specifies the string that you want to compare with the old version of the string. old_text Specifies the old version of the string for comparison. content_type Specifies the content type as a literal: text or html. This parameter is optional. If content_type is html, HTML tags are stripped and are not included in the comparison. If content_type is not specified, it is set by default to text. delimiter An array of string specifying the delimiters to be used to split the content for comparison. This parameter is optional. If content_type is text and delimiter is not specified, the delimiter is set by default to char(13) (or \n, a carriage return). If content_type is html and delimiter is not specified, the delimiter array is populated by default with the following values: ["

", "
", "", "", "", "", ⇒ "", "", "", "", "", ⇒ "
", "", "", ""]

Returns

Returns a String in XML format showing the differences between the two input strings.

Example

This example shows a comparison of two text strings.

The variable &NewText contains the following string:

Line 2. Line 2.1. Line 2.2. Line 3. Line 5. Line 6. Line 8.

The variable &OldText contains the following string:

Line 1. Line 2. Line 3. Line 4. Line 7.

The following PeopleCode statement compares the two ASCII-formatted text strings, &NewText and &OldText.

&OutputXML = CompareStrings(&NewText, &OldText, "Text");

The string variable &OutputXML contains the following text:

<?xml version="1.0" encoding="UTF-8" standalone="no" ?> <CompareReport ContentType="text" Delimitter="&#xA;"> <FileContent Difference="Deleted"> <Line Num="1"> <LineContent>Line 1.</LineContent> </Line> </FileContent> <FileContent Difference="None"> <Line Num="1" OldLineNum="2"> <LineContent>Line 2.</LineContent> </Line> </FileContent> <FileContent Difference="Inserted"> <Line Num="2"> <LineContent>Line 2.1.</LineContent> </Line> <Line Num="3"> <LineContent>Line 2.2.</LineContent> </Line> </FileContent> <FileContent Difference="None"> <Line Num="4" OldLineNum="3"> <LineContent>Line 3.</LineContent> </Line> </FileContent> <FileContent Difference="Changed"> <OldLine Num="4"> <LineContent>Line</LineContent> <LineContent Changed="Deleted">4.</LineContent> </OldLine> <Line Num="4"> <LineContent>Line</LineContent> <LineContent Changed="Inserted">5.</LineContent> </Line> <OldLine Num="5"> <LineContent>Line</LineContent> <LineContent Changed="Deleted">7.</LineContent> </OldLine> <Line Num="5"> <LineContent>Line</LineContent> <LineContent Changed="Inserted">6.</LineContent> </Line> </FileContent> <FileContent Difference="Inserted"> <Line Num="7"> <LineContent>Line 8.</LineContent> </Line> </FileContent> </CompareReport>

This example shows a comparison of two HTML strings.

The variable &NewHTML contains the following string:

<p><H1>peoplesoft<B>file<B> difference utility <I>Peopletools<I> Release &lt;6 and &gt;5 </H1></p> <p> &lt;BOLD&gt;Hello world<ITALIC></p>

The variable &OldHTML contains the following string:

<p><H1>peoplesoft<B>file<B>difference utility <I>Peopletools<I> Release &lt;7 and &gt;5 </H1></p> <p> &lt;BOLD&gt;Hello world<ITALIC></p>

The following PeopleCode statement compares the two HTML-formatted text strings, &NewHTML and &OldHTML.

&OutputXML = CompareStrings(&NewHTML, &OldHTML, "HTML");

The string variable &OutputXML contains the following text:

<?xml version="1.0" encoding="UTF-8" standalone="no" ?> <CompareReport Delimitter="</p>,</H1>" ContentType ="html"> <FileContent Difference="Changed"> <OldLine Num="1"> <LineContent Changed="Deleted">peoplesoftfile difference</LineContent> <LineContent>utility Peopletools Release</LineContent> <LineContent Changed="Deleted ">&lt;6</LineContent> <LineContent>and &gt;5 </LineContent> </OldLine> <Line Num="1"> <LineContent Changed="Inserted">peoplesoftfiledifference</LineContent> <LineContent>utility Peopletools Release</LineContent> <LineContent Changed="Inserted ">&lt;7</LineContent> <LineContent>and &gt;5 </LineContent> </Line> </FileContent> <FileContent Difference="None"> <Line Num="2" OldLineNum="2"> <LineContent>&amp;lt;BOLD&amp;gt;Hello world</LineContent> </Line> <Line Num="3" OldLineNum="3"> <LineContent></LineContent> </Line> </FileContent> </CompareReport>

#### CompareTextDiff

Syntax

CompareTextDiff(new_text, old_text [, content_type [, delimiter]])

Description

Use the CompareTextDiff function to compare the content of new_text with the content of old_text and return an array of array of any detailing the differences between the two strings. The elements of the returned subarray are as follows:

 Element Data Type Description index number The sequential index number in the comparison array. line number The line number for the line of text being compared. subline number The subline is the counter of added lines that exist in the new_text. Note. For DELETE, CHANGED and COMMON operations, 0 is always reported for the subline. type string The type of difference: COMMON – Both lines are the same ADD – A line is present in new_text that is not in old_text. DELETE – A line is absent in new_text that is present in old_text. CHANGED – A change in a line shows as an Add in new_text and a Delete in old_text. text string The actual text being compared.

Parameters

 new_text Specifies the string that you want to compare with the old version of the string. old_text Specifies the old version of the string for comparison. content_type Specifies the content type as a literal: text or html. This parameter is optional. If content_type is html, HTML tags are stripped and are not included in the comparison. If content_type is not specified, it is set by default to text. delimiter An array of string specifying the delimiters to be used to split the content for comparison. This parameter is optional. If content_type is text and delimiter is not specified, the delimiter is set by default to char(13) (or \n, a carriage return). If content_type is html and delimiter is not specified, the delimiter array is populated by default with the following values: ["

", "
", "", "", "", "", ⇒ "", "", "", "", "", ⇒ "
", "", "", ""]

Returns

An array of array of any.

Example

This example shows a comparison of two text strings. The variable &NewText contains the following string:

Line 2. Line 2.1. Line 2.2. Line 3. Line 5. Line 6. Line 8.

The variable &OldText contains the following string:

Line 1. Line 2. Line 3. Line 4. Line 7.

The following PeopleCode statement compares the two ASCII-formatted text strings, &NewText and &OldText:

&Output = CompareTextDiff(&NewText, &OldText, "text");

The string variable &Output contains the following array:

0, 1, 0, DELETED, Line 1. 1, 2, 0, COMMON, Line 2. 2, 2, 1, ADD, Line 2.1. 3, 2, 2, ADD, Line 2.2. 4, 3, 0, COMMON, Line 3. 5, 4, 0, CHANGED, Line 5. 6, 5, 0, CHANGED, Line 6. 7, 5, 1, ADD, Line 8.

#### Component

Syntax

Component data_type &var_name

Description

Use the Component statement to declare PeopleCode component variables. A component variable, after being declared in any PeopleCode program, remains in scope throughout the life of the component.

The variable must be declared with the Component statement in every PeopleCode program in which it is used.

Declarations appear at the beginning of the program, intermixed with function declarations.

Note. Because a function can be called from anywhere, you cannot declare any variables within a function. You receive a design time error if you try.

The system automatically initializes temporary variables. Declared variables always have values appropriate to their declared type. Undeclared variables are initialized as null strings.

Not all PeopleCode data types can be declared as Component.

Parameters

 data_type Specify a PeopleCode data type. &var_name A legal variable name.

Example

Component string &PG_FIRST;

#### ComponentChanged

Syntax

ComponentChanged()

Description

Use the ComponentChanged function to determine whether a component has changed since the last save, whether by the user or by PeopleCode.

Returns

Returns a Boolean value: True if the component has changed.

Example

If ComponentChanged() Then /* do some stuff */ End-if;

#### ConnectorRequest

Syntax

ConnectorRequest(&Message)

Description

Use the ConnectorRequest function to send data to the connector using a message, when the connector properties are assigned in the message.

Note. This function has been deprecated and remains for backward compatibility only. Use the IntBroker class ConnectorRequest method instead.

In general, you would build a message, add the specific connector properties, then use ConnectorRequest.

You do not need to set up any transaction or relationship when you use this function. It is a direct call to the gateway.

The response to the message is returned as a nonrowset-based message. Use the GetXmlDoc message class method to retrieve the content data. The data is wrapped in the CDATA tag.

Parameters

 &Message Specify an already instantiated message.

Returns

A nonrowset-based message object.

#### ConnectorRequestURL

Syntax

ConnectorRequestURL(ConnectorStringURL)

Description

Use the ConnectorRequestURL function to go directly to the gateway for accessing information.

Note. This function has been deprecated and remains for backward compatibility only. Use the IntBroker class ConnectorRequestURL method instead.

Parameters

 ConnectorStringURL Specify the URL of the gateway as a string. This is a fully formed URL.

Returns

A string containing the URL information returned from the message.

Example

The following is the type of URL that could be returned if you were trying to get a PSFT stock quote:

http://finance.yahoo.com/d/quotes.txt/?symbols=PSFT&format=l1c1d1t1

#### ContainsCharType

Syntax

ContainsCharType(source_str, char_code)

Description

Use the ContainsCharType function to determine if any of the characters in source_str are of type char_code. The char_code is a numerical value representing a character type (see the following Parameters section for details). Most character types supported by this function equate to specific Unicode character blocks or are based on Unicode character properties.

Parameters

 source_str String to be examined. char_code A number value representing the character type to be tested for. The following table shows valid values. You can specify either a character code numeric value or a constant:

 Numeric Value Constant Character Set 0 %CharType_AlphaNumeric Basic Latin — Alphanumeric (printable range of 7-bit US-ASCII), Unicode characters in the range U+0020 — U+007E 1 %CharType_ExtendedLatin1 Extended Latin-1 characters (ISO 8859-1 accents for Western European languages), Unicode characters in the range U+00BF — U+07E 2 %CharType_HankakuKatakana Hankaku Katakana (half-width Japanese Katakana) 3 %CharType_ZenkakuKatakana Zenkaku Katakana (full-width Japanese Katakana) 4 %CharType_Hiragana Hiragana (Japanese) 5 %CharType_Kanji Chinese, Japanese and Korean ideographic characters. Includes Japanese Kanji, Chinese Hanzi and Korean Hancha. 6 %CharType_DBAlphaNumeric Full-width Latin Alphanumeric characters, primarily used for Japanese. Excludes 7 None Korean Hangul syllables, excluding Hangul Jamo. 8,9 None Reserved for future use. 10 %CharType_JapanesePunctuation Full- and half-width punctuation, including space (U+0020) and Fullwidth / Ideographic Space (U+3000). 11 None Greek 12 None Cyrillic 13 None Armenian 14 None Hebrew 15 None Arabic 16 None Devanagari 17 None Bengali 18 None Gurmukhi 19 None Gujarati 20 None Oriya 21 None Tamil 22 None Telugu 23 None Kannada 24 None Malayalam 25 None Thai 26 None Lao 27 None Tibetan 28 None Georgian 29 None Bopomofo

Returns

ContainsCharType returns one of the following Number values. You can check for the constant instead of the numeric value if you prefer:

 Numeric Value Constant Value Description 1 %CharType_Matched String contains at least one character of set char_code. 0 %CharType_NotMatched String contains no characters of set char_code. -1 %CharType_Unknown UNKNOWN: unable to determine whether character is of set char_code. This occurs if the character being checked is an unallocated Unicode codepoint, or was added in a version of Unicode greater than that supported by PeopleTools.

Example

This example tests to see if the string contains any Hiragana:

&ANYHIRAGANA = ContainsCharType(&STRTOTEST, 4); If &ANYHIRAGANA = 1 Then WinMessage("There are Hiragana characters"); Else If &ANYHIRAGANA = 0 Then WinMessage("There are no Hiragana characters"); Else WinMessage("UNKNOWN"); End-If; End-If;

#### ContainsOnlyCharType

Syntax

ContainsOnlyCharType(source_str, char_code_list)

Where char_code_list is a list of character set codes in the form:

char_code_1 [, char_code_2]. . .

Description

Use the ContainsOnlyCharType function to determine whether every character in source_str belongs to one or more of the character types in char_code_list. See the following Parameters section for a list of valid character code values. Most character types supported by this function equate to specific Unicode character blocks or are based on Unicode character properties.

Parameters

 Source_str String to be examined. char_code_list A comma-separated list of character set codes. char_code_n Either a Number value identifying a character set, or a constant. The following table shows valid values. You can specify either a character code numeric value or a constant:

 Numeric Value Constant Character Set 0 %CharType_AlphaNumeric Alphanumeric (7-bit ASCII codes; A-Z, a-z, 1-9, punctuation) 1 %CharType_ExtendedLatin1 Extended Latin-1 characters (ISO8859-1 accents for Spanish, French, etc.) 2 %CharType_HankakuKatakana Hankaku Katakana (single-byte Japanese Katakana) 3 %CharType_ZenkakuKatakana Zenkaku Katakana (double-byte Japanese Katakana) 4 %CharType_Hiragana Hiragana (Japanese) 5 %CharType_Kanji Kanji (Japanese) 6 %CharType_DBAlphaNumeric Double-byte Alphanumeric (Japanese) 7,8,9 Reserved for future use 10 %CharType_JapanesePunctuation Japanese punctuation

Returns

ContainsOnlyCharType returns one of the following Number values. You can check for the constant instead of the numeric value, if you prefer:

 Numeric Value Constant Value Description 1 %CharType_Matched String contains only characters belonging to the sets listed in char_code_list. 0 %CharType_NotMatched String contains one or more characters that do not belong to sets listed in char_code_list. -1 %CharType_Unknown UNKNOWN: unable to determine whether character is of set char_code. This occurs if the character being checked is an unallocated Unicode codepoint, or was added in a version of Unicode greater than that supported by PeopleTools.

Note. If any character in the string is determined to be UNKNOWN, the return value is UNKNOWN.

Example

This example tests to see is the string is only Hiragana or Punctuation:

&ONLYHIRAGANA = ContainsOnlyCharType(&STRTOTEST, 4, 10); If &ONLYHIRAGANA = 1 Then WinMessage("There are only Hiragana and Punctuation characters"); Else If &ONLYHIRAGANA = 0 Then WinMessage("Mixed characters"); Else WinMessage("UNKNOWN"); End-If End-If

#### Continue

Syntax

Continue

Description

Use the Continue statement to continue execution in a loop. How the statement performs depends on the type of loop:

• In For loops, this statement continues to do the next step of the iteration

• In While loops, this statement continues to the top of the loop and the test of the condition

• In Repeat-Until loops, this statement continues to the Until check at the bottom of the loop.

Parameters

None.

Example

The following are tests of the continue statement in various types of loops:

SetTracePC(%TracePC_List); /* tests of continue statement */ &N = 0; For &I = 1 To 10; If &I > 5 Then Continue; End-If; &J = &I + 1; &K = 0; /* now a while loop in here */ While &J <= 10; &J = &J + 1; If &J = 7 Then Continue; End-If; For &A = 0 To 5; &K = &K + 2; End-For; /* no continue statement */ &Barf = 2; Repeat &Barf = &Barf; If &Barf = 1 Then Continue; End-If; Until &Barf = &Barf; &K = &K + 1; End-While; MessageBox(0, "", 0, 0, "K=" | &K); If &I < 2 Then Continue; End-If; &N = &N + 1; End-For; MessageBox(0, "", 0, 0, "N=" | &N);

#### ConvertChar

Syntax

ConvertChar(source_str, source_str_category, output_str, target_char_code)

Description

Use the ConvertChar function to convert every character in source_str to type target_char_code, if possible, and place the converted string in output_str. ConvertChar supports the following conversions:

• Conversion among Japanese Hankaku (half-width) Katakana, Zenkaku (full-width) Katakana, and Hiragana .

• Conversion of Japanese Hankaku (half-width) Katakana, Zenkaku (full-width) Katakana, and Hiragana to Hepburn Romaji (Latin representation).

• Conversion of full-width alphanumeric characters to their half-width equivalents.

• Conversion of full-width punctuation characters to their half-width equivalents.

Other source_str and target_char_code combinations are either passed through without conversion, or not supported. Character types 0 and 1 (alphanumeric and extended Latin-1) are always passed through to output_str without conversion. See the Supported Conventions section later in this reference entry for details.

If ConvertChar is unable to determine whether the characters in source_str belong to the specified character set, the function returns a value of UNKNOWN (-1). If source_str can be partially converted, ConvertChar will partially convert string, echo the remaining characters to the output string as-is, and return a value of -2 (Completed with Issues).

Parameters

 Source_str String to be converted. Source_str_category Language category of input string. You can specify either a number or a constant.

 Numeric Value Constant Value Description 0 %ConvertChar_AlphaNumeric Half-width AlphaNumeric 1 %ConvertChar_ExtendedLatin1 Extended Latin-1 Characters (ISO8859-1 accents, Spanish, French etc.) 2 %ConvertChar_Japanese Japanese (any)

 Output_str A String variable to receive the converted string. Target_char_code Either a Number or a constant representing the conversion target character type. You can specify either a character code numeric value or a constant:

 Numeric Value Constant Value Description 0 %CharType_AlphaNumeric Half-width AlphaNumeric — results in a Hepburn Romaji conversion when the input string contains Hiragana or Katakana 2 %CharType_HankakuKatakana Hankaku Katakana (half—width Japanese Katakana) 3 %CharType_ZenkakuKatakana Zenkaku Katakana (full-width Japanese Katakana) 4 %CharType_Hiragana Hiragana (Japanese) 6 %CharType_DBAlphaNumeric Full-width AlphaNumeric (Japanese)

The following target values are not supported; if the source string is of the same type as any of these values, then the string is passed through without conversion.

 Numeric Value Constant Value Description 1 %CharType_ExtendedLatin1 Extended Latin-1 characters (ISO8859-1 accents for Spanish, French, etc.) 5 %CharType_Kanji Chinese, Japanese and Korean ideographic characters. 10 %CharType_JapanesePunctuation Full- and half-width punctuation, including space (U+0020) and Fullwidth / Ideographic Space (U+3000).

Supported Conversions

The following table shows which conversions are supported, which are passed through without conversion, and which are not supported:

 Source Target Conversion 0 (Alphanumeric US-ASCII) 0-6 (All supported character types) Pass through without conversion 1 (Extended Latin-1 characters) 0-6 (All supported character sets) Pass through without conversion 2 (Hankaku Katakana) 0 (Alphanumeric — Hepburn romaji) Conversion supported 1 (Extended Latin) Not supported 2 (Hankaku Katakana) Pass through without conversion 3 (Zenkaku Katakana) Conversion supported 4 (Hiragana) Conversion supported 5 (Kanji) Not supported 6 (Full-width alphanumeric) Not supported 3 (Zenkaku Katakana) 0 (Alphanumeric) Conversion supported 1 (Extended Latin) Not supported 2 (Hankaku Katakana) Conversion supported 3 (Zenkaku Katakana) Pass through without conversion 4 (Hiragana) Conversion supported 5 (Kanji) Not supported 6 (Full-width alphanumeric) Not supported 4 (Hiragana) 0 (Alphanumeric- Hepburn Romaji) Conversion supported 1 (Extended Latin) Not supported 2 (Hankaku Katakana) Conversion supported 3 (Zenkaku Katakana) Conversion supported 4 (Hiragana) Pass through without conversion 5 (Kanji) Not supported 6 (Full-width alphanumeric) Not supported 5 (Kanji) 0-4, 6 Not supported 5 (Kanji) Pass through without conversion 6 (Full-width alphanumeric) 0 (Alphanumeric) Conversion supported 1-5 Not supported 6 (Full-width alphanumeric) Pass through without conversion 10 (Japanese punctuation) 0 (Alphanumeric) Conversion supported 1 (Extended Latin) Not supported 3-6, 10 Pass through without conversion

Returns

Returns either a Number or a constant with one of the following values, depending on what you’re checking for:

 Numeric Value Constant Value Description 1 %ConvertChar_Success String successfully converted. 0 %ConvertChar_NotConverted String not converted. -1 %ConvertChar_Unknown UNKNOWN: unable to determine whether character is of set char_code. This occurs if the character being checked is an unallocated Unicode codepoint, or was added in a version of Unicode greater than that supported by PeopleTools. -2 %ConvertChar_Issues Completed with issues. Conversion executed but there were one or more characters encountered that were either not recognized, or whose conversion is not supported.

Note. If any character cannot be translated, it is echoed as-is to output_str. output_str could therefore be a mixture of converted and non-converted characters.

Example

This example attempts to convert a string to Hiragana:

&RETVALUE = ConvertChar(&INSTR, 2, &OUTSTR, 4); If &RETVALUE = 1 Then WinMessage("Conversion to Hiragana successful"); Else If &RETVALUE = 0 Then WinMessage("Conversion to Hiragana failed"); Else If &RETVALUE = - 1 Then WinMessage("Input string is UNKNOWN character type."); Else WinMessage("Some characters could not be converted."); End-If End-If End-If

#### ConvertCurrency

Syntax

ConvertCurrency(amt, currency_cd, exchng_to_currency, exchng_rt_type, effdt, converted_amt [, error_process [, round] [, rt_index]])

Description

Use the ConvertCurrency function to convert between currencies. The result of the conversion is placed in a variable passed in converted_amt.

Parameters

 Amt The currency amount to be converted. Currency_cd The currency in which the amt is currently expressed. Exchng_to_currency The currency to which the amt should be converted. Exchng_rt_type The currency exchange rate to be used. This is the value of the RT_TYPE field in the RT_RATE table of RT_DFLT_VW. Effdt The effective date of the conversion to be used. Converted_amt The resulting converted amount. You must supply a variable for this parameter. If a conversion rate cannot be found, converted_amt is set equal to amt. Error_process An optional string that, if specified, contains one of the following values: "F" - Produce a fatal error if a matching conversion rate is not found. "W" - Produce a warning message box if a matching conversion rate is not found. "I" - Or other−return without producing a message box If error_process is not specified, it defaults to Fatal ("F"). Round Optional Boolean value indicating whether to round converted_amt to the smallest currency unit. If omitted, round defaults to False. rt_index An optional string to indicate which exchange rate index should be used to retrieve the exchange rate. If omitted, the Default Exchange Rate index (as specified on the Market Rate index definition) is used.

Note. If the currency exchange rate is changed in a PeopleSoft table, this change will not be reflected in an already open page until the user closes the page, then opens it again.

Returns

ConvertCurrency returns a Boolean value where True means a conversion rate was found and converted_amt calculated, and False means a conversion rate was not found and a value of one (1) was used.

Example

rem **-----------------------------------------------**; rem * Convert the cost & accum_depr fields if books *; rem * use different currencies. *; rem **-----------------------------------------------**; rem; If &FROM_CUR <> &PROFILE_CUR_CD Then &CON_COST_FROM = &COST_COST; &CON_ACC_DEPR_FROM = &COST_ACCUM; ConvertCurrency(&CON_COST_FROM, &FROM_CUR, &PROFILE_CUR_CD, RT_TYPE,TRANS_⇒ DT, &CON_COST_TO, "F"); UpdateValue(COST_NON_CAP.COST, &COST_ROW_CUR, &CON_COST_TO); Else UpdateValue(COST_NON_CAP.COST, &COST_ROW_CUR, &COST_COST); End-If; UpdateValue(COST_NON_CAP.FROM_CUR, &COST_ROW_CUR, &PROFILE_CUR_CD); UpdateValue(COST_NON_CAP.OPRID, &COST_ROW_CUR, %UserIdId);

#### ConvertDatetimeToBase

Syntax

ConvertDatetimeToBase(textdatetime, {timezone | "Local" | "Base"});

Description

Use the ConvertDatetimeToBase function to convert the text value textdatetime to a DateTime value. The ConvertDatetimeToBase function then further converts it from the specified time zone to the base time zone. This function automatically calculates whether daylight saving time is in effect for the given textdatetime and time zone.

The system’s base time zone is specified in the PSOPTIONS table.

Parameters

 textdatetime Specify a date/time represented as text in the PeopleSoft internal format: yyyy-mm-dd hh:mm:ss[.S] (for example, "2011-01-01 18:10:52.000000"). In which: yyyy is a four-digit year. mm is a two-digit month (01 through 12). dd is a two-digit day of the month (01 through 31). hh is a two digits of hour (00 through 23). mm is a two digits of minute (00 through 59). ss is two digits of second (00 through 59). S is milliseconds in one or up to six digits. timezone | Local | Base Specify a value for converting textdatetime. Values are: timezone - a time zone abbreviation or a field reference to be used for converting textdatetime Local - use the local time zone for converting textdatetime. Base - use the base time zone for converting textdatetime.

Returns

Returns a DateTime value in the base time zone.

Example

In the following example, assuming the base time (as defined in PSOPTIONS) is PST, &DATETIMEVAL would have a DateTime value of "1999-01-01 07:00:00.000000":

&DATETIMEVAL= ConvertDateTimeToBase("1999-01-01 10:00:00.000000", "EST");

#### ConvertRate

Syntax

ConvertRate(Rate, In_Frequency, Out_Frequency)

Description

Use the ConvertRate function to convert a rate between various compounding frequencies.

Parameters

 Rate The rate to be converted. This parameter takes a number value. In_Frequency The frequency of the rate to be converted from. This parameter takes an array of number, with two elements. The first element is periodicity, (for example, if you chose daily compounding, 1 would represent daily while 7 would represent weekly.) The second element is the unit of measure of frequency. The values for the second element are:

 Value Description 0 continuous compounding 1 daily compounding 2 monthly compounding 3 yearly compounding

 Out_Frequency The frequency of the rate to be converted to. This parameter takes an array of number, with two elements. The first element is periodicity, (for example, if you chose daily compounding, 1 would represent daily while 7 would represent weekly.) The second element is the unit of measure of frequency. The values for the second element are:

 Value Description 0 continuous compounding 1 daily compounding 2 monthly compounding 3 yearly compounding

Returns

A number representing the converted rate.

Example

The following example converts the specified values from days to years.

Local array of number &In, &Out; Local number &rate, &NewRate; &rate = 0.01891; &In = CreateArray(0, 0); &In[1] = 1; /* daily */ &In[2] = 1; /* compound_days */ &Out = CreateArray(0, 0); &Out[1] = 1; /* one year */ &Out[2] = 3; /* compound_years */ &NewRate = ConvertRate(&rate, &In, &Out);

#### ConvertTimeToBase

Syntax

ConvertTimeToBase(texttime,{timezone | "Local" | "Base"});

Description

Use the ConvertTimeToBase function to convert the text value texttime to a Time value and converts it to the base time. This function automatically calculates whether daylight saving time is in effect for the given texttime.

This function is useful for users to convert constant times in specific time zones into database time. For example, there is a deadline for completing Federal Funds transfers by 3:00 PM Eastern Time. ConvertTimeToBase does this conversion, taking into account daylight saving time. The date used to calculate whether daylight saving time is in effect is the current date.

The system’s base time zone is specified on the PSOPTIONS table.

Parameters

 texttime Specify a time value represented as text (e.g., "3:00 PM") timezone | Local | Base Specify a value for converting texttime. Values are: timezone - a time zone abbreviation or a field reference to be used for converting texttime Local - use the local time zone for converting texttime. Base - use the base time zone for converting texttime.

Returns

Returns a time value in the base time zone.

Example

In the following example, &TIMEVAL would have a time value of "07:00:00.000000", assuming the Base time (as defined in PSOPTIONS) was PST.

&TEXTTIME = ConvertTimeToBase("01/01/99 10:00:00AM", "EST");

#### CopyAttachments

Syntax

CopyAttachments(URLSource, URLDestination [, FileRefRecords [, PreserveCase[, AllowLargeChunks]]])

Description

Use the CopyAttachments function to copy all files from one storage location to another. The files to be copied can be limited to those referenced in specific file reference tables.

The Copy File Attachments page is provided as a way to launch a CopyAttachments operation (select PeopleTools, Utilities, Administration, Copy File Attachments). (The CleanAttachments function is also available from this page.)

CopyAttachments looks for the field ATTACHSYSFILENAME in the table that stores the file references. Oracle recommends that you include the FILE_ATTACH_SBR subrecord, which includes the ATTACHSYSFILENAME and ATTACHUSERFILE fields, in your record definition, not just the fields themselves.

CopyAttachments generates a list of all file attachments references, and then performs two operations on each file attachment. First, CopyAttachments calls GetAttachment to retrieve the file from your source location. Then, it calls PutAttachment to copy the attachment to your destination.

Note. If the specified subdirectories do not exist this function tries to create them.

PeopleTools supports multiple types of storage locations. Additional information on using CopyAttachments with storage locations can be found in the PeopleTools 8.52: PeopleCode Developer's Guide PeopleBook.

Considerations on Using PreserveCase with CopyAttachments

If the files to be copied were originally uploaded with the value of the PreserveCase optional parameter unspecified or explicitly specified as False, then CopyAttachments should be similarly invoked (with the value of PreserveCase unspecified or explicitly specified as False). On the other hand, if the files to be copied were originally uploaded with the value of the PreserveCase explicitly specified as True, then CopyAttachments should be similarly invoked (with the value of PreserveCase explicitly specified as True). If the files to be copied fall into both categories, then CopyAttachment will need to be run twice , once with the value of PreserveCase unspecified or explicitly specified as False, and then again with the value of PreserveCase explicitly specified as True.

Parameters

 URLSource Specify the source storage location of the files to be copied. This parameter can either be a URL identifier in the form URL .URL_ID, or a string. The URLSource parameter requires forward slashes (“/”). Backward slashes ("\") are not supported for this parameter. URLDestination Specify the destination storage location for the files to be copied. This parameter can either be a URL identifier in the form URL.URL_ID, or a string. The URLDestination parameter requires forward slashes (“/”). Backward slashes ("\") are not supported for this parameter. FileRefRecords Specify an array of record names each of which is associated with a table containing valid file references. By using this parameter, it is possible to explicitly specify which groups of file references will be considered during a call to CopyAttachments and, in this way, further restrict the scope of that call. If you do not specify this parameter, all the records that contain the FILE_ATTACH_SBR subrecord will be considered to have been implicitly specified (that is, every file at the specified source storage location that has some valid corresponding file reference will be copied). PreserveCase Specify a Boolean value to indicate whether, when searching the source storage locations for the file specified by each file reference and when naming that file at the destination, its file name extension will be preserved or not; True, preserve the case of the file name extension, False, convert the file name extension to all lower case letters. The default value is False. Warning! If you use the PreserveCase parameter, it is important that you use it in a consistent manner with all the relevant file-processing functions or you may encounter unexpected file-not-found errors. AllowLargeChunks Specify a Boolean value to indicate whether to allow large chunks. If the value specified in the Maximum Attachment Chunk Size field on the PeopleTools Options page is larger than is allowed for retrieval, then the system breaks the file upload into the largest sized chunks allowed. If AllowLargeChunks is set to True, this behavior can be overridden so that it is possible for an end user to upload a file in chunks that are too large for the system to retrieve. If AllowLargeChunks is set to False, the system will use the largest size chunk that is allowed for retrieval, or the configured chunk size, whichever is smaller. Note. If the chunks are too big to be retrieved, then any file retrieval built-in function, such as GetAttachment, will fail. Note. The AllowLargeChunks parameter is only applicable when the storage location is a database record. It has no impact when the storage location is an FTP site or an HTTP repository, since attachments at those locations are never chunked. This is an optional parameter. The default value is False.

Returns

You can check for either an integer or a constant value:

Note. Since file attachment references might not always point to real files in your source location (they might point to files in other locations, for example), file not found errors from the GetAttachment operation are ignored and not included in the CopyAttachments return code.

Note. Because CopyAttachments is designed to work with multiple files, to track errors when using CopyAttachments set your PeopleCode trace to 2112 and your SQL trace to 15 so that errors will be written to the appropriate trace files.

Example

Here is another example.

&aRecs = CreateArray("HRATTS", "MFGATTS", "CRMATTS"); &ret = CopyAttachments("ftp://user:pass@system/HR/", "record://HRARCHIVE", &aRecs); If (&ret = %Attachment_Success) Then MessageBox(0, "Copy Archive Status", 0, 0, "Copy attachment archive⇒ succeeded"); Else MessageBox(0, "Copy Archive Status", 0, 0, "Copy attachment archive failed"); End-If;

#### CopyFields

Syntax

CopyFields(from, to)

where from and to are constructions that reference rows of data on specific source and target records in the component buffer; each have the following syntax:

level, scrollpath, target_row

and where scrollpath is:

[RECORD.level1_recname, level1_row, [RECORD.level2_recname, level2_row, ]] RECORD.target_recname

To prevent ambiguous references, you can also use SCROLL. scrollname, where scrollname is the same as the scroll level’s primary record name.

Description

Use the CopyFields function to copy like-named fields from a row on the specific source record to a row on the specific target record.

Note. This function remains for backward compatibility only. Use the CopyFieldsTo or CopyChangedFieldsTo record class methods instead.

Parameters

 from A placeholder for a construction (level, scrollpath, target_row) that references the first row in the comparison. to A placeholder for a construction (level, scrollpath, target_row) that references the second row in the comparison. level Specifies the scroll level for the target level scroll. scrollpath A construction that specifies a scroll level in the component buffer. target_row Specifies the row number of each target row on its scroll level.

Returns

Optionally returns a Boolean value indicating whether the function succeeded.

Example

The following example copies fields from PO_RECEIVED_INV (level 1 scroll) from row &ROW to PO_RECV_INV_VW (level 1 scroll), row &LOC_ROW:

CopyFields(1, RECORD.PO_RECEIVED_INV, &ROW, 1, RECORD.PO_RECV_INV_VW, &LOC_ROW);

#### CopyFromJavaArray

Syntax

CopyFromJavaArray(JavaArray, &PeopleCodeArray [, &RestrictionArray])

Description

Use the CopyFromJavaArray function to copy the array specified by JavaArray into one-dimensional PeopleCode array &PeopleCodeArray.

Note. The Java array must be at least the same size as the PeopleCode array.

The optional &RestrictionArray parameter is a PeopleCode array that contains the index elements of the elements to copy. For example if &RestrictionArray contains the indexes 3, 5 and 7, only elements 3, 5 and 7 in the PeopleCode array are copied to the Java array, and they are copied to the elements 3, 5 and 7. This allows you to minimize the copying when you have arrays that don’t require a full element by element copy. If &RestrictionArray is not specified, a complete array copy is done.

The array types between the PeopleCode array and the Java array must match the standard type mapping between Java and PeopleCode types. For example, trying to copy a PeopleCode array of Any into a Java array of int will fail because the Any PeopleCode type doesn't map onto the Java int type.

Parameters

 JavaArray Specify the name of the Java array that you want to copy data from. &PeopleCodeArray Specify the name of an already instantiated PeopleCode array that you want to copy the data into. &RestrictionArray Specify an already instantiated and populated PeopleCode array that contains the set of elements the copy is restricted to. This array should be of type number.

Returns

None.

Example

Local array of any &x = CreateArrayAny(); &x.Push("First bit"); &x.Push(1); &x.Push(%Datetime); &x.Push(%Date); &x.Push("Final bit"); Local array of number &selection = CreateArray(1, 3, 5); Local JavaObject &Jarray = CreateJavaArray("java.lang.Object[]", &x.Len); /* Full copy to a Java array */ CopyToJavaArray(&x, &Jarray); /* Full copy from Java array to PeopleCode array */ Local array of any &y = CreateArrayAny(); &y [5] = Null; /* make sure it's the right length */ CopyFromJavaArray(&Jarray, &y);

#### CopyRow

Syntax

CopyRow(destination_row, source_row)

Description

Use the CopyRow function to copy data from one row to another row.

Note. This function remains for backward compatibility only. Use the CopyTo row class method instead.

destination_row is the row number to which you want the source _row data values copied. The two rows, and the PeopleCode function call, must all be located on the same scroll level.

Parameters

 destination_row Row number of row to which to copy data. source_row Row number of row from which to read data.

Example

This example uses CopyRow to give an inserted row the same values as the previous row:

/* Get the row number of the inserted row and the previous row */ &NEW_ROW_NUM = CurrentRowNumber(); &LAST_ROW_NUM = &NEW_ROW_NUM - 1; /* Copy the data from the previous row into the inserted row */ CopyRow(&NEW_ROW_NUM, &LAST_ROW_NUM);

#### CopyToJavaArray

Syntax

CopyToJavaArray(&PeopleCodeArray, JavaArray [, &RestrictionArray])

Description

Use the CopyToJavaArray function to copy the one-dimensional array specified by &PeopleCodeArray into the Java array JavaArray. The Java array must be at least as large as the PeopleCode array.

The optional &RestrictionArray parameter is a PeopleCode array that contains the index elements of the elements to copy. For example if &RestrictionArray contains the indexes 3, 5 and 7, only elements 3, 5 and 7 in the PeopleCode array are copied to the Java array, and they are copied to the elements 3, 5 and 7. This allows you to minimize the copying when you have arrays that don’t require a full element by element copy. If &RestrictionArray is not specified, a complete array copy is done.

The array types between the PeopleCode array and the Java array must match the standard type mapping between Java and PeopleCode types. For example, trying to copy a PeopleCode array of Any into a Java array of int will fail because the Any PeopleCode type doesn't map onto the Java int type.

Parameters

 &PeopleCodeArray Specify an already instantiated and populated one-dimentional PeopleCode array that contains the information you want to copy to a Java array. JavaArray Specify the Java array that you want to copy information into. &RestrictionArray Specify an already instantiated and populated PeopleCode array that contains the set of elements the copy is restricted to. This array should be of type number.

Returns

None.

Example

The following example creates an array, then shows both copying the full array, as well as only copying elements of it.

Local array of any &x = CreateArrayAny(); &x.Push("First bit"); &x.Push(1); &x.Push(%Datetime); &x.Push(%Date); &x.Push("Final bit"); Local array of number &selection = CreateArray(1, 3, 5); Local JavaObject &Jarray = CreateJavaArray("java.lang.Object[]", &x.Len); /* Full copy to a Java array */ CopyToJavaArray(&x, &Jarray); /* Only copy elements 1, 3 and 5 */ CopyToJavaArray(&x, &Jarray, &selection);

#### Cos

Syntax

Cos(angle)

Description

Use the Cos function to calculate the cosine of the given angle (adjacent / hypotenuse).

Parameters

Returns

A real number between -1.00 and 1.00.

Example

The following example returns the cosine of an angle measuring 1.2 radians:

&MY_RESULT = Cos(1.2);

#### Cot

Syntax

Cot(angle)

Description

Use the Cot function to calculate the cotangent of the given angle (adjacent / opposite, that is, the reciprocal of the tangent).

Parameters

 angle A value in radians, excluding 0. If the input value is 0, you receive an error message at runtime (“Decimal arithmetic error occurred. (2,110)”). Adjust your code to provide a valid input value.

Note. In theory, all values of angle such that mod(angle, pi) equals 0 are not valid for this function, because inputs approaching such values produce results that tend toward infinity. In practice, however, no computer system can represent such values exactly. Thus, for example, the statement Cot(Radians(180)) produces a number close to the largest value PeopleCode can represent, rather than an error.

Returns

A real number.

Example

The following example returns the cotangent of an angle measuring 1.2 radians:

&MY_RESULT = Cot(1.2);

#### CreateAnalyticInstance

Syntax

CreateAnalyticInstance(AnalyticType, ID, Descr, &RecordRef, ForceDelete)

Description

Use the CreateAnalyticInstance function to create an analytic instance as identified by the analytic ID. If ID is an empty string, the system automatically generates a unique ID.

This function only creates the metadata for the ID. It doesn't load the instance into an analytic server.

If this analytic instance already exists in the system, and you specify ForceDelete as false, the analytic instance is not created. If you specify ForceDelete as true, the existing analytic instance is deleted and the new one is created.

Every analytic type definition is defined with an application package that contains three methods: Create, Delete, and Copy. The values in &RecordRef are passed to the Create method.

Parameters

 AnalyticType Specify the name of the analytic type definition to be used. ID Specify the analytic instance identifier as a string. This parameter must be 20 characters or less. Descr Specify a description for this analytic instance as a string. &RecordRef Specify an already instantiated record object to pass values to the application package Create method that's associated with the analytic type definition. If you do not want to specify a record, you can specify NULL. ForceDelete Specify the behavior if the specified analytic ID already exists. This parameter takes a boolean value. If ForceDelete is set to false and the specified ID exists, this function terminates without creating a new analytic instance. If ForceDelete is set to true and the specified ID exists, the analytic instance is deleted and then recreated.

Returns

An AnalyticInstance object if successful, null otherwise.

Example

Local AnalyticInstance &pi; /* Create a brand new analytic instance */ &pi = CreateAnalyticInstance("BusinessPlanning", "Test", "PopulateTables",⇒ &argrec, True);

#### CreateArray

Syntax

CreateArray(paramlist)

Where paramlist is an arbitrary-length list of values in the form:

param1 [, param2] ...

Description

Use the CreateArray function to construct an array and returns a reference to it.

The type of the first parameter determines the type of array that is built. That is, if the first parameter is of type NUMBER, an array of number is built. If there is no first parameter an empty array of ANY is built.

The CreateArray function uses flattening and promotion as required to convert subsequent values into suitable elements of the array.

Parameters

 paramlist Specify a list of values to be used as the elements of the array.

Returns

Returns a reference to the array.

Example

Local Array of Array of Number &AAN; Local Array of Number &AN; &AAN = CreateArray(CreateArray(1, 2), CreateArray(3, 4), 5); &AN = CreateArray(6, &AAN[1]);

&AAN is a two dimensional array with three elements:

• A one-dimensional array with 1 and 2 as elements.

• A one-dimensional array with 3 and 4.

• A one-dimensional array with only the element 5.

The last parameter to Array was promoted to a one-dimensional array. &AN is a one-dimensional array with 3 elements: 6, 1, and 2. The last parameter to Array in the last line was flattened into its two elements.

#### CreateArrayAny

Syntax

CreateArrayAny([paramlist])

Where paramlist is an arbitrary-length list of values in the form:

param1 [, param2] ...

Description

Use the CreateArrayAny function to construct an array whose elements are of data type ANY and returns a reference to it.

The CreateArrayAny function uses flattening and promotion as required to convert subsequent values into suitable elements of the array.

If you do not specify any parameters with CreateArrayAny, it's the same as using the CreateArray function without any parameters.

If you do not know how many values are needed in a SQL statement until runtime, you can use an array of any to supply the values.

Parameters

 paramlist Specify a list of values to be used as the elements of the array.

Returns

Returns a reference to an array of ANY.

Example

local Array of Any &ArrayAny = CreateArrayAny(1, 2, "hi", "there"); local Array of Array of Any &AAAny = CreateArray(CreateArrayAny(1, 2), CreateArray⇒ Any("hi"), "there");

&ArrayAny is a two dimensional array with four elements: 1, 2, "hi" and "there". All the elements have the data type Any.

&AAAny is a two-dimensional array with three elements: a one-dimensional array with 1 and 2 as elements, a one-dimensional array with "hi" as its element, and a one-dimensional array with only the element "there". The last parameter to the array was promoted to a one-dimensional array.

#### CreateArrayRept

Syntax

CreateArrayRept(val, count)

Description

Use the CreateArrayRept function to create an array that contains count copies of val. If val is itself an array, the created array has one higher dimension, and each element (sub-array) is the array reference val.

The type of the first parameter (val) determines the type of array that is built. That is, if the first parameter is of type NUMBER, an array of number is built. If count is zero, CreateArrayRept creates an empty array, using the val parameter for the type.

If you are making an array that is multi-dimensional, val will be the subarray used as the elements.

To make the subarrays distinct, use the Clone method. For example:

&A = CreateArrayRept(&AN, 4).Clone();

Parameters

 val A value of any type. count The number of copies of val contained in the array.

Returns

Returns a reference to the array.

Example

The following code sets &A to a new empty array of string:

&A = CreateArrayRept("", 0);

The following code sets &A to a new array of ten zeroes:

&A = CreateArrayRept(0, 10);

The following code sets &AAS to a new array of array of strings, with two subarrays:

&AAS = CreateArrayRept(CreateArray("one", "two"), 2);

Note that in this case, both elements (rows) of &AAS contain the same subarray, and changing the value of an element in one of them changes it in both of them. To get distinct subarrays, use the Clone method:

&AAS = CreateArrayRept(CreateArray("one", "two"), 2).Clone();

The following example shows how to create a two-dimension array using CreateArrayRept and Push. In addition, it shows how to randomly assigns values to the cells in a two-dimension array.

Local array of array of string &ValueArray; &Dim1 = 10; &Dim2 = 5; &ValueArray = CreateArrayRept(CreateArrayRept("", 0), 0); For &I = 1 To &Dim1 &ValueArray.Push(CreateArrayRept("", &Dim2)); End-For; &ValueArray[1][1] = "V11"; &ValueArray[2][1] = "V21"; WinMessage("&ValueArray[1][1] = " | &ValueArray[1][1] | " " | "&ValueArray[2][1] =⇒ " | &ValueArray[2][1], 0);

#### CreateDirectory

Syntax

CreateDirectory(path, [, pathtype])

Description

Use the CreateDirectory function to create the directory specified by path and any non-existent directories specified in path.

On UNIX systems, the directory has the mode 755, that is, read-write-execute permission for the owner, while group and other have only read and execute permission.

drwxr-xr-x

Parameters

 path Specify the path to be created. pathtype If you have prepended a path to the file name, use this parameter to specify whether the path is an absolute or relative path. The valid values for this parameter are: %FilePath_Relative (default) %FilePath_Absolute If you don’t specify pathtype the default is %FilePath_Relative. If you specify a relative path, that path is appended to the path constructed from a system-chosen environment variable. A complete discussion of relative paths and environment variables is provided in documentation on the File class. If the path is an absolute path, whatever path you specify is used verbatim. You must specify a drive letter and the complete path. You can’t use any wildcards when specifying a path. The Component Processor automatically converts platform-specific separator characters to the appropriate form for where your PeopleCode program is executing. On a Windows system, UNIX "/" separators are converted to "\", and on a UNIX system, Windows "\" separators are converted to "/". Note. The syntax of the file path does not depend on the file system of the platform where the file is actually stored; it depends only on the platform where your PeopleCode is executing.

Returns

None.

Example

CreateDirectory("D:\Resumes\New_Hires", %FilePath_Absolute);

#### CreateDocument

Syntax

CreateDocument(DocumentKey | Package, DocumentName, Version)

Description

Use this method to instantiate a new Document object.

Parameters

 DocumentKey Specifies a DocumentKey object that defines the document’s package, document name, and version. Package Specifies a document package as a string. DocumentName Specifies the name of the document as a string. Note. The document name also becomes the root element name for the document. Version Specifies the document version as a string.

Returns

A Document object.

Example

The following provides two examples of instantiating a Document object. Both result in the same object.

Example 1:

Local Document &Doc; /* Instatiate the Document object */ &Doc = CreateDocument("Purchasing", "PurchaseOrder", "v1");

Example 2:

Local Document &Doc; Local DocumentKey &DocKey; /* Instatiate the Document object */ &DocKey = CreateDocumentKey("Purchasing", "PurchaseOrder", "v1"); &Doc = CreateDocument(&DocKey);

#### CreateDocumentKey

Syntax

CreateDocumentKey(Package, DocumentName, Version)

Description

Use this method to instantiate a new DocumentKey object.

Parameters

 Package Specifies a document package as a string. DocumentName Specifies the name of the document as a string. Note. The document name also becomes the root element name for the document. Version Specifies the document version as a string.

Returns

A DocumentKey object.

Example

The following provides an example of instantiating a Document object from a document key:

Local Document &Doc; Local DocumentKey &DocKey; /* Populating Document Object */ &DocKey = CreateDocumentKey("Purchasing", "PurchaseOrder", "v1"); &Doc = CreateDocument(&DocKey);

#### CreateException

Syntax

CreateException(message_set, message_num, default_txt [, subslist])

where subslist is an arbitrary-length list of substitutions of undetermined (Any) data type to be substituted in the resulting text string, in the form:

substitution1 [, substitution2]. . .

Description

Use the CreateException function to create an exception object with the given properties. You can use this in your exception handling. Use this function either in conjunction with the throw statement, or on its own to get more information of a message.

Parameters

 message_set Specify the message set number of the message you want associated with this exception. message_num Specify the message number of the message you want associated with this exception. default_txt Specify the text you want associated with the exception if the message specified by message_set and message_num isn't found. subslist A comma-separated list of substitutions; the number of substitutions in the list is arbitrary. The substitutions are referenced in the message text using the % character followed by an integer corresponding to the position of the substitution in the subslist. The number of substitutions specified with this parameter are what get counted with the exception class SubsitutionCount property.

Returns

A reference to an exception object if successful, Null otherwise.

Example

Function t2 throw CreateException(2, 160, "'%1' doesn't support property or method '%2'",⇒ "SomeClass", "SomeMethod"); End-Function;

#### CreateJavaArray

Syntax

CreateJavaArray(ElementClassName[], NumberOfElements)

Description

Use the CreateJavaArray function to create a Java array without knowing the number or value of the elements.

When you create an array in Java, you already know the number of elements in the array. If you do not know the number of elements in the array, but you want to use a Java array, use the CreateJavaArray function in PeopleCode. This creates a Java object that is a Java array, and you can pass in the number of elements that are to be in the array.

The first index in a Java array is 0. PeopleCode arrays start at 1.

Do the following to specify this type of array in Java:

new ​ElementClassName[NumberOfElements];

Parameters

 ElementClassName[] Specify the array class name. This parameter takes a string value. NumberOfElements Specify the number of elements in the array. This parameter takes a number value.

Returns

A Java object

#### CreateJavaObject

Syntax

CreateJavaObject(ClassName [ConstructorParams])

Where ConstructorParams has the form

argument1 [, argument2] . . .

Description

Use the CreateJavaObject function to create a Java object that can be manipulated in PeopleCode.

Note. If you create a class that you want to call using GetJavaClass, it can be located in a directory specified in the PS_CLASSPATH environment variable or in other specified locations. The PeopleCode API Reference provides details on where you can place custom and third-party Java classes.

Use the CreateJavaObject function to create a Java array when you know how many values it should contain. If ClassName is the name of an array class (ending with [ ]), ConstructorParams are used to initialize the array.

In Java, do the following to initialize an array:

intArray = new int[]{1, 2, 3, 5, 8, 13};

Do the following to initialize such a Java array from PeopleCode:

&IntArray = CreateJavaObject("int[]", 1, 2, 3, 5, 8, 13);

To initialize a Java array without knowing the number of parameters until runtime, use the CreateJavaArray function.

Parameters

 ClassName Specify the name of an already existing class. ConstructorParams Specify any construction parameters required for the class. Constructors are matched by construction parameter type and placement.

Returns

A Java object.

Example

The following is an example of using dot notation and CreateJavaObject.

&CHARACTER.Value = CreateJavaObject(&java_path).GetField(&java_newchar).Value; &NUMBER.Value = CreateJavaObject(&java_path).GetField(&java_newnum).Value; &DATE.Value = CreateJavaObject(&java_path).GetField(&java_newdate).Value;

#### CreateMCFIMInfo

Syntax

CreateMCFIMInfo(UserID, Network)

Description

Use the CreateMCFIMInfo function to create an instance of the MCFIMInfo class. This is used to initiate the instant messaging session.

Parameters

 UserID Specify the PeopleSoft user as a string. This is the source user, or the user issuing the presence requests. NetworkID Specify which network to use for instant messaging. The values are: AOL Yahoo

Returns

An MCFIMInfo object if successful, a null value otherwise.

#### CreateMessage

Syntax

CreateMessage(OPERATION.messagename [, message_type])

Description

Use the CreateMessage function to instantiate a message object that refers to a message definition associated with a service operation. The CreateMessage function sets the following properties for the resulting message object, based on the values set for the message definition:

• Name

• QueueName

• Active

Other properties are set when the message is published or subscribed to (TransactionID and so on,) or are dynamically generated at other times (Size, EditError, and so on.)

For rowset-based messages, CreateMessage also sets the LANGUAGE_CD field in the level 0 PSCAMA record for a message based on the USERID default language group. If the message is being published from a component, the language code is set to the USERID language code for the component. If CreateMessage is called from a PeopleSoft Application Engine program, the language code of the user who started the batch process is used.

Parameters

 OPERATION. messagename Specify the name of the message definition you want to create a message object for. message_type Specify the type of message that you want to create. Valid values are:

 Value Description %IntBroker_Request A request message. This is the default. %IntBroker_Response A response message. %IntBroker_Fault A fault message.

Returns

Returns a reference to a message object.

Example

The following example creates a request message &MSG assocaited with the service operation PURCHASE_ORDER.

Local message &MSG; &MSG = CreateMessage(OPERATION.PURCHASE_ORDER);

#### CreateObject

Syntax

CreateObject(str_class_name, create_par, . . .)

Where str_class_name either:

—identifies a class by class name

—identifies a class of OLE Automation object in the form:

app_name.object_name

Description

Use the CreateObject function to return an instance of a class. You can use this function to access an Application Class, a PeopleCode built-in object (like a chart), or an OLE Automation object.

If the class you are creating requires values to be passed, use the create_par parameters to supply them, or use the CreateObjectArray function.

Considerations Using Application Classes

You can use the CreateObject function to access an Application Class. You would want to do this when you were programming at a high-level, when you might not know the name of the class you wanted to access until runtime. You must specify a fully-qualified class name. In addition, the class name is case-sensitive.

The returned object has the type of class you specified.

Considerations Using PeopleCode Built-in Objects

For example, to generate a PeopleSoft chart object without using a chart control (that is, without using the GetChart function) you could use:

&MyChart = CreateObject("Chart");

The returned object has the type of class you specified.

Note. The only way to instantiate a crypt object is using the CreateObject function.

Considerations Using OLE Automation Objects

CreateObject returns an instance of an OLE Automation object as a variable of type Object.

The str_class_name argument uses the syntax app_name.object_type, which consists of: app_name (the name of the application providing the object) and object_type (the class or type of the object to create), separated by a period (dot).

Any application that supports OLE Automation exposes at least one type of object. For example, a spreadsheet application may provide an application object, a worksheet object, and a toolbar object.

To create an OLE Automation object, you assign the object returned by CreateObject to a variable of type Object:

local object &WORKSHEET; &WORKSHEET = CreateObject("Excel.Sheet");

After an object is created, you can reference it using the object variable. In the previous example, you access properties and methods of the new object using the ObjectGetProperty, ObjectSetProperty, and ObjectDoMethod functions.

Note. If an object has registered itself as a single-instance object, only one instance of the object can be created, even if CreateObject is executed more than once. Note also that an object assigned to a global variable is not valid across processes: that is, the scope and lifetime of the global is the same as the scope and lifetime of the instance of PeopleTools in which the object was created.

Parameters

 str_class_name Specify the name of the class that you want to instantiate an object from. create_par Specify the parameters required by the class for instantiating the object.

Example

This example instantiates an Excel worksheet object, makes it visible, names it, saves it, and displays its name. Note the use of ObjectGetProperty in the example to return the Excel.Sheet.Application object.

&WORKAPP = CreateObject("COM", "Excel.Application"); &WORKBOOKS = ObjectGetProperty(&WORKAPP, "Workbooks"); ObjectDoMethod(&WORKBOOKS, "Add", "C:\TEMP\INVOICE.XLT"); /* This associates the⇒ INVOICE template w/the workbook */ ObjectDoMethod(&WORKAPP, "Save", "C:\TEMP\TEST1.XLS"); ObjectSetProperty(&WORKAPP, "Visible", True);

This following example illustrates the creation of an application class object. This code assumes that MyBaseClass is the superclass of both MySubclass1 and MySubclass2 classes.

local MyBaseClass &mbobj; local String &ClassName = "MySubclass1"; if &test then &ClassName = "MySubclass2"; end-if; &mbobj = CreateObject(&ClassName);

The following example creates a chart in an iScript, using the CreateObject function to generate a reference to a chart object.

Function IScript_GetChartURL() Local Chart &oChart; Local Rowset &oRowset; Local string &sMap; Local string &sURL; ​&oChart = CreateObject("Chart"); ​ &oRowset = CreateRowset(Record.QE_CHART_RECORD); &oRowset.Fill("where QE_CHART_REGION= :1", "MIDWEST"); &oChart.SetData(&oRowset); &oChart.Width = 400; &oChart.Height = 300; &oChart.SetDataYAxis(QE_CHART_RECORD.QE_CHART_SALES); &oChart.SetDataXAxis(QE_CHART_RECORD.QE_CHART_PRODUCT); &oChart.SetDataSeries(QE_CHART_RECORD.QE_CHART_REGION); &oChart.HasLegend = True; &oChart.LegendPosition = %ChartLegend_Right; &sURL = %Response.GetChartURL(&oChart); &sMap = &oChart.ImageMap; %Response.Write("<HTML><IMG SRC="); %Response.Write(&sURL); %Response.Write(" USEMAP=#THEMAP></IMG><MAP NAME=THEMAP>"); %Response.Write(&sMap); %Response.Write("</MAP></HTML>"); End-Function;

#### CreateObjectArray

Syntax

CreateObjectArray(Class_Name, Array_of_Args)

Description

Use the CreateObjectArray function to return an instance of a class.

Use this function when you must pass in parameters to create the object and you don’t know when you write the code how many parameters are required. If you can create the object without passing in additional values, or if you know how many parameters are required, use the CreateObject function instead.

The array of parameters is an array of Any. It must be a one-dimensional array, that is, you cannot pass in an array of array of Any. You cannot pass in field references, that is, you cannot pass in references of the form:

RECORD.FIELDNAME

If you do not want to supply any parameters, you can use an empty array, or a reference to a Null array.

Parameters

 Class_Name Specify the name of the class you want to create an instance of, as a string. Array_Of_Args Specify an Array of Any containing all parameters for creating an instance of the class.

Returns

A reference to newly created object.

Example

The following is an example of the creation of an Application Class object where the number of parameters used to create the object varies, depending on data in the database.

local String &ClassName, &RecName; local Record &Rec; /* Read class name and parameter record name from the database. */ SQLExec("SELECT CLASSNAME, RECNAME FROM %TABLE(RECORD.CLASSDATA)", &ClassName,⇒ &RecName); local Record &Rec = CreateRecord(@ ("RECORD." | &RecName)); /* Read the parameters from the database. */ local Array of Any &Params = CreateArrayAny(); SQLExec("%SelectAll(:1)", &Rec, &Params); /* Create the object. */ local MyPackage:BaseClass &Obj = ​CreateObjectArray(&ClassName, &Params);

#### CreateProcessRequest

Syntax

CreateProcessRequest([ProcessType, ProcessName])

Description

Use the CreateProcessRequest function to create a ProcessRequest object. After you’ve created this object, you can assign values to its properties then use the Schedule method to submit the process request for scheduling.

If you specify PSJob for the process type, the ProcessRequest object contains all the items of the job.

Parameters

 ProcessType Specify the process type as a string. Values depend on the process types defined for your system. ProcessName Specify the name of the process as a string.

Returns

A reference to a ProcessRequest object.

Example

Local ProcessRequest &MYRQST; &MYRQST = CreateProcessRequest("PSJOB", &MyJobName);

#### CreateRecord

Syntax

CreateRecord(RECORD.recname)

Description

Use the CreateRecord function to create a standalone record definition and its component set of field objects. The specified record must have been defined previously, that is, it must have a record definition. However, if you are calling this function from PeopleCode associated with a page, the record does not have to be included on the current page.

The record and field objects created by this function are accessible only within PeopleCode. They can be used with any of the record and field object methods and properties. The record and field objects are automatically deleted when there are no remaining references to them stored in any variables.

The fields created by this function are initialized to null values. Default processing is not performed. No data associated with the record definition’s SQL table is brought in: only the record definition.

You can select into a record object created this way using the SelectByKey record class method. You can also select into it using the SQLExec function.

Parameters

 RECORD. recname Specify a record definition that already exists.

Returns

This function returns a record object that references a new record buffer and set of fields.

Example

Local Record &REC2; &REC2 = CreateRecord(RECORD.OPC_METH);

In the following example, a free-standing record is created (&PSBATREPREQRES). Values are assigned to the fields associated with the record. Then a second record is created (&PUBHDR), and the values from the first record are used to populate the second record.

&PSBATREPREQRES = CreateRecord(RECORD.PSBATREPREQRES); &PSBATREPREQRES.BATREPID.Value = &BATREPID; &PSBATREPREQRES.PUBID.Value = &MSG.Pubid; &PSBATREPREQRES.CHNLNAME.Value = &MSG.ChannelName; &PSBATREPREQRES.PUBNODE.Value = &MSG.PubNodeName; &PSBATREPREQRES.MSGNAME.Value = &MSG.Name; &PUBHDR = CreateRecord(RECORD.PSAPMSGPUBHDR); &PSBATREPREQRES.CopyFieldsTo(&PUBHDR);

To create a PeopleCode record object for a record whose name is unknown when the PeopleCode is written, do the following.

Suppose a record name is in the PeopleCode variable &RECNAME. Use the @ operator to convert the string to a component name. The following code creates a corresponding record object:

&RECNAME = "RECORD." | Upper(&RECNAME); &REC = CreateRecord(@ &RECNAME);

The following example uses SQLExec to select into a record object, based on the effective date.

Local Record &DST; &DST = ​CreateRecord(RECORD.DST_CODE_TBL); &DST.SETID.Value = GetSetId(FIELD.BUSINESS_UNIT, DRAFT_BU, RECORD.DST_CODE_TYPE,⇒ ""); &DST.DST_ID.Value = DST_ID_AR; SQLExec("%SelectByKeyEffDt(:1,:2)", &DST, %Date, &DST); /* do further processing using record methods and properties */

#### CreateRowset

Syntax

CreateRowset({RECORD.recname | &Rowset} [, {FIELD.fieldname, RECORD.recname | &Rowset}] . . .)

Description

Use the CreateRowset function to create an unpopulated, standalone rowset.

A standalone rowset is a rowset that has the specified structure, but is not tied to any data (that is, to the component buffer or to a message.) In addition, a standalone rowset isn’t tied to the Component Processor. When you fill it with data, no PeopleCode runs (like RowInsert, FieldDefault, and so on.)

The first parameter determines the structure of the rowset to be created.

If you specify a record as the first parameter, it’s used as the primary level 0 record. If you don’t specify any other parameters, you create a rowset containing one row, with one unpopulated record. To populate this type of rowset with data, you should only use:

• the Fill or FillAppend rowset class methods

• a record method (SelectByKey)

• the SQLExec function

If you specify a rowset object, you are creating a new rowset based on the structure of the specified rowset object, including any child rowsets. It will not contain any data. If you want to populate this type of rowset with data, use the CopyTo method or a SQL statement.

Note. You should not use the rowset Select or SelectNew methods for populating rowsets created using CreateRowset. Use Fill or FillAppend instead.

Restrictions on Using CreateRowset

The following methods and properties don’t work with a rowset created using CreateRowset:

• Select

• SelectNew

• Any GUI methods (like HideAllRows)

• Any effective date methods or properties (like EffDt, EffSeq, or GetCurrEffRow)

In addition, rowsets created using CreateRowset are not automatically tied to the database. This means if you insert or delete rows, the rows will not be inserted or deleted in the database when you save the page.

Parameters

 RECORD.recname | &Rowset Specify either a record name or an existing rowset object. FIELD.fieldname, RECORD.recname | &Rowset Use FIELD.fieldname, RECORD.recname to specify a related display record. FIELD.fieldname refers to the controlling field, (not the related display field) while RECORD.recname refers to the related display record. If you specify &rowset, you are adding a child rowset object to the newly created rowset. This must be an existing rowset object.

Returns

An unpopulated, standalone rowset object.

Example

The following creates a simple rowset of just a single record per row:

&RS = CreateRowset(RECORD.QA_MYRECORD);

The following creates a rowset with the same structure as the specified rowset:

&RS2 = CreateRowset(&RS);

The following code creates a rowset structure composed of four records in an hierarchical structure, that is,

QA_INVEST_HDR QA_INVEST_LN QA_INVEST_TRANS QA_INVEST_DTL

Note that you have to start at the bottom of the hierarchy, and add the upper levels, not the other way around.

Local Rowset &RS, &RS2, &RS_FINAL; &RS2 = CreateRowset(RECORD.QA_INVEST_DTL); &RS = CreateRowset(RECORD.QA_INVEST_TRANS, &RS2); &RS2 = CreateRowset(RECORD.QA_INVEST_LN, &RS); &RS_FINAL = CreateRowset(RECORD.QA_INVEST_HDR, &RS2);

The following example reads all of the QA_MYRECORD records into a rowset, and returns the number of rows read:

&RS = CreateRowset(RECORD.QA_MYRECORD); &NUM_READ = &RS.Fill();

To make a clone of an existing rowset, that is, to make two distinct copies, you can do the following:

&RS2 = CreateRowset(&RS); &RS.CopyTo(&RS2);

The following code example is used for creating multiple children in a standalone rowset:

Local Rowset &rsBOCMRole, &rsBOCMRel, &rsBOCMUse; &rsBOCMRole = CreateRowset(Record.BO_CM_ROLE); &rsBOCMRel = CreateRowset(Record.BO_CM_REL); &rsBOCMUse = CreateRowset(Record.BO_CM_USE); &rsBOCM = CreateRowset(Record.BO_CM, &rsBOCMUse, &rsBOCMRole, &rsBOCMRel);

#### CreateRowsetCache

Syntax

CreateRowsetCache(&Rowset, [Rowset.]Name, Description)

Description

Use the CreateRowsetCache function to create a new RowsetCache object with the given name if it doesn't already exist.

Parameters

 &Rowset Specify an already instantiated and populated rowset that you want to use for creating a RowsetCache object. The RowsetCache object will have the same format and data as &Rowset. Record. Name Specify the name of the created RowsetCache object. If you just specify name, you must enclose the name in quotation marks. Description Specify a description of the RowsetCache as a string.

Returns

A reference to the new RowsetCache object if there is not already a RowsetCache object of the given name.

Example

Local RowsetCache &Cache; Local Rowset &RS; &RS = CreateRowset(Record.PSLANGUAGES); &NUM_READ = &RS.Fill(); &Cache = CreateRowsetCache(&RS, "AAROWSET1", "ROWSET_AAROWSET1");

#### CreateSOAPDoc

Syntax

CreateSOAPDoc()

Description

Use the CreateSOAPDoc function to create an empty SOAPDoc object. Then use the SOAPDoc class methods and properties, as well as the XmlDoc class methods and properties to populate the SOAPDoc object.

Parameters

None.

Returns

A reference to a SOAPDoc object.

Example

Local SOAPDoc &MyDoc; &MyDoc = CreateSOAPDoc();

#### CreateSQL

Syntax

CreateSQL([{sqlstring | SQL.SqlName}[, paramlist]])

Where paramlist is an arbitrary-length list of values in the form:

inval1 [, inval2] ...

Description

Use the CreateSQL function to instantiate a SQL object from the SQL class and opens it on the given sqlstring and input values. sqlstring is a PeopleCode string value giving the SQL statement.

Any errors in the SQL processing cause the PeopleCode program to be terminated with an error message.

You can use CreateSQL with no parameters to create an empty SQL object that can be used to assign properties before being populated and executed.

Opening and Processing sqlstring

If sqlstring is a SELECT statement, it is immediately bound with the inval input values and executed. The SQL object should subsequently be the subject of a series of Fetch method calls to retrieve the selected rows. If you want to fetch only a single row, use the SQLExec function instead. If you want to fetch a single row into a PeopleCode record object, use the record Select method.

If sqlstring is not a SELECT statement, and either there are some inval parameters, or there are no bind placeholders in the SQL statement, the statement is immediately bound and executed. This means that there is nothing further to be done with the SQL statement and the IsOpen property of the returned SQL object will be False. In this case, using the SQLExec function would generally be better. If you want to delete, insert or update a record object, use the record Delete, Insert, or Update methods.

If sqlstring is not a SELECT statement, there are no inval parameters, and there are bind placeholders in the SQL statement, the statement is neither bound nor executed. The resulting SQL object should subsequently be the subject of a series of Execute method calls to affect the desired rows.

Using Arrays with paramlist

You can use a parameter of type "Array of Any" in place of a list of bind values or in place of a list of fetch result variables. This is particularly useful when fetching an unknown number of results.

&Sql1 = CreateSql("Select * from " | &TableName); &AAny = CreateArrayAny(); While &Sql1.Fetch(&AAny) /* Process the row in &AAny. */ ... End-While;

Because the Array of Any promotes to absorb any remaining select columns, it must be the last parameter for the SQL object Fetch method or (for results) SQLExec. For binding, it must be the only bind parameter, as it is expected to supply all the bind values needed.

Parameters

 sqlstring| SQL.SqlName Specify either a SQL string containing the SQL command to be created or a reference to an existing SQL definition. This string can include bind variables, inline bind variables, and meta-SQL. paramlist Specify input values for the SQL string.

Returns

None.

Example

This SQL object should be used in a series of Fetch method calls:

Local SQL &SQL; &SQL = CreateSQL("%SelectAll(:1) where EMPLID = :2", RECORD.ABSENCE_HIST, &EMPLID);

This SQL object has been opened, bound, and is already closed again:

&SQL = CreateSQL("Delete from %Table(:1) where EMPLID = :2", RECORD.ABSENCE_HIST,⇒ &EMPLID);

This SQL object should be used in a series of Execute method calls:

&SQL = CreateSQL("Delete from %Table(:1) where EMPLID = :2");

This SQL object is created as an empty object in order to set properties before being executed:

&Sql = CreateSQL(); &Sql.Tracename = "SQL1"; &Sql.ReuseCursor = True; &Sql.Open(......); /* do the deed */

#### CreateWSDLMessage

Syntax

CreateWSDLMessage(MessageName, ChannelName)

Description

Use the CreateWSDLMessage function to create an unstructured message. This function creates both the message as well as the channel.

This function has been deprecated. It is no longer supported.

#### CreateXmlDoc

Syntax

CreateXmlDoc(XmlString, DTDValidation)

Description

Use the CreateXmlDoc function to create an XmlDoc object. If you specify a Null string for XmlString (""), you create an empty XmlDoc object.

Considerations Using CreateXmlDoc

The following coding is either ignored or removed from the XmlDoc object that is created with this function:

• encoding attributes

PeopleSoft only supports UTF-8 encoding. Any specified encoding statement is removed, as all XmlDoc objects are considered UTF-8.

• version attributes

Regardless of what version is specified in XmlString, the version attribute in the generated XmlDoc object is 1.0.

Parameters

 XmlString Specify an XML string that you want to convert into an XmlDoc object that you can then manipulate using PeopleCode. You can also specify a Null string ("") to generate an empty XmlDoc object. DTDValidation Specify whether a DTD should be validated. This parameter takes a boolean value. If you specify true, the DTD validation occurs if a DTD is provided. If you specify false, and if a DTD is provided, it is ignored and the XML isn't validated against the DTD. False is the default value. In the case of application messaging, if a DTD is provided, it's always ignored and the XML isn't validated against the DTD. If the XML cannot be validated against a DTD, an error is thrown saying that there was an XML parse error.

Returns

A reference to the newly created XmlDoc object.

Example

The following creates an empty XmlDoc object.

Local XmlDoc &MyDoc; &MyDoc = CreateXmlDoc("");

#### CubicSpline

Syntax

CubicSpline(DataPoints, Control_Option, Left_Constraint, Right_Constraint)

Description

Use the CubicSpline function to compute a cubic spline interpolation through a set of at least four datapoints.

Parameters

 DataPoints This parameter takes an array of array of number. The array’s contents are an array of six numbers. The first two of these six numbers are the x and y points to be fit. The last four are the four coefficients to be returned from the function: a, b, c and d. a is the coefficient of the x0 term, b is the coefficient of the x1 term, c is the coefficient of the x2 term, and d is the coefficient of the x3 term. Control_Option Specifies the control option. This parameter takes either a number or constant value. The values are:

 Numeric Value Constant Value Description 0 %SplineOpt_SlEstEst Generate an internal estimate of the beginning and ending slope of the cubic piecewise equations 1 %SplineOpt_SlSetEst Use the user-specified value for the slope of the leftmost point, and generate an estimate for the rightmost point 2 %SplineOpt_SlEstSet Use the user-specified value for the slope of the rightmost point, and generate an estimate for the leftmost point 3 %SplineOpt_SlSetSet Use the user-specified values for the slopes of the leftmost and rightmost points 4 %SplineOpt_CvEstEst Generate an internal estimate of the beginning and ending curvature of the cubic piecewise equations 5 %SplineOpt_CvSetEst Use the user-specified value for the curvature of the leftmost point, and generate an estimate for the rightmost point 6 %SplineOpt_CvEstSet Use the user-specified value for the curvature of the rightmost point, and generate an estimate for the leftmost point 7 %SplineOpt_CvSetSet Use the user-specified values for the curvatures of the leftmost and rightmost points 8 %SplineOpt_ClEstEst Generate an internal estimate of the beginning and ending curl of the cubic piecewise equations 9 %SplineOpt_ClSetEst Use the user-specified value for the curl of the leftmost point, and generate an estimate for the rightmost point 10 %SplineOpt_ClEstSet Use the user-specified value for the curl of the rightmost point, and generate an estimate for the leftmost point 11 %SplineOpt_ClSetSet Use the user-specified values for the curls of the leftmost and rightmost points 12 %SplineOpt_Natural Generate a “natural” spline 13 %SplineOpt_ContCurl Generate a spline wherein the equation for the first segment is the exact same equation for the second segment, and where the equation for the penultimate segment is the same as the equation for the last segment.

 Left_Constraint A single number for the constraint for the left point. Specify a zero if this parameter isn’t needed. Right_Constraint A single number for the constraint for the right point. Specify a zero if this parameter isn’t needed.

Returns

A modified array of array of numbers. The elements in the array correspond to the elements in the array used for DataPoints.

#### CurrEffDt

Syntax

CurrEffDt([level_num])

Description

Use the CurrEffDt function to return the effective date of the specified scroll level as a Date value.

Note. This function remains for backward compatibility only. Use the EffDt rowset class property instead.

If no level is specified, CurrEffDt returns the effective date of the current scroll level.

Returns

Returns a Date value equal to the current effective date of the specified scroll level.

Example

If INSTALLATION.POSITION_MGMT = "P" Then If All(POSITION_NBR) Then If (EFFDT = CurrEffDt(1) and EFFSEQ >= CurrEffSeq(1)) or (EFFDT > CurrEffDt(1) and EFFDT = %Date) Then Gray_employment( ); End-if; End-if; End-if;

#### CurrEffRowNum

Syntax

CurrEffRowNum([level_num])

Description

Use the CurrEffRowNum function to return the effective row number of the selected scroll level.

Note. This function remains for backward compatibility only. Use the RowNumber row class property, in combination with the GetCurrEffRow rowset method, instead.

If no level is specified, it returns the effective row number of the current level.

Example

&ROW = CurrEffRowNum(1);

#### CurrEffSeq

Syntax

CurrEffSeq([level_num])

Description

Use the CurrEffSeq function to determine the effective sequence of a specific scroll area.

Note. This function remains for backward compatibility only. Use the EffSeq rowset class property instead.

If no level is specified, CurrEffSeq returns the effective sequence of the current scroll level.

Returns

Returns a Number representing the effective sequence of the specified scroll level.

Example

If INSTALLATION.POSITION_MGMT = "P" Then If All(POSITION_NBR) Then If (EFFDT = CurrEffDt(1) and EFFSEQ >= CurrEffSeq(1)) or (EFFDT > CurrEffDt(1) and EFFDT = %Date) Then Gray_employment( ); End-if; End-if; End-if;

#### CurrentLevelNumber

Syntax

CurrentLevelNumber()

Description

Use the CurrentLevelNumber function to return the scroll level where the function call is located.

Returns

Returns a Number value equal to the scroll level where the function is being called. The function returns 0 if the field where the function is called is not in a scroll area.

Example

&LEVEL = CurrentLevelNumber();

#### CurrentRowNumber

Syntax

CurrentRowNumber([level])

Description

Use the CurrentRowNumber function to determine the row number of the row currently displayed in a specific scroll area.

Note. This function remains for backward compatibility only. Use the RowNumber row class property instead.

This function can determine the current row number on the level where the function call resides, or on a higher scroll level. It won’t work on a scroll level below the one where the PeopleCode program resides.

Parameters

 level A Number specifying the scroll level from which the function returns the current row number. If the level parameter is omitted, it defaults to the scroll level where the function call resides.

Returns

Returns a Number value equal to the current row number on the specified scroll level. The current number is the row where the PeopleCode program is being processed, or, if level specifies a higher level scroll, CurrentRowNumber returns the row number of the parent or grandparent row.

Example

CurrentRowNumber is typically used in component buffer functions to return the current row of the parent scroll of the target:

&VAL = FetchValue(RECORD.BUS_EXPENSE_PER, CurrentRowNumber(), BUS_EXPENSE_⇒ DTL.CHARGE_DT, &COUNT);

The following example checks if the current row number is equal to the active row count (that is, whether the active row is the last record on the scroll):

If CurrentRowNumber() = ActiveRowCount(EMPLID) Then det_employment_dt(); End-if;

#### Date

Syntax

Date(date_num)

Description

The Date function takes a number in the form YYYYMMDD and returns a corresponding Date value. If the date is invalid, Date displays an error message.

Warning! Make sure that you pass a four-digit year in the year parameter of this function. Two-digit values are interpreted literally: 93, for example, represents the year 93 AD.

Returns

Returns a date equal to the date specified in date_num.

Example

Set the temporary variable &HIREDate to a date field containing the date July 1, 1997:

&HIREDate = Date(19970701);

#### Date3

Syntax

Date3(year, month, day)

Description

The Date3 function accepts a date expressed as three integers: year, month, and day. It returns a corresponding Date value. If the date is invalid, the Date3 displays an error message.

Warning! Make sure that you pass a four-digit year in the year parameter of this function. Two-digit values will be interpreted literally: 93, for example, represents the year 93 AD.

Parameters

 year An integer for the year in the form YYYY. month An integer from 1 to 12 designating the month. day An integer from 1 to 31 designating the day of the month.

Returns

Returns a Date value equal to the date specified in the function parameters.

Example

The following PeopleCode Date3 function returns the first day of the year in which the employee was hired:

Date3(HIRE_YEAR, 1, 1);

#### DatePart

Syntax

DatePart(datetime_value)

Description

Use the DatePart function to determine a date based on a provided DateTime value.

Returns

Returns a Date value equal to the date part of a specified DateTime value.

Example

The following statement sets &D2 to a Date value for 11/12/1997:

&D1 = DateTimeValue("11/12/1997 10:23:15 AM"); &D2 = DatePart(&D1);

#### DateTime6

Syntax

DateTime6(year, month, day, hour, minute, second)

Description

The DateTime6 function returns a DateTime value based on integer values for the year, month, day, hour, minute, and second. If the result of this function is not an actual date, there is a runtime error.

Warning! Make sure that you pass a four-digit year in the year parameter of this function. Two-digit values will be interpreted literally: 93, for example, represents the year 93 AD.

Parameters

 year A four-digit number representing the year. month A number between 1 and 12 representing the month. day A number representing the day of the month. hour A number from 0 to 23 representing the hour of the day. minute A number from 0 to 59 representing the minute of the hour. second A number from 0 to 59.999999 representing seconds.

Returns

Returns a DateTime value based on the integers provided.

Example

The following example sets &DTTM to a DateTime value equal to 10:09:20 on March 15, 1997:

&DTTM = DateTime6(1997, 3, 15, 10, 9, 20);

#### DateTimeToHTTP

Syntax

DateTimeToHTTP(datetime)

Description

Use the DateTimeToHTTP function to convert any DateTime value to a date/time string in the format specified by HTTP 1.0 and 1.1 standards.

Note. Because the HTTP protocol is used to interchange information between diverse computing systems, the value returned from this function is always the ”US English” form of weekdays and months. If you want the value to use the localized form, use the DateTimeToLocalizeString function instead.

The standard HTTP date/time has the following fixed length format:

<dow><,><sp><dd><sp><mon><sp><year><sp><hh><:><mm><:><ss><sp><GMT>

where:

 Value Description a 3-character day of week name, one of Sun, Mon, Tue, Wed, Thu, Fri, Sat. <,> a literal comma character a literal space character
a 2-digit day of month, such as 02 or 22. is a 3-character month name, one of Jan, Feb, Mar, and so on. a 4-digit year number a 24-hour hour number, such as 00 or 13 a 2-digit minute number, such as 01 or 56 a 2-digit second number, such as 03 or 59 a literal 3-character GMT.

As indicated by the trailing GMT, this date/time format is always expressed in GMT (or UTC, which is declared to be the same for the purposes of HTTP).

Parameters

 datetime Specify the DateTime value you want converted to HTTP format. This DateTime is assumed to be in the base time zone of the installation.

Returns

A string containing the converted HTTP date/time.

Example

#### DateTimeToISO

Syntax

DateTimeToISO(textdatetime)

Description

Use the DatetimeToISO function to convert the text value textdatetime (as a base time zone time) to a DateTime value in ISO 8601 format. This function automatically calculates whether daylight saving time is in effect for the given textdatetime.

The system’s base time zone is specified in the PSOPTIONS table.

Parameters

 textdatetime Specify a date/time represented as text in the ISO 8601 format: YYYY-MM-DDThh:mm:ss[.S]TZD (for example, 1999-01-01T19:20:30.000000+0800) In which: YYYY is a four-digit year. MM is a two-digit month (01 through 12). DD is a two-digit day of the month (01 through 31). hh is a two digits of hour (00 through 23). mm is a two digits of minute (00 through 59). ss is two digits of second (00 through 59). S is milliseconds in one or up to six digits. TZD is a time zone designator (Z, +/-hh:mm or +/-hhmm).

Returns

Returns a DateTime value in ISO 8601 format.

Example

In the following example, assuming the base time (as defined in PSOPTIONS) is PST, &DATETIME would have a DateTime value of "1999-01-01T01:00:00.000000-08:00":

&DATETIME= DateTimeToISO("1999-01-01 01:00:00.000000");

#### DateTimeToLocalizedString

Syntax

DateTimeToLocalizedString({datetime | date}, [Pattern])

Description

Use the DateTimeToLocalizedString function to convert either datetime or date to a localized string. You can also specify a particular pattern to convert datetime or date to.

The Pattern is optional. Only specify Pattern if necessary.

If you need to change the pattern for each language, change the first message in Message Catalog set number 138. This is a format for each language.

Parameters

 datetime | date Specify either the DateTime or Date value that you want to convert. Pattern Specify the pattern you want to the localized DateTime or Date value to be converted to.

Using the Pattern Parameter

Pattern takes a string value, and indicates how you want the DateTime or Date value converted.

The valid values for Pattern are as follows.

Note. The values for pattern are case-sensitive. For example, if you specify a lowercase m, you get minutes, while an uppercase M displays the month.

 Symbol Definition Type Example G Era designator Text AD y Year Number 1996 M Month in year Text&Number July&07 d Day in month Number 10 h Hour in am/pm Number (1-12) 12 H Hour in day Number (0-23) 0 m Minute in hour Number 30 s Second in minute Number 55 S Millisecond Number 978 E Day in week Text Tuesday a am/pm marker Text PM k Hour in day Number (1-24) 24 K Hour in am/pm Number (0-11) 0 ' Escape for text Delimiter '' Single quote Literal '

The number of pattern letters determine the format.

 Type Pattern Format Text If 4 or more pattern letters are used, the full form is used. If less than 4 pattern letters are used, the short or abbreviated form is used if one exists. Number Use the minimum number of digits. Shorter numbers are zero-padded to this amount. The year is handled specially; that is, if the count of 'y' is 2, the year is truncated to 2 digits. Text&Number If 3 or more pattern letters are used, text is used, otherwise, a number is used.

Any characters in Pattern are not in the ranges of ['a'..'z'] and ['A'..'Z'] are treated as quoted text. For instance, characters like ':', '.', ' ', '#' and '@' appear in the resulting string even they're not within single quotes.

A pattern containing any invalid pattern letter results in a runtime error.

Examples using a United States locale:

 Pattern Result "yyyy.MM.dd G 'at' hh:mm:ss" 1996.07.10 AD at 15:08:56 "EEE, MMM d, ''yy" Wed, July 10, '96 "h:mm a" 12:08 PM "hh 'o''clock' a" 12 o'clock PM "K:mm a" 0:00 PM "yyyyy.MMMMM.dd GGG hh:mm aaa" 1996.July.10 AD 12:08 PM

Returns

A string.

Example

REM**************************************************************; Function ConvertDateToDTTM(&Date As date) Returns DateTime ; REM ***********************************************************; &String = ​DateTimeToLocalizedString(&Date, "M/d/y"); &String = &String | " 00:00:00.000000"; &DateTime = DateTimeValue(&String); Return &DateTime; End-Function;

#### DateTimeToTimeZone

Syntax

DateTimeToTimeZone(OldDateTime, SourceTimeZone, DestinationTimeZone)

Description

Use the DateTimeToTimeZone function to convert DateTime values from the DateTime specified by SourceTimeZone to the DateTime specified by DestinationTimeZone.

Considerations Using this Function

Typically, this function is used in PeopleCode, not for displaying time. If you take a DateTime value, convert it from base time to client time, then try to display this time, depending on the user settings, when the time is displayed the system might try to do a second conversion on an already converted DateTime. This function could be used as follows: suppose a user wanted to check to make sure a time was in a range of times on a certain day, in a certain timezone. If the times were between 12 AM and 12 PM in EST, these resolve to 9 PM and 9 AM PST, respectively. The start value is after the end value, which makes it difficult to make a comparison. This function could be used to do the conversion for the comparison, in temporary fields, and not displayed at all.

Parameters

 OldDateTime Specify the DateTime value to be converted. SourceTimeZone Specify the time zone that OldDateTime is in. Valid values are: timezone - a time zone abbreviation or a field reference to be used for converting OldDateTime. Local - use the local time zone for converting OldDateTime. Base - use the base time zone for converting OldDateTime. DestinationTimeZone Specify the time zone that you want to convert OldDateTime to. Valid values are: timezone - a time zone abbreviation or a field reference to be used for converting OldDateTime. Local - use the local time zone for converting OldDateTime. Base - use the base time zone for converting OldDateTime.

Returns

A converted DateTime value.

Example

The following example. TESTDTTM, is a DateTime field with a value 01/01/99 10:00:00. This example converts TESTDTTM from Pacific standard time (PST) to eastern standard time (EST).

&NEWDATETIME = DateTimeToTimeZone(TESTDTTM, "PST", "EST");

&NEWDATETIME will have the value 01/01/99 13:00:00 because EST is three hours ahead of PST on 01/01/99, so three hours are added to the DateTime value.

#### DateTimeValue

Syntax

DateTimeValue(textdatetime)

Description

Use the DateTimeValue function to derive a DateTime value from a string representing a date and time.

Using this Function in Fields Without a Default Century Setting

This function may derive the wrong century setting if passed a two-character year and DateTimeValue is executing in a PeopleCode event not associated with a field that has a default century setting.

For example, assume that TEST_DATE is a date field with a default century setting of 10. TEST_FIELD is a field with no default century setting. If the following PeopleCode program is executing in TEST_FIELD, the date will be calculated incorrectly:

TEST_DATE = DateTimeValue("10/13/11 15:34:25");

Although TEST_DATE has a century setting, it isn’t used because the PeopleCode fired in TEST_FIELD. Instead, DateTimeValue uses the 50/50 rule and calculates the year to be 2011 (instead of 1911).

Parameters

 textdatetime Specify a date/time value represented as text in one of three formats: MM/DD/YY[YY] hh:mm:ss.ssssss [{AM|PM}] MM.DD.YY[YY] hh:mm:ss.ssssss [{AM|PM}] YYYY-MM-DDThh:mm:ss[.S]TZD (that is, ISO 8601 format—for example, 1999-01-01T19:20:30.000000+0800) In which: YY[YY] is a two- or four-digit year. YYYY is a four-digit year. MM is a two-digit month (01 through 12). DD is a two-digit day of the month (01 through 31). hh is a two digits of hour (00 through 23). mm is a two digits of minute (00 through 59). ss is two digits of second (00 through 59). ssssss is six digits of milliseconds. S is milliseconds in one or up to six digits. TZD is a time zone designator (Z, +/-hh:mm or +/-hhmm).

Returns

Returns a DateTime value.

Example

Both of the following examples set &Date_TIME to a DateTime value equal to October 13, 1997 10:34:25 PM.:

&Date_TIME = DateTimeValue("10/13/97 10:34:25 PM"); &Date_TIME = DateTimeValue("10/13/97 22:34:25");

Assuming the base time (as defined in PSOPTIONS) is PST, the following three examples set &Date_TIME to a DateTime value equal to 2009-12-31-22.30.40.120000 UTC:

&Date_Time = DateTimeValue("2010-01-01 06:30:40.12Z"); &Date_Time = DateTimeValue("2010-01-01 00:30:40.12-0600"); &Date_Time = DateTimeValue("2010-01-01 10:30:40.12+04:00");

#### DateValue

Syntax

DateValue(date_str)

Description

Use the DateValue function to convert a date string and returns the result as a Date type. date_str must be a string in the active date format user's current personalization date format.

If the user's Date Format personalization setting is set to DDMMYY (or it is defaulted to this from their browser locale or the system-wide personalization defaults) then the following code returns a Date value equal to September 10, 1997.

&DTM = DateValue("10/09/97");

If the user's Date Format personalization setting is set to MMDDYY (or it is defaulted to this from their browser locale or the system-wide personalization defaults) then the same function call returns a value equal to October 9, 1997.

Using this Function in Fields Without a Default Century Setting

This function may derive the wrong century setting if passed a 2-character year and DateValue is executing in a PeopleCode event not associated with a field that has a default century setting.

For example, assume that TEST_DATE is a date field with a default century setting of 10. TEST_FIELD is a field with no default century setting. If the following PeopleCode program is executing in TEST_FIELD, the date will be calculated incorrectly:

TEST_DATE = DateValue("10/13/11");

Though TEST_DATE has a century setting, it isn’t used because the PeopleCode fired in TEST_FIELD. Instead, DateValue uses the 50/50 rule and calculates the year to be 2011 (instead of 1911).

Returns

Returns a Date value.

#### Day

Syntax

Day(dt_val)

Description

Use the Day function to determine an integer representing the day of the month based on a Date or DateTime value.

Returns

Returns a Number value equal to the day of the month for dt_val. The return value is an integer from 1 to 31.

Example

If HIRE_DATE is November, 1, 1997, the following Day function returns the integer 1:

&FIRST_DAY = Day(HIRE_DATE);

#### Days

Syntax

Days(dt_val)

Description

Use the Days function to returns the Julian date for the dt_val specified. This function accepts a Date, DateTime, or Time value parameter.

Returns

Returns a Number value equal to the Julian date for dt_val.

Example

To find the number of days between two dates, use the Days function on both dates, and subtract one from the other:

&NUM_DAYS = Abs(Days(HIRE_Date) - Days(RELEASE_Date));

#### Days360

Syntax

Days360(date_val1, date_val2)

Description

Use the Days360 function to return the number of days between the Date values date_val1 and date_val2 using a 360-day year (twelve 30-day months). Use this function to help compute payments if your accounting system is based on twelve 30-day months.

If date_val2 occurs before date_val1, Days360 returns a negative number.

Example

The following example sets &NUMDAYS to the number of days between TERM_START_DT and PMT_DT based on a 360-day calendar:

&NUMDAYS = Days360(TERM_START_DT, PMT_DT);

#### Days365

Syntax

Days365(date_val1, date_val2)

Description

Use the Days365 function to return the number of days between the Date values date_val1 and date_val2 using a 365-day year. Use this function to help compute payments if your accounting system is based on a 365-day year.

If date_val2 occurs before date_val1, Days365 returns a negative number.

Returns

Returns a Number value equal to the number of days between the two dates in a 365-day calendar.

Example

The following example sets &NUMDAYS to the number of days between and TERM_START_DT and PMT_DT, based on a 365-day calendar:

&NUMDAYS = Days360(TERM_START_DT, PMT_DT);

#### DBCSTrim

Syntax

DBCSTrim(source_str)

Description

Note. This function has been deprecated.

Use the DBCSTrim function to remove a trailing DBCS lead byte at the end of the string.

#### DBPatternMatch

Syntax

DBPatternMatch(Value, Pattern, CaseSensitive)

Description

Use the DBPatternMatch function to match the string in Value to the given pattern.

You can use wildcard characters % and _ when searching. % means find all characters, while _ means find a single character. For example, if you wanted to find if the string in Value started with the letter M, you'd use "M%" for Pattern. If you wanted to find either DATE or DATA, use "DAT_" for Pattern.

These characters can be escaped (that is, ignored) using a \. For example, if you want to search for a value that contains the character %, use \% in Pattern.

If Pattern is an empty string, this function retrieves the value just based on the specified case-sensitivity (that is, specifying "" for Pattern is the same as specifying "%").

Parameters

 Value Specify the string to be searched. Pattern Specify the pattern to be used when searching. CaseSensitive Specify whether the search is case-sensitive. This parameter takes a Boolean value: True, the search is case-sensitive, False, it is not.

Returns

Returns a Boolean value. True if the string matches the pattern, False otherwise.

#### DeChunkText

Syntax

DeChunkText(table_name, seq_field, data_field, &array_of_keys, &array_of_key_datatypes, &array_of_key_values)

Description

Use the DeChunkText function to read the chunks created by the ChunkText function from a database table and assemble them back into a long text string.

Parameters

 table_name Specify the name of the database table as a string. This table stores the chunks created by ChunkText. seq_field Specify the name of the field that stores the sequence number for each chunk as a string. data_field Specify the name of the field that stores the data chunks as a string. &array_of_keys Specify key field names as an array of string. &array_of_key_datatypes Specify the types for the key fields as an array of string. See below. &array_of_key_values Specify the key field values as an array of string.

The values for &array_of_key_datatypes can be as follows:

 Value Description STR String value CHAR Single character LONGTEXT Long text value DATE Date value TIME Time value DATETIME Date/time value INT Integer value SHORT Short integer value LONG Long integer value DOUBLE Double-sized integer value

Returns

A string.

Example

Local array of string &key_names; Local array of string &keyfdatatypes; Local array of string &key_vals; Local string &text; &tablename = "PSPCMTXT"; &seq_fld = "SEQNUM"; &data_fld = "PEOPLECODE"; &key_names = CreateArray("OBJECTID1", "OBJECTVALUE1", "OBJECTID2", "OBJECTVALUE2",⇒ "OBJECTID3", "OBJECTVALUE3"); &keyfdatatypes = CreateArray("INT", "STR", "INT", "STR", "INT", "STR"); &key_vals = CreateArray("1", "PSTRANSFRM_WRK", "2", "IB_TRANSFORM_PB", "12",⇒ "FieldChange"); &text = DeChunkText(&tablename, &seq_fld, &data_fld, &key_names, &keyfdatatypes,⇒ &key_vals);

#### Declare Function

Syntax

PeopleCode Function Syntax

Declare Function function_name PeopleCode record_name.field_name event_type

External Library Function Syntax

Declare Function function_name Library lib_name [Alias module_name ] [paramlist] [Returns ext_return_type [As pc_type]]

In which paramlist is:

([ext_param1 [, ext_param2] . . .)

And in which ext_param1, ext_param2, and so on is:

ext_datatype [{Ref|Value}] [As pc_return_type]

Description

PeopleCode can call PeopleCode functions defined in any field on any record definition. You can create special record definitions whose sole purpose is to serve as function libraries. By convention, PeopleCode functions are stored in FieldFormula PeopleCode, in record definitions with names beginning in FUNCLIB_.

PeopleCode can also call external programs that reside in dynamic link libraries. You must declare either of these types of functions at the top of the calling program using the Declare Function statement.

To support processes running on an application server, you can declare and call functions compiled in dynamic link libraries on windows (*.DLL files) and shared libraries on UNIX (lib*.so files.) The PeopleCode declaration and function call syntax is the same regardless of platform, but UNIX libraries must be compiled with an interface function.

PeopleCode Functions

You can call a PeopleCode function defined on any record definition, provided you declare it at the top of the calling program. The declaration identifies the function name, as well as the record, field, and event type where the function definition resides. The function parameters and return type are not declared; they are determined from the function definition.

Note. You can define functions only in record field PeopleCode. You can’t define functions in component PeopleCode, component record Field PeopleCode, and so on.

External Library Functions

Function declarations define routines in an external (C-callable) library. The function declaration provides the name of the library, an optional alias module_name, a list of parameters to pass to the function, an optional Returns clause specifying the type of any value returned by the external function, and the PeopleCode data type into which to convert the returned value. The library must be a DLL accessible by Windows or a shared library accessible by UNIX.

After you have declared an external library function, you can call it the same way as an external PeopleCode function. Like PeopleCode functions, you must pass the number of parameters the library function expects. Calls to external functions suspend processing: this means that you should exercise caution to avoid “think-time” errors when calling the function in the following PeopleCode events:

• SavePreChange.

• SavePostChange.

• Workflow.

• RowSelect.

• Any PeopleCode event that fires as a result of a ScrollSelect (or one of its relatives) function calls, or a Select (or one of its relatives) Rowset class method.

Parameters

The following are the parameters for the PeopleCode function syntax:

 function_name Name of the function. PeopleCode Reserved word that identifies the function as a PeopleCode function. recordname.fieldname Specifies the record and field where the function is located. event_type Component Processor event with which the function is associated.

Note. event_type can be used to specify record field events only. You can’t specify a component record field event, a component record event, and so on.

The following are the parameters for the external library function syntax:

 function_name Name of the function. Library Reserved word that identifies the function as an external library function. lib_name A string representing the name of the external library. The external routine must be located in a DLL named lib_name accessible by Windows, or an equivalent shared library in a UNIX system. Alias  module_name Optionally specifies the name of the function’s entry point within the shared library. This is needed only if the C function name differs from function_name in the PeopleCode external function declaration. The external module is invoked using the __stdcall calling convention on Windows. paramlist List of parameters expected by the function, each in the form: ext_datatype [{Ref | Value}] [As pc_type] ext_datatype The data type of the parameter expected by the function. To specify the type you can use any of the following: BOOLEAN INTEGER LONG UINTEGER ULONG STRING STRING FLOAT DOUBLE Ref | Value Optionally use one of these two reserved words to specify whether the parameter is passed by reference or by value. If Ref is specified, it is passed by pushing a reference (pointer) on the stack. If Value is specified the value is pushed on the stack (for integers, and so on.) If neither is specified, Ref is assumed. As pc_type Specifies PeopleCode data type of the value passed to the function. You can choose between PeopleCode data types String, Number, Integer, Float, Date, Boolean, and Any. Returns ext_return_type Specifies the data type of any value returned by the function. The Returns clause is omitted if the function is void (returns no value.) To specify the return type you can use any of the following: BOOLEAN INTEGER LONG UINTEGER ULONG FLOAT DOUBLE The types String and LString are not allowed for the result type of a function. As pc_return_type Specifies the PeopleCode data type of the variable or field into which to read the returned value. You can choose between PeopleCode data types String, Number, Integer, Float, Date, Boolean, and Any. If the As clause is omitted, PeopleTools selects an appropriate type based on the type of value returned by the external function (for example, all integer and floating point types are converted to Number).

Example

Assume you have defined a PeopleCode function called VerifyZip. The function definition is located in the record definition FUNCLIB_MYUTILS, in the record field ZIP_EDITS, attached to the FieldFormula event. You would declare the function using the following statement:

Declare Function verifyzip PeopleCode FUNCLIB_MYUTILS.ZIP_EDITS FieldFormula;

Now assume you want to declare a function called PCTest in PSUSER.DLL. It takes an integer and returns an integer. You would write this declare statement:

Declare Function pctest Library "psuser.dll" (integer Value As number) Returns integer As number;

#### Decrypt

Syntax

Decrypt(KeyString, EncryptedString)

Description

Use the Decrypt function to decrypt a string previously encrypted with the Encrypt function. This function is generally used with merchant passwords. For this function to decrypt a string successfully, you must use the same KeyString value used to encrypt the string.

Parameters

 KeyString Specify the key used for encrypting the string. You can specify a NULL value for this parameter, that is, two quotation marks with no blank space between them (""). EncryptedString Specify the string you want decrypted.

Returns

A clear text string.

Example

Encrypt and Decrypt support only strings.

&AUTHPARMS.WRKTOKEN.Value = Decrypt("", RTrim(LTrim(&MERCHANTID_⇒ REC.CMPAUTHNTCTNTOKEN.Value)));

#### Degrees

Syntax

Degrees(angle)

Description

Use the Degrees function to convert the given angle from radian measurement to degree measurement.

Parameters

 angle The size of an angle in radians.

Returns

The size of the given angle in degrees.

Example

The following example returns the equivalent size in degrees of an angle measuring 1.2 radians:

&DEGREE_SIZE = Degrees(1.2);

Acos, Asin, Atan, Cos, Cot, Radians, Sin, Tan.

#### DeleteAttachment

Syntax

DeleteAttachment(URLSource, DirAndSysFileName[, PreserveCase])

Description

Use the DeleteAttachment function to delete a file from the specified storage location.

DeleteAttachment does not generate any type of “Are you sure?” message. If you want the end user to verify the deletion before it is performed, you must write your own checking code in your application.

Additional information that is important to the use of DeleteAttachment can be found in the PeopleTools 8.52: PeopleCode Developer's Guide PeopleBook:

• PeopleTools supports multiple types of storage locations.

• Certain characters are illegal in file names; other characters in file names are converted during file transfer.

• Non-ASCII file names are supported by the PeopleCode file attachment functions.

Parameters

 URLSource A reference to a URL. This can be either a URL identifier in the form URL.URL_ID, or a string. This, along with the DirAndSysFileName parameter, indicates the file's location. Note. The URLSource parameter requires forward slashes (/). Backward slashes (\) are not supported for this parameter. DirAndSysFileName The relative path and system file name of the file on the file server. This is appended to URLSource to make up the full URL where the file is deleted from. This parameter takes a string value. Note. The URLSource requires "/" slashes. Because DirAndSysFileName is appended to the URL, it also requires only "/" slashes. "\" are NOT supported in any way for either the URLSource or the DirAndSysFileName parameter. PreserveCase Specify a Boolean value to indicate whether when searching for the file specified by the DirAndSysFileName parameter, its file name extension is preserved or not; True, preserve the case of the file name extension, False, convert the file name extension to all lower case letters. The default value is False. Warning! If you use the PreserveCase parameter, it is important that you use it in a consistent manner with all the relevant file-processing functions or you may encounter unexpected file-not-found errors.

Returns

You can check for either an integer or a constant value:

Example

&retcode = DeleteAttachment(URL.BKFTP, ATTACHSYSFILENAME);

An example of the DeleteAttachment function is provided in the demonstration application delivered in the FILE_ATTACH_WRK derived/work record. This demonstration application is shown on the PeopleTools Test Utilities page.

Syntax

Description

Use the DeleteEmailAddress function to delete the email address associated with the specified type for the current user. You can only have one email address of a specific type for a user.

Note. You can only delete the Primary Email Address if it's the only address. If the email address you want to delete is marked as the primary email address, and it is not the only email address, you must mark another email address as primary before you can delete the email address you want to delete. Use the MarkPrimaryEmailAddress function to set the primary email address.

Parameters

 Type Specify the type that you want to change the email address to. This parameter takes a string value. The valid values are:

Returns

None.

#### DeleteImage

Syntax

DeleteImage(scrollpath, target_row, [recordname.]fieldname)

where scrollpath is:

[SCROLL.level1_recname, level1_row, [SCROLL.level2_recname, level2_row,]] SCROLL.target_recname

Description

Use the DeleteImage function to remove an image associated with a record field.

Note. To update an image field using this function, be sure that PSIMAGEVER field is also on the same record as the image field being updated.

Parameters

 scrollpath A construction that specifies a scroll area in the component buffer. target_row The row number of the target row. [recordname .]fieldname The name of the field asThe recordname prefix is not required if the program that calls DeleteImage is on the recordname record definition.

Returns

Returns a Boolean value: True if image was successfully deleted, False otherwise.

Example

&Rslt = DeleteImage(EMPL_PHOTO.EMPLOYEE_PHOTO);

#### DeleteRecord

Syntax

DeleteRecord(level_zero_recfield)

Description

Use the DeleteRecord function to remove a high-level row of data and all dependent rows in other tables from the database.

Note. This function remains for backward compatibility only. Use the Delete record class method instead.

DeleteRecord deletes the component’s level-zero row from the database, deletes any dependent rows in other tables from the database, and exits the component.

This function, like DeleteRow, initially marks the record or row as needing to be deleted. At save time the row is actually deleted from the database and cleared from the buffer.

This function works only if the PeopleCode is on a level-zero field. It cannot be used from SavePostChange or WorkFlow PeopleCode.

Parameters

 level_zero_recfield A recordname.fieldname reference identifying any field on the level-zero area of the page.

Returns

Optionally returns a Boolean value indicating whether the deletion was completed successfully.

Example

The following example, which is in SavePreChange PeopleCode on a level-zero field, deletes the high-level row and all dependent rows in other tables if the current page is EMPLOYEE_ID_DELETE.

if %Page = PAGE.EMPLOYEE_ID_DELETE then &success = DeleteRecord(EMPLID); end-if;

#### DeleteRow

Syntax

DeleteRow(scrollpath, target_row)

Where scrollpath is:

[RECORD.level1_recname, level1_row, [RECORD.level2_recname, level2_row, ]] RECORD.target_recname

To prevent ambiguous references, you can also use SCROLL. scrollname, where scrollname is the same as the scroll level’s primary record name.

Description

Use the DeleteRow function to delete rows programmatically.

Note. This function remains for backward compatibility only. Use the DeleteRow rowset class method instead.

See DeleteRow.

A call to this function causes the RowDelete event sequence to fire, as if an user had manually deleted a row.

DeleteRow cannot be executed from the same scroll level where the deletion will take place, or from a lower scroll level. Place the PeopleCode in a higher scroll level record.

When DeleteRow is used in a loop, you have to process rows from high to low to achieve the correct results, that is, you must delete from the bottom up rather than from the top down. This is necessary because the rows are renumbered after they are deleted (if you delete row one, row two becomes row one).

Parameters

 scrollpath A construction that specifies a scroll level in the component buffer. target_row The row number of the row to delete.

Returns

Boolean (optional). DeleteRow returns a Boolean value indicating whether the deletion was completed successfully.

Example

In the following example DeleteRow is used in a For loop. The example checks values in each row, then conditionally deletes the row. Note the syntax of the For loop, including the use of the -1 in the Step clause to loop from the highest to lowest values. This ensures that the renumbering of the rows will not affect the loop.

For &L1 = &X1 To 1 Step - 1 &SECTION = FetchValue(AE_STMT_TBL.AE_SECTION, &L1); &STEP = FetchValue(AE_STMT_TBL.AE_STEP, &L1); If None(&SECTION, &STEP) Then DeleteRow(RECORD.AE_STMT_TBL, &L1); End-If; End-For;

#### DeleteSQL

Syntax

DeleteSQL([SQL.]sqlname[, dbtype[, effdt]])

Description

Use the DeleteSQL function to programmatically delete a SQL definition. The SQL definition must have already been created and saved, either using the CreateSQL and StoreSQL functions, or by using Application Designer.

When you create a SQL definition, you must create a base statement before you can create other types of statements, that is, one that has a dbtype as GENERIC and effdt as the null date (or Date(19000101)). If you specify a base (generic) statement to be deleted, all statements as well as the generic statement are deleted.

If you specify a non-generic statement that ends up matching the generic statement, DeleteSQL does not delete anything, and returns False.

You must commit all database changes prior to using this function. This is to avoid locking critical Tools tables and hence freezing all other users. You receive a runtime error message if you try to use this function when there are pending database updates, and your PeopleCode program terminates. You need to commit any database updates prior to using this function. The CommitWork PeopleCode function has been enhanced to allow this.

Parameters

 sqlname Specify the name of a SQL definition. This is either in the form SQL.sqlname or a string value giving the sqlname. dbtype Specify the database type associated with the SQL definition. This parameter takes a string value. If dbtype isn’t specified or is null (""), it set by default to the current database type (the value returned from the %DbName system variable.) Valid values for dbtype are as follows. These values are not case sensitive: APPSRV DB2ODBC DB2UNIX INFORMIX MICROSFT ORACLE SYBASE Note. Database platforms are subject to change. effdt Specify the effective date associated with the SQL definition. If effdt isn’t specified, it is set by default to the current as of date, that is, the value returned from the %AsOfDate system variable.

Returns

A Boolean value: True if the delete was successful, False if the specified SQL statement wasn’t found, and terminates with an error message if there was another problem (that is, date in incorrect format, and so on.)

Example

The following code deletes the ABCD_XY SQL definition for the current DBType and as of date:

&RSLT = DeleteSQL(SQL.ABC_XY); If NOT(&RSLT) Then /* SQL not found − do error processing */ End-if;

The following code deletes the ABCD_XY SQL Definition for the current DBType and November 3, 1998:

&RSLT = DeleteSQL(SQL.ABCD_XY, "",Date(19981103));

#### DeleteSystemPauseTimes

Syntax

DeleteSystemPauseTimes(StartDay, StartTime, EndDay, EndTime)

Description

Use the DeleteSystemPauseTimes function to delete pause times that occur on your system by adding a row to the system pause times table.

This function is used in the PeopleCode for the Message Monitor. Pause times are set up in the Message Monitor.

Parameters

 StartDay Specify a number from 0-6. The values are:

 Value Description 0 Sunday 1 Monday 2 Tuesday 3 Wednesday 4 Thursday 5 Friday 6 Saturday

 StartTime Specify a time, in seconds, since midnight. EndDay Specify a number from 0-6. The values are:

 Value Description 0 Sunday 1 Monday 2 Tuesday 3 Wednesday 4 Thursday 5 Friday 6 Saturday

 EndTime Specify a time, in seconds, since midnight.

Returns

A Boolean value: True if the system pause time specified was deleted, False otherwise.

Example

Component Boolean &spt_changed; /* deleting a system pause time interval; */ If Not ​DeleteSystemPauseTimes(PSSPTIMES.STARTINGDAY, PSSPTIMES.STARTINGSECOND,⇒ PSSPTIMES.ENDINGDAY, PSSPTIMES.ENDINGSECOND) Then Error MsgGetText(117, 15, ""); Else &spt_changed = True; /* to force a save; */ PSSPTIMES.MSGSPTNAME = " "; DoSave(); End-If;

#### DeQueue

Syntax

Description

Once a task that has been placed in a queue by the EnQueue function and has been completed by the agent, use the DeQueue function to notify the queue server. The queue server removes the task from the queue and subtracts the cost of that task from the agent's workload.

Note. The queue server does not allow a task to be dequeued if the agent who owns that task is not logged on to that particular queue server. PeopleSoft recommends that you only use the DeQueue function in application pages that the MultiChannel Framework Console launches when agents accept or activate assigned tasks.

Parameters

Returns

Returns 0 for success. Otherwise, it returns a message number. The message set ID for MultiChannel Framework is 162.

For example, 1302 is returned when an invalid task type or no value is provided.

Example

#### DetachAttachment

Syntax

DetachAttachment(URLSource, DirAndSysFileName, UserFileName [,PreserveCase])

Description

Use the DetachAttachment function to download a file from its source storage location and save it locally on the end-user machine. The file is sent to the browser with appropriate HTTP headers to cause the browser to display a save dialog box to the user.

The end user can specify any file name to save the file.

Additional information that is important to the use of DetachAttachment can be found in the PeopleTools 8.52: PeopleCode Developer's Guide PeopleBook:

• PeopleTools supports multiple types of storage locations.

• The PeopleCode file attachment functions do not provide text file conversions when files are attached or viewed.

• Because DetachAttachment is interactive, it is known as a “think-time” function, and is restricted from use in certain PeopleCode events.

Parameters

 URLSource A reference to a URL. This can be either a URL identifier the form URL.URL_ID, or a string. The URLSource parameter requires forward slashes (“/”). Backward slashes ("\") are not supported for this parameter. DirAndSysFileName The relative path and file name of the file on the file server. This is appended to URLSource to make up the full URL where the file is transferred from. This parameter takes a string value. Note. The URLSource requires "/" slashes. Because DirAndSysFileName is appended to the URL, it also requires only "/" slashes. "\" are not supported in any way for either the URLSource or the DirAndSysFileName parameter. UserFileName The default file name provided by the Detach dialog. PreserveCase Specify a Boolean value to indicate whether when searching for the file specified by the DirAndSysFileName parameter, its file name extension is preserved or not; True, preserve the case of the file name extension, False, convert the file name extension to all lowercase letters. The default value is False. Warning! If you use the PreserveCase parameter, it is important that you use it in a consistent manner with all the relevant file-processing functions or you may encounter unexpected file-not-found errors.

Returns

You can check for either an integer or a constant value:

Example

&retcode = DetachAttachment(URL.MYFTP, ATTACHSYSFILENAME, ATTACHUSERFILE);

An example of the DetachAttachment function is provided in the demonstration application delivered in the FILE_ATTACH_WRK derived/work record. This demonstration application is shown on the PeopleTools Test Utilities page.

Syntax

Description

Use the DisableMenuItem function to disable (make unavailable) the specified menu item. To apply this function to a pop-up menu, use the PrePopup Event of the field with which the pop-up menu is associated.

If you’re using this function with a pop-up menu associated with a page (not a field), the earliest event you can use is the PrePopup event for the first "real" field on the page (that is, the first field listed in the Order view of the page in Application Designer.)

Restrictions on Use With a Component Interface

This function is ignored (has no effect) when used by a PeopleCode program that’s been called by a Component Interface.

Parameters

Returns

None.

Example

Syntax

Description

Use the DiscardRow function to prevent a row from being added to a page scroll during Row Select processing. This function is valid only in RowSelect PeopleCode. When DiscardRow is called during RowSelect processing, the current row is skipped (not added to the scroll). Processing then continues on the next row, unless the StopFetching function has also been called, in which case no more rows are added to the page.

If you try to discard a row and it's the only row in the scroll, the row is not discarded. You will still have one blank row in your scroll.

DiscardRow has the same functionality as the Warning function in the RowSelect event. The anomalous behavior of Warning is supported for compatibility with previous releases of PeopleTools.

Note. RowSelect processing is used infrequently, because it is more efficient to filter out rows of data using a search view or an effective-dated record before the rows are selected into the component buffer from the database server.

RowSelect Processing Logic

Parameters

None.

Returns

None.

#### DoCancel

Syntax

DoCancel( )

Description

Use the DoCancel function to cancel the current page.

• In the page, the DoCancel function terminates the current component and returns the user to the search dialog box.

• In the menu, the DoCancel function terminates the current component and returns the user to the current menu with no component active.

DoCancel terminates any PeopleCode programs executing prior to a save action. It does not stop processing of PeopleCode in SaveEdit, SavePreChange, and SavePostChange events.

Returns

None.

#### DoModal

Syntax

DoModal(PAGE.pagename, title, xpos, ypos, [level, scrollpath, target_row])

In which scrollpath is:

[RECORD.level1_recname, level1_row, [RECORD.level2_recname, level2_row, ]] RECORD.target_recname

To prevent ambiguous references, you can also use SCROLL. scrollname, in which scrollname is the same as the scroll level’s primary record name.

Description

Use the DoModal function to display a secondary page in a modal, secondary window, which means that the user must dismiss the secondary window before continuing work in the page from which the secondary page was called.

Alternatively, you can specify a secondary page in a command push button definition without using PeopleCode. This may be preferable for performance reasons, especially with PeopleSoft Pure Internet Architecture.

DoModal can display a single page modally. To display an entire component modally, use DoModalComponent.

Any variable declared as a component variable will still be defined after calling the DoModal function.

If you call DoModal without specifying a level number or any record parameters, the function uses the current context as the parent.

Restrictions on Use in PeopleCode Events

Control does not return to the line after DoModal until after the user has dismissed the secondary page. This interruption of processing makes DoModal a “think-time” function, which means that it shouldn’t be used in any of the following PeopleCode events:

• SavePreChange.

• SavePostChange.

• Workflow.

• RowSelect.

• Any PeopleCode event that executes as a result of a ScrollSelect, ScrollSelectNew, RowScrollSelect, or RowScrollSelectNew function call.

• Any PeopleCode event that executes as a result of a Rowset classs Select method or SelectNew method.

• You should not use DoModal or any other think-time function in FieldChange when the field is associated with an edit box, long edit box, or drop-down list box. Use FieldEdit instead.

However, DoModal can be used in FieldChange when the field is associated with a push button, radio button, checkbox, or hyperlink.

In addition, you can't use DoModal in the SearchInit event.

Restrictions on Use With a Component Interface

This function is ignored (has no effect) when used by a PeopleCode program that’s been called by a component interface.

Considerations for the DoModal Function and Catching Exceptions

Using the DoModal function inside a try-catch block does not catch PeopleCode exceptions thrown in the new component. Starting a new component starts a brand new PeopleCode evaluation context. Exceptions are only caught for exceptions thrown within the current component.

In the following code example, the catch statement only catches exceptions thrown in the code prior to the DoModal, but not any exceptions that are thrown within the new component:

/* Set up transaction */ If %CompIntfcName = "" Then try &oTrans = &g_ERMS_TransactionCollection.GetTransactionByName(RB_EM_⇒ WRK.DESCR); &sSearchPage = &oTrans.SearchPage; &sSearchRecord = &oTrans.SearchRecord; &sSearchTitle = &oTrans.GetSearchPageTitle(); If Not All(&sSearchPage, &sSearchRecord, &sSearchTitle) Then Error (MsgGetText(17834, 8081, "Message Not Found")); End-If; &c_ERMS_SearchTransaction = &oTrans; /* Attempt to transfer to hidden search page with configurable filter */ &nModalReturn = ​DoModal(@("Page." | &sSearchPage), &sSearchTitle, - 1, - 1); catch Exception &e Error (MsgGetText(17834, 8082, "Message Not Found")); end-try;

Parameters

 pagename The name of the secondary page. title The text that displays in the caption of the secondary page. xpos The pixel coordinates of the top left corner of the secondary page, offset from the top left corner of the parent page (the default of -1, -1 means centered). ypos The pixel coordinates of the top right corner of the secondary page, offset from the top right corner of the parent page (the default of -1, -1 means centered). level Specifies the level of the scroll level on the parent page that contains the row corresponding to level 0 on the secondary page. scrollpath A construction that specifies a scroll level in the component buffer. target_row The row number of the row in the parent page corresponding to the level 0 row in the secondary page.

Returns

Returns a number that indicates how the secondary page was terminated. A secondary page can be terminated by the user clicking a built-in OK or Cancel button, or by a call to the EndModal function in a PeopleCode program. In either case, the return value of DoModal is one of the following:

• 1 if the user clicked OK in the secondary page, or if 1 was passed in the EndModal function call that terminated the secondary page.

• 0 if the user clicked Cancel in the secondary page, or if 0 was passed in the EndModal function call that terminated the secondary page.

Example

DoModal(PAGE.EDUCATION_DTL, MsgGetText(1000, 167, "Education Details - %1",⇒ EDUCATN.DEGREE), - 1, - 1, 1, RECORD.EDUCATN, CurrentRowNumber());

#### DoModalComponent

Syntax

In which keylist is a list of field references in the form:

[recordname.]field1 [, [recordname.]field2]. . .

Or in which keylist is a list of field references in the form:

&RecordObject1 [, &RecordObject2]. . .

Description

Use the DoModalComponent function to display a secondary component in a modal, secondary window, which means that the user must dismiss the secondary window before continuing work in the page from which the secondary window was called. The secondary component launches modally from within an originating component. After the secondary component displays, the user can’t proceed with changes to the originating component until either accepting or canceling the secondary component.

Secondary components can be displayed in any of the following action modes: Add, Update/Display, Update/Display All, Correction. A secondary component can be launched from any component, including another secondary component. You can also use DoModalComponent from a secondary page.

The originating component and the secondary component share data, including search keys, using a Shared Work Record or the values in the fieldlist parameter. If valid search keys are provided in the shared work record and populated with valid values before launching the secondary component, the search is conducted using the provided search key values. If the fieldlist parameter isn't used and no search keys are provided, or if search key fields contain invalid values, the user accesses the secondary component using a search dialog box.

Note. The user may see a different title for a search page if they enter the search page using this function versus from the regular navigation.

In the component_item_name parameter, make sure to pass the component item name for the page, not the page name. The component item name is specified in the Component Definition, in the Item Name column on the row corresponding to the specific page, as shown here:

Component Item Name parameter

Shared Work Records

The originating component and the secondary component share fields in a Derived/Work record called a shared work record. Shared fields from this record must be placed at level zero of both the originating component and the secondary component.

You can use the shared fields to:

• Pass values that are assigned to the search keys in the secondary component search record. If these fields are missing or not valid, the search dialog box appears, enabling the user to enter search keys.

• Optionally pass other values from the originating component to the secondary component.

• Pass values back from the secondary component to the originating component for processing.

To do this, you have to write PeopleCode that:

• Assigns values to fields in the shared work record in the originating page at some point before the modal transfer takes place.

• Accesses and changes the values, if necessary, in the secondary component.

• Accesses the values from the shared work record from the originating component after the secondary component is dismissed.

Restrictions on Use With a Component Interface

This function is ignored (has no effect) when used by a PeopleCode program that’s been called by a component interface.

Restrictions on Use With SearchInit Event

You can't use this function in a SearchInit PeopleCode program.

Considerations for the DoModalComponent Function and Catching Exceptions

Using the DoModalComponent function inside a try-catch block does not catch PeopleCode exceptions thrown in the new component. Starting a new component starts a brand new PeopleCode evaluation context. Exceptions are only caught for exceptions thrown within the current component.

In the following code example, the catch statement only catches exceptions thrown in the code prior to the DoModal, but not any exceptions that are thrown within the new component:

/* Set up transaction */ If %CompIntfcName = "" Then try &oTrans = &g_ERMS_TransactionCollection.GetTransactionByName(RB_EM_⇒ WRK.DESCR); &sSearchPage = &oTrans.SearchPage; &sSearchRecord = &oTrans.SearchRecord; &sSearchTitle = &oTrans.GetSearchPageTitle(); If Not All(&sSearchPage, &sSearchRecord, &sSearchTitle) Then Error (MsgGetText(17834, 8081, "Message Not Found")); End-If; &c_ERMS_SearchTransaction = &oTrans; /* Attempt to transfer to hidden search page with configurable filter */ &nModalReturn = ​DoModal(@("Page." | &sSearchPage), &sSearchTitle, - 1, - 1); catch Exception &e Error (MsgGetText(17834, 8082, "Message Not Found")); end-try;

Parameters

 menuname Name of the menu through which the secondary component is accessed. barname Name of the menu bar through which the secondary component is accessed. menuitem_name Name of the menu item through which the secondary component is accessed. component_item_name The component item name of the page to be displayed on top of the secondary component when it displays. The component item name is specified in the component definition. action String representing the action mode in which to start up the component. You can use either a character value (passed in as a string) or a constant. See below. If only one action mode is allowed for the component, that action mode is used. If more than one action mode is allowed, the user can select which mode to come up in. shared_record_name The record name of the shared work record (preceded by the reserved word Record). This record must include: Fields that are search keys in the secondary component search record; if search key fields are not provided, or if they are invalid, the user accesses the secondary component using the search dialog box. Other fields to pass to the secondary component. Fields to get back from the secondary component after it has finished processing. keylist An optional list of field specifications used to select a unique row at level zero in the page you are transferring to, by matching keys in the page you are transferring from. It can also be an already instantiated record object. If a record object is specified, any field of that record object that is also a field of the search record for the destination component is added to keylist. The keys in fieldlist must uniquely identify a row in the "to" page search record. If a unique row is not identified, the search dialog box appears. If the keylist parameter is not supplied then the destination components' search key must be found as part of the source component's level 0 record buffer.

The values for action can be as follows:

 Numeric Value Constant Value Description A %Action_Add Add U %Action_UpdateDisplay Update/Display L %Action_UpdateDisplayAll Update/Display All C %Action_Correction Correction E %Action_DataEntry Data Entry P %Action_Prompt Prompt

Returns

Returns a Boolean that indicates how the secondary page was terminated. A secondary page can be terminated by the user clicking a built-in OK or Cancel button, or by a call to the EndModalComponent function in a PeopleCode program. In either case, the return value of DoModalComponent is one of the following:

• True if the user clicked OK in the secondary page, or if 1 was passed in the EndModal function call that terminated the secondary page.

• False if the user clicked Cancel in the secondary page, or if 0 was passed in the EndModal function call that terminated the secondary page.

Example

The following example shows how to structure a DoModalComponent function call:

DoModalComponent(MENUNAME.MAINTAIN_ITEMS_FOR_INVENTORY, BARNAME.USE_A,⇒ ITEMNAME.ITEM_DEFINITION, COMPONENT.ESTABLISH_AN_ITEM, "C", RECORD.NEW7_WRK);

Supporting PeopleCode is required if you must assign values to fields in the shared work record or access those values, either from the originating component, or from the secondary component.

#### DoModalPanelGroup

Syntax

Description

Use the DoModalPanelGroup function to launch a secondary component.

Note. The DoModalPanelGroup function is supported for compatibility with previous releases of PeopleTools. Future applications should use DoModalComponent instead.

#### DoModalX

Syntax

DoModalX(showInModal, cancelButtonName, PAGE.pagename, title, xpos, ypos, [level, scrollpath, target_row])

In which scrollpath is:

[RECORD.level1_recname, level1_row, [RECORD.level2_recname, level2_row, ]] RECORD.target_recname

To prevent ambiguous references, you can also use SCROLL. scrollname, in which scrollname is the same as the scroll level’s primary record name.

Description

Use the DoModalX function to display a secondary page modally when you do not want it to display in a modal, secondary window. Instead, the page to be displayed completely replaces the current page. Similar to DoModal, the user must complete work on the secondary page before continuing work in the page from which the secondary page was called.

Important! To have the page completely replace the current page, set the showInModal parameter to False.

DoModalX can display a single page modally. To display an entire component modally, use DoModalXComponent.

Any variable declared as a component variable will still be defined after calling the DoModalX function.

If you call DoModalX without specifying a level number or any record parameters, the function uses the current context as the parent.

Restrictions on Use in PeopleCode Events

Control does not return to the line after DoModalX until after the user has dismissed the secondary page. This interruption of processing makes DoModalX a “think-time” function, which means that it shouldn’t be used in any of the following PeopleCode events:

• SavePreChange.

• SavePostChange.

• Workflow.

• RowSelect.

• Any PeopleCode event that executes as a result of a ScrollSelect, ScrollSelectNew, RowScrollSelect, or RowScrollSelectNew function call.

• Any PeopleCode event that executes as a result of a Rowset classs Select method or SelectNew method.

• You should not use DoModalX or any other think-time function in FieldChange when the field is associated with an edit box, long edit box, or drop-down list box. Use FieldEdit instead.

However, DoModalX can be used in FieldChange when the field is associated with a push button, radio button, checkbox, or hyperlink.

In addition, you can't use DoModalX in the SearchInit event.

Restrictions on Use With a Component Interface

This function is ignored (has no effect) when used by a PeopleCode program that’s been called by a component interface.

Considerations for the DoModalX Function and Catching Exceptions

Using the DoModalX function inside a try-catch block does not catch PeopleCode exceptions thrown in the new component. Starting a new component starts a brand new PeopleCode evaluation context. Exceptions are only caught for exceptions thrown within the current component.

In the following code example, the catch statement only catches exceptions thrown in the code prior to the DoModal, but not any exceptions that are thrown within the new component:

/* Set up transaction */ If %CompIntfcName = "" Then try &oTrans = &g_ERMS_TransactionCollection.GetTransactionByName(RB_EM_⇒ WRK.DESCR); &sSearchPage = &oTrans.SearchPage; &sSearchRecord = &oTrans.SearchRecord; &sSearchTitle = &oTrans.GetSearchPageTitle(); If Not All(&sSearchPage, &sSearchRecord, &sSearchTitle) Then Error (MsgGetText(17834, 8081, "Message Not Found")); End-If; &c_ERMS_SearchTransaction = &oTrans; /* Attempt to transfer to hidden search page with configurable filter */ &nModalReturn = ​DoModal(@("Page." | &sSearchPage), &sSearchTitle, - 1, - 1); catch Exception &e Error (MsgGetText(17834, 8082, "Message Not Found")); end-try;

Parameters

 showInModal Specify a Boolean value to indicate whether to display the secondary page in a modal, secondary window: True display the page in a secondary, modal window. False do not display the page in a secondary window; instead, completely replace the current page. cancelButtonName Currently, this parameter is not used and should be specified as an empty string: “”. pagename The name of the secondary page. title The text that displays in the caption of the secondary page. xpos The pixel coordinates of the top left corner of the secondary page, offset from the top left corner of the parent page (the default of -1, -1 means centered). ypos The pixel coordinates of the top right corner of the secondary page, offset from the top right corner of the parent page (the default of -1, -1 means centered). level Specifies the level of the scroll level on the parent page that contains the row corresponding to level 0 on the secondary page. scrollpath A construction that specifies a scroll level in the component buffer. target_row The row number of the row in the parent page corresponding to the level 0 row in the secondary page.

Returns

Returns a number that indicates how the secondary page was terminated. A secondary page can be terminated by the user clicking a built-in OK or Cancel button, or by a call to the EndModal function in a PeopleCode program. In either case, the return value of DoModalX is one of the following:

• 1 if the user clicked OK in the secondary page, or if 1 was passed in the EndModal function call that terminated the secondary page.

• 0 if the user clicked Cancel in the secondary page, or if 0 was passed in the EndModal function call that terminated the secondary page.

Example

DoModalX( False, "", PAGE.EDUCATION_DTL, MsgGetText(1000, 167, "Education Details ⇒ - %1", EDUCATN.DEGREE), - 1, - 1, 1, RECORD.EDUCATN, CurrentRowNumber());

#### DoModalXComponent

Syntax

In which keylist is a list of field references in the form:

[recordname.]field1 [, [recordname.]field2]. . .

Or in which keylist is a list of field references in the form:

&RecordObject1 [, &RecordObject2]. . .

Description

Use the DoModalXComponent function to display a secondary component modally when you do not want it to display in a modal, secondary window. The secondary component launches modally from within an originating component, which means that the user must dismiss the secondary component before continuing work in the page from which the secondary component was called. After the secondary component displays, the user can’t proceed with changes to the originating component until either accepting or canceling the secondary component.

Important! To have the new component completely replace the current page, set the showInModal parameter to False.

Secondary components can be displayed in any of the following action modes: Add, Update/Display, Update/Display All, Correction. A secondary component can be launched from any component, including another secondary component. You can also use DoModalXComponent from a secondary page.

The originating component and the secondary component share data, including search keys, using a Shared Work Record or the values in the fieldlist parameter. If valid search keys are provided in the shared work record and populated with valid values before launching the secondary component, the search is conducted using the provided search key values. If the fieldlist parameter isn't used and no search keys are provided, or if search key fields contain invalid values, the user accesses the secondary component using a search dialog box.

Note. The user may see a different title for a search page if they enter the search page using this function versus from the regular navigation.

In the component_item_name parameter, make sure to pass the component item name for the page, not the page name. The component item name is specified in the Component Definition, in the Item Name column on the row corresponding to the specific page, as shown here:

Component Item Name parameter

Shared Work Records

The originating component and the secondary component share fields in a Derived/Work record called a shared work record. Shared fields from this record must be placed at level zero of both the originating component and the secondary component.

You can use the shared fields to:

• Pass values that are assigned to the search keys in the secondary component search record. If these fields are missing or not valid, the search dialog box appears, enabling the user to enter search keys.

• Optionally pass other values from the originating component to the secondary component.

• Pass values back from the secondary component to the originating component for processing.

To do this, you have to write PeopleCode that:

• Assigns values to fields in the shared work record in the originating page at some point before the modal transfer takes place.

• Accesses and changes the values, if necessary, in the secondary component.

• Accesses the values from the shared work record from the originating component after the secondary component is dismissed.

Restrictions on Use With a Component Interface

This function is ignored (has no effect) when used by a PeopleCode program that’s been called by a component interface.

Restrictions on Use With SearchInit Event

You can't use this function in a SearchInit PeopleCode program.

Considerations for the DoModalXComponent Function and Catching Exceptions

Using the DoModalXComponent function inside a try-catch block does not catch PeopleCode exceptions thrown in the new component. Starting a new component starts a brand new PeopleCode evaluation context. Exceptions are only caught for exceptions thrown within the current component.

In the following code example, the catch statement only catches exceptions thrown in the code prior to the DoModal, but not any exceptions that are thrown within the new component:

/* Set up transaction */ If %CompIntfcName = "" Then try &oTrans = &g_ERMS_TransactionCollection.GetTransactionByName(RB_EM_⇒ WRK.DESCR); &sSearchPage = &oTrans.SearchPage; &sSearchRecord = &oTrans.SearchRecord; &sSearchTitle = &oTrans.GetSearchPageTitle(); If Not All(&sSearchPage, &sSearchRecord, &sSearchTitle) Then Error (MsgGetText(17834, 8081, "Message Not Found")); End-If; &c_ERMS_SearchTransaction = &oTrans; /* Attempt to transfer to hidden search page with configurable filter */ &nModalReturn = ​DoModal(@("Page." | &sSearchPage), &sSearchTitle, - 1, - 1); catch Exception &e Error (MsgGetText(17834, 8082, "Message Not Found")); end-try;

Parameters

 showInModal Specify a Boolean value to indicate whether to display the secondary component in a modal, secondary window: True display the component in a secondary, modal window. False do not display the component in a secondary window; instead, completely replace the current page. cancelButtonName Currently, this parameter is not used and should be specified as an empty string: “”. menuname Name of the menu through which the secondary component is accessed. barname Name of the menu bar through which the secondary component is accessed. menuitem_name Name of the menu item through which the secondary component is accessed. component_item_name The component item name of the page to be displayed on top of the secondary component when it displays. The component item name is specified in the component definition. action String representing the action mode in which to start up the component. You can use either a character value (passed in as a string) or a constant. See below. If only one action mode is allowed for the component, that action mode is used. If more than one action mode is allowed, the user can select which mode to come up in. shared_record_name The record name of the shared work record (preceded by the reserved word Record). This record must include: Fields that are search keys in the secondary component search record; if search key fields are not provided, or if they are invalid, the user accesses the secondary component using the search dialog box. Other fields to pass to the secondary component. Fields to get back from the secondary component after it has finished processing. keylist An optional list of field specifications used to select a unique row at level zero in the page you are transferring to, by matching keys in the page you are transferring from. It can also be an already instantiated record object. If a record object is specified, any field of that record object that is also a field of the search record for the destination component is added to keylist. The keys in fieldlist must uniquely identify a row in the "to" page search record. If a unique row is not identified, the search dialog box appears. If the keylist parameter is not supplied then the destination components' search key must be found as part of the source component's level 0 record buffer.

The values for action can be as follows:

 Numeric Value Constant Value Description A %Action_Add Add U %Action_UpdateDisplay Update/Display L %Action_UpdateDisplayAll Update/Display All C %Action_Correction Correction E %Action_DataEntry Data Entry P %Action_Prompt Prompt

Returns

Returns a Boolean that indicates how the secondary page was terminated. A secondary page can be terminated by the user clicking a built-in OK or Cancel button, or by a call to the EndModalComponent function in a PeopleCode program. In either case, the return value of DoModalXComponent is one of the following:

• True if the user clicked OK in the secondary page, or if 1 was passed in the EndModal function call that terminated the secondary page.

• False if the user clicked Cancel in the secondary page, or if 0 was passed in the EndModal function call that terminated the secondary page.

Example

The following example shows how to structure a DoModalXComponent function call:

DoModalXComponent( False, "", MENUNAME.MAINTAIN_ITEMS_FOR_INVENTORY, ⇒ BARNAME.USE_A, ITEMNAME.ITEM_DEFINITION, COMPONENT.ESTABLISH_AN_ITEM, "C", ⇒ RECORD.NEW7_WRK);

Supporting PeopleCode is required if you must assign values to fields in the shared work record or access those values, either from the originating component, or from the secondary component.

#### DoSave

Syntax

DoSave()

Description

Use the DoSave function to save the current page. DoSave defers processing to the end of the current PeopleCode program event, as distinct from DoSaveNow, which causes save processing (including SaveEdit, SavePreChange, SavePostChange, and Workflow PeopleCode) to be executed immediately.

DoSave can be used in the following PeopleCode events only: FieldEdit, FieldChange, or ItemSelected (for menu items in popup menus only).

Parameters

None.

Returns

None.

Example

The following example sets up a key list with AddKeyListItem, saves the current page, and then transfers the user to a page named PAGE_2.

#### DoSaveNow

Syntax

DoSaveNow()

Description

The DoSaveNow function is designed primarily for use with remote calls. It enables a PeopleCode program to save page data to the database before running a remote process (most frequently a COBOL process) that will access the database directly. It is generally necessary to call DoSaveNow before calling the RemoteCall function.

DoSaveNow causes the current page to be saved immediately. Save processing (including SaveEdit, SavePreChange, SavePostChange, and Workflow PeopleCode) is executed before continuing execution of the program where DoSaveNow is called. DoSaveNow differs from the DoSave function in that DoSave defers saving the component until after any running PeopleCode is completed.

DoSaveNow can only be called from a FieldEdit or FieldChange event.

If you call DoSaveNow and there are no changes to save, save processing is skipped entirely. You can call SetComponentChanged right before you call DoSaveNow. The SetComponentChanged function makes the Component Processor think there are changes and so will force full save processing.

See RemoteCall, DoSave.

Errors in DoSaveNow Save Processing

DoSaveNow initiates save processing. It handles errors that occur during save processing as follows:

• If save processing encounters a SaveEdit error, it displays the appropriate message box. DoSaveNow immediately exits from the originating FieldChange or FieldEdit program. The user can correct the error and continue.

• If save processing encounters a fatal error, it displays the appropriate fatal error. DoSaveNow handles the error by immediately exiting from the originating FieldChange or FieldEdit program. The user must then cancel the page.

• If save processing completes with no errors, PeopleCode execution continues on the line after the DoSaveNow call in FieldChange or FieldEdit.

Restrictions on Use of DoSaveNow

The following restrictions apply:

• DoSaveNow can be executed only from a FieldEdit or FieldChange event.

• DoSaveNow is only allowed prior to the first CallAppEngine function in a FieldChange event, but not afterward.

• Deferred operations should not be called before the DoSaveNow. Deferred operations include the DoSave, TransferPage, SetCursorPos, and EndModal functions.

• Components that use DoSaveNow must not use the DoCancel, Transfer, TransferPage, or WinEscape functions in PeopleCode attached to save action events (SaveEdit, SavePreChange, and SavePostChange), because these functions terminate the component, which would cause the program from which DoSaveNow was called to terminate prematurely.

Note. You should be aware that DoSaveNow may result in unpredictable behavior if PeopleCode in save events deletes rows or inserts rows into scrolls. PeopleCode that runs after DoSaveNow must be designed around the possibility that rows were deleted or inserted (which causes row number assignments to change). Modifying data on a deleted row may cause it to become “undeleted.”

Parameters

None.

Returns

None.

Example

The following example calls DoSaveNow to save the component prior to running a remote process in the remote_depletion declared function:

Declare Function remote_depletion PeopleCode FUNCLIB_ININTFC.RUN_DEPLETION Field⇒ Formula; /* Express Issue Page - run Depletion job through RemoteCall() */ If %Component = COMPONENT.EXPRESS_ISSUE_INV Then DoSaveNow(); &BUSINESS_UNIT = FetchValue(SHIP_HDR_INV.BUSINESS_UNIT, 1); &SHIP_OPTION = "S"; &SHIP_ID = FetchValue(SHIP_HDR_INV.SHIP_ID, 1); remote_depletion(&BUSINESS_UNIT, &SHIP_OPTION, &SHIP_ID, &PROGRAM_STATUS); End-If

Syntax

Description

Use the EnableMenuItem function to enable (make available for selection) the specified menu item. To apply this function to a pop-up menu, use the PrePopup Event of the field with which the pop-up menu is associated.

If you’re using this function with a pop-up menu associated with a page (not a field), the earliest event you can use is the PrePopup event for the first "real" field on the page (that is, the first field listed in the Order view of the page in Application Designer.)

Restrictions on Use With a Component Interface

This function is ignored (has no effect) when used by a PeopleCode program that’s been called by a Component Interface.

Parameters

Returns

None.

Example

#### EncodeURL

Syntax

EncodeURL(URLString)

Description

Use the EncodeURL function to apply URL encoding rules, including escape characters, to the string specified by URLString. The method used to encode the URLString is the standard defined by W3C. This function returns a string that contains the encoded URL. All characters outside the Unicode Basic Latin block (U+0020 — U+007F) are encoded, with the exception of the characters in the table below which are not encoded as they may represent valid components of URL or protocol syntax. If you need to encode such characters, use the EncodeURLForQueryString function.

The following table lists the punctuation characters in the Unicode Basic Latin block that are not encoded by the URLEncode function.

 Punctuation Character Description Glyph Unicode Character Name ! Exclamation mark # Number sign $Dollar sign & Ampersand ( Left parenthesis ) Right parenthesis * Asterisk + Plus sign , Coma - Hyphen, minus . Full stop, period / Solidus, slash : Colon ; Semi-colon = Equals sign ? Question mark _ Underscore Parameters  URLString Specify the string you want encoded. This parameter takes a string value. Returns An encoded string. Example The example below returns the following encoded URL: http://corp.office.com/human%20resources/benefits/401kchange_home.htm?FirstName=⇒ Gunter&LastName=D%c3%9crst &MYSTRING = EncodeURL("http://corp.office.com/hr/benefits/401k/401k_home.htm"); See Also #### EncodeURLForQueryString Syntax EncodeURLForQueryString(URLString) Description Use the EncodeURLForQueryString function to encode URLString for use in a query string parameter in an URL. All characters outside the Unicode Basic Latin block (U+0020 — U+007F) are encoded, with the exception of the characters in the table below which are not encoded as they are typically valid in a query string. If the link is constructed in a page, and the value is a link field, you should not call EncodeURL to encode the entire URL, as the PeopleSoft Pure Internet Architecture does this for you. You still need to unencode the parameter value when you retrieve it, however. Always encode each field value being added directly to query strings using EncodeURLForQueryString. The following table lists punctuation characters in the Unicode Basic Latin block that are not encoded by the URLEncodeForQueryString function.  Punctuation Character Description ( Left parenthesis ) Right parenthesis * Asterisk - Hyphen, minus . Full stop, period _ Underscore, low line Parameters  URLString Specify the string you want encoded. This parameter takes a string value. Returns An encoded URL string. Example In an Internet Script, to construct an anchor with a URL in a query string parameter, do the following: &url = "http://host/psp/ps/EMPLOYEE/HRMS/s/EMPL_INFO.FieldFormula.IScript_EMPL_⇒ INFO?emplid=1111&mkt=usa" &href = %Request.RequestURI | "?" | %Request.QueryString | "&myurl=" | ​Encode⇒ URLForQueryString(&url); %Response.WriteLine("<a href= " | EncodeURL(&href) | ">My Link</a>"); The following uses a generic method to find, then encode, the URL, for the external link: &StartPos = Find("?", &URL, 1); &CPColl = &Portal.ContentProviders; &strHREF = ​EncodeURLForQueryString(Substring(&URL, &StartPos + 1, Len(&URL) -⇒ &StartPos)); &LINK = &Portal.GetQualifiedURL("PortalServlet", "PortalOriginalURL=" |⇒ &CPColl.ItembyName(&CP_NAME).URI | "?" | ​&strHREF); See Also #### Encrypt Syntax Encrypt(KeyString, ClearTextString) Description Use the Encrypt function to encrypt a string. This function is generally used with merchant passwords. The value you use for KeyString must be the same for Decrypt and Encrypt. Size Considerations for Encrypt The Encrypt function uses 56-bit DES (Data Encryption Standard). The size of the output string is increased to the nearest multiple of 8 bytes. The string is encrypted (which doesn't modify the size), then encoded, which increases the resulting size to the next multiple of 3. Then, the system multiplies the result by 4/3 to get the final encrypted size. For example, a 16-character, Unicode field is 32 bytes long, which is already an even multiple of 8. After it is encrypted, it is encoded, which increases the size of the string to 33 bytes (the next multiple of 3). Then, the system multiplies this by 4/3 to get the final encrypted string size of 44 bytes. Parameters  KeyString Specify the key used for encrypting the string. You can specify a Null value for this parameter, that is, two quotation marks with no blank space between them (""). ClearTextString Specify the string you want encrypted. Returns An encrypted string. Example The following encrypts a field if it contains a value. It also removes any blanks either preceding or trailing the value. If All(PSCNFMRCHTOKEN.WRKTOKEN) Then CMPAUTHTOKEN = Encrypt("", RTrim(LTrim(PSCNFMRCHTOKEN.WRKTOKEN))); End-If; See Also #### EncryptNodePswd Syntax EncryptNodePswd(Password) Description Use the EncryptNodePswd function to encrypt an Integration Broker node password. Note. This function is generally used with Integration Broker node password encryption. This function should not be used casually, as once you encrypt your node password, there is no decrypt PeopleCode method. Parameters  Password Specify the Integration Broker node password that you want encrypted, as a string. Returns An encrypted password as a string. Example In the following example, the password is stored in the database in an encrypted form instead of as plain text: PSMSGNODEDEFN.IBPASSWORD = EncryptNodePswd(RTrim(LTrim(PSNODE_WRK.WRKPASSWORD))); See Also #### EndMessage Syntax EndMessage(message, messagebox_title) Description Note. The EndMessage function is obsolete and is supported only for backward compatibility. The MessageBox function, which can now be used to display informational messages in any PeopleCode event, should be used instead. Use the EndMessage function to display a message at the end of a transaction, at the time of the database COMMIT. This function can be used only in SavePostChange PeopleCode. When an EndMessage function executes, PeopleTools: • Verifies that the function is in SavePostChange; if it is not, an error occurs and the function terminates. • Displays the message. • Terminates the SavePostChange PeopleCode program. Because it terminates the SavePostChange program, EndMessage is always be the last statement executed in the program on the specific field and row where the EndMessage is called. For this reason, you must write the SavePostChange program so that all necessary processing takes place before the EndMessage statement. PeopleCode programs on other fields and rows execute as usual. Parameters  message A string that must be enclosed in quotes containing the message text you want displayed. messagebox_title A string that must be enclosed in quotes containing the title of the message. It appears in the message box title bar. Returns None. Example The following example is from SavePostChange event PeopleCode. It checks to see whether a condition is true, and if so, it displays a message and terminates the SavePostChange program. If the condition is false, then processing continues in the Else clause: If BUSINESS_UNIT = BUS_UNIT_WRK.DEFAULT_SETID Then EndMessage(MsgGet(20000, 12, "Message not found in Message Catalog")," "); Else /* any other SavePostChange processing in Else clause */ See Also #### EndModal Syntax EndModal(returnvalue) Description Use the EndModal function to close a currently open secondary page. It is required only for secondary pages that do not have OK and Cancel buttons. If the secondary page has OK and Cancel buttons, then the function for exiting the page is built in and no PeopleCode is required. Restrictions on Use With a Component Interface This function is ignored (has no effect) when used by a PeopleCode program that’s been called by a Component Interface. Parameters  returnvalue A Number value that determines whether the secondary page data is copied back to the parent page. A positive value runs SaveEdit PeopleCode and copies the data (this is the same as clicking the OK button). A value of zero skips SaveEdit and discards buffer changes made in the secondary page (this is the same as clicking the Cancel button). This value becomes the return value of the DoModal function that started the secondary page, and it can be tested after the secondary page is closed. Returns None. Example The following statement acts as an OK button: EndModal(1); The following statement acts as a Cancel button: EndModal(0); See Also #### EndModalComponent Syntax EndModalComponent(ReturnValue) Description Use the EndModalComponent function to close a currently open secondary component. You could use this for creating your own links to exit a secondary component. Restrictions on Use With a Component Interface This function can’t be used by a PeopleCode program that’s been called by a Component Interface, and is ignored. Parameters  ReturnValue A Number value that determines whether the secondary component data is saved and copied back to the parent page. A positive value saves the data in the component to the database, including all save processing and PeopleCode (this is the same as pressing the OK button). It also copies the data in the shared work record, if any, back to the primary component. A value of zero skips save processing discards buffer changes made in the secondary component (this is the same as pressing the Cancel button). Returns A Boolean value: True if a non-zero value was used, False if zero was used. Example EndModalComponent(0); /* cancels the component without saving */ EndModalComponent(1); /* saves and closes the component */ See Also #### EnQueue Syntax EnQueue(logical queue, task type, Relative URL, Language_Code [,subject][, agent ID][, overflow timeout][, escalation timeout][, cost][, priority][, skill level]) Description Use the EnQueue function to assign a task to one of the active, physical queues belonging to the specified logical queue. The physical queue to which the system assigns the task is chosen randomly to balance load across the queues. Note. PeopleSoft recommends that you always follow the EnQueue function with the NotifyQ function. See NotifyQ. Parameters  logical queue ID Specifies the logical queue in which the task should be queued. It is a string value. The logical queue ID is a case-sensitive value. The case used in the EnQueue function must exactly match the case used when creating the logical queue ID with the MultiChannel Framework administration pages. task type Specifies the type of task to be inserted. It is a string value. The valid values are: email generic Note. This parameter does not apply to voice or chat. Chat tasks are enqueued using the InitChat function. Voice queueing is managed by PeopleSoft CTI. Relative URL The system uses this relative URL to generate the URL of the appropriate application page for the MultiChannel Framework console to launch when an agent accepts this task. The application page should contain the logic to enable the agent to resolve the task and either forward the task using the Forward function or dequeue the task using the DeQueue function. Language_Code This is the language code associated with the task to be enqueued. It is a string value that must exist in the PeopleSoft language table. The queue server only assigns this task to an agent whose list of languages contains this value. For example if an email to be enqueued is written in English, the language code would be “ENG”, and this email would only be assigned to agents whose language list contains English. subject This is an optional parameter. It is a string value describing the purpose of the request. This value appears on the agent's console when the system assigns the task. agent ID Specifies the assigned agent. This is an optional, string parameter. If specified, the system holds the task until the specified agent is available to take this task. If this parameter is left blank, the queue server assigns it to the first available agent. Note. For better performance, PeopleSoft recommends not specifying the target agent as this has a processing overhead for the queue servers and does not allow the system to balance workload across all available agents. overflow timeout This is an optional parameter. It is an integer value expressing the overflow timeout in minutes. The overflow timeout is the time period within which a queue server has to find an agent who accepts the task (clicks on the flashing icon on the MultiChannel console). If the task is not accepted within this time, the task is removed from the queue and placed in the MultiChannel overflow table. If you do not specify a value, the system uses the default value specified for that task type in the Task Configuration page. escalation timeout This is an optional parameter. It is an integer value expressing the escalation timeout in minutes. The escalation timeout is the time period within which a task must be completed by the agent and closed with DeQueue. If the task is not closed within this time, the task is removed from the queue and from the agent's accepted task list, which means the task becomes unassigned. Then the task is placed in the MultiChannel Framework escalation table. If no value is specified, the system uses the default specified for that task type in the Task Configuration pages. cost This is an optional parameter. It is an integer value measuring the workload each task places on an agent. The cost of a task is an estimate of the tasks's expected complexity and of the time required to resolve the task. The minimum value is 0, and there is no maximum value. The cost of a task is added to an agent's workload after accepting a task on the MultiChannel Framework console. A task can't be assigned to an agent if the difference between the current workload and the maximum workload defined for that agent on the Agent configuration page is less than the cost of this task. If you do not specify a value, the system uses the default value specified for that task in the Task Configuration pages. Note. If the required skill level or cost submitted exceeds the highest skill level or maximum workload of any of the agents on that queue, the task cannot be assigned. priority This is an optional parameter. It is an integer value expressing the priority level of the request. The minimum value is 0 and there is no maximum value. A higher value means a higher priority. Tasks are ordered on a physical queue based on their assigned priority. That is, the system assigns a task of a higher priority before it assigns a task of a lower priority. If no value is specified, the system uses the default value specified for that task type in the Task Configuration page. When tasks have the same priority, the system orders the tasks according to the time they were created. For example, suppose the following tasks exist: Priority 2 created at 11:15 AM and Priority 2 created at 11:16 AM. In this case, the system assigns the task created at 11:15 AM before the task created at 11:16 AM. skill level This is an optional parameter. It is an integer value expressing the minimum skill level required of the agent to whom the system routes the request. You set an agent's skill level in the Agent configuration page. The queue server assigns this task type to an available agent on that queue whose lowest skill level is greater than or equal to the skill level required by the task. If no value is specified, the system uses the default value specified for that task type in the Task Configuration page. Note. If the required skill level or cost submitted exceeds the highest skill level or maximum workload of any of the agents on that queue, the task cannot be assigned. Returns If the insert was successful, the function returns a task number in the form of a string. If unsuccessful, it returns a message number. The message set ID for MultiChannel Framework is 162. For example, 1302 is returned when an invalid task type or no value is provided. Example &PortalValue = Portal.EMPLOYEE; &NodeValue = Node.QE_LOCAL; /*If running in Application Engine, this code assumes CONTENT URI has been set in node defn admin page*/ &MyCompURL = GenerateComponentContentRelURL(&PortalValue, &NodeValue, MenuName.PT_MCF, "GBL", Component.MCFEM_DEMOERMS_CMP, Page.MCFEM_ERMSMN, ""); &MyCompURL = &MyCompURL | "&ps_emailid=" | &emailid; /*Query string dependent on component. Our demo comonent just needs email id*/ rem The URL to be passed will look something like; rem "/psc/ps/EMPLOYEE/QE_LOCAL/c/PT_MCF.MCF_DEMOERMS_CMP.GBL?Page=MCFEM_ERMSMN"; &strtasknum = ​EnQueue(&queueID, "email", &MyCompURL, &langcode, &subject, "QEDMO", 15, 60, &cost, &priority, &minskill); See Also #### Error Syntax Error str Description Use the Error function in FieldEdit or SaveEdit PeopleCode to stop processing and display an error message. It is distinct from Warning, which displays a warning message, but does not stop processing. Error is also used in RowDelete and RowSelect PeopleCode events. Warning! The behavior of the Error function in the RowSelect event is very different from its normal behavior. See the Error in RowSelect section for more details. The text of the error message (the str parameter), should always be stored in the Message Catalog and retrieved using the MsgGet or MsgGetText functions. This makes it much easier for the text to be translated, and it also enables you to include more detailed Explain text about the error. Note. If you pass a string to the Error function instead of using a Message Catalog function, the explanation text from the last call to the Message Catalog may be appended to the message. This can cause unexpected results. See WinMessage. When Error executes in a PeopleCode program, the program terminates immediately and no statements after the Error are executed. In other respects behavior of Error differs, depending on which PeopleCode event the function occurs in. Errors in FieldEdit and SaveEdit The primary use of Error is in FieldEdit and SaveEdit PeopleCode: • In FieldEdit, Error stops processing, displays a message, and highlights the relevant field. • In SaveEdit, Error stops all save processing and displays a message, but does not highlight any field. You can move the cursor to a specific field using the SetCursorPos function, but be sure to call SetCursorPos before calling Error, otherwise Error stops processing before SetCursorPos is called. Note that an Error on any field in SaveEdit stops all save processing, and no page data is saved to the database. Errors in RowDelete When the user attempts to delete a row of data, the system first prompts for confirmation. If the user confirms, the RowDelete event fires. An Error in the RowDelete event displays a message and prevents the row from being deleted. Error in RowSelect The behavior of Error in RowSelect is totally anomalous, and is supported only for backward compatibility. It is used to filter rows that are being added to a page scroll after the rows have been selected and brought into the component buffer. No message is displayed. Error causes the Component Processor to add the current row (the one where the PeopleCode is executing) to the page scroll, then stops adding any additional rows to the page scroll. The behavior of Error in the RowSelect event enables you to filter out rows that are above or below some limiting value. In practice this technique is rarely used, because it is more efficient to filter out rows of data before they are brought into the component buffer. This can be accomplished with search views or effective date processing. Errors in Other Events Do not use the Error function in any of the remaining events, which include: • FieldDefault • FieldFormula • RowInit • FieldChange • Prepopup • RowInsert • SavePreChange • SavePostChange Parameters  Str A string containing the text of the error message. This string should always be stored in the Message Catalog and retrieved using the MsgGet or MsgGetText function. This makes translation much easier and also enables you to provide detailed Explain text about the error. Returns None. Example The following example, from SaveEdit PeopleCode, displays an error message, stops all save processing, and places the cursor in the QTY_ADJUSTED field. Note that SetCursorPos must be called before Error. If PAGES2_INV_WRK.PHYS_CYC_INV_FLG = "Y" Then SetCursorPos(%Page, PHYSICAL_INV.INV_LOT_ID, CurrentRowNumber(1), QTY_⇒ ADJUSTED, CurrentRowNumber()); Error MsgGet(11100, 180, "Message not found."); End-If; See Also #### EscapeHTML Syntax EscapeHTML(TextString) Description Use the EscapeHTML function to replace all characters in TextString that would otherwise be interpreted as markup sequences. The characters that are replaced are ones that would cause the browser to interpret them as HTML tags or other markup if they aren't encoded, and therefore pre-formatted HTML should not be passed to this function unless the output desired is a rendering of the HTML code itself as opposed to it's interpretation. This function is intended to make the text "browser safe". This function is for use with strings that display in an HTML area. Either HTML character entities (eg. &lt) or Numeric Character Representations (e.g. &#039) are output by the EscapeHTML function, depending on the character passed. The table below shows the escaping that is performed by EscapeHTML. In addition to escaping characters that could be misinterpreted as HTML tags or other elements, EscapeHTML escapes the percentage sign (%) as this could interfere with meta HTML processing. As all PeopleTools HTML is generated in Unicode, it is not necessary to escape other Unicode characters — their value may be passed directly to the browser instead of a character entity or in Numeric Character Representation. The following table lists the Unicode characters that are escaped by the EscapeHTML function. For example, the less-than symbol (<) is replaced with &lt., a single quotation mark (') is replaced with &#039., and so on.  Unicode Character Name Glyph Escape Sequence Quotation mark ” " Ampersand & & Less than sign < < Apostrophe, single quote ' ' Percentage sign % % New line Not applicable Parameters  TextString Specify a string of HTML that contains characters that must be replaced with HTML escape sequences. Returns A string containing the original text plus HTML escape sequences. See Also #### EscapeJavascriptString Syntax EscapeJavascriptString(String) Description Use the EscapeJavascriptString function to replace the characters in String that have special meaning in a JavaScript string as escape sequences. For example, a single quotation mark ( ' ) is replaced by \', a new line character is replaced by \n, and so on. This function is for use with text that becomes part of a JavaScript program. The characters that are replaced are ones that cause the browser to misinterpret the JavaScript if they aren't encoded. This function is intended to make the text “browser safe.” The table below shows the strings that are replaced by this function, and their replacement character sequence.  Character Name Glyph Description Apostrophe, single quote ' \' Quotation mark " \" New line Not applicable \n Carriage return Not applicable Deleted Double backslash \\ \\\\ Parameters  String Specify a string that contains character that need to be replaced with JavaScript escape sequences. Returns A string containing the original text plus JavaScript escape sequences. See Also #### EscapeWML Syntax EscapeWML(String) Description Use the EscapeWML function to escape special characters that are significant to WML. This includes <, >,$ (escaped as ), &, ' and ".

This function is for use with strings that display on an WML browser.

Parameters

 String Specify a string that contains characters that need to be replaced with WML escape sequences.

Returns

A string containing the original plus text plus WML escape sequences.

#### Evaluate

Syntax

Evaluate left_term When [relop_1] right_term_1 [statement_list] . . .

[When [relop_n] right_term_n [statement_list]] [When-other [statement_list]] End-evaluate

Description

Use the Evaluate statement to check multiple conditions. It takes an expression, left_term, and compares it to compatible expressions (right_term) using the relational operators (relop) in a sequence of When clauses. If relop is omitted, then = is assumed. If the result of the comparison is True, it executes the statements in the When clause, then moves on to evaluate the comparison in the following When clause. It executes the statements in all of the When clauses for which the comparison evaluates to True. If and only if none of the When comparisons evaluates to True, it executes the statement in the When-other clause (if one is provided).

To end the Evaluate after the execution of a When clause, you can add a Break statement at the end of the clause.

Considerations Using When Clause

Generally, you use the When clause without a semicolon at the end of the statement. However, in certain circumstances, this can cause an error. For example, the following PeopleCode produces an error because the PeopleCode compiler cannot separate the end of the Where clause with the beginning of the next statement:

When = COMPONENT.GARBAGE (create BO_SEARCH:Runtime:BusinessContact_Contact(&fBusObjDescr, Null, &f⇒ DerivedBOID, &fDerivedBORole, &fBusObjDescr1, Null, &fContactBOID, &fContactRole⇒ ID, &fCustBOID, &fCustRoleID, "")).SearchItemSelected(); End-Evaluate;

If you place a semicolon after the When clause, the two expressions are read separately by the compiler. For example:

When = COMPONENT.GARBAGE;

Example

The following is an example of a When statement taken evaluates ACTION and performs various statements based on its value:

&PRIOR_STATUS = PriorEffdt(EMPL_STATUS); Evaluate ACTION When "HIR" If %Mode = "A" Then Warning MsgGet(1000, 13, "You are hiring an employee and Action is not set to Hire."); End-if; Break; When = "REH" If All(&PRIOR_STATUS) and not (&PRIOR_STATUS = "T" or &PRIOR_STATUS = "R" ) Then Error MsgGet(1000, 14, "Hire or Rehire action is valid only if employee status is Terminated or Retired."); End-if; Break; When-Other /* default code */ End-evaluate;

#### Exact

Syntax

Exact(string1, string2)

Description

Use the Exact function to compare two text strings and returns True if they are the same, False otherwise. Exact is case-sensitive because it uses the internal character codes.

Returns

Returns a Boolean value: True if the two strings match in a case-sensitive comparison.

Example

The examples set &MATCH to True, then False:

&MATCH = Exact("PeopleSoft", "PeopleSoft"); &MATCH = Exact("PeopleSoft", "Peoplesoft");

#### Exec

Syntax

Exec(command_str [, parameter])

where parameter has one of the following formats:

Boolean constant

Exec_Constant + Path_Constant

Description

Exec is a cross-platform function that executes an external program on either UNIX or Windows.

This function has two parameter conventions in order to maintain upward compatibility with existing programs.

Note. All PeopleCode is executed on the application server. So if you're calling an interactive application, you receive an error. There shouldn't be any application interaction on the application server console.

The function can make either a synchronous or asynchronous call. Synchronous execution acts as a "modal" function, suspending the PeopleSoft application until the called executable completes. This is appropriate if you want to force the user (or the PeopleCode program) to wait for the function to complete its work before continuing processing. Asynchronous processing, which is the default, launches the executable and immediately returns control to the calling PeopleSoft application.

If Exec is unable to execute the external program, the PeopleCode program terminates with a fatal error. You may want to try to catch these exceptions by enclosing such statements in a try-catch statement (from the Exception Class).

Command Formatting

The function automatically converts the first token on command_str platform-specific separator characters to the appropriate form for where your PeopleCode program is executing, regardless of the path_constant. On a Windows system, a UNIX "/" separator is converted to "\", and on a UNIX system, a Windows "\" separator is converted to "/".

This is only done for the first token on command_str assuming it to be some sort of file specification. This allows you to put file or program names in canonical form (such as, UNIX style) as the first token on the exec command.

Using an Absolute Path

If you do not specify anything for the second parameter, or if you specify a Boolean value, the path to PS_HOME is prefixed to the command_str.

If you specify constant values for the second parameter, PS_HOME may or may not be prefixed, depending on the values you select.

You can use the GetEnv function to determine the value of PS_HOME.

Creating a File in UNIX

If you try to create a file on a UNIX machine using the Exec function the file might not be created due to permission issues. If you encounter this problem, create a script file that includes the file creation commands and run the script using the Exec function. The script file must have correct privileges.

If you pass an absolute path in the Exec argument you must use the %FilePath_Absolute flag

Restrictions on Use in PeopleCode Events

When Exec is used to execute a program synchronously (that is, if its synch_exec parameter is set to True) it behaves as a think-time function, which means that it can’t be used in any of the following PeopleCode events:

• SavePreChange.

• SavePostChange.

• Workflow.

• RowSelect.

• Any PeopleCode event that fires as a result of a ScrollSelect (or one of its relatives) function calls, or a Select (or one of its relatives) Rowset class method.

Parameters

 command_str The command_str parameter consists of a series of tokens that together make up the name of the executable to run and the parameters to be passed to it. Tokens are separated by unquoted space characters. Single or double quote characters can be used for quoting. Both types of quotes are treated equivalently, but the starting and ending quotes for a quoted portion of a token must match. A quoted string may not contain quotes of the same type but a single quoted string can contain double quote characters and vice versa. A single token may consist of multiple adjacent quoted characters (There must be no spaces between the quoted fragments). Unterminated quoted fragments will result in an error. Note. PeopleCode strings will require two double quote characters within a string to embed a double quote character. Boolean | Constants If you specify a Boolean value, it indicates whether to execute the external program synchronously or asynchronously. Values are: True - Synchronous False - Asynchronous (default) If you do not specify a value, the program executes asynchronously. If you use this style, PS_HOME is always prefixed to command_str. If you specify constant values, you're specifying a numeric value composed of an exec_constant and a path_constant. The exec_constant specifies whether to execute the external program synchronously or not. The path_constant specifies how the path name is to be treated. The value specified is made up of the addition of these predefined constants. Values are:

 Exec Constant Description %Exec_Asynchronous Program executes asynchronously (the default) %Exec_Synchronous Program executes synchronously.

 Path Constant Description %FilePath_Relative PS_HOME is prefixed to command_str. %FilePath_Absolute Nothing is prefixed to command_str.

Returns

What is returned depends on what you specified for the second parameter.

If you specified a Boolean, a Number value equal to the process ID of the called process is returned.

If you specify constant values, the returned value contains the value of the exit code of the program executed using this function, unless you have executed the program asynchronously.

Example

&ExitCode = Exec("sh -c " | &scriptFile, %Exec_Synchronous + %FilePath_Absolute);

The following example demonstrates executing a program where the path to the executable contains spaces and a single parameter containing space characters is passed. Suppose the location of the executable is C:\Program Files\App\program.exe and the value of the first parameter is 1 2 3.

Exec("'c:\Program Files\App\program.exe' '1 2 3'", %FilePath_Absolute)

or

Exec("""c:\Program Files\App\program.exe"" ""1 2 3""", %FilePath_Absolute)

This is an example of executing a program with a parameter that contains space and single quote characters. The second parameter is enclosed in double quotes so that the single quote and space characters are passed correctly. Suppose your executable is program.exe. The first parameter is -p and the second parameter is customer's update.

Exec("program.exe -p ""customer’s update""")

This is an example of executing a program with a parameter that contains space, single quote, and double quote characters. The second parameter consists of several adjacent quoted fragments. The first fragment is enclosed in double quotes so that the single quote and space characters are passed correctly and the second fragment is enclosed in single quotes so that the double quote and space characters are passed correctly. Note that there are no spaces between the quoted fragments. Suppose your executable is program.exe. The first parameter is -p and the second parameter is John’s comment: “Hello There”.

Exec("program.exe -p ""John's comment: ""'""Hello There""'")

#### ExecuteRolePeopleCode

Syntax

ExecuteRolePeopleCode(RoleName)

Description

Use the ExecuteRolePeopleCode function to execute the PeopleCode Rule for the Role RoleName. This function returns an array of string containing dynamic members (UserIds).

Typically, this function is used by an Application Engine process that runs periodically and executes the role rules for different roles. It could then write the results of the rules (a list of users) into the security tables, effectively placing users in certain roles based on the rule.

Parameters

 RoleName Specify the name of an existing role.

Returns

An array of string containing the appropriate UserIds.

Example

The following saves valid users to a temporary table:

Local array of string &pcode_array_users; SQLExec("delete from ps_dynrole_tmp where ROLENAME=:1", &ROLENAME); If &pcode_rule_status = "Y" Then SQLExec("select RECNAME, FIELDNAME, PC_EVENT_TYPE, PC_FUNCTION_NAME from PSROLEDEFN where ROLENAME= :1", &ROLENAME, &rec, &fld, &pce, &pcf); If (&rec <> "" And &fld <> "" And &pce <> "" And &pcf <> "") Then &pcode_array_users = ​ExecuteRolePeopleCode(&ROLENAME); &pcode_results = True; Else &pcode_results = False; End-If; &comb_array_users = &pcode_array_users; End-If;

#### ExecuteRoleQuery

Syntax

ExecuteRoleQuery(RoleName, BindVars)

where BindVars is an arbitrary-length list of bind variables that are stings in the form:

bindvar1 [, bindvar2]. . .

Description

Use the ExecuteRoleQuery function to execute the Query rule for the role rolename, passing in BindVars as the bind variables. This function returns an array object containing the appropriate user members (UserIds).

Parameters

 RoleName Specify the name of an existing role. BindVars A list of bind variables to be substituted in the query. These bind variables must be strings. You can't use numbers, dates, and so on.

Returns

An array object containing the appropriate UserIds.

#### ExecuteRoleWorkflowQuery

Syntax

ExecuteRoleWorkflowQuery(RoleName, BindVars)

where BindVars is an arbitrary-length list of bind variables in the form:

bindvar1 [, bindvar2]. . .

Description

Use the ExecuteRoleWorkflowQuery function to execute the Workflow Query rule for the role rolename, passing in BindVars as the bind variables. This function returns an array object containing the appropriate user members (UserIds).

Parameters

 RoleName Specify the name of an existing role. BindVars A list of bind variables to be substituted in the query.

Returns

An array object containing the appropriate UserIds.

#### Exit

Syntax

Exit([1])

Description

Use the Exit statement to immediately terminate a PeopleCode program. If the Exit statement is executed within a PeopleCode function, the main program terminates.

Note. Exit(1) does not rollback iScript transactions. To rollback in an iScript, you can use the SqlExec built-in function with the parameter of ROLLBACK (SQLEXEC("ROLLBACK")) or the MessageBox built-in function with a message error severity of error. You can also use the built-in function Error, but only if you are not sending HTML or XML in the error text itself.

Parameters

 1 Use this parameter to rollback database changes. Generally, this parameter is used in PeopleCode programs that affect messages. When used with a message, all database changes are rolled back, errors for the subscription contract are written to the subscription contract error table, and the status of the message is marked to Error. All errors that have occurred for this message are viewable in the message monitor: even those errors detected by the ExecuteEdits method.

Note. This function takes only numeric values. It fails if you use a Boolean value, True or False.

Returns

None.

Example

The following example terminates the main program from a For loop:

For &I = 1 To ActiveRowCount(RECORD.SP_BUIN_NONVW) &ITEM_SELECTED = FetchValue(ITEM_SELECTED, &I); If &ITEM_SELECTED = "Y" Then &FOUND = "Y"; Exit; End-If; End-For;

#### Exp

Syntax

Exp(n)

Description

Exp returns the constant e raised to the power of n where n is a number. The constant e equals 2.71828182845904, the base of natural logarithms. The number n is the exponent applied to the base e.

Exp is the inverse of the Ln function, which is the natural logarithm of x.

Returns

Returns a Number value equal to the constant e raised to the power of n.

Example

The examples set &NUM to 2.71828182845904, then 7.389056099(e2):

&NUM = Exp(1); &NUM = Exp(2);

Ln, Log10.

#### ExpandBindVar

Syntax

ExpandBindVar(str)

Description

Inline bind variables can be included in any PeopleCode string. An inline bind variable is a field reference (in the form recordname.fieldname), preceded by a colon. The inline bind variable references the value in the field.

Use the ExpandBindVar function to expand any inline bind variables that it finds in str into strings (converting the data type of non-character fields) and returns the resulting string. This works with inline bind variables representing fields containing any data type except Object. It also expands bind variables specified using additional parameters.

See SQLExec.

Parameters

 str A string containing one or more inline bind variables.

Returns

Returns a String value equal to the input string with all bind variables expanded.

Example

A bind variable is included in the string &TESTSTR, which is then expanded into a new string containing the current value of BUS_EXPENSE_PER.EMPLID in place of the bind variable. If this program runs on the row for EMPLID 8001, the message displayed reads "This is a test using EmplID 8001".

&TESTSTR = "This is a test using EmplID :bus_expense_per.emplid"; &RESULT = ExpandBindVar(&TESTSTR); WinMessage(&RESULT);

#### ExpandEnvVar

Syntax

ExpandEnvVar(string)

Description

Use the ExpandEnvVar function to convert any environment variables that it finds within string into String values and returns the entire resulting string.

Parameters

 string A string containing an environment variable.

Returns

Returns a string equal to string with any enclosed environment variables expanded to their values.

Example

Assume that the environment variable %NETDRIVE% is equal to "N:". The following PeopleCode sets &newstring equal to "The network drive is equal to N:":

&newstring = ExpandEnvVar("The network drive is equal to %netdrive%.");

#### ExpandSqlBinds

Syntax

ExpandSqlBinds(string)

Description

Prior to PeopleTools 8.0, the PeopleCode replaced runtime parameter markers in SQL strings with the associated literal values. For databases that offer SQL statement caching, a match was never found in the cache so the SQL had to be re-parsed and re-assigned a query path.

To process skipped parameter markers, each parameter marker is assigned a unique number. This doesn’t change the values associated with the parameter markers.

However, some SQL statements can’t contain parameter markers because of database compatibility.

To process these exceptions, use the ExpandSqlBinds function. This function does the bind variable reference expansion, and can be used within a SQLExec statement or on its own.

You should use ExpandSQLBinds only for those parts of the string that you want to put literal values into. The following code shows how to use ExpandSQLBinds with %Table:

SQLExec(ExpandSqlBinds("Insert.... Select A.Field, :1, :2 from ", "01", "02") | "%table(:1)", Record.MASTER_ITEM_TBL);

Parameters

 string Specify the string you want to do the bind variable reference expansion on.

Returns

A string.

Example

The following example shows both the original string and what it expands to.

&NUM = 1; &STRING = "My String"; &STR2 = ExpandSqlBinds("This :2 is an expanded string(:1)", &STRING, &NUM);

The previous code produces the following value for &STR2:

This 1 is an expanded string(My String)

If you’re having problems with an old SQL statement binds, you can use ExpandSqlBinds with it. For example, if your SQLExec is this:

SQLExec("String with concatenated bindrefs ‘M’:2, ‘M’:1", &VAR1, &VAR2), &FETCHRESULT1, &FETCHRESULT2);

you can make it work by expanding it as follows:

SQLExec(ExpandSqlBinds("String with concatenated bindrefs ‘M’:2, ‘M’:1", &VAR1, &VAR2), &FETCHRESULT1, &FETCHRESULT2);

#### Fact

Syntax

Fact(x)

Description

Use the Fact function to return the factorial of a positive integer x. The factorial of a number x is equal to 1*2*3*...*x. If x is not an integer, it is truncated to an integer.

Returns

Returns a Number equal to the factorial of x.

Example

The example sets &X to 1, 1, 2, then 24. Fact(2) is equal to 1*2; Fact(4) is equal to 1*2*3*4:

&X = Fact(0); &X = Fact(1); &X = Fact(2); &X = Fact(4);

#### FetchSQL

Syntax

FetchSQL([SQL.]sqlname[, dbtype[, effdt]] )

Description

Use the FetchSQL function to return the SQL definition with the given sqlname as SQL.sqlname or a string value, matching the dbtype and effdt. If sqlname is a literal name, it must be in quotes.

Parameters

 sqlname Specify the name of a SQL definition. This is either in the form SQL.sqlname or a string value giving the sqlname. dbtype Specify the database type associated with the SQL definition. This parameter takes a string value. If dbtype isn’t specified or is null (""), it is set by default to the current database type (the value returned from the %DbType system variable.) Values for dbtype are as follows. These values are not case-sensitive: APPSRV DB2ODBC DB2UNIX INFORMIX MICROSFT ORACLE SYBASE Note. Database platforms are subject to change. effdt Specify the effective date associated with the SQL definition. If effdt isn’t specified, it is set by default to the current as of date, that is, the value returned from the %AsOfDate system variable.

Returns

The SQL statement associated with sqlname as a string.

Example

The following code gets the text associated with the ABCD_XY SQL Definition for the current DBType and as of date:

&SQLSTR = FetchSQL(SQL.ABC_XY);

The following code gets the text associated with the ABCD_XY SQL Definition for the current DBType and November 3, 1998:

&SQLSTR = FetchSQL(SQL.ABCD_XY, "", Date(19981103));

#### FetchValue

Syntax

FetchValue(scrollpath, target_row, [recordname.]fieldname)

where scrollpath is:

[RECORD.level1_recname, level1_row, [RECORD.level2_recname, level2_row, ]] RECORD.target_recname

To prevent ambiguous references, you can also use SCROLL.scrollname, where scrollname is the same as the scroll level’s primary record name.

Description

Use the FetchValue function to return the value of a buffer field in a specific row of a scroll level.

Note. This function remains for backward compatibility only. Use the Value field class property instead.

This function is generally used to retrieve the values of buffer fields outside the current context; if a buffer field is in the current context, you can reference it directly using a [recordname.]fieldname expression.

Parameters

 scrollpath A construction that specifies a scroll level in the component buffer. target_row An integer specifying the row on the target scroll level where the referenced buffer field is located. [recordname.]fieldname The name of the field where the value to fetch is located. The field can be on scroll level one, two, or three of the active page. The recordname prefix is required if the call to FetchValue is not on the record definition recordname.

Returns

Returns the field value as an Any data type.

Example

The following example retrieves the value from field DEPEND_ID in record DEPEND on row &ROW_CNT from scroll level one:

&VAL = FetchValue(SCROLL.DEPEND, &ROW_CNT, DEPEND.DEPEND_ID);

#### FieldChanged

Syntax

The syntax of the FieldChanged function varies depending on whether you want to use a scroll path reference or a contextual reference to specify the field.

If you want to use a scroll path reference, the syntax is:

FieldChanged(scrollpath, target_row, [recordname.]fieldname)

where scrollpath is:

[RECORD.level1_recname, level1_row, [RECORD.level2_recname, level2_row, ]] RECORD.target_recname

To prevent ambiguous references, you can also use SCROLL.scrollname, where scrollname is the same as the scroll level’s primary record name.

If you want to use a contextual reference, the syntax is:

FieldChanged([recordname.]fieldname)

In this construction the scroll level and row number are determined based on the current context.

Description

The FieldChanged function returns True if the referenced buffer field has been modified since being retrieved from the database either by a user or by a PeopleCode program.

Note. This function remains for backward compatibility only. Use the IsChanged field class property instead.

This is useful during SavePreChange or SavePostChange processing for checking whether to make related updates based on a change to a field.

Parameters

 scrollpath A construction that specifies a scroll level in the component buffer. [recordname.]fieldname The name of the field where the value to check is located. The field can be on scroll level one, two, or three of the active page. The recordname prefix is required if the call to FieldChanged is not on the record definition recordname. target_row The row number of the target row. If this parameter is omitted, the function assumes the row on which the PeopleCode program is executing.

Related Functions

Save PeopleCode programs (SaveEdit, SavePreChange, SavePostChange) normally process each row of data in the component. The following four functions enable you to control more precisely when the Component Processor should perform save PeopleCode:

• FieldChanged

• RecordChanged

• RecordDeleted

• RecordNew

These functions enable you to restrict save program processing to specific rows.

Example

The following example checks three fields and sets a flag if any of them has changed:

/* Set the net change flag to 'Yes' if the scheduled date, scheduled */ /* time or quantity requested is changed */ If FieldChanged(QTY_REQUESTED) Or FieldChanged(SCHED_DATE) Or FieldChanged(SCHED_TIME) Then NET_CHANGE_FLG = "Y"; End-If;

#### FileExists

Syntax

FileExists(filename [, pathtype])

Description

Use the FileExists function to determine whether a particular external file is present on your system, so you can decide which mode to use when you open the file for writing.

Note. If you want to open a file for reading, you should use the "E" mode with the GetFile function or the File class Open method, which prevents another process from deleting or renaming the file between the time you tested for the file and when you open it.

Parameters

 filespec Specify the name, and optionally, the path, of the file you want to test. pathtype If you have prepended a path to the file name, use this parameter to specify whether the path is an absolute or relative path. The valid values for this parameter are: %FilePath_Relative (default) %FilePath_Absolute If you don’t specify pathtype the default is %FilePath_Relative. If you specify a relative path, that path is appended to the path constructed from a system-chosen environment variable. A complete discussion of relative paths and environment variables is provided in documentation on the File class. If the path is an absolute path, whatever path you specify is used verbatim. You must specify a drive letter and the complete path. You can’t use any wildcards when specifying a path. The Component Processor automatically converts platform-specific separator characters to the appropriate form for where your PeopleCode program is executing. On a Windows system, UNIX "/" separators are converted to "\", and on a UNIX system, Windows "\" separators are converted to "/". Note. The syntax of the file path does not depend on the file system of the platform where the file is actually stored; it depends only on the platform where your PeopleCode is executing.

Returns

A Boolean value: True if the file exists, False if it doesn’t.

Example

The following example opens a file for appending if it exists in the system:

If FileExists("c:\work\item.txt", %FilePath_Absolute) Then &MYFILE = GetFile("c:\work\item.txt", "A"); /* Process the file */ &MYFILE.Close(); End-If;

#### Find

Syntax

Find(string, within_string [, number])

Description

Use the Find function to locate one string of text within another string of text and returns the character position of the string as an integer. Find is case-sensitive and does not allow wildcards.

If you need to do either case-sensitive search or pattern matching, just to find if a string matches a pattern, use the DBPatternMatch function.

If you need to find a quotation mark, you need to double it in a string.

&find = Find("""", PSOPRDEFN_SRCH.OPRID);

Parameters

 string The text you are searching for. A tilde character (~) used in the string parameter stands for an arbitrary number of white spaces. within_string The text string you are searching within. number The position of within_string at which you want to start your search. If you omit number, Find starts at the first character of within_string.

Returns

Returns a Number value indicating the starting position of string in within_string.

Find returns with 0 if string does not appear in within_string, if number is less than or equal to zero, or if number is greater than the length of within_string.

Example

In the following example, the first statement returns 1; the second statement returns 6.

&POS = Find("P", "PeopleSoft") &POS = Find("e", "PeopleSoft", 4)

#### Findb

Syntax

Findb(string, within_string [, number])

Description

Note. This function has been deprecated and is no longer supported.

#### FindCodeSetValues

Syntax

FindCodeSetValues(CodesetName, &NameValuePairs, SourceNodeName, TargetNodeName)

Description

Use the FindCodeSetValues function to find a list of code set name-value pairs. Code sets are primarily used with data value translations as part of a transformation.

Parameters

 CodeSetName Specify the name of the code set you want to find, as a string. &NameValuePairs Specify a 2 dimensional array containing the name value pairs in the specified code set that you want to use. SourceNodeName Specify the name of the source (initial) node used in the data transformation. TargetNodeName Specify the name of the target (result) node used in the data transformation.

Returns

A two-dimensional array of any.

Example

This example checks the specified CodeSet values, with the name value pairs of "locale/en_us" and "uom/box". It takes the returned array and adds XML nodes to the document. The XML nodes names are the unique names of the CodeSet value, and the XML node value is the corresponding return value.

/* Get the data from the AE Runtime */ Local TransformData &incomingData = %TransformData; /* Set a temp object to contain the incoming document */ Local XmlDoc &tempDoc = &incomingData.XmlDoc; /* Declare the node */ Local XmlNode &tempNode; /* Create an array to hold the name value pairs */ Local array of array of string &inNameValuePairsAry; /* Clear out the doc and put in a root node */ If (&tempDoc.ParseXmlString("<?xml version=""1.0""?><xml/>")) Then /* Load the array with some values */ &inNameValuePairsAry = CreateArray(CreateArray("locale", "en_us"), CreateArray("uom", "box")); /* Find the codeset values */ &outAry = ​FindCodeSetValues("PS_SAP_PO_01", &inNameValuePairsAry, "SAP_SRC", "PSFT_TGT"); /* Local XmlNode &tempNode; */ /* Make sure something was returned */ If &outAry.Len > 0 Then /* Loop through the quantities and make sure they are all above 5 */ For &i = 1 To &outAry.Len /* Add the current system date to the working storage*/ &tempNode = &tempDoc.DocumentElement.AddElement(&outAry [&i][1]); &tempNode.NodeValue = &outAry [&i][2]; End-For; End-If; End-If;

#### FindFiles

Syntax

FindFiles(filespec_pattern [, pathtype])

Description

Use the FindFiles function to return a list of the external file names that match the file name pattern you provide, in the location you specify.

Parameters

 filespec_pattern Specify the path and file name pattern for the files you want to find. The path can be any string expression that represents a single relative or absolute directory location. The file name pattern, but not the path, can include two wildcards: * (Asterisk): matches zero or more characters at its position. ? (Question mark): matches exactly one character at its position. pathtype If you have prepended a path to the file name, use this parameter to specify whether the path is an absolute or relative path. The valid values for this parameter are: %FilePath_Relative (default) %FilePath_Absolute If you don’t specify pathtype the default is %FilePath_Relative. If you specify a relative path, that path is appended to the path constructed from a system-chosen environment variable. A complete discussion of relative paths and environment variables is provided in documentation on the File class. If the path is an absolute path, whatever path you specify is used verbatim. You must specify a drive letter and the complete path. You can’t use any wildcards when specifying a path. The Component Processor automatically converts platform-specific separator characters to the appropriate form for where your PeopleCode program is executing. On a Windows system, UNIX "/" separators are converted to "\", and on a UNIX system, Windows "\" separators are converted to "/". Note. The syntax of the file path does not depend on the file system of the platform where the file is actually stored; it depends only on the platform where your PeopleCode is executing.

Returns

A string array whose elements are file names qualified with the same relative or absolute path you specified in the input parameter to the function.

Example

The following example finds all files in the system’s TEMP location whose names end with ".txt", then opens and processes each one in turn:

Local array of string &FNAMES; Local file &MYFILE; &FNAMES = FindFiles("\*.txt"); while &FNAMES.Len > 0 &MYFILE = GetFile(&FNAMES.Shift(), "R"); /* Open each file */ /* Process the file contents */ &MYFILE.Close(); end-while;

#### FlushBulkInserts

Syntax

FlushBulkInserts()

Description

Use the FlushBulkInserts function to move the bulk inserted rows from the bulk insert buffers of the PeopleSoft process to the physical tables on the database. This flushes all open SQL objects that have pending bulk inserts, but performs no COMMITs. If the flush fails, the PeopleCode program terminates.

When executing a SQL insert using a SQL object with the BulkMode property set to True, the rows being inserted cannot be selected by this database connection until the bulk insert is flushed. For another connection to the database to be able to select those rows, both a flush and a COMMIT are required. To have your process see the bulk inserted rows without committing and without closing the SQL object or its cursor (that is, maintaining reuse for the SQL object), use FlushBulkInserts.

An example of using this function would be in preparation for a database commit where you do not want to close the SQL insert statement, but need to ensure that all the rows you have inserted up to this point are in fact in the database and not in the buffer.

Another example would be when another SQL statement in the same PeopleSoft process needs to select rows that have been inserted using bulk insert and you do not want to close the SQL insert statement. The SELECT cannot read rows in the bulk insert buffer, so you need to flush them to the table from which the SELECT is reading.

Parameters

None.

Returns

None. If the flush fails, the PeopleCode program terminates.

Example

&CM_DEPLETION_REC = CreateRecord(Record.CM_DEPFIFO_VW); &CM_DEPLETE_REC = CreateRecord(Record.CM_DEPLETE); &DEPLETE_FIFO_SEL = GetSQL(SQL.CM_DEPLETE_FIFO_SEL); &ONHAND_FIFO_SEL = GetSQL(SQL.CM_ONHAND_FIFO_SEL); DEPLETE_INS = GetSQL(SQL.CM_DEPLETE_INS); &DEPLETE_INS.BulkMode = True; &DEPLETE_FIFO_SEL.Execute(&CM_DEPLETION_REC, CM_COSTING_AET.BUSINESS_UNIT, CM_COSTING_AET.CM_BOOK); While &DEPLETE_FIFO_SEL.Fetch(&CM_DEPLETION_REC); /* Call functions that populate &CM_DEPLETE_REC.values */ . . . &DEPLETE_INS.Execute(&CM_DEPLETE_REC); . . . If &CM_DEPLETION_REC.CM_COST_PROC_GROUP.Value = "BINTOBIN" Then /* Bin to Bin transfers are both a deplete and receipt, call functions to create the receipt */ . . . /* Flush Bulk Insert to be able to see the current on hand quantities in CM_ONHAND_VW */ FlushBulkInserts(); End-if; End-While; . . .

#### For

Syntax

For count = expression1 To expression2 [Step i]; statement_list End-for

Description

Use the For loop to cause the statements of the statement_list to be repeated until count is equal to expression2. Step specifies the value by which count will be incremented each iteration of the loop. If you do not include Step, count is incremented by 1 (or -1 if the start value is greater than the end value.) Any statement types are allowed in the loop, including other loops.

A Break statement inside the loop causes execution to continue with whatever follows the loop. If the Break occurs in a nested loop, the Break does not apply to the outside loop.

Example

The following example loops through all of the rows for the FIELDNAME scroll area:

&FIELD_CNT = ActiveRowCount(DBFIELD_VW.FIELDNAME); For &I = 1 to &FIELD_CNT; WinMessage(MsgGetText(21000, 1, "Present Row Number is: %1", &I)); End-for;

#### FormatDateTime

Syntax

FormatDateTime(datetime, {timezone | "Local" | "Base"}, displayTZ)

Description

Use the FormatDateTime function to take a datetime value and convert it to text. If a specific time zone abbreviation, or a field reference, is passed in timezone, FormatDateTime adjusts the DateTime to the user’s local time zone instead of the specified time zone. The system’s base time zone is specified on the PSOPTIONS table. The value datetime is assumed to be in base time.

If Local is specified for time zone, FormatDateTime adjusts the DateTime to the user’s local time zone instead of a specific time zone.

If True is specified for displayTZ, FormatDateTime appends the time zone abbreviation to the returned string.

Parameters

 datetime Specify the DateTime value to be formatted. timezone | Local | Base Specify a value for converting datetime. The values are: timezone - a time zone abbreviation or a field reference to be used for converting datetime. Local - use the local time zone for converting datetime. Base - use the base time zone for converting datetime. displayTZ Specify whether the time zone abbreviation should be appended to the returned string. This parameter takes a Boolean: True if the abbreviation should be appended, False, otherwise.

Returns

A formatted string value.

Example

The following example populates the &DISPDATE variable with a string containing the DateTime value in the ORDER_DATE field adjusted to the user’s local time zone, and with the time zone abbreviation.

&DISPDATE=FormatDateTime(ORDER_DATE, "Local", True);

The following example populates the &DISPDATE variable with a string containing the DateTime value in the SHIP_DATE field adjusted to the time zone stored in the SHIP_TZ field, and does not include the time zone abbreviation in the output.

&DISPDATE=FormatDateTime(SHIP_DATE, SHIP_TZ, False);

#### Forward

Syntax

Forward(from physical queue ID, from agent ID, task number, task type, to logical queue ID[, to agent ID])

Description

Use the Forward function to transfer a task from one agent to another agent or from one agent's logical queue to another logical queue. This enables agents to reroute tasks that are not appropriate for their skill level or functional expertise.

Keep the following in mind when using Forward:

• The queue server subtracts the task's cost from the transferring agent's workload.

• The system cannot forward tasks to logical queues that do not have active physical queues on the same MultiChannel Framework cluster as the physical queue to which the task currently belongs. That is, you can't forward tasks across MultiChannel Framework clusters.

• A queue server does not allow a task to be transferred if the agent who owns that task is not logged on to that queue server. PeopleSoft recommends that you only use Forward for application pages that the MultiChannel Framework console launches when agents accept or activate assigned tasks.

• Forward only applies to email and generic task types.

Parameters

Returns

Returns 0 on success.

If unsuccessful, it returns a message number. The message set ID for MultiChannel Framework is 162.

For example, 1302 is returned when an invalid task type or no value is provided.

Example

Forward("SALES5", "TSAWYER", "email_2145", "email", "MARKETING", "GSALMON");

The following example shows how to retrieve parameters from the application page using the GetParameter request class method.

#### Function

Syntax

Function name[(paramlist)] [Returns data_type] [statements] End-function

Where paramlist is:

&param1 [As data_type] [, &param2 [As data_type]]...

Where data_type is any valid data type, including Number, String, Date, Rowset, SQL, Record, and so on.

Where statements is a list of PeopleCode statements.

Description

PeopleCode functions can be defined in any PeopleCode program. Function definitions must be placed at the top of the program, along with any variable and external function declarations.

Functions can be called from the program in which they are defined, in which case they don’t need to be declared, and they can be called from another program, in which case they need to be declared at the top of the program where they are called.

Any variables declared within a function are valid for the scope of the function.

By convention, external PeopleCode functions are stored in records whose names begin in FUNCLIB_, and they are always placed in the FieldFormula event (which is convenient because this event should no longer be used for anything else).

Note. Functions can be stored in the FieldFormula event only for record fields, not for component record fields.

A function definition consists of:

• The keyword Function followed by the name of the function and an optional list of parameters. The name of the function can be up to 100 characters in length.

• An optional Returns clause specifying the data type of the value returned by the function.

• The statements to be executed when the function is called.

• The End-function keyword.

The parameter list, which must be enclosed in parentheses, is a comma-separated list of variable names, each prefixed with the & character. Each parameter is optionally followed by the keyword As and the name for one of the conventional PeopleCode data types (Number, String, Date, and so on) or any of the object data types (such as Rowset, SQL, and so on.) If you specify data types for parameters, then function calls are checked to ensure that values passed to the function are of the appropriate type. If data types are not specified, then the parameters, like other temporary variables in PeopleCode, take on the type of the value that is passed to them.

Note. If a parameter is listed in the function definition, then it is required when the function is called.

PeopleCode parameters are always passed by reference. This means that if you pass the function a variable from the calling routine and change the value of the variable within the function, the value of the variable is changed when the flow of execution returns to the calling routine.

If the function is to return a result to the caller, the optional Returns part must be included to specify the data type of the returned value. You have seven choices of value types: Number, String, Date, Time, DateTime, Boolean, or Any.

PeopleCode internal subroutines are part of the enclosing program and can access the same set of variables as the other statement-lists of the program, in addition to local variables created by the parameters and local variable declarations within the function.

Returning a Value

You can optionally return a value from a PeopleCode function. To do so, you must include a Returns statement in the function definition, as described in the preceding section. For example, the following function returns a Number value:

Function calc_something(&parm1 as number, &parm2 as number) Returns number

In the code section of your function, use the Return statement to return the value to the calling routine. When the Return statement executes, the function ends and the flow of execution goes back to the calling routine.

Example

This example returns a Boolean value based on the return value of a SQLExec:

Function run_status_upd(&PROCESS_INSTANCE, &RUN_STATUS) Returns boolean; &UPDATEOK = SQLExec("update PS_PRCS_RQST set run_status = :1 ⇒ where process_instance = :2", &RUN_STATUS, &PROCESS_INSTANCE); If &UPDATEOK Then Return True; Else Return False; End-If; End-Function;

#### GenABNNodeURL

Syntax

GenABNNodeURL(node,initial_node,display_parent)

Description

Use the GenABNNodeURL function to generate a URL for a specific node within a SmartNavigation chart.

Important! This function must be called during a user action that displays the SmartNavigation chart—for example, when the user clicks on a folder icon from the menu or when the user clicks on the first description link of a SmartNavigation chart node. Otherwise, the function returns an empty string.

Parameters

 node Specify the ID of the node to be displayed as a string. initial_node Specify the ID of the initial node of the SmartNavigation chart as a string. display_parent A Boolean value indicating whether the node to be displayed requires that its parent node also be displayed in the chart.

Returns

A string representing the URL to navigate to the specified node.

Example

&Mode = %Request.GetParameter("mode"); If None(&Mode) Then rem only valid during a click event since this code sets a panel buffer field; &NodeID = "10400"; &Node = &MyTree.FindNode(&NodeID, ""); &rootNode = &MyTree.FindRoot(); If &rootNode.Name = &Node.Name Then &bDisplParent = False; Else &bDisplParent = True; End-If; &Field = GetLevel0()(1).GetRowset(Scroll.PT_ABNCHARTNODE)(1).PT_ABN_CHART_ND.⇒ PT_ABN_CHART_DFLD6; &Field.Value = GenABNNodeURL(&NodeID, GetABNInitialNode(&reqParams), ⇒ &bDisplParent); End-If;

#### GenDynABNElement

Syntax

GenDynABNElement(&str_param1[,&str_param2], ...)

Description

Use the GenDynABNElement function to generate <li> elements for the specified data source to be used as a dynamically generated SmartNavigation subfolder. This built-in function is required when the root SmartNavigation folder is designated as a “dynamic hierarchy” folder on the Folder Administration page.

The <li> elements generated by this function can be provided as the input to the GenHTMLMenu function. Alternatively, the output of one invocation of GenDynABNElement can be concatenated to subsequent invocations prior to calling the GenHTMLMenu function.

Parameters

 &str_param1, &str_param2, ... Specifies the first and additional input parameters to the function as string variables.

Note. Each string parameter can be specified as a string literal or a string variable.

While this function can accept an unlimited number of string parameters, in practical terms, the function expects a specific number of string parameters in a specific order depending on whether the data source for the dynamically generated SmartNavigation subfolder is a tree or a rowset.

When the data source for the SmartNavigation subfolder is a tree, 11 string parameters are required in the following order with the following specifications:

• Data source type – For a tree, this parameter must be "t".

• Display as CREF – Indicates that the SmartNavigation folder is to be displayed as a CREF, which immediately displays the SmartNavigation chart, instead of as a folder with submenus. Specify as false = "f"; true = "t".

• Folder ID – Specifies a programmatically generated folder ID. For example: "PRS_DATA_001".

• Folder label – Specifies the label to display for this subfolder in the SmartNavigation menu drop-downs, fly-outs, and breadcrumbs. For example: "Personnel Data".

• Chart component – Specifies the page used to render the SmartNavigation chart in the following format: COMPONENT.PAGE.MKT.

• PeopleCode ID – Specifies the PeopleCode program to run to generate the SmartNavigation elements for the specified data source. The PeopleCode ID must be in the following format: APP_PKG.Class.Method.

• Tree name – Specifies the name for the tree. For example: "PERS_DATA".

• Tree setID – Specifies the setID for the tree. For example: "SHARE".

• Tree user key – Specifies the user key value for the tree (also known as the set control value). An actual value is optional but must be specified as the null string: "".

• Tree effective date – Specifies the effective date for the tree. An actual value is optional but must be specified as the null string: "".

• Tree branch – Specifies the tree branch. An actual value is optional but must be specified as the null string: "".

SmartNavigation passes the values of several tree-specific fields to the application via URL. Certain characters are inappropriate for use in a URL and must be avoided. When using a tree as a SmartNavigation data source, do not use any of the following characters in the tree name, setID, user key value, and tree branch values:

 pound (#) percent (%) dollar ($) ampersand (&) plus (+) comma (,) forward slash/virgule (/) colon (:) semi-colon (;) equals (=) question mark (?) at symbol (@) space ( ) quotation marks(") less than symbol (<) greater than symbol (>) left curly brace ({) right curly brace (}) vertical bar/pipe (|) backslash (\) caret (^) tilde (~) left square bracket ([) right square bracket (]) grave accent () For example: rem Create SmartNavigation dynamic folder from a tree; &fldr = GenDynABNElement(&ds_t, &cref_t, &fldr_id, &label_t, &chart_t, &pcode_t, ⇒ &tree_name, &tree_setid, &tree_userkey, &tree_effdt, &tree_branch); When the data source for the SmartNavigation subfolder is a rowset, 6 string parameters are required in the following order with the following specifications: • Data source type – For a rowset, this parameter must be "r". • Display as CREF – Indicates that the SmartNavigation folder is to be displayed as a CREF, which immediately displays the SmartNavigation chart, instead of as a folder with submenus. Specify as false = "f"; true = "t". • Folder ID – Specifies a programmatically generated folder ID. For example: "PRS_DATA_001". • Folder label – Specifies the label to display for this subfolder in the SmartNavigation menu drop-downs, fly-outs, and breadcrumbs. For example: "Personnel Data". • Chart component – Specifies the page used to render the SmartNavigation chart in the following format: COMPONENT.PAGE.MKT. • PeopleCode ID – Specifies the PeopleCode program to run to generate the SmartNavigation elements for the specified data source. The PeopleCode ID must be in the following format: APP_PKG.Class.Method. For example: rem Create SmartNavigation dynamic folder from a rowset; &fldr = GenDynABNElement(&ds_r, &cref_r, &fldr_id, &label_r, &chart_r, &pcode_r); Returns A string representing the <li> elements for the data source. Example The following example demonstrates how the GenDynABNElement function could be implemented in a method. This method would be specified in the application package parameters on the Folder Administration page for a folder that is configured as a “dynamic hierarchy” folder. In this example, the output of the second invocation of GenDynABNElement is concatenated to the output of the first invocation resulting in two dynamically generated SmartNavigation subfolders being displayed beneath the root “dynamic hierarchy” folder. method QE_ABN_DYN_HIERARCHY_MIXED Local string &fldrList; rem variables for abn tree; Local string &ds_t, &cref_t, &fldr_id, &id_t, &label_t, &portal, &node, ⇒ &chart_t, &pcode_t, &tree_name, &tree_setid, &tree_userkey, &tree_effdt, ⇒ &tree_branch; rem variables for abn rowset; Local string &ds_r, &cref_r, &id_r, &label_r, &chart_r, &pcode_r; rem abn tree sample; &ds_t = "t"; &cref_t = "f"; &fldr_id = "QE_ABN_DH_44"; rem &id_t=""; &label_t = "Dynamic ABN Tree"; rem &portal=""; rem &node = ""; &chart_t = "PT_ABN_ORGCHART.PT_ABN_ORGCHART.GBL"; &pcode_t = "QE_ABNTREE.qe_abntree.QE_ABN_TREE_AP"; &tree_name = "QE_PERS_DATA"; &tree_setid = "QEDM1"; &tree_userkey = ""; &tree_effdt = "1997/05/05"; &tree_branch = ""; rem create abn tree folder here; &fldrList = GenDynABNElement(&ds_t, &cref_t, &fldr_id, &label_t, &chart_t, ⇒ &pcode_t, &tree_name, &tree_setid, &tree_userkey, &tree_effdt, &tree_branch); rem abn rowset sample; &ds_r = "r"; &cref_r = "f"; rem &id_r=""; &label_r = "Dynamic ABN Rowset"; &chart_r = "QE_PIA_TEST_PAGES.QE_ABN_ORGCHART.GBL"; &pcode_r = "QE_ABN_RS_APKG.QE_ABN_RS_1:QE_ABNRS_C1.QE_ABNRS_M"; rem append abn rowset folder after the abn tree; &fldrList = &fldrList | GenDynABNElement(&ds_r, &cref_r, &fldr_id, &label_r, ⇒ &chart_r, &pcode_r); rem generate menu item in nav; GenHTMLMenu(&fldrList); end-method; See Also #### GenerateActGuideContentUrl Syntax GenerateActGuideContentlUrl(PORTAL.portalname, NODE.nodename, MENUNAME.menuname, Marketname, COMPONENT.componentname, ActivityGuide) Description Use the GenerateActGuideContentUrl function to create a URL string that represents an absolute reference to the specified activity guide (life event) for the content servlet. The ContentURI of the node that hosts the specified portal is used in the generated URL. The URL contains a reference to the content service (psc) servlet. If you want to generate a URL for the portal service (psp) servlet, use the GenerateActGuidePortalURL function. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. nodename Specify the name of the node that contains the activity guide, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. menuname Specify the name of the menu containing the activity guide, prefixed with the reserved word MENUNAME. You can also use a string, such as %Menu, for this value. Marketname Specify the name of the market of the component. You can also use a string, such as %Market, for this value. ComponentName Specify the name of the component, prefixed with the reserved word COMPONENT. You can also use a string, such as %Component, for this value. ActivityGuide Specify the name of the Activity Guide, as a string. Returns A string with the following format: http://Content URI of node/portal/node/l/ActivityGuide.component.market This function returns a Null string if you specify an invalid portal or node. Example The following code: &AGURL = GenerateActGuideContentUrl(%Portal, %Node, MENUNAME.MAINTAIN_SECURITY,⇒ "GBL", COMPONENT.CHANGE_PASSWORD, "QE_ACTIVITY_GUIDE_DEMO"); might produce the following URL string: http://boynten8700/psc/ps/EMPLOYEE/QE_LOCAL/l/QE_ACTIVITY_GUIDE_DEMO.MAINTAIN_ SECURITY.CHANGE_PASSWORD.GBL See Also #### GenerateActGuidePortalUrl Syntax GenerateActGuidePortalUrl(PORTAL.portalname, NODE.nodename, MENUNAME.menuname, Marketname, COMPONENT.componentname, ActivityGuide) Description Use the GenerateActGuidePortalUrl function to create a URL string that represents an absolute reference to the specified activity guide (life event) for the portal servlet. The PortalURI of the node that hosts the specified portal is used in the generated URL. The URL contains a reference to the portal service (psp) servlet. If you want to generate a URL for the portal content (psc) servlet, use the GenerateActGuideContentURL function. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. nodename Specify the name of the node that contains the activity guide, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. menuname Specify the name of the menu containing the activity guide, prefixed with the reserved word MENUNAME. You can also use a string, such as %Menu, for this value. Marketname Specify the name of the market of the component. You can also use a string, such as %Market, for this value. ComponentName Specify the name of the component, prefixed with the reserved word COMPONENT. You can also use a string, such as %Component, for this value. ActivityGuide Specify the name of the Activity Guide, as a string. Returns A string with the following format: http://Portal URI of node/portal/node/l/ActivityGuide.component.market This function returns a Null string if you specify an invalid portal or node. Example The following code: &AGURL = GenerateActGuidePortalUrl(%Portal, %Node, MENUNAME.MAINTAIN_SECURITY, "GBL", COMPONENT.CHANGE_PASSWORD, "QE_ACTIVITY_GUIDE_DEMO"); might create the following URL string: http://boynte700/psp/ps/EMPLOYEE/QE_LOCAL/l/QE_ACTIVITY_GUIDE_DEMO.MAINTAIN_ SECURITY.CHANGE_PASSWORD.GBL See Also #### GenerateActGuideRelativeUrl Syntax GenerateActGuideRelativeUrl(PORTAL.portalname, NODE.nodename, MENUNAME.menuname, Marketname, COMPONENT.componentname, ActivityGuide) Description Use the GenerateActGuideContentUrl function to create a URL string that represents an relative reference to the specified activity guide (life event). The relative reference is suitable for use on any page that itself has the simple URL format. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. nodename Specify the name of the node that contains the activity guide, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. menuname Specify the name of the menu containing the activity guide, prefixed with the reserved word MENUNAME. You can also use a string, such as %Menu, for this value. Marketname Specify the name of the market of the component. You can also use a string, such as %Market, for this value. ComponentName Specify the name of the component, prefixed with the reserved word COMPONENT. You can also use a string, such as %Component, for this value. ActivityGuide Specify the name of the Activity Guide, as a string. Returns A string with the following format: ../../../Portal/node/l/ActivityGuide.menu.component.market This function returns a Null string if you specify an invalid portal or node. Example The following code: &AGURL = GenerateActGuideRelativeUrl(%Portal, %Node, MENUNAME.MAINTAIN_SECURITY, "GBL", COMPONENT.CHANGE_PASSWORD, "QE_ACTIVITY_GUIDE_DEMO"); might produce the following URL string: ../../../EMPLOYEE/QE_LOCAL/l/QE_ACTIVITY_GUIDE_DEMO.MAINTAIN_SECURITY.CHANGE_ PASSWORD.GBL See Also #### GenerateComponentContentRelURL Syntax GenerateComponentContentRelURL(PORTAL.portalname, NODE.nodename,MENUNAME.menuname, MARKET.marketname, COMPONENT.componentname, PAGE.pagename, action, [, keylist]) where keylist is a list of field references in the form: [recordname.]field1 [, [recordname.]field2]. . . OR &RecordObject1 [, &RecordObject2]. . . Description Use the GenerateComponentContentRelURL function to create a URL string that represents a relative reference to the specified component for the content servlet. The relative reference is suitable for use on any page that itself has the simple URL format. If you want to generate an absolute URL for a component, use the GenerateComponentContentURL function. Note. PeopleSoft recommends using the Transfer function for opening new windows, not this function, as there may be problems maintaining state and window count. Parameters  PortalName Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. This parameter is ignored by the content service, but is a required part of the psc URL format. NodeName Specify the name of the node that contains the content, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. MenuName Specify the name of the menu containing the content, prefixed with the reserved word MENUNAME. You can also use a string, such as %Menu, for this value. Marketname Specify the name of the market of the component, prefixed with the reserved word MARKET. You can also use a string, such as %Market, for this value. ComponentName Specify the name of the component, prefixed with the reserved word COMPONENT. You can also use a string, such as %Component, for this value. Pagename Specify the name of the page that contains the content. If you specify a page name, it must be prefixed with the keyword PAGE. You can also specify an empty string ("") for this value. Action Specify a single-character code. Valid actions are: "A" ( add) "U" (update) "L" (update/display all) "C" (correction) "E" (data entry) You can also specify an empty string ("") for this value. Keylist An optional list of field specifications used to select a unique row at level zero in the page you are transferring to, by matching keys in the page you are transferring from. It can also be an already instantiated record object. If a record object is specified, any field of that record object that is also a field of the search record for the destination component is added to keylist. The keys in the fieldlist must uniquely identify a row in the "to" page search record. If a unique row is not identified, of if Force Search Processing has been selected, the search dialog appears. If the keylist parameter is not supplied the destination component's search key must be found as part of the source components level 0 record buffer. Returns If the node has a Node Type of PIA, a string of the following format is returned: ../../../Portal/node/c/menu.component.market?parameters If the node has a Node Type of ICType, a string of the following format is returned: ../../../portal/node/?ICType=Panel&Menu=menu&Market=market&PanelGroupName=component?parameters The question mark and the text following the question mark may or may not be included, depending on whether or not you specified a page and action or not. This function returns a Null string if you specify an invalid portal or node. Example The following code: &MyCompURL = GenerateComponentContentRelURL("EMPLOYEEPORTAL", "CRM", MenuName.SFA, "GBL", Component.CUSTOMERINFO, Page.CUST_DATA1, "U", EMPLID); Might create the following URL: ../../../psc/PS84/EMPLOYEEPORTAL/CRM/c/SFA.CUSTOMERINFO.GBL?page= CUST_DATA1&&Action=U&emplid=00001 Because this function terminates if the portal or node name is invalid, it's enclosed in a try-catch section so if an exception gets raised, it can be handled. try &MyURL = GenerateComponentContentRelURL(%Portal, "HRMS", Menuname.ADMIN_ WORKFORCE, "GBL", Component.ABSENCE_HISTORY, Page. ABSENCE_HISTORY, "U", EMPLID) catch ExceptionPortal &Ex1 /* error handling portal name not valid */ catch ExceptionNode &Ex2 /* error handling Node name not valid */ end-try; See Also #### GenerateComponentContentURL Syntax GenerateComponentContentURL(PORTAL.portalname, NODE.nodename, MENUNAME.menuname, MARKET.marketname, COMPONENT.componentname, PAGE.pagename, action, [, keylist]) where keylist is a list of field references in the form: [recordname.]field1 [, [recordname.]field2]. . . OR &RecordObject1 [, &RecordObject2]. . . Description Use the GenerateComponentContentURL function to create a URL string that represents an absolute reference to the specified component for the content servlet. The ContentURI of the specified node is used in the generated URL. The URL contains a reference to the portal content (psc) servlet. If you want to generate a URL for the portal service (psp), use the GenerateComponentPortalURL function. Parameters  PortalName Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. This parameter is ignored by the content service, but is a required part of the psc URL format. NodeName Specify the name of the node that contains the content, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. MenuName Specify the name of the menu containing the content, prefixed with the reserved word MENUNAME. You can also use a string, such as %Menu, for this value. Marketname Specify the name of the market of the component, prefixed with the reserved word MARKET. You can also use a string, such as %Market, for this value. ComponentName Specify the name of the component, prefixed with the reserved word COMPONENT. You can also use a string, such as %Component, for this value. Pagename Specify the name of the page that contains the content. If you specify a page name, it must be prefixed with the keyword PAGE. You can also specify an empty string ("") for this value. Action Specify a single-character code. Valid actions are: "A" ( add) "U" (update) "L" (update/display all) "C" (correction) "E" (data entry) You can also specify an empty string ("") for this value. Keylist An optional list of field specifications used to select a unique row at level zero in the page you are transferring to, by matching keys in the page you are transferring from. It can also be an already instantiated record object. If a record object is specified, any field of that record object that is also a field of the search record for the destination component is added to keylist. The keys in the fieldlist must uniquely identify a row in the "to" page search record. If a unique row is not identified, of if Force Search Processing has been selected, the search dialog appears. If the keylist parameter is not supplied the destination component's search key must be found as part of the source components level 0 record buffer. Returns If the node has a Node Type of PIA, a string of the following format is returned: http://Content URI of host node/Portal/node/c/menu.component.market?parameters If the node has a Node Type of ICType, a string of the following format is returned: http://Content URI of host node/portal/node/?ICType=Panel&Menu=menu&Market=market &PanelGroupName=component?parameters The question mark and the text following the question mark may or may not be included, depending on whether or not you specified a page and action or not. This function returns a Null string if you specify an invalid portal or node. Example The following code: &MyCompURL = GenerateComponentContentURL("EMPLOYEEPORTAL", "CRM", MenuName.SFA, "GBL", Component.CUSTOMERINFO, Page.CUST_DATA1, "U", EMPLID); Might create the following URL: http://serverx/servlets/psc/PS84/EMPLOYEEPORTAL/CRM/c/SFA.CUSTOMERINFO.GBL?page= CUST_DATA1&&Action=U&emplid=00001 Because this function terminates if the portal or node name is invalid, it's enclosed in a try-catch section so if an exception gets raised, it can be handled. try &MyURL = GenerateComponentContentURL(%Portal, "HRMS", Menuname.ADMIN_WORKFORCE, "GBL", Component.ABSENCE_HISTORY, Page. ABSENCE_HISTORY, "U", EMPLID) catch ExceptionPortal &Ex1 /* error handling portal name not valid */ catch ExceptionNode &Ex2 /* error handling Node name not valid */ end-try; See Also #### GenerateComponentPortalRelURL Syntax GenerateComponentPortalRelURL(PORTAL.portalname, NODE.nodename, MENUNAME.menuname, MARKET.marketname, COMPONENT.componentname, PAGE.pagename, action, [, keylist]) where keylist is a list of field references in the form: [recordname.]field1 [, [recordname.]field2]. . . OR &RecordObject1 [, &RecordObject2]. . . Description Use the GenerateComponentPortalRelURL function to create a URL string URL string that represents a relative reference the specified content (component). The relative reference is suitable for use on any page that itself has the simple URL format. If you want to generate an absolute URL for a component, use the GenerateComponentPortalURL function. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. nodename Specify the name of the node that contains the content, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. menuname Specify the name of the menu containing the content, prefixed with the reserved word MENUNAME. You can also use a string, such as %Menu, for this value. Marketname Specify the name of the market of the component, prefixed with the reserved word MARKET. You can also use a string, such as %Market, for this value. ComponentName Specify the name of the component, prefixed with the reserved word COMPONENT. You can also use a string, such as %Component, for this value. pagename Specify the name of the page that contains the content. If you specify a page name, it must be prefixed with the keyword PAGE. You can also specify a Null string ("") for this value. action Specify a single-character code. Valid actions are: "A" ( add) "U" (update) "L" (update/display all) "C" (correction) "E" (data entry) You can also specify a Null string ("") for this value. keylist An optional list of field specifications used to select a unique row at level zero in the page you are transferring to, by matching keys in the page you are transferring from. It can also be an already instantiated record object. If a record object is specified, any field of that record object that is also a field of the search record for the destination component is added to keylist. The keys in the fieldlist must uniquely identify a row in the "to" page search record. If a unique row is not identified, of if Force Search Processing has been selected, the search dialog appears. If the keylist parameter is not supplied the destination component's search key must be found as part of the source components level 0 record buffer. Returns If the node has a Node Type of PIA, a string of the following format is returned: ../../../portal/node/c/menu.component.market?parameters If the node has a Node Type of ICType, a string of the following format is returned: ../../../portal/node/?ICType=Panel&Menu=menu&Market=market&PanelGroupName=component?parameters The question mark and the text following the question mark may or may not be included, depending on whether or not you specified a page and action or not. This function returns a Null string if you specify an invalid portal or node. Example The following code: &MyCompURL = GenerateComponentPortalRelURL("EMPLOYEEPORTAL", "CRM", MenuName.SFA, "GBL", Component.CUSTOMERINFO, , "", ""); Might create the following URL: ../../../EMPLOYEEPORTAL/CRM/c/sfa.customerinfo.gbl See Also #### GenerateComponentPortalURL Syntax GenerateComponentPortalURL(PORTAL.portalname, NODE.nodename, MENUNAME.menuname, MARKET.marketname, COMPONENT.componentname, PAGE.pagename, action, [, keylist]) where keylist is a list of field references in the form: [recordname.]field1 [, [recordname.]field2]. . . OR &RecordObject1 [, &RecordObject2]. . . Description Use the GenerateComponentPortalURL function to create a URL string that represents an absolute reference to the specified component for the portal servlet. The PortalURI of the node that hosts the specified portal is used in the generated URL. The URL contains a reference to the portal service (psp) servlet. If you want to generate a URL for the portal content (psc) servlet, use the GenerateComponentContentURL function. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. nodename Specify the name of the node that contains the content, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. menuname Specify the name of the menu containing the content, prefixed with the reserved word MENUNAME. You can also use a string, such as %Menu, for this value. Marketname Specify the name of the market of the component, prefixed with the reserved word MARKET. You can also use a string, such as %Market, for this value. ComponentName Specify the name of the component, prefixed with the reserved word COMPONENT. You can also use a string, such as %Component, for this value. pagename Specify the name of the page that contains the content. If you specify a page name, it must be prefixed with the keyword PAGE. You can also specify a Null string ("") for this value. action Specify a single-character code. Valid actions are: "A" ( add) "U" (update) "L" (update/display all) "C" (correction) "E" (data entry) You can also specify a Null string ("") for this value. keylist An optional list of field specifications used to select a unique row at level zero in the page you are transferring to, by matching keys in the page you are transferring from. It can also be an already instantiated record object. If a record object is specified, any field of that record object that is also a field of the search record for the destination component is added to keylist. The keys in the fieldlist must uniquely identify a row in the "to" page search record. If a unique row is not identified, of if Force Search Processing has been selected, the search dialog appears. If the keylist parameter is not supplied the destination component's search key must be found as part of the source components level 0 record buffer. Returns If the node has a Node Type of PIA, a string of the following format is returned: http://Portal URI of host node/portal/node/c/menu.component.market?parameters If the node has a Node Type of ICType, a string of the following format is returned: http://Portal URI of host node/portal/node/?ICType=Panel&Menu=menu&Market=market&PanelGroupName=component?parameters Note. If the host node is local, then Portal URI of host node will always be the one you're currently logged in as. The question mark and the text following the question mark may or may not be included, depending on whether or not you specified a page and action or not. This function returns a Null string if you specify an invalid portal or node. Example The following code: &MyCompURL = GenerateComponentPortalURL("EMPLOYEEPORTAL", "CRM", MenuName.SFA, "GBL", Component.CUSTOMERINFO, , "", ""); Might create the following URL: http://mike.com/servlets/psp/testsite/EMPLOYEEPORTAL/CRM/c/sfa.customerinfo.gbl The following example uses a de-referenced name for the component. &sComponent = "Component." | &sComponent; &sPage = "Page.EM_VCHR_PYMNT_CLN"; &rwCurrent = GetRow(); /*- The Search Record keys -*/ &sQueryString = &sQueryString | "&BUSINESS_UNIT=" | &rwCurrent.EM_VCHR_INQ_VW.EM_ BUSINESS_UNIT.Value; &sQueryString = &sQueryString | "&VOUCHER_ID=" | &rwCurrent.EM_VCHR_INQ_VW.VOUCHER_ID.Value; &sQueryString = ​GenerateComponentPortalURL(%Portal, %Node, MenuName.EM_BILL_PRESENTMENT, %Market, ​@&sComponent, @&sPage, "U") | &sQueryString; %Response.RedirectURL(&sURL); See Also #### GenerateComponentRelativeURL Syntax GenerateComponentRelativeURL(PORTAL.portalname, NODE.nodename, MENUNAME.menuname, MARKET.marketname, COMPONENT.componentname, PAGE.pagename, action, [, keylist]) where keylist is a list of field references in the form: [recordname.]field1 [, [recordname.]field2]. . . OR &RecordObject1 [, &RecordObject2]. . . Description Use the GenerateComponentRelativeURL function to create a URL string that represents a relative reference the specified content (component). The relative reference is suitable for use on any page that itself has the simple URL format. If you want to generate an absolute URL for a component, use either the GenerateComponentContentURL or GenerateComponentPortalURL function. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. nodename Specify the name of the node that contains the content, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. menuname Specify the name of the menu containing the content, prefixed with the reserved word MENUNAME. You can also use a string, such as %Menu, for this value. Marketname Specify the name of the market of the component, prefixed with the reserved word MARKET. You can also use a string, such as %Market, for this value. ComponentName Specify the name of the component, prefixed with the reserved word COMPONENT. You can also use a string, such as %Component, for this value. Pagename Specify the name of the page that contains the content. If you specify a page name, it must be prefixed with the keyword PAGE. You can also specify a Null string ("") for this value. Action Specify a single-character code. Valid actions are: "A" ( add) "U" (update) "L" (update/display all) "C" (correction) "E" (data entry) You can also specify a Null string ("") for this value. Keylist An optional list of field specifications used to select a unique row at level zero in the page you are transferring to, by matching keys in the page you are transferring from. It can also be an already instantiated record object. If a record object is specified, any field of that record object that is also a field of the search record for the destination component is added to keylist. The keys in the fieldlist must uniquely identify a row in the "to" page search record. If a unique row is not identified, of if Force Search Processing has been selected, the search dialog appears. If the keylist parameter is not supplied the destination component's search key must be found as part of the source components level 0 record buffer. Returns If the node has a Node Type of PIA, a string of the following format is returned: ../../../portal/node/c/menu.component.market?parameters If the node has a Node Type of ICType, a string of the following format is returned: ../../../portal/node/?ICType=Panel&Menu=menu&Market=market&PanelGroupName=component?parameters The question mark and the text following the question mark may or may not be included, depending on whether or not you specified a page and action or not. This function returns a Null string if you specify an invalid portal or node. Example The following code example: &MyCompURL = GenerateComponentRelativeURL("EMPLOYEEPORTAL", "CRM", MenuName.SFA, "GBL", Component.CUSTOMERINFO, "", ""); Might yield the following: ../../../EMPLOYEEPORTAL/CRM/c/sfa.customerinfo.gbl See Also #### GenerateExternalPortalURL Syntax GenerateExternalPortalURL(PORTAL.portalname, NODE.nodename, URL) Description Use the GenerateExternalPortalURL function to create a URL string that represents an absolute reference the specified external content (URL) on the portal servlet. The PortalURI of the node that hosts the specified portal is used in the generated URL. The generated URL contains a reference to the portal service (psp) servlet. If you want to generate a relative URL, use the GenerateExternalRelativeURL function. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. NodeName Specify the name of the node that contains the content, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. URL Specify the URL to be used for this content. Returns A string of the following format is returned: http://Portal URI of host node/Portal/node/e/encodedURL When the portal servlet evaluates an external URL, the Node is ignored, so %Node can always be passed in for the Node parameter. This function returns a Null string if you specify an invalid portal or node. Example The following code: &url = GenerateExternalPortalURL("EMPLOYEEPORTAL", "CRM", "http://www.excite.com"); Might create the following URL: http://myserver/psp/ps/EMPLOYEEPORTAL/CRM/e/http%3a%2f%2fwww.excite.com See Also #### GenerateExternalRelativeURL Syntax GenerateExternalRelativeURL(PORTAL.portalname, NODE.nodename, EncodedURL) Description Use the GenerateExternalRelativeURL function to create a URL string that represents a relative reference the specified external content (URL). The relative reference is suitable for use on any page that itself has the simple URL format and which is served by the portal servlet (psp). If you want to generate an absolute URL, use the GenerateExternalPortalURL function. Parameters  PortalName Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. NodeName Specify the name of the node that contains the content, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. EncodedURL Specify the URL to be used for this content. Returns A string of the following format is returned: ../../../Portal/node/e/encodedURL This function returns a Null string if you specify an invalid portal or node. Example The following code: &url = GenerateExternalRelativeURL("EMPLOYEEPORTAL", "CRM", "http: //www.excite.com"); Might create the following URL: ../../../EMPLOYEEPORTAL/CRM/e/http%3a%2f%2fwww.excite.com See Also #### GenerateHomepagePortalURL Syntax GenerateHomepagePortalURL(PORTAL.portalname, NODE.nodename, Tabname) Description Use the GenerateHomepagePortalURL function to create a URL string that represents an absolute reference the specified homepage tab on the portal servlet. The PortalURI of the node that hosts the specified portal is used in the generated URL. The generated URL contains a reference to the portal service (psp) servlet. If you want to generate a relative URL, use the GenerateHomepageRelativeURL function. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. Note. The value specified for this parameter is ignored. The node name that is used is automatically calculated. However, you must still specify a value for this parameter. nodename Specify the name of the node that contains the content, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. This should be the node that hosts the specified portal. Tabname Specify the name of the tab on the homepage that you want to generate a URL for. If you specify a null string (""), the default tab is used. Returns If the node has a Node Type of PIA, a string of the following format is returned: http://Portal URI of host node/Portal/node/h/?tab=tabname This function returns a Null string if you specify an invalid portal or node. Example Specifying the following code: &HomePage = GenerateHomepagePortalURL(%Portal, NODE.North_Asia, ""); Might generate the following string: http://bejing/psp/psoft/crm/North_Asia/h/?tab=DEFAULT See Also #### GenerateHomepageRelativeURL Syntax GenerateHomepageRelativeURL(PORTAL.portalname, NODE.nodename, Tabname) Description Use the GenerateHomepageRelativeURL function to create a URL string that represents a relative reference the specified homepage on the portal servlet. The relative reference is suitable for use on any page that itself has the simple URL format. If you want to generate an absolute URL, use the GenerateHomepagePortalURL function. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. nodename Specify the name of the node that contains the content, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. . This should be the node that hosts the specified portal. Tabname Specify the name of the tab on the homepage that you want to generate a URL for. If you specify a null string (""), the default tab is used. Returns If the node has a Node Type of PIA, a string of the following format is returned: ../../../Portal/node/h/?tab=tabname If the node has a Node Type of ICType, a string of the following format is returned: ./?cmd=start This function returns a Null string if you specify an invalid portal or node. Example The following code: &HomePage = GenerateHomepageRelativeURL(%Portal, NODE.North_Asia, ""); Might generate the following string: ../../../crm/North_Asia/h/?tab=DEFAULT See Also #### GenerateMobileTree Syntax GenerateMobileTree(&CIObject [,CIObject_property]) Description Note. PeopleSoft Mobile Agent is a deprecated product. This mobile function currently exists for backward compatibility only. Use the GenerateMobileTree function to display data in a tree format, with nodes and leaves. The result of the GenerateMobileTree function is an HTML string, which can be displayed in an HTML area control. Use this function in the OnInit event to display the mobile tree, and on the OnChange event for programs related to expanding, collapsing or selecting nodes. Mobile HTML Tree The positional links at the top of the page (First, Previous, Next, Last, Left, Right) enable the user to navigate around the tree. These links are automatically generated as part of the execution of GenerateTree. The icon next to a node can have a + sign or a - sign in it, depending on whether the node is collapsed or expanded. When a node is collapsed, none of the nodes that report to the collapsed node are displayed, and the icon has a + sign. When a node is expanded, all the nodes that report to it are displayed, and the icon has a - sign. You can collapse and expand a node by clicking in the icon. This enables you to view the tree at different levels of detail. When the icon for a node has no + or − sign in it, it is a terminal node, and cannot be expanded or collapsed. Using the GenerateMobileTree Function The GenerateMobileTree function is similar to the GenerateTree function, however, there are several important differences. • The GenerateMobileTree function does not take a standalone rowset for data. Mobile does not support standalone rowsets, so you must populate your tree data one item at a time. • You cannot use the Tree Classes with the GenerateMobileTree function. To use the GenerateMobileTree function: 1. Define the Component Interface. You must use a Component Interface that is created from a component that contains the TREECTL_HDR and TREECTL_NODE records. When the Component Interface is synched to the device, these records do not have to contain any data, they can be populated using PeopleCode. 2. Add an HTML area to the mobile page. This involves adding a long text field to the Component Interface, specifying how it displays on the mobile page, and so on. The value of the Component Interface long text field is what is displayed in the HTML area. 3. Determine what property on the Component Interface is going to contain the OnChange PeopleCode used to evaluate the end-user action and call the appropriate PeopleCode programs. The action an end user takes (selecting a row, or expanding or collapsing a node) is accessible to this property. This property must be a character field that is at least 46 characters long. The field can be made invisible. 4. Specify this property as the value for the PAGE_FIELD_NAME field on the TREECTRL_HDR_SBR record. 5. Populate the tree, specify values for the nodes, leaves, images, and so on. Parameters  &CIObject This is the mobile object that is to be viewed in a hierarchy tree view. This object is from a peer reference. CIObject_property This is a property on the mobile object that is to be viewed in a hierarchy tree view. Returns None. Example In the OnInit event, generate the mobile tree. Local ApiObject &ob; &ob = %ThisMobileObject; &MyCI = %Session.GetCompIntfc(ComIntfc.RDM_RELTREE); &MyCI.Key_01 = "2"; &MyCI.Create(); &MyCI.PAGE_FIELD_NAME = "TREELEVELNT"; &MyCI.RDM.RELTREE_NDE.InsertItem(1); &MyCI.RDM.RELTREE_NDE.Item(1).TREE_NODE = "NAME 1"; &MyCI.RDM.RELTREE_NDE.Item(1).DESCR = "Descr 1"; &MyCI.RDM.RELTREE_NDE.Item(1).PARENT_FLAG = "Y"; &MyCI.RDM.RELTREE_NDE.Item(1).TREE_LEVEL_NUM = 1; &MyCI.RDM.RELTREE_NDE.Item(1).LEAF_FLAG = "N"; &MyCI.RDM.RELTREE_NDE.InsertItem(2); &MyCI.RDM.RELTREE_NDE.Item(2).TREE_NODE = "NAME 3"; &MyCI.RDM.RELTREE_NDE.Item(2).DESCR = "Descr 2"; &MyCI.RDM.RELTREE_NDE.Item(2).PARENT_FLAG = "Y"; &MyCI.RDM.RELTREE_NDE.Item(2).TREE_LEVEL_NUM = 2; &MyCI.RDM.RELTREE_NDE.Item(2).LEAF_FLAG = "N"; &MyCI.RDM.RELTREE_NDE.InsertItem(3); &MyCI.RDM.RELTREE_NDE.Item(3).TREE_NODE = "NAME 1"; &MyCI.RDM.RELTREE_NDE.Item(3).DESCR = "Descr 3"; &MyCI.RDM.RELTREE_NDE.Item(3).PARENT_FLAG = "Y"; &MyCI.RDM.RELTREE_NDE.Item(3).TREE_LEVEL_NUM = 1; &MyCI.RDM.RELTREE_NDE.Item(3).LEAF_FLAG = "N"; &OB.QE_COMMENTS = GenerateMobileTree(&MyCI); The following PeopleCode is used in the OnChange event (used for when a user selects a node, expands a node or closes a node): Local ApiObject &ob; &ob = %ThisMobileObject; &MyCI = %Session.GetCompIntfc(ComIntfc.RDM_RELTREE); &MyCI.Key_01 = "2"; &MyCI.Get(); &MyCI.PAGE_FIELD_NAME = "TREECTLEVENT" If Left(%ThisMobileObject.TREELEVENT, 1) = "S" Then Warning ("This node has been selected"); End-If; &ob.QE_COMMENTS = ​GenerateMobileTree(&MyCI, %ThisMobileObject.TREELEVENT); See Also #### GenerateQueryContentURL Syntax GenerateQueryContentURL(PORTAL.portalname, NODE.nodename, QueryName, IsPublic [, IsNewWindow]) Description Use the GenerateQueryContentURL function to create a URL string that represents an absolute reference the specified query (URL) on the content servlet. The PortalURI of the node that hosts the specified portal is used in the generated URL. The generated URL contains a reference to the portal content (psc) servlet. If you want to generate a relative URL, use the GenerateQueryRelativeURL function. If you want to generate a URL for the portal service (psp) servlet, use the GenerateQueryPortalURL function. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. nodename Specify the name of the node that contains the query, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. Queryname Specify the name of the query you want to generate a URL for. This parameter takes a string value. IsPublic Specify whether the query is public or private. This parameter takes a Boolean value: True, the query is public, False otherwise. IsNewWindow Specify whether the URL is for a new browser instance. This parameter takes a Boolean value: True, the URL is for a new browser instance, False otherwise. The default is False. If the value is True this function generates a new state block for use in a separate browser instance. This does not automatically open a new browser instance. It just supports it. Note. When Query is being run on a PeopleTools version prior to 8.16, the query URL does not include the ability to specify if a query is public or private. On PeopleTools versions 8.16 and higher, the generated URL contains either the keyword PUBLIC or PRIVATE prepended to the query name. If you are building a URL for a portal node that is on a PeopleTools release prior to 8.16, you must remove the public or private keyword before trying to use the URL. Returns If IsPublic is specified as True, and the node has a Node Type of PIA, a string of the following format is returned: http://PortalURI/Portal/node/q/?ICAction=ICQryNameURL=PUBLIC.QueryName If IsPublic is specified as False, and the node has a Node Type of PIA, a string of the following format is returned: http://PortalURI/Portal/node/q/?ICAction=ICQryNameURL=PRIVATE.QueryName This function returns a Null string if you specify an invalid portal or node. Example The following code example: &url = GenerateQueryContentURL(%Portal, "RMTNODE", "QUERYNAME", True); might produce a string as follows: http://bsto091200/psc/ps/EMPLOYEE/RMTNODE/q/?ICAction=ICQryNameURL=PUBLIC.QUERYNAME The following code example uses the optional parameter to produce a URL that supports a new browser instance: &url = GenerateQueryContentURL(%Portal, "RMTNODE", "QUERYNAME", True, True); might produce a string as follows: http://bsto091200/psc/ps_newwin/EMPLOYEE/RMTNODE/q/?ICAction=ICQryNameURL= PUBLIC.QUERYNAME See Also #### GenerateQueryPortalURL Syntax GenerateQueryPortalURL(PORTAL.portalname, NODE.nodename, QueryName, IsPublic [, IsNewWindow]) Description Use the GenerateQueryPortalURL function to create a URL string that represents an absolute reference the specified query (URL) on the portal servlet. The PortalURI of the node that hosts the specified portal is used in the generated URL. The generated URL contains a reference to the portal service (psp) servlet. If you want to generate a relative URL, use the GenerateQueryRelativeURL function. If you want to generate a URL for the portal content (psc) servlet, use the GenerateQueryContentURL function. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. nodename Specify the name of the node that contains the query, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. Queryname Specify the name of the query you want to generate a URL for. This parameter takes a string value. IsPublic Specify whether the query is public or private. This parameter takes a Boolean value: True, the query is public, False otherwise. IsNewWindow Specify whether the URL is for a new browser instance. This parameter takes a Boolean value: True, the URL is for a new browser instance, False otherwise. The default is False. If the value is True this function generates a new state block for use in a separate browser instance. This does not automatically open a new browser instance. It just supports it. Note. When Query is being run on a PeopleTools version prior to 8.16, the query URL does not include the ability to specify if a query is public or private. On PeopleTools versions 8.16 and higher, the generated URL contains either the keyword PUBLIC or PRIVATE prepended to the query name. If you are building a URL for a portal node that is on a PeopleTools release prior to 8.16, you must remove the public or private keyword before trying to use the URL. Returns If IsPublic is specified as True, and the node has a Node Type of PIA, a string of the following format is returned: http://PortalURI/Portal/node/q/?ICAction=ICQryNameURL=PUBLIC.QueryName If IsPublic is specified as False, and the node has a Node Type of PIA, a string of the following format is returned: http://PortalURI/Portal/node/q/?ICAction=ICQryNameURL=PRIVATE.QueryName This function returns a Null string if you specify an invalid portal or node. Example The following code example: &url = GenerateQueryPortalURL(%Portal, "RMTNODE", "QUERYNAME", True); might produce a string as follows: http://bsto091200/psp/ps/EMPLOYEE/RMTNODE/q/?ICAction=ICQryNameURL=PUBLIC.QUERYNAME The following code example uses the optional parameter to produce a URL that supports a new browser instance: &url = GenerateQueryPortalURL(%Portal, "RMTNODE", "QUERYNAME", True, True); might produce a string as follows: http://bsto091200/psp/ps_newwin/EMPLOYEE/RMTNODE/q/?ICAction=ICQryNameURL= PUBLIC.QUERYNAME See Also #### GenerateQueryRelativeURL Syntax GenerateQueryRelativeURL(PORTAL.portalname, NODE.nodename, QueryName, IsPublic [, IsNewWindow]) Description Use the GenerateQueryRelativeURL function to creates a URL string that represents a relative reference to the specified query on the portal servlet. The relative reference is suitable for use on any page that itself has the simple URL format. If you want to generate an absolute URL, use either the GenerateQueryPortalURL or GenerateQueryContentURL function. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. nodename Specify the name of the node that contains the query, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. Queryname Specify the name of the query you want to generate a URL for. This parameter takes a string value. IsPublic Specify whether the query is public or private. This parameter takes a Boolean value: True, the query is public, False otherwise. IsNewWindow Specify whether the URL is for a new browser instance. This parameter takes a Boolean value: True, the URL is for a new browser instance, False otherwise. The default is False. If the value is True this function generates a new state block for use in a separate browser instance. This does not automatically open a new browser instance. It just supports it. Note. When Query is being run on a PeopleTools version prior to 8.16, the query URL does not include the ability to specify if a query is public or private. On PeopleTools versions 8.16 and higher, the generated URL contains either the keyword PUBLIC or PRIVATE prepended to the query name. If you are building a URL for a portal node that is on a PeopleTools release prior to 8.16, you must remove the public or private keyword before trying to use the URL. Returns If IsPublic is specified as True, and the node has a Node Type of PIA, a string of the following format is returned: ../../../portal/node/q/?ICAction=ICQryNameURL=PUBLIC.QueryName If IsPublic is specified as False, and the node has a Node Type of PIA, a string of the following format is returned: ../../../portal/node/q/q/?ICAction=ICQryNameURL=PRIVATE.QueryName This function returns a Null string if you specify an invalid portal or node. Example The following code example: &url = GenerateQueryRelativeURL(%Portal, "RMTNODE", "QUERYNAME", True); might produce a string as follows: ../../../EMPLOYEE/RMTNODE/q/?ICAction=ICQryNameURL=PUBLIC.QUERYNAME See Also #### GenerateScriptContentRelURL Syntax GenerateScriptContentRelURL(PORTAL.portalname, NODE.nodename, RECORD.recordname, FIELD.fieldname, event_name, function_name, [, keylist]) where keylist is a list of field references in the form: [recordname.]field1 [, [recordname.]field2]. . . OR &RecordObject1 [, &RecordObject2]. . . Description Use the GenerateScriptContentRelURL function to create a URL string that represents a relative reference to the specified iScript. The generated URL contains a reference to the portal content (psc) servlet. If you want to generate an absolute URL for an iScript for the portal content servlet, use the GenerateScriptContentURL function. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. nodename Specify the name of the node that contains the iScript, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. recordname Specify the name of the record containing the iScript, prefixed with the reserved word RECORD. fieldname Specify the name of the field containing the iScript, prefixed with the reserved word FIELD. event_name Specify the name of the event containing the iScript. This is generally the FieldFormula event. function_name Specify the name of the iScript function. keylist An optional list of parameters used with the function. It can also be an already instantiated record object. Returns If the node has a Node Type of PIA, a string of the following format is returned: /psc/s/recname.fieldname.event_name.function_name?parameters If the node has a Node Type of ICType, a string of the following format is returned: /portal/node/?ICType=Script&ICScriptProgramName=recname.fieldname.event_name.function_name?parameters The question mark and the text following the question mark may or may not be included, depending on whether or not you specified a page and action or not. This function returns a Null string if you specify an invalid portal or node. Example The following code: &MyScriptURL = GenerateScriptContentRelURL("EMPLOYEEPORTAL", "CRM", Record.WEBLIB_ CRM, Field.SFASCRIPTS, "FieldFormula", "Iscript_SFAHOME "); Might yield the following URL: /psc/s/WEBLIB_CRM.SFASCRIPTS.FieldFormula.IScript_SFAHOME See Also #### GenerateScriptContentURL Syntax GenerateScriptContentURL(PORTAL.portalname, NODE.nodename, RECORD.recordname, FIELD.fieldname, event_name, function_name, [, keylist]) where keylist is a list of field references in the form: [recordname.]field1 [, [recordname.]field2]. . . OR &RecordObject1 [, &RecordObject2]. . . Description Use the GenerateScriptContentURL function to create a URL string that represents an absolute reference to the specified iScript for the content servlet. The ContentURI of the specified node is used in the generated URL. The URL contains a reference to the portal content (psc) servlet. If you want to generate a URL for an iScript for the portal servlet, use the GenerateScriptPortalURL function. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. nodename Specify the name of the node that contains the iScript, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. recordname Specify the name of the record containing the iScript, prefixed with the reserved word RECORD. fieldname Specify the name of the field containing the iScript, prefixed with the reserved word FIELD. event_name Specify the name of the event containing the iScript. This is generally the FieldFormula event. function_name Specify the name of the iScript function. keylist An optional list of parameters used with the function. It can also be an already instantiated record object. Returns If the node has a Node Type of PIA, a string of the following format is returned: http://Content URI of host node/portal/node/s/recname.fieldname.event_ name.function_name?parameters If the node has a Node Type of ICType, a string of the following format is returned: http://Content URI of host node/portal/node/?ICType=Script&ICScriptProgramName=recname.fieldname.event_name.function_name?parameters The question mark and the text following the question mark may or may not be included, depending on whether or not you specified a page and action or not. This function returns a Null string if you specify an invalid portal or node. Example The following code: &MyScriptURL = GenerateScriptContentURL("EMPLOYEEPORTAL", "CRM", Record.WEBLIB_ CRM, Field.SFASCRIPTS, "FieldFormula", "Iscript_SFAHOME "); Might yield the following URL: http://mike.com/servlets/psc/testsite/EMPLOYEEPORTAL/CRM/s/WEBLIB_ CRM.SFASCRIPTS.FieldFormula.IScript_SFAHOME See Also #### GenerateScriptPortalRelURL Syntax GenerateScriptPortalRelURL(PORTAL.portalname, NODE.nodename, RECORD.recordname, FIELD.fieldname, event_name, function_name, [, keylist]) where keylist is a list of field references in the form: [recordname.]field1 [, [recordname.]field2]. . . OR &RecordObject1 [, &RecordObject2]. . . Description Use the GenerateScriptPortalRelURL function to create a URL string that represents a relative reference to the specified iScript. The generated URL contains a reference to the portal service (psp) servlet. If you want to generate an absolute URL for an iScript for the portal service servlet, use the GenerateScriptPortalURL function. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. nodename Specify the name of the node that contains the iScript, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. recordname Specify the name of the record containing the iScript, prefixed with the reserved word RECORD. fieldname Specify the name of the field containing the iScript, prefixed with the reserved word FIELD. event_name Specify the name of the event containing the iScript. This is generally the FieldFormula event. function_name Specify the name of the iScript function. keylist An optional list of parameters used with the function. It can also be an already instantiated record object. Returns If the node has a Node Type of PIA, a string of the following format is returned: /psp/s/recname.fieldname.event_name.function_name?parameters If the node has a Node Type of ICType, a string of the following format is returned: /portal/node/?ICType=Script&ICScriptProgramName=recname.fieldname.event_name.function_name?parameters The question mark and the text following the question mark may or may not be included, depending on whether or not you specified a page and action or not. This function returns a Null string if you specify an invalid portal or node. Example The following code: &MyScriptURL = GenerateScriptPortalRelURL("EMPLOYEEPORTAL", "CRM", Record.WEBLIB_ CRM, Field.SFASCRIPTS, "FieldFormula", "IScript_SFAHOME"); Might yield the following: /psp/s/WEBLIB_CRM.SFASCRIPTS.FieldFormula.IScript_SFAHOME See Also #### GenerateScriptPortalURL Syntax GenerateScriptPortalURL(PORTAL.portalname, NODE.nodename, RECORD.recordname, FIELD.fieldname, event_name, function_name, [, keylist]) where keylist is a list of field references in the form: [recordname.]field1 [, [recordname.]field2]. . . OR &RecordObject1 [, &RecordObject2]. . . Description Use the GenerateScriptPortalURL function to create a URL string that represents an absolute reference to the specified iScript for the portal servlet. The PortalURI of the node that hosts the specified portal is used in the generated URL. The URL contains a reference to the portal service (psp) servlet. If you want to generate a URL for an iScript for the portal content (psc) servlet, use the GenerateScriptContentURL function. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. nodename Specify the name of the node that contains the iScript, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. recordname Specify the name of the record containing the iScript, prefixed with the reserved word RECORD. fieldname Specify the name of the field containing the iScript, prefixed with the reserved word FIELD. event_name Specify the name of the event containing the iScript. This is generally the FieldFormula event. function_name Specify the name of the iScript function. keylist An optional list of parameters used with the function. It can also be an already instantiated record object. Returns If a node has a Node Type of PIA, a string of the following format is returned: http://Portal URI of host portal/portal/node/s/recname.fieldname.event_ name.function_name?parameters If the node has a Node Type of ICType, a string of the following format is returned: http://Portal URI of host node/portal/node/?ICType=Script&ICScriptProgramName= recname.fieldname.event_name.function_name?parameters The question mark and the text following the question mark may or may not be included, depending on whether or not you specified a page and action or not. This function returns a Null string if you specify an invalid portal or node. Example The following code: &MyScriptURL = GenerateScriptPortalURL("EMPLOYEEPORTAL", "CRM", Record.WEBLIB_CRM, Field.SFASCRIPTS, "FieldFormula", "IScript_SFAHOME"); Might yield the following: http://mike.com/servlets/psp/testsite/EMPLOYEEPORTAL/CRM/s/WEBLIB_ CRM.SFASCRIPTS.FieldFormula.IScript_SFAHOME See Also #### GenerateScriptRelativeURL Syntax GenerateScriptRelativeURL(PORTAL.portalname, NODE.nodename, RECORD.recordname, FIELD.fieldname, event_name, function_name, [, keylist]) where keylist is a list of field references in the form: [recordname.]field1 [, [recordname.]field2]. . . OR &RecordObject1 [, &RecordObject2]. . . Description Use the GenerateScriptRelativeURL function to create a relative URL string that represents a relative reference to the specified iScript. The relative reference is suitable for use on any page that has the simple URL format. If you want to generate an absolute URL for an iScript, use either the GenerateScriptContentURL or GenerateScriptPortalURL function. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. nodename Specify the name of the node that contains the iScript, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. recordname Specify the name of the record containing the iScript, prefixed with the reserved word RECORD. fieldname Specify the name of the field containing the iScript, prefixed with the reserved word FIELD. event_name Specify the name of the event containing the iScript. This is generally the FieldFormula event. function_name Specify the name of the iScript function. keylist An optional list of parameters used with the function. It can also be an already instantiated record object. Returns If the node has a Node Type of PIA, a string of the following format is returned: portal/node/s/recname.fieldname.event_name.function_name?parameters If the node has a Node Type of ICType, a string of the following format is returned: portal/node/?ICType=Script&ICScriptProgramName=recname.fieldname.event_ name.function_name?parameters The question mark and the text following the question mark may or may not be included, depending on whether or not you specified a page and action or not. This function returns a Null string if you specify an invalid portal or node. Example The following code: &MyScriptURL = GenerateScriptRelativeURL("EMPLOYEEPORTAL", "CRM", Record.WEBLIB_ CRM, Field.SFASCRIPTS, "FieldFormula", "IScript_SFAHOME"); Might yield the following: ../../../EMPLOYEEPORTAL/CRM//s/WEBLIB_CRM.SFASCRIPTS.FieldFormula.IScript_SFAHOME See Also #### GenerateTree Syntax GenerateTree(&rowset [, TreeEventField]) Description Use the GenerateTree function to display data in a tree format, with nodes and leaves. The result of the GenerateTree function is an HTML string, which can be displayed in an HTML area control. The tree generated by GenerateTree is called an HTML tree. The GenerateTree function can be used in conjunction with the Tree Classes to display data from trees created using Tree Manager. The GenerateTree function works with both an HTML area control and a hidden field. The TreeEventField parameter contains the contents of the invisible character field used to process the HTML tree events. When an end user selects a node, expands a node, collapses a node, or uses one of the navigation links, that event (end-user action) is passed to the invisible field, and the invisible field's FieldChange PeopleCode is executed. See Also Parameters  &rowset Specify the name of the rowset you've populated with tree data. TreeEventField Specify the contents of the invisible character field used to process the HTML tree events. The first time the GenerateTree function is used, that is, to generate the initial tree, you do not need to include this parameter. Subsequent calls require this parameter. Returns A string that contains HTML code that can be used with the HTML control to display a tree. Example In the following example, TREECTLEVENT is the name of the invisible control field that contains the event string that was passed from the browser. HTMLAREA = GenerateTree(&TREECTL, TREECTLEVENT); See Also #### GenerateWorklistPortalURL Syntax GenerateWorklistPortalURL(PORTAL.portalname, NODE.nodename, BusProc, Activity, Event, Worklist, Instance) Description Use the GenerateWorklistPortalURL function to create a URL string that represents an absolute reference the specified Worklist (URL) on the portal servlet. The PortalURI of the node that hosts the specified portal is used in the generated URL. The generated URL contains a reference to the portal service (psp) servlet. If you want to generate a relative URL, use the GenerateWorklistRelativeURL function. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. nodename Specify the name of the node that contains the content, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. BusProc Specify the business process of the Worklist. Activity Specify the activity of the Worklist. Event Specify the event of the Worklist. Instance Specify the instance of the Worklist. Returns A string of the following format: http://PortalURI/Portal/node/w/BusProc.Activity.Event.Worklist.Instance This function returns a Null string if you specify an invalid portal or node. See Also #### GenerateWorklistRelativeURL Syntax GenerateWorklistRelativeURL(PORTAL.portalname, NODE.nodename, BusProc, Activity, Event, Worklist, Instance) Description Use the GenerateWorklistRelativeURL function to create a URL string that represents a relative reference to the specified Worklist on the portal servlet. The relative reference is suitable for use on any page that itself has the simple URL format. If you want to generate an absolute URL, use the GenerateWorklistPortalURL function. Parameters  portalname Specify the name of the portal used for this request, prefixed with the reserved word PORTAL. You can also use a string, such as %Portal, for this value. nodename Specify the name of the node that contains the content, prefixed with the reserved word NODE. You can also use a string, such as %Node, for this value. BusProc Specify the business process of the Worklist. Activity Specify the activity of the Worklist. Event Specify the event of the Worklist. Instance Specify the instance of the Worklist. Returns A string of the following format: ../../../Portal/Node/w/BusProc.Activity.Event.Worklist.Instance This function returns a Null string if you specify an invalid portal or node. Example Given the following activity: Example activity The following is an example PeopleCode statement used to access this activity: GenerateWorklistRelativeURL(%Portal, %Node, "Administer Workflow", "Find Timeout Worklists", "Worklist Current Operator", "Timeout Notification", 1); See Also #### GenHTMLMenu Syntax GenHTMLMenu(list[, fldr_img_class_ID] [, element_label]) Description Use this function to generate an HTML code fragment that will be rendered in the browser as menu drop-downs, fly-outs, and breadcrumbs. Typically, this function is used when the SmartNavigation data source is a tree. The <li> elements in the input string are created by the GenRelatedActions function, the GenABNMenuElement method of the Node class, and the GenABNMenuElement method of the Leaf class. Parameters  list Specifies the list of • elements as a string. fldr_img_class_ID Specifies the class ID for a custom folder icon as a string. This class must be defined in a style sheet, and the style sheet must be assigned to the SmartNavigation folder. This is an optional parameter. To use the default folder icon, you can omit this parameter or specify the null string "". However, to ensure forward compatibility or to use the default folder icon while specifying the element_label parameter, you must specify the null string. element_label Specifies a label for a drop-down menu item as an array with two numeric elements, which represents a message catalog entry. The first element is the message set number and the second element is the message number. This label is applied to a drop-down menu item that is generated for the SmartNavigation breadcrumb on which the user has clicked, allowing the user to view the chart associated with that breadcrumb. The complete label is the word “View” with the element_label message appended. This is an optional parameter. If the element_label is not provided or if the message set or number is undefined, then a default message catalog entry (95, 9109) is used, which includes the default message, “User Profile Page,” in the label for the drop-down menu item. • Returns None. Example To use the default folder icon, use a call similar to one of the following: GenHTMLMenu(&szLI, ""); GenHTMLMenu(&szLI); Note. To ensure forward compatibility or to use the default folder icon while specifying the element_label parameter, you must follow the first example and specify the null string. The following example shows how the list of <li> elements is created for a node. In this example, <li> elements are generated for related actions, the first child node, and child leaves. This list is then passed to the GenHTMLMenu function. Local string &szLI; Local array of number &NavElementLabel; rem generate the requested node's related actions; &szLI = &szLI | &MyNode.GenRelatedActions(); /* Begin, Filter the requested tree node's child nodes and leaves that are */ /* displayed based on whatever criteria */ &nNodeOrder = &MyNode.allChildCount; If &MyNode.HasChildNodes Then /* get the first child node */ &ChildNode = &MyNode.FirstChildNode; /* generate the LI tag that is consumed by the portal for this node */ &szLI = &szLI | &ChildNode.GenABNMenuElement(GetABNInitialNode(&reqParams)); &ChildNode.LoadABNChart(&rs, &rars, False, GetABNInitialNode(&reqParams)); End-If; If &MyNode.HasChildLeaves Then If &MyNode.ChildLeafCount >= 3 Then &MaxCount = 3; Else &MaxCount = &MyNode.ChildLeafCount; End-If; For &i = 1 To &MaxCount If &i = 1 Then /* get the first child leaf */ &ChildLeaf = &MyNode.FirstChildLeaf; Else /* get the next child leaf */ &ChildLeaf = &ChildLeaf.NextSib; End-If; /* generate the LI tag that is consumed by the portal for this leaf */ &szLI = &szLI | &ChildLeaf.GenABNMenuElement(); &ChildLeaf.LoadABNChart(&rs, &rars); End-For; End-If; /* End, Filter the requested tree node's child nodes and leaves that are */ /* displayed based on whatever criteria */ /* GenHTMLMenu(&szLI): Generate the HTML snippet required by the portal */ /* html snippet written to the response object when mouse over event */ /* inject html snippet during page generation when on click event */ &NavElementLabel = CreateArray(6045, 4); GenHTMLMenu(&szLI, "myfldricon", &NavElementLabel); ​ See Also #### GenToken Syntax GenToken() Description Use the GenToken function to create an authentication token for the user currently logged in, as a string. Generally this function is used in an application engine program when an authentication token is not automatically generated. However, it can be used anytime. The token that is generated is usually passed to another process that has no token. Parameters None. Returns A string containing the authentication token. See Also #### GetABNChartRowSet Syntax GetABNChartRowSet() Description Use this function to return a reference to a rowset representing the SmartNavigation chart for the rowset or tree data currently in the component buffer. This function flushes the rowset prior to returning. The SmartNavigation chart rowset comprises two record definitions: and PT_ABNCHARTNODE and PT_ABN_CHART_ND. Parameters None. Returns A SmartNavigation chart rowset. If the user clicks on a menu folder description instead, then this function returns Null. Example &chart_RS = GetABNChartRowSet(); #### GetABNInitialNode Syntax GetABNInitialNode(&reqParams) Description Use this function to return the identifier of the initial SmartNavigation chart node as a string. Parameters  &reqParams Specifies the array of request parameters (name-value pairs) generated by the GetABNReqParameters function. This is an array of array of string. Returns The identifier of the initial chart node as a string. Example The following example loads the SmartNavigation chart with the initial chart node set to tree node 10100: &reqParams = GetABNReqParameters("10100"); &MyTree = &Session.GetTree(); &MyNode = &MyTree.FindNode(GetABNNode(&reqParams), ""); &MyNode.LoadABNChart(&rs, True, GetABNInitialNode(&reqParams)); The following example loads the SmartNavigation chart with the initial chart node set to the root of the tree: &reqParams = GetABNReqParameters(); &MyTree = &Session.GetTree(); &MyNode = &MyTree.FindNode(GetABNNode(&reqParams), ""); &MyNode.LoadABNChart(&rs, True, GetABNInitialNode(&reqParams)); The following example loads the SmartNavigation chart with the initial chart node set to a specific row in the rowset data source: &reqParams = GetABNReqParameters("MYROW01"); &rs_ChartRowset = GetABNChartRowSet(); &rs_RelatedActions = GetABNRelActnRowSet(); LoadABN(&rs_DataSource, &rs_ChartRowset, &rs_RelatedActions, ⇒ GetABNNode(&reqParams), GetABNInitialNode(&reqParams)); See Also #### GetABNNode Syntax GetABNNode(&reqParams) Description Use this function to return the identifier of the current SmartNavigation chart node as a string. The user requests this chart node through a mouse-click event Parameters  &reqParams Specifies the array of request parameters (name-value pairs) generated by the GetABNReqParameters function. This is an array of array of string. Returns The identifier of the current SmartNavigation chart node as a string. See Also #### GetABNRelActnRowSet Syntax GetABNRelActnRowSet() Description Use this function to return a reference to the related actions rowset for the SmartNavigation chart. This function flushes the rowset prior to returning. Parameters None. Returns A related actions rowset. If the user clicks on the menu folder description instead, then this function returns Null. Example &relAction_RS = GetABNRelActnRowSet(); #### GetABNReqParameters Syntax GetABNReqParameters([start]) Description Use this function to generate HTTP request parameters as an array of name-value pairs. The start parameter specifies the initial node of the data source. When using a tree data source, the start parameter is optional. If the initial node is not provided, the tree's root node is the initial node. When using a rowset data source, the start parameter is required. The returned request parameter array contains the following values:  Array Element HTTP Request Parameter Name/Value [1][1] [1][2] TREE_NAME The tree's name.* [2][1] [2][2] TREE_SETID The tree's setID key.* [3][1] [3][2] TREE_USERKEY The tree's user key.* [4][1] [4][2] TREE_EFFDT The tree's effective date key.* [5][1] [5][2] TREE_NODE The name of the currently requested tree node.* [6][1] [6][2] INITIAL_TREE_NODE The name of the initial node. * Set to an empty string when the data source is a rowset. Parameters  start Specifies a string representing the initial node of the tree or rowset data source. Returns An array of array of string representing the HTTP request parameters (name-value pairs). Example Local array of array of string &reqParams; &reqParams = GetABNReqParameters("00001"); #### GetABNTreeEffdt Syntax GetABNTreeEffdt(&reqParams) Description Use this function to extract the effective date key for the tree from the request parameter array. The output of this function is used to open the specified tree. Parameters  &reqParams Specifies the array of request parameters (name-value pairs) generated by the GetABNReqParameters function. This is an array of array of string. Returns A string representing the effective date key for the tree. Note. If the SmartNavigation chart data source is a rowset, this function returns an empty string. Example Local array of array of string &reqParams; &reqParams = GetABNReqParameters(); &TreeReturn = &MyTree.Open(GetABNTreeSetid(&reqParams), GetABNTreeUserKey⇒ (&reqParams), GetABNTreeName(&reqParams), GetABNTreeEffdt(&reqParams), "", True); See Also #### GetABNTreeName Syntax GetABNTreeName(&reqParams) Description Use this function to extract the tree name from the request parameter array. The output of this function is used to open the specified tree. Parameters  &reqParams Specifies the array of request parameters (name-value pairs) generated by the GetABNReqParameters function. This is an array of array of string. Returns A string representing the tree name. Note. If the SmartNavigation chart data source is a rowset, this function returns an empty string. Example Local array of array of string &reqParams; &reqParams = GetABNReqParameters(); &TreeReturn = &MyTree.Open(GetABNTreeSetid(&reqParams), GetABNTreeUserKey⇒ (&reqParams), GetABNTreeName(&reqParams), GetABNTreeEffdt(&reqParams), "", True); See Also #### GetABNTreeSetid Syntax GetABNTreeSetid(&reqParams) Description Use this function to extract the setID key for the tree from the request parameter array. The output of this function is used to open the specified tree. Parameters  &reqParams Specifies the array of request parameters (name-value pairs) generated by the GetABNReqParameters function. This is an array of array of string. Returns A string representing the setID key for the tree. Note. If the SmartNavigation chart data source is a rowset, this function returns an empty string. Example Local array of array of string &reqParams; &reqParams = GetABNReqParameters(); &TreeReturn = &MyTree.Open(GetABNTreeSetid(&reqParams), GetABNTreeUserKey⇒ (&reqParams), GetABNTreeName(&reqParams), GetABNTreeEffdt(&reqParams), "", True); See Also #### GetABNTreeUserKey Syntax GetABNTreeUserKey(&reqParams) Description Use this function to extract the user key for the tree from the request parameter array. The output of this function is used to open the specified tree. Parameters  &reqParams Specifies the array of request parameters (name-value pairs) generated by the GetABNReqParameters function. This is an array of array of string. Returns A string representing the user key for the tree. Note. If the SmartNavigation chart data source is a rowset, this function returns an empty string. Example Local array of array of string &reqParams; &reqParams = GetABNReqParameters(); &TreeReturn = &MyTree.Open(GetABNTreeSetid(&reqParams), GetABNTreeUserKey⇒ (&reqParams), GetABNTreeName(&reqParams), GetABNTreeEffdt(&reqParams), "", True); See Also #### GetAESection Syntax GetAESection(ae_applid, ae_section [, effdt]) Description Use the GetAESection function to open and associate an AESection PeopleCode object with the base section, as specified. If no base section by the specified name is found, one is created. This enables you to create base sections as needed. Warning! When you open or get an AESection object, (that is, the base section) any existing steps in the section are deleted. After you’ve instantiated the AESection object, set the template section using the SetTemplate AESection class method. You can copy steps from the template section to the base section before you start the Application Engine program. This is useful for applications that let users input their "rules" into a user-friendly page, then convert these rules, at save time, into Application Engine constructs. When an AESection is opened (or accessed), the system first looks to see if it exists with the given input parameters. If such a section doesn’t exist, the system looks for a similar section based on market, database platform, and effective date. The AESection Object is designed for use within an online program. Typically, dynamic sections should be constructed in response to an end-user action. Note. Do not call an AESection object from an Application Engine PeopleCode Action. If you need to access another section, use the CallSection action instead. Parameters  ae_applid Specifies the application ID of the section you want to modify. ae_section Specifies the section name of the base section you want to modify. If no base section by the specified name is found, one is created. effdt Specifies the effective date of the section you want to modify (optional). Returns An AESection object is returned. See Also #### GetAnalyticGrid Syntax GetAnalyticGrid(PAGE.pagename, gridname) Description Use the GetAnalyticGrid function to instantiate an analytic grid object from the AnalyticGrid class, and populates it with the grid specified by gridname, which is the Page Field Name on the General tab of that analytic grid’s page field properties. Specify a grid name consisting of any combination of uppercase letters, digits and "#", "$", "@", and "_".

Note. PeopleSoft builds a page grid one row at a time. Because the AnalyticGrid class applies to a complete grid, you can’t attach PeopleCode that uses the AnalyticGrid class to events that occur before the grid is built; the earliest event you can use is the page Activate event.

See Activate Event.

Using the Grid Name

When you place an analytic grid on a page, the grid is automatically named the same as the name of the primary record of the scroll for the grid (in the Page Field Name.)

Note. If the name of the record changes, the Page Field Name is not automatically updated. You must change this name if you want the name of the grid to reflect the name of the record.

This is the name you use with the GetAnalyticGrid function. You can change this name on the General tab of the Analytic Grid control properties.

To change a grid name:

1. Open the page in Application Designer, select the analytic grid and access the Analytic Grid control properties.

2. On the General tab, type the new grid name in Page Field Name.

Note. Every grid on a page must have a unique name.

Parameters

 PAGE. pagename Specify the name of the page definition containing the grid you want to access. gridname Specify the Page Field Name on the General tab of the grid’s page field properties.

Returns

A reference to an AnalyticGrid object.

#### GetAnalyticInstance

Syntax

GetAnalyticInstance(ID)

Description

Use the GetAnalyticInstance function to return a reference to the AnalyticInstance object as specified by the ID.

The analytic instance specified by ID must already be created before using this function.

Parameters

 ID Specify the analytic instance identifier that you want to access.

Returns

An AnalyticInstance object if successful, null otherwise.

Syntax

Description

Use the GetArchPubHeaderXMLDoc function to retrieve an archived message header from the message queue.

This function has been deprecated. You will receive an error if you use this function.

#### GetArchPubXmlDoc

Syntax

GetArchPubXmlDoc(PubID, PubNode, ChannelName, VersionName, MessageName, SubNode[, Segment])

Description

Use the GetArchPubXmlDoc function to retrieve an archived message from the message queue.

This function has been deprecated. You will receive an error if you use this function.

#### GetArchSubXmlDoc

Syntax

GetArchSubXmlDoc(PubID, PubNode, ChannelName, VersionName, MessageName[, Segment])

Description

Use the GetArchSubXmlDoc function to retrieve an archived message from the message queue.

This function has been deprecated. You will receive an error if you use this function.

#### GetAttachment

Syntax

GetAttachment(URLSource, DirAndSysFileName, DirAndLocalFileName[, LocalDirEnvVar[, PreserveCase]])

Description

Use the GetAttachment function to download a file from its source storage location to the file system of the application server. The file system of the application server includes any directories accessible from the application server including those on local disks as well as on network shares.

Note. All directories that are part of the destination full path name must exist before GetAttachment is called. The GetAttachment function will not create any directories on the application server's file system.

Additional information that is important to the use of GetAttachment can be found in the PeopleTools 8.52: PeopleCode Developer's Guide PeopleBook:

• PeopleTools supports multiple types of storage locations.

• Certain characters are illegal in file names; other characters in file names are converted during file transfer.

• Non-ASCII file names are supported by the PeopleCode file attachment functions.

• The PeopleCode file attachment functions do not provide text file conversions when files are attached or viewed.

File System Considerations

If you are uncertain which type of file system the file is going to be transferred to, either a UNIX or Windows system, you should simply specify a file name for the DirAndLocalFileName parameter and either explicitly set the LocalDirEnvVar parameter or accept its default value, which is “TMP” (indicating that the value of the TMP environment variable will be used).

The following code example works for Windows systems, but not UNIX systems:

&retcode = GetAttachment(&FTPINFO, &SOURCEFILENAME, "c:\temp\resume.doc");

The following code example works for Unix systems, but not Windows systems:

&retcode = GetAttachment(&FTPINFO, &SOURCEFILENAME, "/tmp/resume.doc");

The following two examples work for both Windows and Unix systems:

&retcode = GetAttachment(&FTPINFO, &SOURCEFILENAME, "resume.doc"); &retcode = GetAttachment(&FTPINFO, &SOURCEFILENAME, "resume.doc", "PS_CFG_HOME");

Warning! If the effectively specified target directory that is to ultimately contain the downloaded file on the application server is a UNC (Universal Naming Convention) share, an error will occur and GetAttachment will fail to download the file.

You cannot use a share as the target directory—that is, as the ultimate destination—to download a file onto an application server using GetAttachment. However, you can use a subdirectory of a UNC share as the target directory.

For example, if a directory similar to the following were the target directory, GetAttachment would fail:

\\server_name\share_name

However, the following subdirectory of the same UNC share could be used with GetAttachment:

\\server_name\share_name\temp

Parameters

 URLSource A reference to a URL. This can be either a URL identifier the form URL.URL_ID, or a string. This (along with the DirAndSysFileName parameter) indicates the file's source location. The URLSource parameter requires forward slashes (“/”). Backward slashes ("\") are not supported for this parameter. DirAndSysFileName The relative path and file name of the file at the storage location. This is appended to URLSource to form the full URL where the file will be transferred from. This parameter takes a string value.