Understanding Population Selection
This chapter provides an overview of population selection and discusses how to:
Set up selection tools.
Define and map contexts.
See Also
Using the Population Selection Process
Understanding Population Selection
Population selection enables you to use different tools to select IDs for a process. You can use a PS query, equation engine equation, or flat file or delimited file as a selection tool, or you can create other tools, to control which fields and records to use to identify the population. When you set up the tool in your system, you identify how many result rows to return and whether you want users to be able to preview results before running the process. Using contexts, you identify the processes for which the Population Selection feature will be available. Using context mapping, you can see which fields are mandatory or optional for the process. Inside the context, you also grant selection tool security to users.
Note. The PeopleSoft system delivers functionality for using PS queries, the equation engine, and external files as selection tools. You can create other tools, but they will require significant programming effort.
Setting Up Selection Tools
To set up selection tools, use the Selection Tool component (SCCPS_TOOL_DFN).
This section discusses how to set up selection tools.
Page Used to Set Up Selection Tools
|
Page Name |
Definition Name |
Navigation |
Usage |
|
SCCPS_TOOL_DFN |
Set Up SACR, System Administration, Utilities, Population Selection, Selection Tool |
Identify and configure the selection tools (PS query, equation engine equation, and external file) to make available for population selection. |
Setting Up a Selection Tool
Access the Selection Tool page (Set Up SACR, System Administration, Utilities, Population Selection, Selection Tool).
Values on the Selection Tool page determine which selection tools will be available from the Population Selection subpage throughout PeopleSoft Campus Solutions and how they will appear and behave.
|
Selection Tool |
Displays the type of tool (Equation Engine, PS Query, or External File) that you are configuring. You can rename a selection tool. If you do, consider using a name that reflects the tool. Internal sequencing preserves the tool type for system use. For example, if you rename External File to Spreadsheet, the internal sequencing remains. Therefore, the system displays the appropriate fields and links for an external file when the user selects Spreadsheet. Warning! The Population Selection process has limitations when using the external file selection tool on the OS/390 and z/OS operating systems. Files created in a different character set than the character set for the operating system on which process scheduler runs might not be processed. For example, an ASCII delimited file created in the Microsoft Windows environment cannot be processed on an EBCDIC-based OS/390 or z/OS process scheduler. The file may be processed on a NT or Unix (non-EBCDIC) process scheduler. |
|
Status |
The default status for each tool is Active. If your institution does not want to use or make a tool available for use, change the status of the tool to Inactive. Only active tools are available for selection in the Context Definition component. |
Tool Configuration
Values in this area identify the prompt sources and file destinations for a tool and the maximum results to process at a time. They also control which labels and links to use in the Population Selection group box.
|
Application Class and Selection View |
Display the name of the application class delivered for the specific tool type and the view to use as the prompt from that application class. Application classes and views are predefined for delivered selection tools, and you cannot change them. For the equation engine tool, the Application Class is SCC_POP_SELECT:MODEL:Adapters:EqtEngAdapter and the Selection View is SCCPS_EQTN_VW. For the query tool, the Application Class is SCC_POP_SELECT:MODEL:Adapters:PSQueryAdapter and the Selection View is SCCPS_PSQRY_VW. For the external file tool, the Application Class is SCC_POP_SELECT:MODEL:Adapters:FileParserAdapter and the Selection View is SCCPS_FILE_VW. |
|
Selection Label |
Displays the text to use as the field label in the Population Selection group box for the prompt containing values for that selection tool. For the equation engine tool, the default text is Equation Name. For the query tool, the default text is Query Name. For the external file tool, the default text is File Mapping. You can change the default text. |
|
Maximum Results Rows |
Displays the maximum number of results rows to return. To control processing time, if the selection process returns more than the recommended maximum number of IDs, the process will not process the extra IDs. You can change the maximum number. For the equation engine tool, the recommended maximum is 100,000. For the query tool, the recommended maximum is 50,000. For the external file tool, the recommended maximum is 10,000. |
|
Enable Preview Results and Maximum Preview Rows |
Control whether the Preview Selection Results link appears on the Population Selection subpage. As delivered, this check box is selected, which causes the link to appear. When clicked, the system displays a preview of the results retrieved by the tool. You can change the maximum number of rows that appear in the preview. If your institution does not want to use the results preview, clear the check box. When the check box is cleared, the Maximum Preview Rows field is hidden. |
|
File Input Support and File Option |
These fields apply to external file tool only. The File Input Support check box is delivered turned on only for the external file tool, causing the File Option field to appear. You must select whether your institution wants to provide external files to the system by Attachment or by Physical Path. The default value, which is Attachment, is recommended. You can specify in the URL Identifier field, where the system should place attachments for the tool so that PeopleSoft Applications Engine and Process Scheduler can access them. If you select Physical Path,users must enter the physical file path in the Population Selection group box located on the run control page. Both the Applications Engine and Process Scheduler must be able to access this path. |
|
URL Identifier |
If you select the Attachment file option, you must enter the PeopleTools URL that identifies where PeopleTools should place attachments for this tool so that the Applications Engine and Process Scheduler can access it. The URL can point to an FTP server or a physical table. The PeopleSoft system delivers an external file tool that points to a PeopleTools URL named SCCFP_FILE_PARSER. This URL is configured to write attachments to a table named SCCFP_FILE_ATT. See PeopleTools: PeopleCode Developer's Guide, "Understanding File Attachments and PeopleCode" |
|
Max File Size (Kbytes) (maximum file size [kilobytes]) |
Displays, in kilobytes, the maximum file size that you permit users to upload. Applies to the external file selection tool only. |
Tool Launch Parameters
Values in this area control where users are to be redirected from links in the Population Selection group box.
|
Tool URL Edit Label and Tool URL Add Label |
Enter text to use as a link to redirect users to where they can edit an existing query, equation, or file mapping (Tool URL Edit Label) and add a new query, equation, or file mapping (Tool URL Add Label). |
|
Menu Name, Menu Bar Name, Item Name, and Page Name |
For each of the delivered selection tools (equation engine, query, and external file), these parameters are predefined and cannot be modified. The system displays their values for your information and reference only. If you were creating a new tool, these fields would be available for you to complete. |
Defining and Mapping Contexts
To define and map contexts, use the Application Specific Context (SCCPS_VARY_MAP), Context Definition (SCCPS_CNTXT_DFN), and Equation to Context Mapping (SCCPS_EQTCTXT_MAP) components.
This section discusses how to:
Define an application-specific context.
Define a context.
Map a context definition to the Population Selection process.
Map an equation to a context.
Pages Used to Define and Map Contexts
|
Page Name |
Definition Name |
Navigation |
Usage |
|
SCCPS_VARY_MAP |
Set Up SACR, System Administration, Utilities, Population Selection, Application Specific Context |
Identify the application keys to use to map a context to a specific process. |
|
|
SCCPS_CNTXT_DFN |
Set Up SACR, System Administration, Utilities, Population Selection, Context Definition |
For a specific process, define which menu navigation should allow the Population Selection process to be used. Select the Selection Tools to make available for the process and grant users security to them. |
|
|
SCCPS_CNTXT_MAP |
Set Up SACR, System Administration, Utilities, Population Selection, Context Definition, Selection Mapping |
Map the fields required for a process with the process results fields (not all results fields are required). |
|
|
SCCPS_EQTCTXT_MAP |
Set Up SACR, System Administration, Utilities, Population Selection, Equation to Context Mapping |
Map an equation to a Population Selection context. |
Defining an Application-Specific Context
Access the Application Specific Context page (Set Up SACR, System Administration, Utilities, Population Selection, Application Specific Context).
An application-specific context is required when different field values require different fields and records to run a process. For example, the 3C Engine process requires different fields and records to extract the proper variable data based on the administrative function selected. The ADMA administrative function requires a set of fields different from those required by the AVIN administrative function.
You can define the key field and prompt record to use for a specific application before mapping the application to the Population Selection process.
The PeopleSoft system delivers three predefined application-specific contexts: Administrative Function, Membership Type, and Population Update. These application specific contexts map key values to the appropriate prompt record for the business process. You cannot change the predefined application-specific contexts, but you can create new ones.
|
Application Data |
Identify the specific application data name. |
Application Prompt Setup
|
Field Label |
Enter the field to use as the key field for selecting IDs for that application. |
|
Prompt Record |
Enter the record to use to prompt for values for the key field. |
Defining a Context
Access the Context Definition page (Set Up SACR, System Administration, Utilities, Population Selection, Context Definition).
Use contexts to associate population selection with a specific process and to make the Population Selection group box available on the run control page for that process.
|
Context Name |
Enter a name for the context that you are defining. |
|
Process Type |
Enter the type of process to associate with this context. |
|
Process Name |
Enter the name of the process. Only the processes of the specified process type are available. |
Applicable Menu Navigation
|
Menu Name and Component Name |
Identify the menus and components where the run control page for the process is located. Note. The PeopleSoft system delivers some processes, such as the Mass Assign Service Indicator process, set to use only the Population Selection feature to select the IDs to process. If the process you select is one of those, all the menu and component names where the process is used are listed. For other processes, such as the 3C Engine process, where the Population Selection feature is not required and you have more than one choice of methods for selecting the IDs to process, list only the menus and components where you want to make the Population Selection feature available as choice for users. |
Applicable Selection Tools
|
Selection Tool |
Enter the selection tools to allow for this process. The selection tools that you specify will be the only selection tools available in the Selection Tool prompt in the Population Selection group box for this process. The order in which you enter the tools in the context is the order in which they will appear in the drop-down list box. If you want to encourage the use of one tool over another, consider entering them in the order of preference. |
|
Full Access and Exception |
The choices that you make here, control the selection tools in the Population Selection group box that are accessible to users. Select the Full Accesscheck box to give all users access to the tool. For example, if you select the PS Query tool and the Full Accesscheck box, all users are able to use the PS Query selection tool from the Population Selection group box for this process. If the number of users to whom you want to give full access to the tool is greater than the number of users to whom you do not want to grant full access, select the Full Access check box and then click the Exception link to specify those users who should not have full access. If the number of users to whom you want to give limited access to the tool is greater than the number of users to whom you want to give full access, clear the Full Access check box and then click the Exception link to specify those users who should have full access. Note. If you do not want to provide anyone with access to this tool, delete the row. |
Mapping a Context Definition to the Population Selection Process
Access the Selection Mapping page (Set Up SACR, System Administration, Utilities, Population Selection, Selection Mapping).
A context must be mapped to control how the results records are populated. Delivered contexts are pre-mapped; therefore, case values on the Selection Mapping page are display only. If your institution creates a new context definition, the fields for mapping that context are available for entry.
Pop Selection Integration
|
Context varies per Application Data |
When selected, the Application Data field appears and values defined on the Application Specific Context page are available in the prompt list. |
|
Application Data |
Select the application data to use. Delivered values are: (Blank) Administrative Function Membership Type Population Update |
Process Required Fields
In this section, the system displays the values for which required fields and records vary for the context. For example, the 3C Engine uses Administrative Function application data. The Population Selection context for the 3C Engine process needs subcontexts for each of the administrative function values. Each value requires different fields and records based on the variable data fields. The system displays the results records and required fields record for the administrative function.
|
Administrative Function, Membership Type, or Population Update |
If the Context varies per Application Data check box is selected, a field appears in this section based on the associated Application Data value. For example, when the Application Data field is set to Administrative Function, the Administration Function field appears. If the Application Data field is set to Membership Type, for PeopleSoft Contributor Relations, then the Membership Type field appears. If the Application Data field is set to Population Update, the Population Update field appears. |
|
Results Record |
Displays the results record that contains all of the fields that are required for the process to run. When integrating the Population Selection feature into a process, the system uses the results record to map values extracted by the Population Selection process to the required fields. |
|
Required Fields Record |
Displays the name of the bind record that contains the fields that are required for the application process to select IDs. The Population Selection process must extract data for these required fields. Therefore, any Equation Engine equation, PS Query, or external file created to select the IDs for the process must include the record listed here. Note. Each delivered application process into which the Population Selection process has been integrated, includes a corresponding sample PS_Query prefixed with QA_CS_xx where xx is the product code. |
Data Source Records
The Population Selection process selects IDs based on the required fields in the bind record and places the values in the results record for the application process. The Population Selection process selects from the resulting IDs, which are the IDs that qualify based on the required and optional fields specified within the selection tool. These required and optional fields are the fields in the data source bind record that you specify.
When using PS Query, you must specify a data source record within the query for the query to be valid for the Population Selection process. When the user selects the selection tool of PS Query from the standard Population Selection group box, only the queries created with the associated data source record are available.
The data source record is the same as the required field record except where more than one data source record is required. or when the required fields record includes fields that are not relevant for selection by PS Query.
Two data sources are required when data must be pulled from two tables with the same data type but where the tables cannot be joined because they do not have the same rows. When you run a process set to select both people and organization IDs, you will likely need two data source records because the people data is in one table and the organization data is in another.
The required fields record might contain a comments field, however, a comments field is usually not relevant for selection by PS Query. In that case the corresponding data source record should not include the comments field and would therefore be different from the required fields record. If you use the external file selection tool, the comments field is selected as an optional field.
You can create an Equation Engine equation using the data source record, but it is not mandatory.
|
Record (Table) Name |
Enter the records that contain the fields for the Population Selection process to use to select only the desired IDs. |
|
Validate Edit Prompt Values |
Select this check box to validate prompt values in a query or equation against the same values on the process run control page. This selection will prevent the Population Selection process from selecting IDs with values that are different from values on the run control page. For example, if the run control page includes the Institution field, and the query or equation includes a prompt for the Institution field, the Population Selection process will select only those IDs whose values are the same. If the prompt value is blank, the system provides the value from the run control page. |
Required Fields Mapping
|
Results Records Fields |
The system lists each field on the specified results record. It displays how each field from the Required Fields Record selected is set to be mapped . |
Mapping an Equation to a Context
Access the Equation To Context Mapping page (Set Up SACR, System Administration, Utilities, Population Selection, Equation to Context Mapping).
This page is applicable only when the selection tool is Equation Engine.
Equations are segmented by an attribute called an Application Prompt. Enter the application prompts that separate the equations for a context. Only the application prompts associated with the context are available.
When you select the selection tool of Equation Engine on a run control page, only the equations with the application prompt that you select here, are available. For example, if you enter the Application Prompt ID of SI Mass Assignment (Person), then only the equations with that application prompt are available on the SI Mass Assignment run control page.
See Working with Equation Engine.