Guidelines and Limitations for Using Fluid Components in Activity Guides

Note:

See the “Terminology” section for definitions of terms including optimized, non-optimized, activity guide-optimized fluid components, and others.

Guidelines for All Activity Guide Types

All fluid components must adhere to the following guidelines to be used in an activity guide template of any type (optimized or non-optimized):

  • The fluid component must be defined as a Standard fluid component.

    Important:

    A fluid wrapper component (that is, another fluid activity guide, a master/detail component, or fluid navigation collection) can never be included as target content inside a fluid activity guide.

  • Typically, for each page defined within the fluid component, the outermost group box must include the ps_apps_content style or another styling appropriate to the page design.

  • The fluid component must have the search page type set to None to be included in a fluid activity guide. Otherwise, if the search page type is set to Standard or Master/Detail, the fluid component cannot be included in a fluid activity guide.

  • Unless AJAX transfers are enabled on the activity guide, the fluid component should not perform a transfer to another component. This includes transfers via a hyperlink, a push button, a PeopleCode program, or transfers from the left panel. Such transfers will result in the user exiting that activity guide instance in an invalid manner. See Fluid User Interface Developer’s Guide: AJAX Transfers for more information.

  • The activity guide instance maintains the fluid banner and the visibility of items in the banner.

    • Direct manipulation of the fluid banner via PeopleCode (to set the page title, for example) will result in a PeopleCode error. Therefore, use the PT_PAGE_UTILS:Banner application class to indirectly attempt to manipulate the fluid banner. When used, the methods and properties of PT_PAGE_UTILS:Banner are ignored and have no effect if the component is rendered in a context that does not allow access to the fluid banner and Actions menu such as in an activity guide instance. See PeopleCode API Reference: Banner Class Methods for more information.

    • In addition, pages in the fluid component cannot include an “application header”—that is, the use of any of the Custom Header group box types (Left, Right, Middle, or Bottom) is not allowed.

    • Nevertheless, custom Actions menu items can be defined using the Custom Action Menu group box type.

  • If the fluid component includes a page definition for a Header page type, this page definition will be ignored and not displayed within an activity guide instance.

Additional Guidelines for Optimized Activity Guide Types

The following additional guidelines and limitations apply to “activity guide-optimized fluid components”:

  • If the target content is a fluid component that employs an internal two-panel construct (that is, it either includes a Side Page 1 page, was built from the PeopleTools 8.54 PSL_TWOPANEL layout page, or was designed with an internal left panel similar to PSL_TWOPANEL), you must enable left panel collision handling with the slide-out left panel on the activity guide. See Fluid User Interface Developer’s Guide: Left Panel Collision Handling with Slide-out Left Panels for more information.

  • For each page defined within the component, include a group box of type Page Title that is defined to be visible when the page is rendered within an activity guide context. Depending on the implementation, the activity guide itself might control the title displayed by this group box. To hide this page title if the page is rendered outside of an activity guide instance, use the psc_hideinmode-notag style.

  • To maintain a clear and consistent user experience, Oracle recommends that the fluid component not include a page definition for a Footer Page type.

  • To use a multi-page fluid component in an optimized activity guide, you can do one of the following to maintain a clear and consistent user experience:

    • Re-parent the page tabs to a group box of type Page Tab that is included on each page definition.

    • Include PT_SIDE_PAGETABS in the component definition to re-parent the page tabs to the left panel. You must also enable left panel collision handling with the slide-out left panel on the activity guide. See Fluid User Interface Developer’s Guide: Left Panel Collision Handling with Slide-out Left Panels for more information.

    • Hide the page tabs. You can do so in the component definition by deselecting the Display Folder Tabs (top) on the Internet tab. Alternatively, you can use delivered styles to hide the page tabs.

Related Topics