peoplecodeapi

GenerateComponentPortalURL

Mon 01 January 2018

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

Field or Control

Definition

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.