Understanding Service Parameter, Filter, and Security Configuration

When you assign a related content or related actions, you typically must configure the service parameters. Configuration can include mapping the field data to the service parameters, specifying which type of menu the service link is listed in, adding filters to the service, and specifying security options. The service parameter list and other configuration options vary based the service type, the service definition, and the service target that you choose.

Related content service configuration establishes the relationships between the service and the transaction data so that the service appears in context with the current transaction. To establish contextually relevant relationships, service configuration includes working with:

  • Service parameter mapping.

  • Security options.

Service Parameter Mapping

Many services include parameters that you must map to key fields or page fields, system variables, and fixed values. You map the parameters to these elements so that they can pass the data to the service and create the relevant context for the related content.

This table discusses the source of the parameters for each of the service types.

Service Type Parameter Source

Content reference

Search key fields from the component search record

Note: If the search record has no key fields, the system retrieves search key fields from the component context search record.

Grouplet

Values in the Name field if the RCF_SERVICE_PARAMETER content reference attribute is defined on the Content Reference Administration page.

Pagelet

Values in the Name field if the RCF_SERVICE_PARAMETER content reference attribute is defined on the Content Reference Administration page.

Service

Values in the URL Parameters grid for the service definition.

When you map parameters, usually you must first select the mapping type and then select the mapping data. Some services might already have the mapping defined.

This table discusses the mapping types.

Mapping Type Description Example

Fixed value

A hard-coded value that does not change respective to context.

Service that includes the service ID as a parameter for example, ANALYTICSERVICE.

Key field

Primary or composite keys from the component search record.

DEPT_ID from the department table.

Page field

Any level 0, 1, 2, or 3 field in the component buffer.

SCHOOL_NAME on the education page.

System variable

Any variable that the PeopleSoft system resolves at run time.

For example, %UserId (the current user).

After you select a mapping type, click the Select button to see the mapping type prompt page.

Note these points about the prompt pages:

  • If the mapping type is Key Field, then the prompt page displays a list of search key fields from the component search record.

  • If the mapping type is Page Field, then the prompt page constructs a grid and dynamically populates it with a row for each page field that is available to the service. For each page field row, the grid also includes a hidden field indicator, the occurs or scroll level, the record (table) name, the field definition name, and the page field ID number.

    Use the page field ID number to identify a specific occurrence of a page field when the field appears multiple times in the same occurs level on the page. Each instance of a page field has a unique ID number that you find on the Order tab of the page definition in Application Designer.

  • If the mapping type is System Variable, then the prompt page displays valid system variables.

    See PeopleCode Language Reference: Understanding System Variables.

  • If the mapping type is Fixed Value, then the Select button is hidden.

Note:

To reduce mapping effort, the PeopleSoft Related Content Framework defines a set of reserved words and service parameters.

See Reserved Words Default Mapping.

Service Filters

Important:

Service filters are desupported and are retained for backward compatibility only.

Select this option to indicate that a service filter is required when this service is assigned to an application page.

A service filter hides or displays a service link in a field-level menu or the Related Content menu based on the value in the field at runtime. The application package PeopleCode that you specify can access the component buffer, using field values to trigger data-specific logic that causes the related content service link to be visible or hidden based on the value of the field. The filter enables the context of the data to determine whether the service link appears.

Security Options

The service definition determines the choices of security options that appear.

See Understanding Service Security.