Common Elements Used in This Section

Field or Control Description

Configure

Click to access the Configure Service page, where you map field values to the service parameters.

Content Reference

This is the content reference to which you are assigning the related content. You select the content reference on the Select a Content Reference page. This field is display-only.

Display in field menu

Select to enable access to a related content field-level contextual pop-up menu in the field to which you are mapping the service parameter. This field is enabled only when the mapping type is Page Field.

Selecting this check box causes the red related content glyph to appear in the field at runtime, even if the field is display-only.

Important: When mapping a service parameter to a page field, always examine the page to determine whether the selected page field lies within a collapsible page control such as a group box, grid, and scroll area. Services that access page fields that lie within a collapsible control that is set to the collapsed state by default must be configured to use the Display in field menu contextual menu option only.

Note: If you select a hidden field, the menu does not appear at runtime.

Enable

Select to activate the configured related content or related action.

Note: Deselecting an item allows you to deactivate the related content or related action while retaining its configuration.

Is Value Required?

Some service might accept valid null values being passed to its parameters. If you select the Refresh Service On Change and Is Value Required? check boxes for this parameter, then when the mapped field value of that parameter on the transaction page changes to a null value, the system does not refresh the related content frame.

Mapping Data

Enter the constant if the mapping type is Fixed Value.

For all other mapping types, this field is disabled and displays the name of the field or variable that you map to the service parameter.

Mapping Type

Select from four possible mapping types to map the service parameter to:

  • Fixed Value: Select to map the service parameter to a constant. Selecting this option enables the Mapping Data field.

  • Key Field: Select to map the service parameter to one of the level 0 search keys of the component assigned to the content service.

    Note: For related actions, the key name used for the related actions component is the field name that you enter here. The key value comes from the corresponding key field from the detail component key list.

  • Page Field: Select to map the service parameter to any level 0, level 1, or level 2 page field, including hidden fields. This option is available for page-level services only.

  • System Variable: Select to map the service parameter to one of the available system variables.

Package

Enter the application class package name to use for the service filter.

Path

Enter the names of each subpackage in the application class hierarchy that define the location of the application class that defines the service filter. Separate subpackage names by a colon. If the class is defined in the top-level application package, enter or select the colon.

Note: The application class parameters are validated when you save the definition; the service does not allow you to save an invalid application class.

ClassID

Enter the class name that defines the data-specific logic.

Page

Select the specific page in the component to which you are assigning related content.

This field appears in the grid when you select the Services at Page level option.

Page Name

Displays the page label. This field is display-only.

This field appears in the grid when you select the Services at Page level option.

Portal Name

This is the name of the current portal where the related content will be assigned. This field is display-only.

Read help text

Click to display the help text as defined on the Related Content Service Definition page.

See Writing Help Text for Related Content Service Definitions.

Refresh Service On Change

Select to have the service data refresh automatically when the key values on the transaction page changes. The default value is deselected.

Important: Use this option judiciously. If the service is linked to a level 1 or level 2 key field and the application user scrolls through data rapidly, performance can be affected.

Note: If the page or the page field to which a service is mapped is in deferred processing mode, a trip to the server is required to refresh related content.

Required

Specifies whether the service parameter is defined as Required in the service definition on the Related Content Service Definition page in the Service URL Parameter grid.

See Understanding Service URL Parameters.

Unrestricted Prompt

Select this option if the field is on a page that is not part of the component structure, such as a secondary page invoked through PeopleCode.

Select

Click to access the lookup page associated with the corresponding service type. The lookup pages enable you to choose the content reference, pagelet, or service that you want to assign as related content. This button is enabled only after you select the service type.

Service Parameter

Displays the list of parameters that the service requires to form the contextual relationship to the primary transaction page.

See Application Designer Developer’s Guide: Understanding Search Records.

See Understanding Service URL Parameters.

Service ID

Specifies the unique identifier of the service definition. For content references and pagelets, the service ID corresponds to the Name field on the Content Reference Administration page.

Service Label

Enter the label for this service. The content reference name (for Content Reference, Grouplet, and Pagelet service types) or the service definition name appears as the service label by default when you select the service; you can change the default value.

Service Target

Select the target location where the related action appears. Select from these options:

  • Modal Window - select to have the related content appear in a modal window that hovers in front of the transaction page.

  • New Window - select to have the related content appear in a new browser window.

  • Replace Window - select to have the related content refresh the entire browser window, including navigation.

  • Target Content - select to have the related content appear in the target area, replacing the current page.

Service Type

The service types available depend on the item being configured and the type of related content or related actions:

  • Content Reference – Select this option to assign an existing content reference as related content. Because content references can be used as anonymous services, you do not have to create an explicit service definition. However, in certain circumstances, you might require an explicit service definition. See Explicit Definition Versus Anonymous Services.

  • Grouplet – Select this option to assign an existing local content reference definition as related content. Because locally registered content references can be used as anonymous services, you do not have to create an explicit service definition.

  • Pagelet – Select this option to assign an existing locally registered pagelet as related content. Because locally registered pagelets can be used as anonymous services, you do not have to create an explicit service definition.

  • Service – Select this option to assign an existing service that you configured using the Define Related Content Service page.

Note: After you select a service type, the system enables the Select button.

Magic Button

Select this option to display a Magic Button (represented by the selected or default image) instead of the standard Related Action menu indicator for a Related Content service that has a single action. When selected, the system displays an icon next to the configured field. Selecting the icon immediately executes the associated Related Content service without displaying a Related Actions menu.

See Configuring a Magic Button on Fluid Pages.

Image Name

Specify an image name, which is displayed as an icon alongside the text on the Related Actions menu or as an icon for a single Related Action. To ensure that the icon is displayed correctly, the image size should be 16px by 16px.

PeopleTools delivers a default image for a Magic Button. However, you may specify a different image to better represent the action performed by the button.

Add to Project

Click the Add to Project link to access the Add Project page to insert this related content configuration into an ADS project. See Lifecycle Management Guide: Searching for, Adding and Deleting Projects for more information.