Understanding PeopleSoft Search Framework in PeopleSoft Receivables

PeopleSoft Receivables allow keyword search when viewing items and payments. This section provides information related to PeopleSoft Receivables for:

  • Components.

  • Search definitions, search categories, and search keys.

  • Faceted fields.

  • Related actions.

  • Queries.

These components use the PeopleSoft Search Framework:

  • Item Maintenance (ITEM_MAINTAIN) (link to AR > Changing and Reviewing Item Information)

  • Regular Deposit Entry (PAYMENT_ENTRY) (link to AR > Entering Regular Deposits)

  • Payment Status (PYMT_QUERY_ALL) (link to AR > Looking up Information about Payments)

Search Definitions, Search Categories, and Search Keys are all part of the PeopleSoft Search Framework.

Search Definitions

Search definitions define the main structure of a search index. A search definition contains everything needed to create a search index, which includes facets, security, attachments, pre- and post-processing, and component mapping.

PeopleSoft Receivables has these search definitions:

  • EP_AR_ITEMS

  • EP_AR_PAYMENTS

  • EP_AR_PMT_ENTRY

Search Categories

Search categories contain one or more search definitions. Search categories are secured by role within PeopleTools security and reduce the number of indexes searched, which can improve search performance.

PeopleTools uses Permission List Security when performing component searches, which is based on the search definition for the component. If you don’t have access (through your permission list) to that component, then the system doesn’t display results when searching against the indexes built for the search definition.

PeopleSoft Receivables has these search categories:

  • EP_AR_ITEMS

  • EP_AR_PAYMENTS

  • EP_AR_PMT_ENTRY

Search Keys

Search keys are used to identify specific records in the table identified in the primary search query.

The primary search queries and search keys for PeopleSoft Receivables are:

Query

Query Name

Search Key(s)

Items

AR_SRCH_ITEM

BUSINESS_UNIT, CUST_ID, ITEM, ITEM_LINE

Payment Inquiry

AR_SRCH_PAYMENT

DEPOSIT_BU, DEPOSIT_ID, PAYMENT_SEQ_NUM

Payment Entry

AR_SRCH_PMT_ENTRY

DEPOSIT_BU, DEPOSIT_ID

These search keys affect the number of search results that appear when performing a traditional PeopleTools (real-time) search versus performing search. However, regardless of the number of results that appear for each type of search, when selecting a link in the Search Results section, the system takes you to the same page.

A facet is a field that is relevant to the search and that allows you to browse or refine search results.

These fields are predefined as faceted fields for Receivables:

  • Business Unit/Deposit Unit,

  • Customer Name,

  • Item Status,

  • Credit Analyst,

  • AR Specialist,

  • Collector,

  • Salesperson,

  • Accounting Date,

  • Entry Type,

  • Payment Method,

  • Operator Id,

  • Payment Status,

  • Bank Code/Bank Account Number

  • Payment Worksheet Type

For additional information about faceted fields, see Search Result Facets in Viewing PeopleSoft Search Results.

Queries are used with the Search Framework to extract data from the database for component and global searches. Queries must be assigned to an access group and a related security tree.

Query Tree Definition

The security information for the Receivables tree definition is:

Query Tree Name

Access Group

Permission List

SEARCH_TREE_AR

AR_ACCESS_GROUP

EPAR9500

Types of Queries

These types of queries are used for the PeopleSoft Search Framework:

  • Primary Query

  • Connected Query

  • Related Query

  • Delete Query

For additional information about queries as they relate to the PeopleSoft Search Framework, see PeopleTools: PeopleSoft Search Technology.

Predefined queries for PeopleSoft Receivables are:

Query Name

Description

Additional Information

AR_SRCH_ITEM

Item Search Main Query

This is a primary query and uses SEARCH_TREE_AR as its security tree.

AR_SRCH_ITEM_ACTIVITY

Item Activity search

This is a related query.

AR_SRCH_ITEM_DST

Item Distribution Search

This is a related query.

AR_SRCH_ITEM_ATTACH

Item Attachments Search

This is a related query.

AR_SRCH_ITEM_DELETE

Remove archived Item Details from Index

This is a delete query.

AR_SRCH_PAYMENT

AR Payment Search Main Query

This is a primary query and uses SEARCH_TREE_AR as its security tree.

AR_SRCH_PMT_ENTRY

AR Payment Entry Search

This is a primary query and uses SEARCH_TREE_AR as its security tree.

AR_SRCH_PAYMENT_ID_CUST

Payment ID Cust Search

This is a related query.

AR_SRCH_PMT_ATTACH

Payment Attachments Search

This is a related query.

AR_SRCH_PAYMENT_DELETE

Remove deleted Payment Details from Index

This is a delete query.

AR_SRCH_ITEM_CQ

AR Item Connected Query

This is a connected query. Its parent query name is AR_SRCH_ITEM

AR_SRCH_PAYMENT_CQ

AR Payment Connected Query

This is a connected query. Its parent query name is AR_SRCH_PAYMENT

AR_SRCH_PMT_ENTRY_CQ

AR Payment Entry Connected Query

This is a connected query. Its parent query name is AR_SRCH_PMT_ENTRY

RTI Batch Switch allows you to set a threshold that is checked by a set of delivered batch programs. When a batch program is enabled and the threshold is exceeded, RTI is disabled until the next incremental build.

The threshold is checked at the beginning of the batch program (AR Posting) against a count of the total of all transactions being processed, such as items, payments, maintenance, and so forth.

Access the Configure Real Time Indexing page to see which batch programs are configured to use RTI Switch and delivered by Receivables.

See PeopleTools: PeopleSoft Search Technology documentation.

RTI Switch is enabled for these search definitions:

Search Definition

Batch Programs

EP_AR_ITEMS

AR_POST1 (AR_POSTING)

EP_AR_ITEM_ACT_COLL_KIB

AR_POST1 (AR_POSTING)

EP_AR_PAYMENTS

AR_POST1 (AR_POSTING)

EP_AR_PMT_ENTRY

AR_POST1 (AR_POSTING)

Note: RTI Batch Switch is not enabled for On-demand processing for AR Posting.