Understanding External Search/MatchThis chapter provides an overview of external search/match and discusses how to:
Select criteria for an integrated search.
View integrated search results.
Conduct an automatic search.
Understand external search/match web services.
Note. If you are implementing separate instances of your PeopleSoft Campus Solutions and PeopleSoft HCM systems, you should read the additional documentation describing how to configure and use External Search/Match directly between the two systems. The CS-HCM Integration Information Knowledge Document details the additional documents that describe the setup, functional, and technical implementation considerations.
See Also
Setting Up External Search/Match Functionality
Integrating Campus Solutions with Human Capital Management
CS-HCM Integration Information, posted to My Oracle Support https://support.oracle.com
Understanding External Search/MatchAs is the case for Internal Search/Match, there are two options to perform searches in an external system:
Online search: Manually navigate to the Search/Match Integrated component and enter search options.
Note. When your institution configures External Search/Match functionality and integrates with an external system, Oracle recommends that you revoke your users' security access to the Search/Match component and replace it with the Search/Match Integrated component so that users will use the same tool for searching existing IDs.
Automatic search: From a Campus Solutions component where an ID can be created, the External Search/Match triggers behind the scenes after user clicks Save.
Selecting Criteria for an Integrated Search
This section discusses how to perform an integrated search.
Page Used to Select Criteria for an Integrated Search
|
Page Name |
Definition Name |
Navigation |
Usage |
|
HCR_SM_SEARCH |
|
Enter criteria to search for duplicate person or multiple person records contained inside an external system. When the page is accessed through the SCC_SM_SEARCH component, then the system performs the External Search/Match evaluation. |
Entering Search Criteria
Access the Search Criteria page (Campus Community, Personal Information, Search/Match Integrated).
The fields on this page are the same as those on the Search/Match page. However, the SCC_SM_SEARCH component includes logic that evaluates the external system data settings when you click the Search or Selective Search button. Note that this is only true when the Search Type is Person. For a Search Type of Applicant or Organization, the system triggers Search/Match.
Viewing Integrated Search Results
This section discusses how to:
View search results.
View biographic details.
View regional details.
Pages Used to View Integrated Search Results
|
Page Name |
Definition Name |
Navigation |
Usage |
|
SCC_SM_RESULTS |
Enter criteria on the Search Criteria page and click Search or click one of the search by order number Selective Search buttons to launch a manual search. |
View Search/Match results of an external system search and investigate potential duplicate IDs. |
|
|
SCC_SM_RESP_DTL |
Click the Detail link on the Search Results page for a matching candidate that does not have an EmplID. |
View personal data stored inside the external system. |
|
|
SCC_BIO_DEMO_REG |
Click the Detail link on the Integrated Search Results page, then Regional tab. |
View regional data stored inside the external system. |
Viewing Search Results
Access the Integrated Search Results page (Click the Search button or one of the available Selective Search buttons on the Search Criteria page). If the External Search/Match is triggered and the system has found matching candidates on a search rule number lower or equal to the Search/Match, the Integrated Search Results page appears.
Many fields on this page are the same as those on the Search Results page. However, there are some important distinctions:
Records with no EmplIDs appear first in the Search Results group box.
Records with no EmplIDs are assigned an External Sys ID.
Records with no EmplIDs, that are importing EmplIDs from an external system, are assigned an External Sys ID and display the External Employee ID.
Where an EmplID exists, the Detail link leads to a page where you can view details of the ID record from the CS system.
Where no EmplID exists, the Detail link leads to a page where you can view details of the data from the external system.
The Import button appears when a person meets the criteria in the external system.
The Score % and Universal ID columns appear based on settings defined on the External System Search Match Options page.
Masking configuration is in effect for all matching constituents, even those with no EmplID.
For matching constituent records found by External Search/Match, this page displays information that is not necessarily stored inside the external system (for example, Aid Year).
|
Number of ID's Found |
The system displays the total number of distinct IDs returned by both Search/Match and External Search/Match, just Search/Match, or just External Search/Match. |
|
Search Order Number |
The system shows the Search Order Number where results were found. When the internal and external searches find results under different search rules, the Results Engine evaluates the Search Order Number returned by both searches and displays the results for the search that found results under the smallest search order number (the most restrictive search). When the internal and external searches find results under the same search rule, the Results Engine displays them both. |
Search Results
The fields in this group box are similar to those on the Search Results page. The system displays the results returned from both the CS database and the external system, along with additional data to describe the IDs retuned. However, the columns are dynamic and they can refer to personal data info or transaction data info. Define static columns to appear here on the External System Search Match Options page.
|
Score % |
The system displays a percentage or a number to weight the matching candidate. If the external system calculates a score and sends it with the matching candidates, the score value is returned from the external system with each ID, to indicate the relevance of the ID found. (You can customize the column label on the External System Search Match Options page.) |
|
Carry ID and Import |
The Carry ID button appears when an EmplID exists; otherwise the system displays the Import button. Security access to the Add/Update Person component controls whether users can use the Import button. Click the Import button to import external system data when the person does not exist in the CS system (there is no CS EmplID associated with the person). When you click the button, the system displays a message asking if you want to create the new ID in the system. If you click Yes, the system performs a Fetch Request to request the complete constituent record from the external system. When the system receives the Fetch Response from the external system, it uses the personal data in it to create a new EmplID. After successfully importing the data, the Search Results group box refreshes and the newly created EmplID appears; the Import button for the person row changes to Carry ID. Notice that no other import can be performed (all the Import buttons are then grayed out). This is to prevent the user from importing multiple matching candidates. If you click No, the system does not import any data and returns to the Integrated Search Results page. If the system is configured on the External Core Data Integration page where the external system selected is the Higher Ed Constituent Hub, and the option to Import External Emplid is selected, if the person in the Higher Ed Constituent Hub contains am EmplID from the spoke system, the value of the EmplID will be imported and used to create the person in the CS system. After successfully importing the data, the Search Results group box refreshes and the Imported EmplID appears; the Import button for the person row changes to Carry ID. Notice that no other import can be performed (all the Import buttons are then grayed out). This is to prevent the user from importing multiple matching candidates. |
|
Detail |
If no EmplID exists for the person, click this link to invoke a Fetch Request to retrieve the complete constituent record from the external system. When the system receives the Fetch Response from the external system, it displays the personal data in the response on the Biographical Details page. Note. Both the Import button and the Detail link (when no EmplID exists) trigger the same Fetch Request. The data received inside the Fetch Response will only be saved to your database when the Fetch request is triggered from the Import button. It is therefore good practice to always review the detailed information prior to import. If an EmplID exists, click this link to access the page set up inside the Search Results Code used to view more information about the person. If a user has access to the page set up inside the Search Results Code used, he also has access to the Integrated Details page. Else, user cannot preview the information. |
Additional Information
The Universal ID column appears here, when selected as a static field on the External System Search Match Options page.
Viewing Biographical Details
Access the Biographic Details page (click the Detail link on the Integrated Search Results page).
This page displays sections of data that are not actually stored in the CS database until you click the Import button.
The system displays messages on this page based on the following conditions:
Note. Where no data exists, the system hides the fields and displays a message in the Missing Information group box.
|
Data Region |
Condition |
Message |
|
Current Names |
No name information exists |
No Current Name Information |
|
Personal Information |
No personal information exists |
No Personal Information |
|
Biographical Information |
No biographical information exists |
No Biographical Information |
|
National ID |
No national ID information exists |
No National ID Information |
|
Email Addresses |
No email address information exists |
No Email Addresses Information |
|
Phone Numbers |
No phone information exists |
No Phone Number Information |
|
Current Addresses |
No address information exists |
No Address Information |
|
Regional |
No regional data exists |
No Regional Information |
|
Import |
Click this button to import the Universal ID and all the information displayed into the CS system and create an EmplID. |
Current Names
|
History |
This link appears only if the Universal ID contains a past or future date in addition to the current row. Click the link to access the Name Type History page. |
Current Addresses
|
History |
This link appears only if the Universal ID contains a past or future date in addition to the current row. Click the link to access Address Type History page. |
View Regional Details
Access the Regional page (click the Detail link on the Integrated Search Results page, then Regional tab).
This page is available only if it contains data. If the Fetch Response contains no Regional information, this message appears on the Missing Information group box on the Biographical Details page.
|
Data Region |
Condition |
Message |
|
Regional |
No regional data exists |
No Regional Information |
Conducting an Automatic Search
The same XML messaging that is triggered when you use External Search/Match is integrated with other pages within Campus Solutions. On any page where you can add a new person, you trigger an automatic search to the external system when you click the Save button, if an external system is configured.
Understanding External Search/Match Web Services
This section discusses the delivered constituent web services that are triggered and used by External Search/Match functionality. Specifically, this section discusses these web services:
Match service (SCC_SM_SERVICE).
Fetch request and fetch response (SCC_SM_FETCH).
The PeopleSoft Campus Solutions Constituent Web Services Developer's Guide contains more technical details of these web services including examples of the XML message code.
See Also
PeopleSoft Campus Solutions Constituent Web Services Developer's Guide on My Oracle Support https://support.oracle.com
Match Service
When you click the Search or Selective Search buttons on the Integrated Search Criteria page, the system conducts an Internal Search/Match, External Search/Match, or both. External Search/Match sends a Match Request to the external system. This is an XML message that contains all of the fields included in the search request. The external system returns a Match Response, also an XML message.
The Match Request XML message (SCC_SM_SERVICE_REQ.V1) to the external system exposes all information that the system has:
All of the search order numbers that can potentially return matching candidates.
Search fields.
Search data.
Search/Match configuration information.
The Match Response XML message (SCC_SM_SERVICE_RESP.V1) from the external system contains:
Search order number/rule that found results.
Matching candidates.
Score.
Universal ID/cross reference.
Person data.
External Employee ID when importing EmplIDs from external spoke system.
Fetch Request and Fetch Response
When you click the Detail or Import buttons on the Integrated Search Results page for a constituent without a CS EmplID, the system sends a Fetch Request to the external system. This is an XML message that requests the full constituent record from an external system. The external system returns a Fetch Response, also an XML message.
The Fetch Request XML message (SCC_SM_FETCH_REQ.V1) to the external system contains the universal ID for which the Import or Detail buttons were selected.
The Fetch Response XML message (SCC_SM_FETCH_RESP.V1) from the external system contains the full constituent record.
When you import a new person record fetched from an external system:
The CS system creates an EmplID.
If the system is configured to import the EmplID from the HECH system, the CS system will use this EmplID when the person is created within CS.
The CS system populates the SCC_HUB_MAP table with the EmplID and its Universal ID.
The CS system publishes the PERSON_BASIC_SYNC message.
The CS system publishes an outbound constituent message (which includes the Universal ID).
Using the Universal ID, the external system updates the constituent's reference table with a new EmplID.
See Also
Using Constituent Web Services
PeopleSoft Campus Solutions Constituent Web Services Developer's Guide on My Oracle Support https://support.oracle.com