RCServiceDefinition Class Properties

In this section, the RCServiceDefinition class properties are presented in alphabetical order.

Description

When the related content service definition type is application class (ServiceUrlType = UAPC), use the AppclassId property to set or return a string value representing the name of the application class.

Note: The full path to the application class is constructed from three properties: PackageRoot, QualifyPath, and AppclassId.

This property is read-write.

Example

&rcServDefn.PackageRoot = "MY_PACKAGE";
&rcServDefn.QualifyPath = ":";
&rcServDefn.AppclassId = "My_Class";

Description

Use the Descr property to set or return a string value representing the description of the related content service definition.

This property is read-write.

Example

import PTCS_SRVDEFN:*;

Component PTCS_SRVDEFN:RCServiceDefinition &rcServDefn;

&rcServDefn = create PTCS_SRVDEFN:RCServiceDefinition("SERVICE_DEFN", "ENG");
Local string &old_descr = &rcServDefn.Descr; /* Get */
&rcServDefn.Descr = "New Service Definition"; /* Set */

Description

Use the EscapeParam property to set or return a Y/N string value indicating whether to escape, or encode, the service URL parameters and values when the system forms the complete service URL.

Note: The default value is Y.

This property is read-write.

Example

&rcServDefn.EscapeParam = "N"; /* Set Y/N value */

Description

When the related content service definition type is PeopleSoft script (ServiceUrlType = USCR), use the FieldName property to set or return a string value representing the name of the record field storing the iScript.

Note: The full path to the iScript function is constructed from four properties: PortalRecName, FieldName, PcEventType, and PcFunctionName.

This property is read-write.

Example

&rcServDefn.PortalRecName = "WEBLIB_MYREC";
&rcServDefn.FieldName = "ISCRIPT1";
&rcServDefn.PcEventType = "FieldFormula";
&rcServDefn.PcFunctionName = "IScript_MyFunction";

Description

Use the IsBulkAction property to set or return a Y/N string value indicating whether the related content service definition is defined as a bulk action. Bulk actions are supported for three service types:

  • Application class (UAPC).

  • PeopleSoft component (UPGE).

  • PeopleSoft script (USCR).

Note: The default value is N.

This property is read-write.

Example

&rcServDefn.IsBulkAction = "Y"; /* Set Y/N values */

Description

Use the IsNew property to return whether the instantiation of this related content service definition is for a new definition. This property returns True only after the RCServiceDefinition constructor is invoked with the service_ID parameter set to a new and unique ID or when CloneForNew is invoked. All other times and after a Save is invoked, IsNew returns False.

This property is read-only.

Example

import PTCS_SRVDEFN:*;

Component PTCS_SRVDEFN:RCServiceDefinition &rcServDefn;

&rcServDefn = create PTCS_SRVDEFN:RCServiceDefinition("NEW_SERVICE_DEFN", "ENG");
If &rcServDefn.IsNew Then
   /* Set properties of the new definition. */
Else
   /* Examine properties of the existing definition. */
End-If;

Description

Use the LanguageCD property to return the language code in use for this related content service definition as a three-character string.

This property is effectively read-only.

Example

Local string &langCD = &rcServDefn.LanguageCD;

Description

When the related content service definition type is PeopleSoft component (ServiceUrlType = UPGE), use the Market property to set or return a string value representing the market for this component definition.

Note: The full component name is constructed from four properties: PortalMenuName, PnlGrpName, Market and PnlName (optional).

This property is read-write.

Example

&rcServDefn.PortalMenuName = "PORTAL_MENU_1";
&rcServDefn.Market = "GBL";
&rcServDefn.PnlGrpName = "COMPONENT_TEST";
&rcServDefn.PnlName = "MAIN_PAGE";

Description

Use the MsgNodeName property to set or return the name of the portal node as a string value.

Note: This property is used with all service types except for application class (ServiceUrlType = UAPC).

This property is read-write.

Example

&rcServDefn.MsgNodeName = "HRMS";

Description

When the related content service definition type is application class (ServiceUrlType = UAPC), use the PackageRoot property to set or return a string value representing the name of the application package that contains the application class.

Note: The full path to the application class is constructed from three properties: PackageRoot, QualifyPath, and AppclassId.

This property is read-write.

Example

&rcServDefn.PackageRoot = "MY_PACKAGE";
&rcServDefn.QualifyPath = ":";
&rcServDefn.AppclassId = "My_Class";

Description

When the related content service definition type is PeopleSoft script (ServiceUrlType = USCR), use the PcEventType property to set or return a string value representing the name of the PeopleCode event storing the iScript. Typically, iScripts are stored in the FieldFormula event.

Note: The full path to the iScript function is constructed from four properties: PortalRecName, FieldName, PcEventType, and PcFunctionName.

This property is read-write.

Example

&rcServDefn.PortalRecName = "WEBLIB_MYREC";
&rcServDefn.FieldName = "ISCRIPT1";
&rcServDefn.PcEventType = "FieldFormula";
&rcServDefn.PcFunctionName = "IScript_MyFunction";

Description

When the related content service definition type is PeopleSoft script (ServiceUrlType = USCR), use the PcFunctionName property to set or return a string value representing the name of the function that is the iScript.

Note: The full path to the iScript function is constructed from four properties: PortalRecName, FieldName, PcEventType, and PcFunctionName.

This property is read-write.

Example

&rcServDefn.PortalRecName = "WEBLIB_MYREC";
&rcServDefn.FieldName = "ISCRIPT1";
&rcServDefn.PcEventType = "FieldFormula";
&rcServDefn.PcFunctionName = "IScript_MyFunction";

Description

When the related content service definition type is PeopleSoft component (ServiceUrlType = UPGE), use the PnlGrpName property to set or return a string value representing the component for this component definition.

Note: The full component name is constructed from four properties: PortalMenuName, PnlGrpName, Market and PnlName (optional).

This property is read-write.

Example

&rcServDefn.PortalMenuName = "PORTAL_MENU_1";
&rcServDefn.Market = "GBL";
&rcServDefn.PnlGrpName = "COMPONENT_TEST";
&rcServDefn.PnlName = "MAIN_PAGE";

Description

When the related content service definition type is PeopleSoft component (ServiceUrlType = UPGE), use the PnlName property to set or return a string value representing the page name for this component definition. Use this optional property to open a specific page in the component.

Note: The full component name is constructed from four properties: PortalMenuName, PnlGrpName, Market and PnlName (optional).

This property is read-write.

Example

&rcServDefn.PortalMenuName = "PORTAL_MENU_1";
&rcServDefn.Market = "GBL";
&rcServDefn.PnlGrpName = "COMPONENT_TEST";
&rcServDefn.PnlName = "MAIN_PAGE";

Description

When the related content service definition type is PeopleSoft component (ServiceUrlType = UPGE), use the PortalMenuName property to set or return a string value representing the page name for this component definition. Use this optional property to open a specific page in the component.

Note: The full component name is constructed from four properties: PortalMenuName, PnlGrpName, Market and PnlName (optional).

This property is read-write.

Example

&rcServDefn.PortalMenuName = "PORTAL_MENU_1";
&rcServDefn.Market = "GBL";
&rcServDefn.PnlGrpName = "COMPONENT_TEST";
&rcServDefn.PnlName = "MAIN_PAGE";

Description

When the related content service definition type is PeopleSoft script (ServiceUrlType = USCR), use the PortalRecName property to set or return a string value representing the name of the record storing the iScript.

Note: The full path to the iScript function is constructed from four properties: PortalRecName, FieldName, PcEventType, and PcFunctionName.

This property is read-write.

Example

&rcServDefn.PortalRecName = "WEBLIB_MYREC";
&rcServDefn.FieldName = "ISCRIPT1";
&rcServDefn.PcEventType = "FieldFormula";
&rcServDefn.PcFunctionName = "IScript_MyFunction";

Description

When the related content service definition type is non-PeopleSoft URL (ServiceUrlType = UEXT), use the PortalUrlAdm property to set or return a string value representing the full or partial URL external to the PeopleSoft application.

This property is read-write.

Example

The following example sets a full, external URL value:

&rcServDefn.PortalUrlAdm = "http://www.bing.com";

Description

When the related content service definition type is generic PeopleSoft URL (ServiceUrlType = UGEN), use the PortalUriText property to set or return a string value representing the full or partial URL to the PeopleSoft definition.

This property is read-write.

Example

The following example sets a partial URL value. The complete URL is constructed by the system by appending this URL value to the URI text defined for the portal node specified by the MsgNodeName property.

&rcServDefn.PortalUriText = "c/PTCSSERVICES.PTCSSERVICES.GBL";

Description

Use the PostMapdata property to set or return a Y/N string value indicating whether to have the mapping definition data, such as the parameter name and its mapping page field or key field name, and the parameter’s actual mapped value posted with the service request.

Note: The default value is N.

This property is read-write.

Example

&rcServDefn.PostMapdata = "Y"; /* Set Y/N values */

Description

When the related content service definition type is either embeddable pagelet (ServiceUrlType = PEP) or OBIEE pagelet (ServiceUrlType = POP), use the PtppbPageletId property to set or return a string value representing the pagelet ID.

This property is read-write.

Example

&rcServDefn.PtppbPageletId = "MY_PAGELET";

Description

When the related content service definition type is application class (ServiceUrlType = UAPC), use the QualifyPath property to set or return a string value representing the names of each subpackage in the application class hierarchy that define the location of the application class. Separate subpackage names by a colon. If the class is defined in the top-level application package, use a colon only.

Note: The full path to the application class is constructed from three properties: PackageRoot, QualifyPath, and AppclassId.

This property is read-write.

Example

&rcServDefn.PackageRoot = "MY_PACKAGE";
&rcServDefn.QualifyPath = ":";
&rcServDefn.AppclassId = "My_Class";

Description

When the related content service definition type is PeopleSoft query (ServiceUrlType = UQRY), use the Queryname property to set or return a string value representing the query ID.

This property is read-write.

Example

&rcServDefn.Queryname = "USER_QRY";

Description

Use the SecUseEdit property to set or return an integer value indicating which security options are available when the service is assigned and configured for an application page.

Use the following integer values, which can be summed to indicate that more than one security option is available:

Value

Description

1

Public access, which provides access to the service based on the permissions of the public user

2

Related content provider security, which uses the security implemented by the content provider system.

4

Related content consumer security, which uses the security implemented by the consuming system—that is, the basic PeopleTools transaction security model (user-role-permission list).

16

App Class Required, which indicates that a service filter is required when this service is assigned to an application page.

Important! Service filters are deprecated and this option is retained for backward compatibility only. Do not select this option for new service definitions.

This property is read-write.

Example

In the following example, a value of 7 is the sum of the public (1), provider (2), and consumer (4) options:

&rcServDefn.SecUseEdit = 7; /* Allow multiple security options */

Description

Use the ServiceId property to return the unique identifier for the related content service definition.

This property is effectively read-only.

Example

In the following example, ServiceId returns SERVICE_DEFN, the value used to instantiate the service definition object:

Component PTCS_SRVDEFN:RCServiceDefinition &rcServDefn;
&rcServDefn = create PTCS_SRVDEFN:RCServiceDefinition("SERVICE_DEFN", "ENG");
Local string &serviceId = &rcServDefn.ServiceId;

Description

Use the ServiceName property to set or return the service name for the related content service definition as a string value.

Note: This string is limited to 18 characters or less.

This property is read-write.

Example

Component PTCS_SRVDEFN:RCServiceDefinition &rcServDefn;
&rcServDefn = create PTCS_SRVDEFN:RCServiceDefinition("SERVICE_DEFN", "ENG");
&rcServDefn.ServiceName = "My RC Service";

Description

Use the ServiceType property to set or return or return a string value representing the service type of this related content service definition.

For explicit service definitions, use the value of S. For anonymous service definitions (that is, an ad hoc service definition based on an existing content reference definition), use the values of C, P, or G. See Explicit Definition Versus Anonymous Services for more information.

Note: The default value is S.

This property can have the following values:

Value

Description

C

Component content reference (anonymous).

G

Tile content reference (anonymous).

P

Pagelet content reference (anonymous).

S

Service definition (explicit).

This property is read-write.

Description

Use the ServiceUrlType property to set or return a string value specifying the URL type for this related content service definition:

Value

Description

PEP

Embeddable Pagelet

POP

OBIEE Pagelet

UAPC

Application Class

UEXT

Non-PeopleSoft URL

UGEN

Generic PeopleSoft URL

UPGE

PeopleSoft Component

UQRY

PeopleSoft Query

USCR

PeopleSoft Script

UTIL

PeopleSoft Tile

This property is read-write.

Example

&rcServDefn.ServiceUrlType = "UPGE";

Description

When the related content service definition type is application class (ServiceUrlType = UAPC), use the SrvcAttribute property to set or return a string value indicating the type of application class service:

Value

Description

GNRL

Used for all application class services except simplified analytics.

Note. This is the default value.

MSTR

Used to specify the simplified analytics master (template) definition.

CLON

Used to specify a clone of the simplified analytics master.

This property is read-write.

Example

&rcServDefn.SrvcAttribute = "CLON";

Description

Use the SrvHelpText property to set or return a string value representing the HTML-formatted help text (as entered in the rich text editor) for this related content service definition.

This property is read-write.

Example

&rcServDefn.SrvHelpText = "<p>Some <em>help</em> text.<p>";

Description

When the related content service definition type is PeopleSoft tile (ServiceUrlType = UTIL), use the TileCategory property to set or return a string value indicating the content reference ID for the tile definition.

This property is read-write.

Example

&rcServDefn.TileCategory = "EP_BI_BILLINGNC_FL_GBL";

Description

Use the Useedit property to set or return an integer value representing which display options are available when configuring classic related content for the bottom frame.

Use the following integer values, which can be summed to indicate that both display options available:

Value

Description

1

New window

2

Refresh

This property is read-write.

Example

&rcServDefn.Useedit = 3; /* Make both options available for configuration */