Establishing Supplemental Data

To establish supplemental data, use the following components:

  • Register Record (FS_SD_REG_REC) component.

  • Register Component (FS_SD_REG_COMP) component.

  • Define Record (FS_SD_RECDEFN) component.

  • Define Display Group (FS_SD_GRPDEFN) component.

  • Assign Display Group (FS_SD_PAGE_GRP) component.

This section discusses how to define a supplemental data record, define and map supplemental data record fields to data store records, specify details for supplemental data record files, define a supplemental data display group, assign a supplemental data display group, and define conditions for display groups.

Page Name

Definition Name

Usage

Register Record Page

SD_REG_REC

Registers the supplemental data base record and optionally registers the record that saves the search criteria for the base record.

This is PeopleSoft system-defined data and is not set up by users. It should not be modified.

Register Component Page

SD_REG_COMP

Registers and enables the component and the pages for supplemental data.

This is PeopleSoft system-defined data and is not set up by users. It should not be modified.

Supplemental Data Record - Record Page

SD_RECDEFN

Defines the supplemental data record associated with the base record and identifies where to store this record.

Supplemental Data Record - Fields Summary Page

SD_RECFLD

Maps fields to the data storage fields.

Supplemental Data Record - Fields Detail Page

SD_RECFLD_DTL

Defines a field's detail information.

Define Display Group Page

SD_GRPDEFN

Defines a display group and associates any records and fields, as well as identifies the order in which the fields appear on the page.

Assign Display Group Page

SD_PAGE_GRP

Assigns one or more display groups to a supplemental data-enabled component and page.

Assign Display Group - Conditions Page

SD_PHRASE_SEC

SD_TERM_SEC

Specify conditions that control when a display group appears.

Use the Supplemental Data Record - Record page (SD_RECDEFN) to defines the supplemental data record associated with the base record and identifies where to store this record.

Navigation:

Enterprise Components > Supplemental Data > Supplemental Data Record > Record

This example illustrates the fields and controls on the Supplemental Data Record - Record page. You can find definitions for the fields and controls later on this page.

 Define Record - Record page

Field or Control

Description

Record

Enter a name for a supplemental data record. For example a possible supplemental data record name used for PeopleSoft Maintenance Management may be PS_WASTE.

Base Record

Select a base record on the Define Record page to associate with this supplemental data record. For example, a PeopleSoft Maintenance Management base record is WM_WO_TSK.

Status

Select a status of In Design during the time that you are defining this record. Change the status to Activated to indicate that you completed mapping the supplemental data fields.

Note: If you update a record, before you add a field or make changes to a record, you must change this status back to In Design. When you have completed the modification, you must change the status back to Activated before saving and exiting the component.

Data Store Record

Select one of the data store records that you previously registered that you want to use to store this supplemental data record. For example, the data store record for this supplemental data record in PeopleSoft Maintenance Management is WM_WO_TSK_SD.

Recycle Cache

Clears the cache for the Supplemental Data.

Use the Supplemental Data Record - Fields Summary page (SD_RECFLD) to maps fields to the data storage fields.

Navigation:

Enterprise Components > Supplemental Data > Supplemental Data Record > and select the Fields Summary tab.

This example illustrates the fields and controls on the Supplemental Data Record - Fields Summary page. You can find definitions for the fields and controls later on this page.

 Define Record - Fields Summary page

Field or Control

Description

Field Name, Use Type, Length, Mapped to and Field Status

Click the Field Name link to access the Fields Detail page. The remaining fields on this page are all defined in the Fields Detail page. Once you finish adding all the fields and their descriptions on the Field Details page, and change the Status value in the Record page to Activated, each new field name and its characteristics appear on this summary page. You may then click on each field name and access the field name's detail information in the Define Record - Fields Detail page.

Use the Supplemental Data Record - Fields Detail page (SD_RECFLD_DTL) to defines a field's detail information.

Navigation:

  • Enterprise Components > Supplemental Data > Supplemental Data Record > Fields Detail

  • Click a field name on the Define Record - Fields Summary page.

This example illustrates the fields and controls on the Supplemental Data Record - Fields Detail page. You can find definitions for the fields and controls later on this page.

 Define Record - Fields Detail page

Field or Control

Description

Field Name

Enter a name for the supplemental data field and a description of the field. For example, in PeopleSoft Maintenance Management this field might be called WASTE_CD.

Field Label

Enter the a label to display on the page for this field. For example, in PeopleSoft Maintenance Management this field might be Waste Code.

Use Type

Select one of the following based on how the field will be used:

  • Code

  • Date

  • Number

  • Prompt

  • Section

  • Signed

  • Text

  • Time

  • Yes/No

Field Length

Select a length based on the selected Use Type:

  • If the use type is a number or signed number consisting of an integer or decimal position, the field lengths may only be: 9.0, 7.2, and 15.4.

  • If the use type is text, the field length may be 4, 20, 50, or 100.

  • If you select any of the remaining use types, each type's field length is dictated by the specific length of the selected use type.

Mapped To

Select the data store field to which you want to map this field.

Note: Once you change the status to Activated on the Record page, the information listed above, with the exception of the description and field label, becomes read-only and cannot be modified.

Codes

This group box displays if you selected code as a Use Type and identifies a list of code values for a drop-down list.

Field or Control

Description

Sequence

Enter a number to represent the order in which you want to see these codes listed in a drop-down list or lookup page.

Field Value and Translate Long Name

Enter each valid code in this list along with the text that you want to appear on the list when the drop-down list displays.

Field Status

Displays the current status of the field. Initially this value will be In Design. The value changes to Activated after you change the record status to Activated on the Define Record - Record page.

Reorder

Click this button to assign each code a unique sequential number and reorganize the sequence numbers in top-down numerical order.

Use the Define Display Group page (SD_GRPDEFN) to defines a display group and associates any records and fields, as well as identifies the order in which the fields appear on the page.

Navigation:

Enterprise Components, Supplemental Data, Define Display Group

This example illustrates the fields and controls on the Define Display Group page. You can find definitions for the fields and controls later on this page

 Define Display Group page

Field or Control

Description

Display Group

Select a base record to associate this new display group with and enter a name for this display group in the Define Display Group Add page.

Label

Enter a label for the display group data group box.

Occurs

Enter the number of rows of data to display in the group box.

Left and Right Columns

The supplemental fields that you want to appear on a page are defined in left and right columns.

Field or Control

Description

Sequence, Record, Field Name, and Label

Select the record and field name, enter a label that you want to display on the page for the field name for each supplemental data field. Enter a sequence number to determine the order in which the fields should display on the page for each column.

Reorder

Reorders the group as per the sequence entered by the user in the Sequence column.

Recycle Cache

Clears the cache for the Supplemental Data.

Use the Assign Display Group page (SD_PAGE_GRP) to assigns one or more display groups to a supplemental data-enabled component and page.

Navigation:

Enterprise Components, Supplemental Data, Assign Display Group

Use the Assign Display Group page (SD_PAGE_GRP) to assigns one or more display groups to a supplemental data-enabled component and page

 Assign Display Group page

Field or Control

Description

Component Name and Market

Select the component that is enabled for supplemental data and with which you want to associate a supplemental data display group in the Assign Display Group Search page. The Market for which this component was defined displays as read-only along with the Component Name.

Enabled Pages and Display Groups

This group box displays the name of the pages within the component that are enabled for supplemental data, their associated base record, and any associated display groups. You may also add the display groups that you want to appear in this component and page.

Field or Control

Description

Sequence, Display Group, Use

Add a supplemental data display group that you want to associate with this component and this page, and select whether you want the text associated with the display group to be Editable or Read-only.

User Friendly Text

Describes the condition associated with this display group in easy to understand terminology.

Edit

Click the Edit icon to access the Assign Display Group - Conditions page where you can establish conditions that control when a display group appears. For example, you could set a condition so that a display group appears only when there is a hazardous asset associated with a work order task, or when the work order is of the type CM (corrective maintenance).

Clear

Click the Clear icon to remove the condition that is associated with this display group.

Reorder

Reorders the group as per the sequence entered by the user in the Sequence column.

Recycle Cache

Clears the cache for the Supplemental Data.

Note: If the supplemental data page is registered as a search page, then you may add only one display group to the page; you must select 1 as the value in the Occurs field for the selected display group; you must define all fields for this display group for the same record definition; and you must map this record to a data store record defined with a Search Supplemental Search record. With PeopleSoft Maintenance Management, you can only search based on supplemental data for the Work Order Header.

Use the Assign Display Group - Conditions page (SD_PHRASE_SEC) to specify conditions that control when a display group appears.

Navigation:

Click the Edit icon on the Assign Display Group page.

Use the Assign Display Group - Conditions page (SD_PHRASE_SEC) to specify conditions that control when a display group appears

 Assign Display Group - Condition page

Supplemental data depends on the Active Analytics Framework (AAF) to define and resolve the conditions for a supplemental data display group. AAF is a PeopleSoft Enterprise Component that includes the following components:

  • Data Library Framework.

  • Rule Evaluation Engine.

  • Rule Builder Framework.

  • Action Framework.

PeopleSoft Maintenance Management utilizes all of these AAF components with the exception of the Action Framework.

You define a condition using a combination of a term, an operator, and a value or term. A term is a nontechnical name that refers to the information (data) that can be retrieved or computed and is the object evaluated within a condition. This page enables you to build conditions by viewing and selecting the terms, operators, and value/term that define the condition.

To add a condition:

  1. Select a term.

  2. Select an operator.

  3. Enter or select values or terms to define the right side of the condition equation, if required by the selected operator.

Note: To add conditions for values derived from control tables that are keyed by SetID (for example, Work Type, Service Group ID), you must use one of the "in list" operators (is in list, or is not in list).

There are two modes that you can use to specify conditions:

  • Basic.

    This is the default mode. When you select this option, the Select Subject Area group box appears, with a folder hierarchy of subjects. Navigate through the subjects and select one to view the terms available in an adjacent group box. Click a term to select it and insert it into the condition.

    If the criteria you define includes more than one condition row, the system uses AND logic for the conditions, therefore all of the conditions must be met for the criteria to evaluate as true.

  • Advanced.

    This mode enables you to group condition rows using parenthesis, specify the logical operator for each condition row (AND, OR), and specify terms as values in the right-hand side of the condition equation.

Field or Control

Description

Switch to Advanced Mode

Click to activate advanced mode.

Switch to Basic Mode

Click to activate basic mode.

Switch to Search Mode

Click to activate search mode, where you can execute a search for defined terms.

Switch to Browse Mode

Click to activate browse mode, where you can browse defined terms.

Select Term

Click to insert the term into the condition.

Term

Displays the term name used in the condition that is evaluated against the Value.

Operator

Select the operator to use for the condition. The list of available operators depends on the term upon which the condition is based.

Value

Displays the value to which the Term is compared.

Done

Click to create the condition and return to the Assign Display Group page.

Cancel

Click to cancel building the condition.