PeopleCode Built-in Functions and Language Constructs: G

Syntax

GenABNNodeURL(node,initial_node,display_parent)

Description

Use the GenABNNodeURL function to generate a URL for a specific node within a SmartNavigation chart.

Parameters

Returns

A string representing the URL to navigate to the specified node.

Syntax

GetComponentTitle()

Description

Use the GetComponentTitle function to return the name of the component (from the component definition).

Parameters

None.

Returns

A String value.

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

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:

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.

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 Workflow activity guide 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

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.

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 Workflow activity guide 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

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.

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 Workflow activity guide. The relative reference is suitable for use on any page that itself has the simple URL format.

Parameters

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.

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.

Parameters

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.

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

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.

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

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.

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

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

Syntax

GenerateQueryContentURL(Portal.portalname, Node.nodename, QueryName, IsPublic [, IsNewWindow])

Description

Use the GenerateQueryContentURL function to create a URL string that represents an absolute reference to 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

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.

Syntax

GenerateQueryPortalURL(Portal.portalname, Node.nodename, QueryName, IsPublic [, IsNewWindow])

Description

Use the GenerateQueryPortalURL function to create a URL string that represents an absolute reference to 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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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.

Parameters

Returns

A string that contains HTML code that can be used with the HTML control to display a tree.

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

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.

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

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.

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

Returns

None.

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.

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.

Syntax

GetABNInitialNode(&reqParams)

Description

Use this function to return the identifier of the initial SmartNavigation chart node as a string.

Parameters

Returns

The identifier of the initial chart node as a string.

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

Returns

The identifier of the current SmartNavigation chart node as a string.

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.

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:

* Set to an empty string when the data source is a rowset.

Parameters

Returns

An array of array of string representing the HTTP request parameters (name-value pairs).

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

Returns

A string representing the effective date key for the tree.

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

Returns

A string representing the tree name.

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

Returns

A string representing the setID key for the tree.

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

Returns

A string representing the user key for the tree.

Syntax

GetAddSearchRecName()

Description

Use the GetAddSearchRecName function to return the add search record name for the component.

Parameters

None.

Returns

A string value.

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.

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.

Parameters

Returns

An AESection object is returned.

Syntax

GetAnalyticGrid(Page.page_name, grid_name)

Description

Use the GetAnalyticGrid function to instantiate an analytic grid object from the AnalyticGrid class, and populates it with the grid specified by grid_name, which is the Page Field Name on the General tab of that analytic grid’s page field properties.

See Activate Event.

Parameters

Returns

A reference to an AnalyticGrid object.

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

Returns

An AnalyticInstance object if successful, null otherwise.

Syntax

GetArchPubHeaderXmlDoc(PubID, PubNode, ChannelName, VersionName[, Segment])

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.

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.

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.

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.

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

• PeopleTools supports multiple types of storage locations.

  See Understanding File Attachment Storage Locations.

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

  See File Name Considerations.

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

  See Attachments with non-ASCII File Names.

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

  See Considerations When Attaching Text Files.

&retcode = GetAttachment(&FTPINFO, &SOURCEFILENAME, "c:\temp\resume.doc");

&retcode = GetAttachment(&FTPINFO, &SOURCEFILENAME, "/tmp/resume.doc");

&retcode = GetAttachment(&FTPINFO, &SOURCEFILENAME, "resume.doc"); 

&retcode = GetAttachment(&FTPINFO, &SOURCEFILENAME, "resume.doc", "PS_CFG_HOME");

\\server_name\share_name

\\server_name\share_name\temp

Parameters

Returns

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

Syntax

GetAttachmentURL(URLSource, DirAndSysFileName, UserFileName , AttachmentURL [, AuthToken][, ContentURI][, PreserveCase])

Description

Use the GetAttachmentURL function within a Mobile Application Platform (MAP) application to temporarily download a file from its source storage location and return the associated attachment URL. This attachment URL can subsequently be used by the MAP application to temporarily gain secure access to the downloaded file.

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

• PeopleTools supports multiple types of storage locations.

  See Understanding File Attachment Storage Locations.

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

  See File Name Considerations.

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

  See Attachments with non-ASCII File Names.

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

  See Considerations When Attaching Text Files.

Parameters

Returns

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

Syntax

GetBiDoc(XMLstring)

Description

Use the GetBiDoc function to create a BiDocs structure. You can populate the structure with data from XMLstring. This is part of the incoming Business Interlink functionality, which enables PeopleCode to receive an XML request and return an XML response.

Parameters

Syntax

GetBreadcrumbs()

Description

Use the GetBreadcrumbs function to return the user’s current history stack as an array of array of string in reverse order of access—that is, the first history record in the list represents the current content reference. The array of string includes 11 elements as specified in the following table. Specific values are included in the table when they do not vary based on the breadcrumb type; otherwise, blank cells indicate values that are dependent on the specific breadcrumb. For example, breadcrumbs created by PeopleTools do not include certain values such as a page ID or component keys. These and any other unknown values are returned as the literal string “UnknownValue”.

The GetBreadcrumbs function returns a Null value in the following situations:

• When the history stack is empty—for example, when the function is invoked by an action on a homepage pagelet or tile.

• When the source content is not displayed in the PeopleSoft portal template—for example, if you display the content in your own portal or if the content is displayed via a direct psc URL.

• When executing JavaScript fails to retrieve any history stack data.

Parameters

None

Returns

A array of array of string.

Syntax

GetCalendarDate(comparedate, periods, periodadjustment,outfieldname, company, paygroup)

Description

Use the GetCalendarDate function to return the value of a Date field from the PS_PAY_CALENDAR table. If a table entry is not found, GetCalendarDate returns 1899-01-01.

Parameters

Returns

Returns a Date value from the PS_PAY_CALENDAR table.

Syntax

GetChart(RecordName.FieldName)

Description

Use the GetChart function to get a reference to a Chart object.

A chart must be associated with a record and field merely so that the chart object can be instantiated in PeopleCode. Which record and field you use doesn't matter. Commonly, the same derived/work record is used for all the charts in an application.

Parameters

Returns

A reference to a Chart object.

Syntax

GetChartURL(&Chart)

Description

Use the GetChartURL function to generate the URL of a chart object. This URL can then be used in your application for displaying a chart.

GetChartURL can be used only with the Chart class and Gantt class.

Parameters

Returns

A URL as a string.

Syntax

GetComponentTitle()

Description

Use the GetComponentTitle function to return the name of the component (from the component definition).

Parameters

None.

Returns

A String value.

Syntax

GetCwd()

Description

Use the GetCwd function to determine the current working directory of the process that executes it. This means that in PeopleSoft Pure Internet Architecture it returns the current working directory on the server, in an Application Engine program it returns the current working directory of the Application Engine process, and so on.

Returns

Returns a string containing the path of the current working directory.

Syntax

GetDefinitionAccess(Definition_Type, Key_Collection)

Description

Use the GetDefinitionAccess function to return the access setting of a particular definition for a user.

Parameters

Valid definition types:

Returns

Integer.

Syntax

GetDialGauge(RecordName.FieldName)

Description

Use the GetDialGauge function to get a reference to a DialGauge object.

A gauge must be associated with a record and field merely so that the gauge object can be instantiated in PeopleCode. Which record and field you use doesn't matter. Commonly, the same derived/work record is used for all the charts in an application.

Parameters

Returns

A reference to a DialGauge object.

Example

&MyGauge = GetDialGauge(GAUGEREC_WRK.GAUGE_FLD);

Syntax

GetEnv(env_var)

Description

Use the GetEnv function to return the value of an environment variable specified by env_var as a string. If the environment variable does not exist, GetEnv it returns a null string.

For example, you can use the GetEnv function to determine the actual path of PS_HOME. You could use this with the Exec function, which automatically prepends the command string with the path of PS_HOME.

Parameters

Returns

A string representing the value of the specified environment variable; Null if the variable does not exist.

Syntax

GetField([recname.fieldname])

Description

Use the GetField function to create a reference to a field object for the current context; that is, from the row containing the currently executing program.

If you do not specify recname.fieldname, the current field executing the PeopleCode is returned.

When GetField is used with an associated record and field name on component buffer data, the following is assumed:

&FIELD = GetRow().recname.fieldname;

Parameters

Returns

This function returns a field object that references the field from the specified record.

Syntax

GetFile(filename, mode [, charset] [, pathtype])

Description

Use the GetFile function to instantiate a new file object from the File class, associate it with an external file, and open the file so you can use File class methods to read from or write to it.

Any file opened for writing (using a call to the GetFile function or the File class Open method) by a PeopleCode program that runs in the Process Scheduler is automatically managed by the Report Repository.

You can use the GetFile or GetTempFile functions to access an external file, but each execution of GetFile or GetTempFile instantiates a new file object. If you plan to access only one file at a time, you need only one file object. Use GetFile or GetTempFile to instantiate a file object for the first external file you access. Then, use Open to associate the same file object with as many different external files as you want. However, if you expect to have multiple files open at the same time, you need to instantiate multiple file objects with GetFile or GetTempFile.

GetFile and Open both perform implicit commits. Therefore, the GetTempFile function has been introduced specifically to avoid these implicit database commits. GetTempFile differs from GetFile in two respects:

• GetTempFile does not perform an implicit commit.

• GetTempFile does not make the associated file available through the Report Repository even when the calling PeopleCode program is run through the Process Scheduler.

Therefore, GetTempFile can be a good choice when you wish to avoid implicit database commits and when you do not need to have the file managed through the Report Repository. Otherwise, GetTempFile operates exactly the same as GetFile.

See GetTempFile.

Parameters

Returns

A File object if successful; Null otherwise.

Syntax

GetGanttChart(RecordName.FieldName)

Description

Use the GetGanttChart function to get a reference to a Gantt object.

A chart must be associated with a record and field merely so that the chart object can be instantiated in PeopleCode. Which record and field you use doesn't matter. Commonly, the same derived/work record is used for all the charts in an application.

Parameters

Returns

A reference to a Gantt object.

Syntax

GetGaugeThreshold()

Description

Use the GetGaugeThreshold function to get a reference to a GaugeThreshold object. GaugeThreshold objects can then be associated with a RatingGaugeChart object.

Parameters

None.

Returns

A reference to a GaugeThreshold object.

Syntax

GetGrid(Page.page_name, grid_name, [L1_row_num])

Description

Use the GetGrid function to instantiate an object of the Grid class and populate it with the grid specified by grid_name. For grids at level 2, specify the optional L1_row_num parameter. The grid_name corresponds to the Page Field Name on the General tab of that grid’s page field properties.

Use the GetGrid function to return a reference to a Grid object. If you want to access an AnalyticGrid object, use the GetAnalyticGrid function instead.

See Activate Event.

Parameters

Returns

A Grid object populated with the requested grid.

Syntax

GetHTMLText(HTML.textname [, paramlist])

Where paramlist is an arbitrary-length list of values of undetermined (Any) data type in the form:

inval1 [, inval2] ...

Description

Use the GetHTMLText function to retrieve a predefined HTML text from an HTML definition in the user's current language, or the base language if no entry exists in the user's current language. If any values are included in paramlist, they are substituted into the HTML text based on positional reference (for example, %BIND(:1) is the first parameter, %BIND(:2) is the second, and so on.)

See GetJavaScriptURL.

Parameters

Returns

The resulting HTML text is returned as a string.

Syntax

GetImageExtents(IMAGE.ImageName)

Description

Use the GetImageExtents function to return the width and height of the image specified by ImageName.

Parameters

Returns

An array of data type number, where element 1 is the image height and element 2 is the image width.

Syntax

GetInterlink(Interlink.name)

Description

Use the GetInterlink function to instantiate a Business Interlink definition object based on a Business Interlink definition created in Application Designer. The Business Interlink object can provide a gateway for PeopleSoft applications to the services of any external system.

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

Generally, do not use the GetInterlink function in a program you create from scratch. If you drag a Business Interlink definition from the project workspace (in Application Designer) to an open PeopleCode editor window, a "template" is created, with values filled in based on the Business Interlink definition you dragged in.

The following is the template created from dragging the Business Interlink definition LDAP_SEARCHBIND to an open PeopleCode editor window.

/* ===> 
   This is a dynamically generated PeopleCode template to be used only as a helper
 to the application developer.  You need to replace all references to '<*>' OR
 default values with  references to PeopleCode variables and/or a Rec.Fields.*/ 
 
/* ===> Declare and instantiate: */ 
Local Interlink &LDAP_SEARCHBI_1; 
Local BIDocs &inDoc; 
Local BIDocs &outDoc; 
Local Boolean &RSLT; 
Local number  &EXECRSLT; 
&LDAP_SEARCHBI_1 =  GetInterlink(INTERLINK.LDAP_SEARCHBIND); 
 
/* ===> You can use the following assignments to set the configuration parameters. 
*/ 
 
&LDAP_SEARCHBI_1.Server = "jtsay111198.peoplesoft.com"; 
&LDAP_SEARCHBI_1.Port = 389; 
&LDAP_SEARCHBI_1.User_DN = "cn=Admin,o=PeopleSoft"; 
&LDAP_SEARCHBI_1.Password = &password; 
&LDAP_SEARCHBI_1.UserID_Attribute_Name = "uid"; 
&LDAP_SEARCHBI_1.URL = "///file:C:/User/Documentum/XML%20Applications/proddoc/
peoplebook_upc/peoplebook_
upc.dtd"; 
&LDAP_SEARCHBI_1.BIDocValidating = "Off"; 
 
 
/* ===> You might want to call the following statement in a loop if there is more than one row of data to be added.  */ 
 
/* ===> Add inputs: */ 
&inDoc = &LDAP_SEARCHBI_1.GetInputDocs(""); 
&ret = &inDoc.AddValue("User_ID", <*>); 
&ret = &inDoc.AddValue("User_Password", <*>); 
&ret = &inDoc.AddValue("Connect_DN", <*>); 
&ret = &inDoc.AddValue("Connect_Password", <*>); 
&Directory_Search_ParmsDoc = &inDoc.AddDoc("Directory_Search_Parms"); 
&ret = &Directory_Search_ParmsDoc.AddValue("Host", <*>); 
&ret = &Directory_Search_ParmsDoc.AddValue("Port", <*>); 
&ret = &Directory_Search_ParmsDoc.AddValue("Base", <*>); 
&ret = &Directory_Search_ParmsDoc.AddValue("Scope", <*>); 
&ret = &Directory_Search_ParmsDoc.AddValue("Filter", <*>); 
 
 
/* ===> The following statement executes this instance: */ 
&EXECRSLT = &LDAP_SEARCHBI_1.Execute(); 
If ( &EXECRSLT <> 1 ) Then 
   /* The instance failed to execute */ 
Else 
&outDoc = &LDAP_SEARCHBI_1.GetOutputDocs(""); 
&ret = &outDoc.GetValue("Distinguished_Name", <*>); 
&ret = &outDoc.GetValue("return_status", <*>); 
&ret = &outDoc.GetValue("return_status_msg", <*>); 

End-If; /* If NOT &RSLT ...  */

Parameters

Returns

A Business Interlink object.

Syntax

GetJavaClass(ClassName)

Description

Use the GetJavaClass function to access a Java class so that you can manipulate it in PeopleCode. This is used for those classes that have static members, where it isn't appropriate to instantiate an object of the class. You can call only static methods, that is, class methods, with the object created with this function.

In Java, you access such static members of a class by using the class name:

result = java.class.name.SomeStaticMethod();

To do this in PeopleCode, do the following:

&Result = GetJavaClass("java.class.name").SomeStaticMethod();

See System Setup for Java Classes.

Parameters

Returns

A JavaObject that refers to the named Java class.

Syntax

GetLEDGauge(RecordName.FieldName)

Description

Use the GetLEDGauge function to get a reference to an LEDGauge object.

A gauge must be associated with a record and field merely so that the gauge object can be instantiated in PeopleCode. Which record and field you use doesn't matter. Commonly, the same derived/work record is used for all the charts in an application.

Parameters

Returns

A reference to an LEDGauge object.

Example

&MyGauge = GetLEDGauge(GAUGEREC_WRK.GAUGE_FLD);

Syntax

GetLevel0()

Description

Use the GetLevel0 function to create a rowset object that corresponds to level 0 of the component buffer. If used from PeopleCode that isn’t associated with a page, it returns the base rowset from the current context.

Parameters

GetLevel0 has no parameters. However, it does have a default method, GetRow, and a shortcut. Specifying GetLevel0()(1) is the equivalent of specifying GetLevel0().GetRow(1).

Returns

This function returns a rowset object that references the base rowset. For a component, this is the level 0 of the page. For a Application Engine program, this is the state record rowset. For a message, this is the base rowset.

Syntax

GetMethodNames(Type, Name)

Description

Use the GetMethodNames function to return either the method names for a Component Interface, or the function names of a WEBLIB record.

Parameters

Returns

An array of string containing the method or function names.

Syntax

GetMessage()

Description

Use the GetMessage function to return a message.

It retrieves a message from the message queue for the current message being processed.

Parameters

None.

Returns

A reference to an empty message object if successful, NULL if not successful.

Syntax

GetMessageInstance(pub_id, pub_nodename, channelname)

Description

Use the GetMessageInstance function to get a message from the message queue.

Syntax

GetMessageXmlDoc()

Description

Use the GetMessageXmlDoc function in any of the messaging PeopleCode events.

It retrieves an XML message, either from the message queue for asynchronous messages, or in memory for synchronous messages, for the current message being processed. An XML message is a message that is unstructured, that is, isn't based on a record hierarchy. It creates and loads a data tree for the default message version, and returns NULL if not successful.

Parameters

None.

Returns

A reference to an XmlDoc object if successful, NULL if not successful.

Syntax

GetNextNumber({record.field | record_name, field_name}, max_number)

Description

Use the GetNextNumber function to increment the value in a record for the field you specify by one and returns that value. You might use this function to increment an employee ID field by one when you are adding a new employee. If the new value generated exceeds max_number, a negative value is returned and the field value isn't incremented.

The maximum value possible for max_number is 2147483647.

Parameters

Returns

A Number value equal to the highest value of the field specified plus one.

GetNextNumber returns an error if the value to be returned would be greater than max_number. The function returns one of the following:

Syntax

GetNextNumberWithGaps(record.field, max_number, increment [, WHERE_Clause, paramlist])

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

var1 [, var2] ...

Description

Use the GetNextNumberWithGaps function to determine the highest value in a table for the field you specify, and return that value plus increment.

This function also enables you to specify a SQL WHERE clause as part of the function for maintaining multiple sequence numbers in a single record.

Parameters

Returns

A Number value equal to the highest value of the field specified plus one.

GetNextNumberWithGaps returns an error if the value to be returned would be greater than max_number. The function returns one of the following:

Syntax

GetNextNumberWithGapsCommit(record.field, max_number, increment [, WHERE_Clause, paramlist])

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

var1 [, var2] ...

Description

Use the GetNextNumberWithGapsCommit function to return the sequence number value plus increment for the given field residing in the given record. This function also enables you to specify a SQL Where clause as part of the function for maintaining multiple sequence numbers in a single record.

This function is typically used for obtaining a new sequence number for the application, for example, getting a new Purchase Order number to be used in the application transaction.

Use this function instead of the GetNextNumberWithGaps function. The GetNextNumberWithGaps function is very restrictive in its usage. The GetNextNumberWithGapsCommit function can be used in any event. The sequence number (record.field ) is incremented right away and it doesn't hold any database internal row lock beyond the execution of this function.

Parameters

Returns

A number value equal to the highest value of the field specified plus one increment.

The GetNextNumberWithGapsCommit function returns an error if the value to be returned would be greater than max_number. The function returns one of the following:

Syntax

GetNextProcessInstance([Commit])

Description

Use the GetNextProcessInstance function to retrieve the next available process instance from the Process Scheduler System table. When determining to find the next process instance in the sequence, the function ensures the next available process instance does not exist in both the Process Request and Message Log tables.

By default, the function commits the changes to the Process Scheduler system table to set it to the next available process instance for the next available request. If this function is called within a PeopleCode function for which issuing a COMMIT to the database destroys a unit of work, specify "0" for Commit.

Parameters

Returns

An integer representing the next available process instance if successful, otherwise 0 in case of a failure.

Syntax

GetNRXmlDoc(NRID, EntityName)

Description

Use the GetNRXmlDoc function in any of the messaging PeopleCode events. It retrieves an XML message, categorized as non-repudiation, from the message queue for the specified non-repudiation ID. An XML message is a message that is unstructured, that is, isn't based on a record hierarchy. It creates and loads a data tree for the default message version, and returns Null if not successful.

Parameters

Returns

A reference to an XmlDoc object if successful, Null if not successful.

Syntax

GetOrgChart(RecordName.FieldName)

Description

Use the GetOrgChart function to get a reference to an OrgChart object.

A chart must be associated with a record and field merely so that the chart object can be instantiated in PeopleCode. Which record and field you use doesn't matter. Commonly, the same derived/work record is used for all the charts in an application.

Parameters

Returns

A reference to a an OrgChart object.

Syntax

GetPage(PAGE.pagename)

Description

Use the GetPage function to return a reference to a page object. Generally, page objects are used to hide or unhide pages in a component.

Generally, the PeopleCode used to manipulate a page object would be associated with PeopleCode in the Activate event.

PAGE.name.property

Parameters

Returns

A page object that references the page.

Syntax

GetPageField(Page.pagename, [scrollpath. [target_row, ]] page_field_name)

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 GetPageField function to reference a specific page field anywhere in the current component. Generally, you will need to use GetPageField to reference radio buttons, which represent multiple instances of a record field.

If you need to reference a field that is unique in the current context, you can use the GetField function.

See Idiv, Idiv, GetField, Understanding Current Context.

Parameters

Returns

This function returns a field object that references a specific instance of a page field in the component buffer.

Syntax

GetPagePrefix(page_type)

Description

Use the GetPagePrefix function to return the prefix for the page based on the page type as set on the Use tab.

Parameters

Returns

A String value:

• "" = Standard Page

• ftr = Footer Page

• hdr - Header page

• side = Side Page 1

• side2 = Side Page 2

• srch = Search Page

Syntax

GetPageTitle()

Description

Use the GetPageTitle function to return the title of the page.

Parameters

None.

Returns

A string value.

Syntax

GetPageType(Page.PAGE_NAME)

Description

Use the GetPageType function to return the page type—for example, header, footer, prompt, and so on.

Parameters

Returns

One of the following Integer values:

Syntax

GetPanelControlStyle()

Description

Use the GetPanelControlStyle function to return the styles set by the system that control the state of the left and right panels as a String value.

Parameters

None.

Returns

A String value.

Syntax

GetProgramFunctionInfo(ProgramId)

Where ProgramId is the following for PeopleCode user-defined functions:

RECORD.RecordName.FIELD.FieldName.METHOD.MethodName

Where ProgramId is the following for Component Interface user-defined methods:

COMPONENTINTERFACE.CIName.METHODS.Methods

Description

Use the GetProgramFunctionInfo function to determine the full signature and return values of a PeopleCode user-defined function, or a Component Interface method.

Parameters

Returns

An array of array of any.

There is one array for every function or method defined in the program. Each array contains the following information:

1. The name of the function.

2. The signature of the parameters as a comma-separated string (see additional information below.)

3. The signature of the result (see result list below.)

4. The annotation of the Doc tag.

5. A boolean indicator of whether this function is to be exported (as indicated by the noexp tag).

6. A boolean indicator of whether this function is permitted to be called by this user. This only makes sense for Functions defined as CI methods in Component Interface PeopleCode. The default value is True.

The parameters may be modified by the following values:

The possibly values of the result are as follows. Note the use of both lower and upper case letters.

Syntax

GetPubContractInstance(pub_id, pub_nodename, channelname, sub_nodename)

Description

See GetPubXmlDoc.

Syntax

GetPubHeaderXmlDoc(PubID, PubNode, ChannelName, VersionName[, Segment])

Description

Use the GetPubHeaderXmlDoc function to retrieve the message header from the message queue.

The message header, also known as the message instance, is the published message before any transformations were performed.

Parameters

Returns

A reference to an XmlDoc object if successful, NULL if not successful.

Syntax

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

Description

Use the GetPubXmlDoc function to retrieve a message from the message queue.

This is the message after any transformations have been preformed. It creates and loads a data tree for the specified message version, and returns NULL if not successful. This function is used for publication contract error correction when the error correction process needs to fetch a particular message instance for the publication contract in error. SQL on the Publication Contract table is used to retrieve the key fields.

Parameters

Returns

A reference to an XmlDoc object if successful, NULL if not successful.

Syntax

GetRatingBoxChart(RecordName.FieldName)

Description

Use the GetRatingBoxChart function to get a reference to an RatingBoxChart class object.

A chart must be associated with a record and field merely so that the chart object can be instantiated in PeopleCode. Which record and field you use doesn't matter. Commonly, the same derived/work record is used for all the charts in an application.

Parameters

Returns

A reference to a RatingBoxChart object.

Syntax

GetRatingGauge(RecordName.FieldName)

Description

Use the GetRatingGauge function to get a reference to a RatingGaugeChart object.

A gauge must be associated with a record and field merely so that the gauge object can be instantiated in PeopleCode. While the record and field you use doesn't matter, for a rating gauge, the field must be either Numeric or Float. Commonly, the same derived/work record is used for all the charts in an application.

Parameters

Returns

A reference to a RatingGaugeChart object.

Syntax

GetRatingGaugeState()

Description

Use the GetRatingGaugeState function to get a reference to a RatingGaugeState object. A RatingGaugeState object can then be associated with the corresponding state property on the RatingGaugeChart object.

Parameters

None.

Returns

A reference to a RatingGaugeState object.

Syntax

GetRecord([Record.REC_NAME])

Description

Use the GetRecord function to create a reference to a record object for the current context, that is, from the row containing the currently executing program.

The following code:

&REC = GetRecord();

is equivalent to:

&REC = GetRow().GetRecord(Record.recname);

or

&REC = GetRow().recname;

Parameters

With no parameters, this function returns a record object for the current context (the record containing the program that is running).

If a parameter is given, Record. REC_NAME must specify a record in the current row.

Returns

GetRecord returns a record object.

Syntax

GetReferenceArea()

Description

Use the GetReferenceArea function to get a reference to a ReferenceArea object. ReferenceArea instances can then be associated with a Chart object.

Parameters

None.

Returns

A reference to a ReferenceArea object.

Example

&MyRefArea = GetReferenceArea();

Syntax

GetReferenceLine()

Description

Use the GetReferenceLine function to get a reference to a ReferenceLine object. ReferenceLine instances can then be associated with a Chart object.

Parameters

None.

Returns

A reference to a ReferenceLine object.

Example

&MyRefLine = GetReferenceLine();

Syntax

GetRelField(ctrl_field, related_field) 

Description

Use the GetRelField function to retrieve the value of a related display field and returns it as an unspecified (Any) data type.

The field ctrl_field specifies the display control field, and related_field specifies the name of the related display field whose value is to be retrieved. In most cases, you could get the value of the field by referencing it directly. However, there are two instances where GetRelField can be useful:

• If there are two related display fields bound to the same record field, but controlled by different display control fields, use this function to specify which of the two related display fields you want.

• If all of a page’s level-zero fields are search keys, the Component Processor does not load the entire row of level-zero data into the component buffer; it only loads the search keys. Adding a non-search-key level-zero field to the page would cause the Component Processor to load the entire row into the component buffer. To prevent a large row of data from being loaded into the buffer, you may occasionally want to make a level-zero display-only field a related display, even though the field is in the primary level-zero record. You won’t be able to reference this related display field directly, but you can using GetRelField.

See GetRelated.

Syntax

GetRow()

Description

Use the GetRow function to obtain a row object for the current context, that is the row containing the currently executing program.

Using the GetRow function is equivalent to:

&ROW = GetRowset().GetRow(CurrentRowNumber());

Parameters

None.

Returns

GetRow returns a row object that references the current row in the component buffers. If the program is not being run from a page (such as from Application Engine, or as part of a Message program) it references that data.

Syntax

GetRowset([SCROLL.scrollname])

Description

Use the GetRowset function to get a rowset object based on the current context. That is, the rowset is determined from the row containing the program that is running.

RECORD.scrollname.property

RECORD.scrollname.method(. . .)

Parameters

If a parameter is specified, it must be the name of the primary record for the scroll that is a child of the current context.

Returns

With no parameters, GetRowset returns a rowset object for the rowset containing the currently running program. If a parameter is specified, it returns a rowset for that child scroll. scrollname must be the name of the primary record for the scroll.

Syntax

GetRowsetCache([Rowset.]name, [language])

Description

Use GetRowsetCache to return the existing rowset cache with the given name.

Every time you use the GetRowsetCache function, you should verify that the function executed successfully by testing for a null object. For example:

Local RowsetCache &RSC;

&RSC = GetRowsetCache(Rowset.MyRowset);

If All(&RSC) Then
		/* do processing */
Else
		/* call to populate rowset cache */
End-if;

Parameters

Returns

A RowsetCache object populated with the rowset cache instance specified.

Syntax

GetSearchRecName()

Description

Use the GetSearchRecName function to return the search record name for the component.

Parameters

None.

Returns

A string value.

Syntax

GetSelectedTreeNode(RECORD.recordname)

Description

Use the GetSelectedTreeNode function to determine what node the user has selected in a dynamic tree control.

Syntax

GetSeries()

Description

Use the GetSeries function to get a reference to a Series object. Series instances can then be associated with a Chart object.

Parameters

None.

Returns

A reference to a Series object.

Syntax

GetSession()

Description

Use the GetSession function to retrieve a PeopleSoft session object.

After you use GetSession, you can instantiate many other types of objects, like Component Interfaces, data trees, and so on.

After you use GetSession you must connect to the system using the Connect property.

If you are connecting to the existing session and not doing additional error checking, you may want to use the %Session system variable instead of GetSession. %Session returns a connection to the existing session.

Parameters

None.

Returns

A PeopleSoft session object.

Syntax

GetSetId({FIELD.fieldname | text_fieldname}, set_ctrl_fieldvalue, {RECORD.recname | text_recname}, treename)

Description

Use the GetSetId function to return a string containing a setID based on a set control field (usually BUSINESS_UNIT), a set control value, and one of the following:

• The name of a control table (or view) belonging to a record group in the TableSet Control controlled by the set control value.

• The name of a tree in the TableSet Control controlled by the set control value.

If you want to pass a control record name to the function, you must pass an empty string in the treename parameter. Conversely, if you want to pass a tree name, you must pass an empty string in the text_recname parameter. In practice, tree names are rarely used in this function.

Parameters

Returns

GetSetId returns a five-character setID string.

Syntax

GetSparkChart(RecordName.FieldName)

Description

Use the GetSparkChart function to return a reference to a SparkChart object.

A spark chart must be associated with a record and field merely so that the spark chart object can be instantiated in PeopleCode. Which record and field you use doesn't matter. Commonly, the same derived/work record is used for all the charts in an application.

Parameters

Returns

A reference to a SparkChart object.

Syntax

GetSparkChartItem()

Description

Use the GetSparkChartItem function to return a reference to a SparkChartItem object.

Parameters

None.

Returns

A reference to a SparkChartItem object.

Syntax

GetSQL(SQL.sqlname [, paramlist])

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

inval1 [, inval2] ...

Description

Use the GetSQL function to instantiate a SQL object and associates it with the SQL definition specified by sqlname. The SQL definition must already exist, either created using Application Designer or the StoreSQL function.

Processing of the SQL definition is the same as for a SQL statement created by the CreateSQL function.

"INSERT INTO PS_TESTREC (TESTF1, TESTF2, TESTF3, TESTF4, . . .TESTN) VALUES (:1, :2, %DateTimeIn(:3), %TextIn(:4). . .N)";

&AAny = CreateArrayAny("a", 1, %DateTime, "abcdefg", . . .N);

GetSQL(SQL.INSERT_TEST, &AAny);

Parameters

Returns

A SQL object.

Syntax

GetStatusMeterGauge(RecordName.FieldName)

Description

Use the GetStatusMeterGauge function to get a reference to a StatusMeterGauge object.

A gauge must be associated with a record and field merely so that the gauge object can be instantiated in PeopleCode. Which record and field you use doesn't matter. Commonly, the same derived/work record is used for all the charts in an application.

Parameters

Returns

A reference to a StatusMeterGauge object.

Example

&MyGauge = GetStatusMeterGauge(GAUGEREC_WRK.GAUGE_FLD);

Syntax

GetStoredFormat(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 GetStoredFormat function to return the name of a field’s custom stored format.

To return the format for a field on level zero of the page, pass 1 in target_row.

Parameters

Returns

Returns a String equal to the name of the stored custom format for the field.

Syntax

GetSubContractInstance(pub_id, pub_nodename, channelname, messagename, sub_name)

Description

See GetSubXmlDoc.

Syntax

GetSubXmlDoc(PubID, PubNode, ChannelName, VersionName, MessageName[, Segment])

Description

Use the GetSubXmlDoc function to retrieve a message from the message queue.

It creates and loads a data tree for the specified message version, and returns NULL if not successful. This function is used for subscription contract error correction, when the error correction process needs to fetch a particular message instance for the subscription contract in error. SQL on the Subscription Contract table is used to retrieve the key fields.

Parameters

Returns

A reference to an XmlDoc object if successful, NULL if not successful.

Syntax

GetSyncLogData(GUID, pubnode, chnlname, msg_name, logtype [, message_version])

Description

Use the GetSyncLogData to return a log containing information about the specified synchronous message.

You can use this information for debugging. Using this function, you can obtain the request and response data in a synchronous request, both pre- and post-transformation.

This function is used in the PeopleCode for the Message Monitor.

Parameters

Returns

An XML string containing the log data.

Syntax

GetTempFile(filename, mode  [, charset] [, pathtype])

Description

The GetTempFile function provides an alternative to GetFile. Similar to GetFile, use the GetTempFile function to instantiate a new file object from the File class, associate it with an external file, and open the file so you can use File class methods to read from or write to it.

GetTempFile differs from GetFile in two respects: \

• GetTempFile does not perform an implicit commit.

• GetTempFile does not make the associated file available through the Report Repository even when the calling PeopleCode program is run through the Process Scheduler.

Therefore, GetTempFile can be a good choice when you wish to avoid implicit database commits and when you do not need to have the file managed through the Report Repository. Otherwise, GetTempFile operates exactly the same as GetFile. For additional information about GetTempFile, see the documentation on GetFile.

See GetFile.

Parameters

Returns

A file object if successful; Null otherwise.

Syntax

GetThreshold()

Description

Use the GetThreshold function to get a reference to a Threshold object. Threshold instances can then be associated with gauge instances.

Parameters

None.

Returns

A reference to a Threshold object.

Example

&MyThreshold = GetThreshold();

Syntax

GetToolTip()

Description

Use the GetToolTip function to get a reference to a TooltipLabel object. TooltipLabel instances can then be associated with a Chart object.

Parameters

None.

Returns

A reference to a TooltipLabel object.

Syntax

GetTreeNodeParent(node)

Description

Use the GetTreeNodeParent function to access data from dynamic tree controls.

Syntax

GetTreeNodeRecordName(node)

Description

Use the GetTreeNodeRecordName function in accessing data from dynamic tree controls.