Searching for Library and Document Contents

This chapter provides an overview of Verity and where-used searches and discusses how to:

Click to jump to parent topicUnderstanding Verity and Where-Used Searches

This section discusses:

Click to jump to top of pageClick to jump to parent topicVerity Searches

PeopleSoft Supplier Contract Management provides Verity searching to assist in advanced, text-based searches for elements in the library and in current authored contracts. You enable search content by creating or updating file-based search collections. The system creates these collections by extracting current information and key values from the PeopleSoft database using predefine application engine jobs. The system searches for library contents using Verity advanced searching.

The Verity search index process extracts information from the supplier contract database and loads it into Verity formatted files on a process scheduler server. The Verity indexing application transforms those record files into flat files in an index that the system uses for searching. Values indexed in Verity fields are returned back to PeopleSoft Supplier Contract Management using a PeopleSoft PeopleTools search application program interface. The returned values are based on the search attributes that you enter for the search.

Note. PeopleSoft delivers predefined system data for setting up Verity searches in PeopleSoft Supplier Contract Management. Predefined data includes searches for clauses, sections, document configurators and current authored documents.

The system builds the Verity-based search collection from actual generated Microsoft Word XML documents versus the plain-text versions of the contract as in the previous release. The system stores the most current .xml version of each ad hoc, purchase order, and purchasing contract for searching purposes and generates the Verity collection directly from the Microsoft Word XML file and any other attachments to the contracts.

Verity-type searches in PeopleSoft Supplier Contract Management include content type, and individual object maintenance searches. You can perform searches for clauses, sections, and configurators. You can also search for ad hoc and purchase order and purchasing contracts that include text strings in full-text and object-specific searches, such as searching for transactional contracts containing a specific item category or searching for specific text in a contract. After completing a search, you can review the results and then, depending on the context, select an object that meets the search attributes to use, update, view, or against which to perform where-used searches.

While you can further configure Verity searches, this chapter only describes tasks that you need to perform with predefined PeopleSoft Supplier Contract Management search data. These tasks define specific fields to store in the search index and to build and test the index.

See Also

"Configuring Search and Building Search Indexes," Enterprise PeopleTools PeopleBook: PeopleSoft System and Server Administration

Implementing the Verity Search Engine

Setting Up Verity Searches

Configuring Verity Search Indexing Options

Click to jump to top of pageClick to jump to parent topicContent Search Component

PeopleSoft Supplier Contract Management provides two launching points for searches. This section describes the first point, which is a stand-alone component for searching contents. Content searches enable you to search the library, view search results, perform additional where-used searches, and finally update or view the elements using PeopleSoft. The second launching point is from within various Supplier Contract Management maintenance components, such as for clauses and sections, described in the Content Searches in Library Maintenance section.

See Content Searches in Library Maintenance.

You can search across executed documents or documents at any status. A search can also be limited by certain transactional field values. For example, you can search across all contracts that involve an item category of computer hardware, remaining contract amounts, and contract default chartfields. Content type searches support full-text string screening, case-sensitive options, thesaurus searches, wildcard, and Boolean and expressions.

Content-based searches include the capability to search for a text string across multiple ad hoc, purchase order, and purchasing contracts at one time. You can search for attachments which might include supplier papers, Adobe .pdf files, or Microsoft Excel spreadsheets. And finally, you can perform content-based searches for document types, user-defined fields, and imported documents.

Note. If you are using transactional data, such as item or vendor information that display as binds in a document, and you change the transactional data and do not update the document, then Verity text searches will not find the changes. This applies only to text searches against the document, but does not apply to keyword searches. For chartfield searches if you have customized chartfields you may need to customize the Verity setup information in order to include chartfield changes in the Verity collection so they can be searched on.

See Also

Searching Document Content

Click to jump to top of pageClick to jump to parent topicContent Searches in Library Maintenance

When you maintain clauses, sections, and configurators, it can be useful to perform full-text verity searches for other elements in the library. The system enables Verity search directly from within various components so you can search and retrieve elements to complete the maintenance of another element. For example, using a document configurator, you can invoke a Verity search to identify a list of clauses containing specific text. and then one or more of the resulting clauses to the configurator you are defining.

The types of searches available from within maintenance components are in the context of the object you are maintaining. In these cases, the system restricts the content type translation values to certain content types. Maintenance searches are performed against clause and sections. For example, searching for a contract line agreement is limited to a clause search because you can only associate clauses with contract agreements; whereas, a section search can include clauses and sections.

These contract maintenance programs use Verity object maintenance searches:

Click to jump to top of pageClick to jump to parent topicWhere-Used Searches

Where-used searches enable you to locate where a document element is used within the document library. You can access where-used searches from maintenance pages and from within the Search Contents component. Where-used searches are performed using PeopleSoft structured query language and while they are not dependent on Verity, you can use them in combination with Verity search results to search and traverse the system.

Using maintenance components, you can perform where-used searches for a bind variable, clause, document, document configurator, question group, rule, section, and wizard definition. In addition, after searching for a content type and receiving the search results within a Verity contents search, you can perform a where-used search on specific objects in the results. For example, if you search content type by clause, the system presents a list of clauses, each with a Where Used link. From within the search results, you can click the link to access each instance of a clause's use, such as in a section or configurator.

Where-used functionality appears in these areas:

See Also

Performing Where-Used Searches

Click to jump to parent topicSetting Up Verity Searches

Verity is an embedded feature in PeopleTools that enables you to do full-text searching for information. PeopleSoft delivers Supplier Contracts Management with predefined Verity setup values that simplify setting up and using basic Verity search capabilities. This section discusses how to:

Note. This section does not describe advanced Verity search setup tasks, rather how you use those searches predefined for PeopleSoft Supplier Contract Management.

See Also

Implementing the Verity Search Engine

Click to jump to top of pageClick to jump to parent topicPages Used to Set Up Verity Searches

Page Name

Definition Name

Navigation

Usage

Define Data Object Set

SAC_IDX_DO_SET

Supplier Contracts, Search Content, Define Data Object Set

Define data object sets by identifying groups of related records to use for a search index. Data object sets are sets of data objects that are related to each other with level and parent/child information.

Source Data Object

EOEW_SRCDO

Supplier Contracts, Search Content, Define Data Object Set

Click the Define Data Objects link on the Define Data Object Set page.

Define data objects. A data object is an Enterprise Common Component object that defines records relationship and is the basis for setting up Verity searches.

Search Index

SAC_IDX_DEFINE

Supplier Contracts, Search Content, Define Search Index

Locate predefined search indexes. Also, to define a new search index and a specific data object set for use with the index. You can define specific fields that the system will store in the search index. This search retrieves and processes data from a group of records that have multilevel parent and child relationships.

Search Index Fields

SAC_IDX_FIELDS

Supplier Contracts, Search Content, Define Search Index, Search Index Fields

Define search index fields. To support attachment searches, this page contains the Attachment Type and Attachment Component fields. The attachment type is used to determine where to get the attachment files. For attachment type SCM Framework, the system retrieves the attachment files recorded in PV_ATTACHMENTS table, then downloads the file to the collection location. The attachment type should contain a valid uniform resource locator address so that Verity commands have proper access to the files.

Build Search Index

SAC_IDX_RUN_CTRL

Supplier Contracts, Search Content, Build Search Index

Build contract search indexes.

Search Test Page

SAC_IDX_TEST_SEC

Supplier Contracts, Search Content, Build Search Index

Click the Test Index link on the Build Search Index page.

Test the index before running it. The system checks for the text that you enter and displays the results about where the text is used and when the element in which it is used has been updated. The display is sequenced and in text format.

Define Search Options

SAC_SRCH_OPTIONS

Supplier Contracts, Search Content, Define Search Options

Activate option codes for searches. For example, these codes include codes that indicate the system should match the case or match the word exactly when searching.

Define Search Query

SAC_SRCH_QRY

Supplier Contracts, Search Content, Define Search Query

Group search fields, field labels, and application classes into a search index that you can use to perform Verity searches for supplier documents. Search queries can include the system-supplied search indexes: CS_CONFIGURATOR, CS_DOCUMENTS, and CS_OBJECTS.

Define Search Results

SAC_SRCH_RSLT

Supplier Contracts, Search Content, Define Search Result

Group search fields, field labels, and application classes into a search index that you can use to perform Verity searches for supplier documents. Search results can include the system-supplied search results: CS_CONFIGURATOR, CS_DOCUMENTS_RESULT, and CS_OBJECTS_RESULT.

Maintain Verity Thesaurus

SAC_SRCH_THESAURUS

Set Up Financials/Supply Chain, Common Definitions, Search Indexes, Maintain Thesaurus

Build a thesaurus for Verity searches, which makes it possible to search for a word that is similar to the search word you use. You build the list starting with a search word and enter the similar or related words. When the system searches on the word, it also includes the synonyms that you define in the search results.

Daemon Group

DAEMONGROUP

PeopleTools, Process Scheduler, Daemon Group

Set up daemon groups.

Daemon Group

SERVERDAEMON

PeopleTools, Process Scheduler, Servers, Daemon

Define daemon group details. This includes defining the time interval for when the process checks for any updates to clauses and documents.

Click to jump to top of pageClick to jump to parent topicLocating Predefined Search Indexes

Access the Search Index page (Supplier Contracts, Search Content, Define Search Index).

PeopleSoft Supplier Contract Management provides predefined search indexes for contract library elements and current transactional and ad hoc contracts in the system. Use the Search Index Name field to select a search index. System-supplied supplier contract field values are:

CS_OBJECTS: Contains clause and section search fields.

CS_CONFIGURATOR: Contains document configurator search fields.

BUILD_CS_DOCUMENTS: Contains search fields for ad hoc, purchase order, and purchasing contract search indexes.

Click to jump to top of pageClick to jump to parent topicBuilding Contract Search Indexes

Access the Build Search Index page (Supplier Contracts, Search Content, Build Search Index).

Use this page to create and update the Verity search indexes and collections to enable supplier contract content searches. The system initializes the page with values based on the index name that you select.

You must first create three run controls that the system uses to build or rebuild the entire index. After building the indexes, if you change the clause, section, document configurators, or ad hoc, purchase order, or purchasing contract documents, you can use the Last Modified Index build option to refresh the indexes.

See Updating Contract Search Indexes.

To create the initial search indexes, create these run controls and submit them for processing:

Note. The system uses values defined on the configuration file, located on the application server, as the index file path default value.

See Building the Verity Search Index.

Run Control ID

Displays the run control ID for either building or updating search indexes. You initially define the value for this field.

Index Name

Displays the search index that you will build or update. Three IDs are for initially building the indexes and the other three are for performing net-change updates to indexes. Supplier Contract Management values for this field are:

BUILD_CS_CONFIGURATOR

BUILD_CS_DOCUMENTS

BUILD_CS_OBJECTS

LAST_MOD_CS_CONFIGURATOR

LAST_MOD_CS_DOCUMENTS

LAST_MOD_CS_OBJECTS

Build Options

Select a build option. Build options are the methods that you use to create and update a search index. Options include:

Create New/Rebuild: Select to create the initial search index. You must run this option for each of the three contract management search indexes before you can refresh the index file. After creating the initial file, you can then maintain the file using the Update Last Modified option.

When you create the initial file, the system gathers the fields that are defined for the search index, creates a flat file from the fields, and stores the file on the server that is defined in the Index File Path field.

Update: Select to build a search index based on additional structured query language selection criteria.

Note. You do not need to use this option to create or update predefined contract management searches.

Update Last Modified: Select to update a Verity search index based on the last modified records from various records. This option is mainly for incremental-search index updates. Each time that you build or update the index, the system stores the last modified date and time stamp. Using the contract library, the system also stores the last modified date and time when you add or change an element or its contents in the base tables.

When you select this option, the system only selects the elements and their contents that have the last modified date and time stamp that is greater than the index's last modified date and time stamp. The system updates the search index file accordingly.

The system uses the date value that was last modified from the Define Search Index page on which to base the update. The system does not update records with changes that were made prior to that date. You must run this option for each of the three contract management search indexes to update the index file.

This is a manual update. You can set up automatic updates using a daemon group to schedule processing.

See Setting Up Daemon Groups.

Remove temp data files

Select this check box to remove temporary data files that the system stores when it builds a Verity collection. The system creates temporary data files (.bif and .dat) from extracted database information to be included in the index. These files can be large. You might want to remove them unless you are reviewing them after builds for debugging purposes.

Index File Path

Displays where the Verity index flat file is located. When you build or update searches, the system updates files at this location.

Source

Displays the source data set from which you will build or update this search index.

Test Index

Displays the search index that you will build or update. When you access the page, you can enter a text string on which to search. The system checks for the text and displays the information about where the text is used and when the element in which it is used was updated. The system displays the information in sequence and in text format.

Note. Verity search collections for transactional and ad hoc authored documents are possible for only the current version of the document content, and not all prior versions. Furthermore, the system creates the collection based on the text content in the body of the authored document stored in the PeopleSoft database rather than in the document file stored on the server.

 

Attachment Server Network Path

Enter a value to override the attachment path values specified on the Define Search Index Field page that the system will use to retrieve attachments for indexing.

Filtering Criteria - Optional for Create New/Rebuild

Use this grid box to define source data objects, record names, and field names. Filter criteria is optional when you create or rebuild an index, but is required when you update or update the last modified records for the search index. These variables limit searches to more specific data.

Use the Value field to enter attributes for field values that you to include in the search index.

Collection Language

Use this grid box to define language information for the Verity search index.

All Available Languages

Select to include all available languages when you create or build the index.

Specific Language

Select a language code. You can index Verity for each language, for example, English, Spanish, or Dutch. Selecting language codes makes it possible to support multiple languages in one system.

Click to jump to top of pageClick to jump to parent topicUpdating Contract Search Indexes

Access the Build Search Index page (Supplier Contracts, Search Content, Build Search Index).

After initially building a search index, you should keep it updated to reflect changes that are being made in the contract library. You use the Update Last Modified build option in the Build Options field to run the update manually. Or, you can alternatively set up a daemon group to automatically update the index files periodically. You should set up either of these processes to run as frequently as needed depending on how often changes are made to the library elements and authored documents.

To update the search indexes manually, create run controls values that are based on the corresponding Verity search index, and submit them for processing. These values include:

See Building the Verity Search Index.

Click to jump to top of pageClick to jump to parent topicSetting Up Daemon Groups

Access the Daemon Group page (PeopleTools, Process Scheduler, Daemon Group).

Use this page to add the CS_SRCH_DAEM process to the daemon group. You use daemon processing to save time in rebuilding the index. You can set daemon processes to periodically schedule a job to update indexes for you. The system checks for updates to contract records and when it finds a change, it automatically runs the Update Last Modified Index Build process so that you don't have to run the update process manually.

Note. When setting up a daemon process, you must restart the application server to which the process links.

To locate the CS_SRCH_DAEM process and set its timing:

  1. Select PeopleTools, Process Scheduler, Daemon Group.

  2. Click the Load All Programs button to load all available application engine programs.

    Programs must be marked as daemon in their properties to be available. The CS_SRCH_DAEM process should appear in the list.

  3. Select PeopleTools, Process Scheduler, Servers, Daemon.

  4. Select a server and then select the Daemon tab.

  5. Select CS_SRCH_DAEM from the Daemon Group field list of values.

  6. Click the Save button.

    The system checks whether there have been updates to document elements. When a change is detected within the daemon sleep time, the system initiates the Update Last Modified Index Build process. You do not need to run from the Build Index process.

See Also

"Setting Server Definitions," Enterprise PeopleTools PeopleBook: PeopleSoft Process Scheduler

Click to jump to parent topicSearching for Library and Document Contents

This section provides a lists of common elements and discusses how to:

Note. You can also use much of the information provided in the next sections when performing Verity searches from within library maintenance definition pages.

Click to jump to top of pageClick to jump to parent topicCommon Elements Used in This Section

Content Type

Select the type of content for which you want to perform searches against. This is a required field. Search attributes that the system displays depend on the content type that you select. When you select the content type and define attributes for the search, click the Search button to review results that match the search attributes. Field values are:

  • Clause: Select to search the contents of clauses.

  • Document: Select to search the contents of ad hoc, purchase order, and purchasing contract documents. In addition, when you search for purchasing contracts, you can search for some of the purchasing transaction elements, such as item category, in addition to document content.

  • Document Configurator: Select to search the ad hoc contents of document configurators.

  • Section: Select to search the contents of sections.

    Note. Use where-used searches to traverse the use of elements and their use. For example, to search for document configurators based on which clauses, sections, or rules that are used in the configurator, you use a where-used search. You can also perform these searches from an element's maintenance component.

Date Range

Use Date Range group boxes to select date ranges for when a user or multiple users took specific actions against a clause, document, configurator, or contract. Example of ranges that the system uses include status changes, check in and check out, execution, and modification dates. Depending on the attribute data that you enter, you can search for all objects that are checked out by all users during a time span or search for all objects that were checked out by a single user during a specific time frame.

Exact Word

Select to match exact words in the search. Use the Define Search Options page to make this option active on the Search Content by Type page.

Title or Body Text

Enter the text that you want to find in the clause. The system searches through titles for the content type that you selected, as well as the body of the text in document.

Ad Hoc Clause Verbiage

Enter the text that you want to find in a document configurator ad hoc clause. This field is available when the content type is document configurator. An ad hoc clause is one that you assign from within the configurator. The system searches through clause text to find matches.

Match Case

Select to indicate that you want to match upper and lower case characters. Use the Define Search Options page to make this option active on the Search Content by Type page.

Use Thesaurus

Select to indicate that you want to use the Verity thesaurus for searching. During the search, the system searches for like terms that you define for a word. To define a thesaurus, you create a list of similar or like terms using the Maintain Verity Thesaurus page. To access the page, select Set Up Financials/Supply Chain, Common Definitions, Search Indexes, Maintain Thesaurus. Use the Define Search Options page to make this option active on the Search Content by Type page.

See Also

Implementing the Verity Search Engine

Click to jump to top of pageClick to jump to parent topicPages Used to Search for Library and Document Contents

Page Name

Definition Name

Navigation

Usage

Search Content By Type

CS_CONTENTS_SEARCH

Supplier Contracts, Search Content, Search Contents

Select either Clause, Document, Document Configurator, or Section in the Content Type field on the Search Content by Type page.

Search content by clause, documents, configurators, and sections.

Chartfields Search Criteria

CS_CONT_CF_EXP

CS_PUR_CF_EXP

Click the Chartfields link in either the purchase order or purchasing contract section on the Search Content By Type page.

Define searches for purchase order and purchasing contract source transaction chartfields. Verity searching enables you to identify related contracts by chart fields such as department and project as part of contract searching.

Search Content By Type

CS_CONTENTS_DOC

Supplier Contracts, Search Content, Search Contents

Select either Clause, Document, Document Configurator, or Section in the Content Type field on the Search Content by Type page.

Click the Search button on the Search Content By Type page.

Populate the Search Results grid with the results of a search for clause, documents, configurators, and sections.

Click to jump to top of pageClick to jump to parent topicSearching Clause Content

Access the Search Content by Type page (Supplier Contracts, Search Content, Search Contents, and select Clause in the Content Type field).

Use this page to define search attributes for a document clause search. You access the page by selecting Clause in the Content Type field. After entering the attributes, click the Search button to view a list of search results.

Note. To ensure that you have the most up-to-date search collection, run the Build Search Index process for the CS_OBJECTS index. The system provides a message at the bottom of the page that indicates when the collection was last built.

Description

Enter text that you want to find in a clause description. You can also perform a spell check on the text you enter. When you perform the search, the system displays all clauses that use the text in the Search Results grid and that meet the remaining search attributes. If you enter a clause ID, the system populates this field with its description.

Class Name

Select a class name to include in a clause search. Clauses that use this class and that meet other search attributes will appear in the search results.

Effective Date Used

Select a date to search for only the most current clause or section based on the search criteria and effective date you enter. To retrieve effective-dated clauses or sections, leave this date field blank.

Note. When searching for only current or specific effective-dated results, the system suppresses history rows during Verity searches. The Verity search counter displayed above the grid counts history rows and includes them in its count results. So, it's possible that a Verity count indicates that six rows were found in a search, but the system may display only four of them because it suppressed the history rows. The system displays a note when it suppresses history rows.

Status (Effective)

Select to search for clauses or sections that are Active or Inactive. If you leave the field blank, the system searches for both statuses.

Clause ID

Select a specific clause for which to search. For example, you can search for all effective-dated versions that contain specific text.

The system populates the Description field. If the clause is assigned to a group or library, the system also populates those fields. When searching documents, a Clause ID field enables you to search for specific documents that use this clause.

Clause Group

Select a clause group on which to search. If you entered a clause ID and it belongs to a group, the system populates this field. Search results display all clauses that are assigned to the group.

Library

Select a clause library on which to search. If you entered a clause ID and it belongs to a library, the system populates this field. Search results display all clauses that are assigned to the group.

Approval Status

Select an approval status on which to search for clauses or sections. The clause approval status indicates the current state of the approval process; whereas, the clause status indicates whether the clause is active or inactive. You can search on approval workflow status values such as Approved, Initial, and Pending. Sections do not approval workflow, so the Pending status does not apply to sections.

Checked Out By, Last Approved and Last Updated By

Select to search for clauses that are based on actions that have been taken by users. For example, if you want to locate clauses that are currently checked out by a user, select the user ID.

Notes

Enter a text sting on which to search in notes. The system searches Notes fields for all the clauses, sections, or configurators as part of the search.

Search

Click this button to initiate the search process and produce search results.

Where Used Search

Click this button to initiate a search for a clause, section, or configurator depending on the search page content type.

See Searching for Library and Document Contents.

Check Out Date From and Check Out Date To

Select a date range. You can search for when clauses are still checked out by selecting from and to dates. The system displays the clauses that are checked out within the date range you select.

Approved Date From and Approved Date To

Select a date range. You can search for when clause statuses were approved within the date range selected.

Last Modified Date From and Last Modified Date To

Select a date range. You can search for when clause attributes were last modified within the date range that you select.

Search Results

This grid appears with the results of the search when you select to search content by clause. The Content Type, Clause ID, and Effective Date fields display information about the clause.

Description

Click to access the Clause Definition page where you can view clause information and preview the clause in Microsoft Word. You cannot make changes to the clauses.

Where Used

Click to access the Search for All Content Instances page. The page displays where the clause is used throughout this setID. You can navigate to each use of the clause.

Click to jump to top of pageClick to jump to parent topicSearching Section Content

Access the Search Content By Type page (Supplier Contracts, Search Content, Search Contents, and select Section in the Content Type field).

You can associate clauses to a section definition and add sections to configurators. Sections can also be stored separately and classified in the same manner as configurators so that the creation of a document occurs by adding clauses to sections and sections to configurators.

Use the search results to access the section where you can review section contents and preview the section document. You cannot make changes to the section. Use the Manage Contract Library component to make updates to the section.

Note. Fields on the Search by Content Type page vary depending on the type of content search. Fields that are not defined in this section are defined in the Searching Content by Clause section.

Note. To ensure that you have the most up-to-date search collection, run the Build Search Index process for the CS_OBJECTS index. The system provides a message at the bottom of the page that indicates when the collection was last built.

Section Type

Select a section type to use in the search. Values are:

General: Select to include only general sections in the search results. These are overall sections that can be used throughout a document.

Introduction/Title: Select to include only introduction sections in the search results. These are the first sections in documents.

Section ID

Select a section for which you want to search. This restricts the search to a single section.

Search Results

This grid appears with the results of the search when you select to search content by section. The Content Type, Clause ID, and Effective Date fields display information about the section.

Description

Click to access the Clause Definition page where you can view clause information and preview the clause in Microsoft Word. You cannot make changes to the clauses.

Where Used

Click to access the Search for All Content Instances page. The page displays where the section is used throughout this setID. You can navigate to each use of the section.

See Also

Searching Clause Content

Click to jump to top of pageClick to jump to parent topicSearching Configurator Content

Access the Search Content By Type page (Supplier Contracts, Search Content, Search Contents, and select Document Configurator in the Content Type field).

Use this page to search for document configurators that match the selection criteria that you enter.

Note. Fields on the Search by Content Type page vary depending on the type of content search. Fields that are not defined in this section are defined in the Searching Content by Clause and Searching Content by Document sections.

To ensure that you have the most up-to-date search collection, run the Build Search Index process for the CS_CONFIGURATOR index. The system provides a message at the bottom of the page that indicates when the collection was last built.

Word Template Name

Select a Microsoft Word template on which to base the configurator search. If you define a template, the system displays only those configurators that use the template in the search results.

Wizard ID

Select a wizard on which you want to base a configurator search. The system displays all documents that use this wizard in the search results.

Configurator Status

Select a status on which to base the search. Values are Available, In Progress, and Obsolete.

Created Date From andCreated Date To

Enter a range of values on which to search for document configurators. For example, you can search for configurators that were created between June 1, 2005 and July 15, 2005.

Approved Date From andApproved Date To

Enter a range of values on which to search for document configurators. This date range search results includes status changes to configurators within the two dates that are provided and that meet other search attributes.

Last Modified Date From and Last Modified Date From

Enter a range of values on which to search for document configurators. The system displays the configurators that were changed within the two dates you provide.

Search Results

This grid appears with the results of the search when you select to search content by document configurator. The Content Type, Clause ID, and Effective Date fields display information about the configurator.

Description

Click to access the Configurator Definition page where you can view information about the configurator. You can navigate to review each content element of the configurator.

Where Used

Click to access the Search for All Content Instances page. The page displays where the configurator is used throughout this setID. You can navigate to each use of the configurator. For example, you can locate and access document types that use the configurator you selected.

See Also

Searching Clause Content

Click to jump to top of pageClick to jump to parent topicSearching Document Content

Access the Search Content By Type page (Supplier Contracts, Search Content, Search Contents, and select Document in the Content Type field).

Use this page to:

Click the Search button after you define search attributes. The system will display those documents matching the criteria. You can also click the Where-Used Search button to search for where specific document elements are used throughout the document library.

Note. If you are using transactional data, such as item or vendor information that display as binds in a document, and you change the transactional data, but do not update the document, then Verity text searches will not find the changes. This applies only to text searches against the document, but does not apply to keyword searches.

Note. To ensure that you have the most up-to-date search collection, run the Build Search Index process for the CS_DOCUMENTS index. The system provides a message at the bottom of the page that indicates when the collection was last built.

Search Type

Select the type of search you want to perform. Both Authored and Imported Doc is the default value for the field. Values include:

Authored Documents Only: Select to search for documents that were created using the document authoring system.

Both Authored and Imported Doc: Select to search for both the documents that were created using the document authoring system and the documents that were imported into the document authoring system as a document to be managed in the system.

Imported Documents Only: Select to search for the documents that were imported into the document authoring system as a document that is now being managed in the system.

Include Attachments

Select this check box to search for supporting attachments, such as supplier papers and spreadsheets. The system uses the search type you select in conjunction with this check box. The default value for the Include Attachments check box is deselected.

The system uses the text string you enter to search file attachments with AND conditions from other attributes. For example, if you enter inspection contract in the text string, along with the Purchasing Contracts source transaction, the system searches all purchasing contracts for contracts with file attachments containing the inspection contracts text sting. If you select the Include Attachment check box, the system displays all the supporting attachment file names and their descriptions.

Note. When you search for attachments, the system only searches for supported Verity formats. Some formats, such as image-based formats, may not be searchable.

Source

Select a document source on which to base a search. Values include Ad Hoc, Purchase Orders, and Purchasing Contracts. The value that you select determines the content for the page.

If you select Ad Hoc, the system uses only document attributes for the search. Ad hoc documents are not linked to transactions. The PO Contract Attributes (purchase order contract attributes) and Purchase Order Attributes grids do not appear when you select to search for ad hoc documents.

Document search attributes are the same for ad hoc, purchasing contracts, and purchase order searches. If you leave the field empty, the system searches documents for ad hoc, purchase order, and purchasing contracts that match the other criteria you enter on this page. The default value for the field is blank.

Note. If the Filter Results Without Chunking For Documents check box is selected on the Installation Options page, the system filters search results based on user security access to the document. Only rows for users who have access to documents appear in the search results.

Document Attributes

This grid is available for both ad hoc, purchase order, and purchasing contract document searches. When you are searching for transactional information, such as in a purchase order contract, you can also apply document attributes from this grid to the purchase order contract search.

Library SetID

Select the library setID upon which you want to base the search.

Description

Enter a text stream to limit the search to documents that contain this text in their description. This text must match the text that was entered as the description when the document was initially created.

Document Type

Select the document type you want to use to search for documents. The system displays the documents that match this document type and other search criteria. This field is not available if document types have not been selected for use on the Installation Options page.

Ad Hoc SetID

Select an ad hoc setID in which to search for a document. This field is available when you select Ad Hoc in the Source field.

Ad Hoc ID

Select the ID for the ad hoc document for which you want to search. This field is available when you select Ad Hoc in the Source field.

Document State

Select to search for ad hoc, purchase order, or purchasing contract documents according to their state. The default value for the field is All Documents. You can also search for Inactive Documents Only or Active Documents Only.

Document Status

Select to search for ad hoc, purchase order, or purchasing contract documents according to their approval status. The default value for the field is blank which means that the system searches for all statuses. You can search for:

Approved

Collaborated

Collaborated, Pending Review

Complete

Dispatched

Draft

Executed

Pending Approval

Pending Collaboration

Pending External Collaboration

Pending Internal Review

Configurator Type

Select a configurator type by which to search for documents. Used by itself, the system displays all documents that were used in the search results. Configurator types define requirements that you can use in document configurators. These requirements provide instructions and specific details about a transaction type.

Configurator ID

Select a configurator ID by which to search for documents. Used by itself, the system displays all documents that use the configurator ID in the search results.

Clause ID

Select a clause on which to search. The system displays all documents that include this clause for either ad hoc documents or purchasing order contracts (or both), depending on the source document.

Administrator

Select to search for documents that are based on the administrator.

Sponsor

Select a user ID to search for documents that are sponsored by that user. A sponsor should represent the user from the department that sponsors the contract.

Department

Select a value to search for documents that are sponsored by a single department.

Created By, Checked Out By, and Last Update User ID

Select to search for documents that a user has created, checked out, or last updated.

Begin Date From

Select a value to search for a contract begin date from.

Begin Date To

Select a value to search for a contract begin date to.

Expire Date From

Select a value to search for a contract expiration date from.

Expire Date To

Select a value to search for a contract expiration date to.

Last Executed From

Select a value to search for a contract last execution date from.

Executed Date To

Select a value to search for a contract last execution date to.

Created Date From

Select a value to search for a contract creation date from.

Created Date To

Select a value to search for a contract creation date to.

Checked Out Date From

Select a value to search for a contract checked out date from.

Checked Out Date To

Select a value to search for a contract checked out date to.

Last Modified Date From

Select a value to search for a contract last modified date from. This date represents the last update date of the document management header that includes updates when a document is checked in.

Last Modified Date To

Select a value to search for a contract last modified date to. This date represents the last update date of the document management header that includes updates when a document is checked in.

User Defined Fields

Use this section to define search criteria for user-defined fields. These are fields that you can use to link specific information to documents. Fields that have been designated for use in searching appear in the section. You use the User Define Fields page to define the search availability within search contents. . User-defined fields are only available for document searches.

Note. If you select to search using a specific document type, the system displays the subset of user-defined field defined for the document type if the document type is set up to override default user-defined fields.

See Setting Up User-Defined Fields.

Purchase Order Attributes

Use this section to define attributes on which to search for purchase order contract documents. You can use transaction contract values in conjunction with document attributes from the top section to perform searches.

Note. See the next topic for descriptions of the Vendor ID, Vendor Name, Currency Code, Category, Item ID, and Item Description fields and the Chartfields link.

Business Unit

Select a business unit to which you want to limit the search for a purchase order contract document. Purchase orders are defined by business unit.

PO Status (purchase order status)

Select a purchase order status on which to base a search. Statuses range from Open to Approved and Complete.

PO Number (purchase order number)

Select a purchase order number on which to base the purchase order document search.

Buyer

Select a buyer on which to base the document search. This is the buyer defined on the purchase order.

Vendor ID

Select a vendor on which to base the document search.

PO Reference (purchase order reference)

Enter the free-form text that is associated to a purchase order. The system searches on the text string that you enter. The text is defined using the Maintain Purchase Order - Purchase Order page.

Vendor Name

Select a vendor name on which you want to base the search for purchasing order documents.

Currency Code

Select a currency code on which to base a search.

Category

Select an item category on which to base the search.

Hold From Further Processing

Select to identify those purchase orders that are on hold from further processing.

Item ID

Select an item to include in search results.

Budget Checked

Select to filter only those POs that have been budget checked. Budget checking is available when commitment control is enabled for PeopleSoft Purchasing.

Chartfields

Click this link to access the Chartfields Search Criteria page where you can select individual default chartfields

PO Date From

Select a PO from date on which to base the document search. The system displays any purchase order that was created on the date that you enter.

Amount Open From and Amount Open To

Enter values for the remaining open amount on the purchase order. The system displays documents for those purchase orders that have the amount open within the range that you enter.

PO Date To

Select a PO to date on which to base the document search. The system displays any purchase order that was created on the date that you enter.

Purchasing Contract Attributes

Use this section to define attributes on which to search for purchasing contract documents. You can use transaction contract values in conjunction with document attributes from the top section to perform searches.

SetID

Select the setID in which you want to search for a purchasing contract document.

Contract Status

Select a status for which you want to search for transactional contract documents. The system displays only those purchasing contract documents that are at the same status that you select. If you enter a contract ID, the system applies the status.

Values include:

  • Approved for Purchasing

  • Canceled

  • Closed, May be Purged

  • Hold, Awaiting an Action

  • Open, Requires Approval

Contract ID

Select a contract on which to base the search. The search results display the contract and its document if a document exists. If you select an ID, the system displays only this contract in the search results.

Description

Enter a contract description on which to search. The system displays all contracts with this text in the search results.

Vendor ID

Select a vendor identifier on which you want to base the search for purchasing contract documents.

Currency Code

Select a currency code on which to base a contract search.

Chartfields

Click this link to access the Chartfields Search Criteria page where you can select individual default chartfields as entered within Contract Entry to include in the search. The chartfield collection does not include chartfield changes for individual purchase orders related to the contract.

Among the standard chartfields available in the search criteria are: Operating Unit, Fund Code, Budget Reference, and Project. If you customize chartfields, the Verity setup data may need to be customized to support adding your own chartfields to the collection so they can be searched on.

Note. You can select the General Ledger business unit on which to base the Chartfields search. The GL Business Unit field is required when you are searching for content using the Program Code and Class Field fields. If you do not select a GL business unit, the system does not provide search results for these two fields.

Vendor Name

Select a vendor name on which you want to base the search for purchasing contract documents. The system displays all contracts that use this vendor and meet other search attributes in the search results.

Process Option

Select the process to use for the search. Processing options determine a specific contract process that a contract uses throughout its entire contract life cycle. The system uses the value that you select to display all contracts that use the process.

Field values are:

  • General Contract

  • Prepaid Voucher

  • Prepaid Voucher w/Advance PO (prepaid voucher with advance purchase order)

  • Purchase Order

  • Recurring PO Voucher (recurring purchase order voucher)

  • Recurring Voucher

  • Release to Single PO Only (release to single purchase order only)

See Using Voucher and Order Contracts.

Master Contract ID

Select a master contract on which to base the search. Master contracts group several contracts for the same supplier and then track them using one master contract ID. You associate the individual contracts with the master contract ID by designating the master contract ID on the Contract Entry page. Search results produce all contracts that are within the master contract you define and that meet other attributes you enter.

Administrator

Select a contract administrator on which to search for contracts. If you only complete this field, the system displays all contracts for which this administrator is responsible in the search results.

Item Category

Select an item category on which to base the search. Categories are groupings of items. The system searches for contracts that contain this category ID and displays them in the search results.

Item ID

Select an item to include in search results. The system displays contracts in the search results that contain this item.

Approved By

Select a user on which to base a search for contracts. The system searches for all contracts that this user has approved.

Item Description

Enter an item description against which to perform a search. The system searches for the text stream that is used in the Description field on the line item.

Contract Category

Select a contract category on which to base the purchasing contract search. Categories enable you to specify groups of items on a contract, rather than having to enter the items one at a time.

Maximum Amount From and Maximum Amount To

Enter a range of values on which to search for purchasing contracts.

Remaining Amount From andRemaining Amount To

Enter a starting and ending amount. The values you enter will determine the amount range on which the system bases its search. Remaining amounts are the unused amounts on purchase order contracts.

Click to jump to top of pageClick to jump to parent topicReviewing Document Search Results

Access the Search Content by Type page: Search Results grid. (Supplier Contracts, Search Content, Search Contents, and click the Search button).

Use this grid to view document information. The grid appears with the results of the search when you search content by documents. For documents, the setting for the Filter Results Without Chunking field on the Installation Options page controls if all rows are returned for a user (unfiltered by user access security) and the appearance of the chunking buttons to page through the results. If this option is selected, then for documents the chunking buttons are not shown, and only those documents for which the user has administrator or view access will be included in the search result.

Source Transaction

Displays either Purchase Order, Purchasing Contract or Ad Hoc, depending on the selection that you make in the Source field. If you selected to search based on both sources, then both sources will appear in the results.

Document Type

Displays the document type for the document. If document types are not set for use in installation options, the column does not appear.

Short Vendor Name

Displays the short name for the vendor.

SetID

Displays the setID to which this document belongs.

Contract ID

Displays either the system-defined identifier for the contract or the user-defined ad hoc document identifier. Click to access either the Contract Entry page if this is a purchase order contract or the Document Management page if this is an ad hoc contract

File Type

Displays the file type for a document. File types can be Main, Doc Attach (document attachment), and Txn transaction attachment.

Version

Displays the version number for the document.

Amendment

Displays the amendment number for the document.

Description

Displays a system-generated description that indicates the use of this document. Click the value to access the Document Management page.

Where Used

Displays a link when a document has been associated to another document as a related document. When you click the link, the Search for All Content Instances page appears with the other documents to which this document has been associated.

View

Click the View button to open the Microsoft Word document for the purchase order or ad hoc document.

Details

Select the Details tab.

This tab displays document attributes that include the document status, department, sponsor, and administrator. Also, if the document is an imported document, it is marked with a selected check box.

Attachments

Select the Attachments tab.

This tab displays attachment information that includes the attachment name and description.

Click to jump to parent topicPerforming Where-Used Searches

This section discusses how to search for where document elements are used. Where-Used functionality enables you to traverse and identify document elements in addition to searching content of document library elements using Verity searches.

For example, you can use the two features in combination by first using Verity searches to identify specific clauses that might contain specific text that you need to edit. Then you can identify sections, configurators, and documents that you need to review and update.

You can access where-used searches from multiple locations including the Search Contents component and individual definitional components for clauses, sections, binds, rules, document configurators, question groups, and wizards.

Click to jump to top of pageClick to jump to parent topicPage Used to Perform Where-Used Searches

Page Name

Definition Name

Navigation

Usage

Search for All Content Instances

CS_CONTENTS_XREF

Supplier Contracts, Search Content, Search Contents

Click the Where Used Search button on the Search Content by Type page.

Search where document elements are used. This includes searches for bind variable, clauses, documents, configurators, question groups, rules, sections, and wizard definitions.

Click to jump to top of pageClick to jump to parent topicSearching for Where Document Elements are Used

Access the Search for All Content Instances page (click the Where Used Search button on the Search Content by Type page).

Use this page to search where specific document elements are used throughout the document library. For example, if you select a clause, the search results could contain where the clause is included in a rule, section, or configurator. Search results could also contain whether the clause is used as an alternate or dependent clause.

Note. Where-Used search functionality does not use Verity searches.

Content Type

Select the type of document element for which you want to search. This is a required field. Search values are:

Bind Variables

Clause

Document

Document Configurator

Question Group

Rule

Section

Wizard Definition

Word Template

SetID

Select a setID on which to base the search. This field is not available for bind variables.

Content ID

Select a specific ID for the content type that you defined. The values that are available for this field are determined by the selection you make in the Content Type field. This is a required field.

Source

Select the source transaction on which you want to base a search. This field is available for document content types. Values include Ad Hoc, Purchase Orders, and Purchasing Contracts.

Ad Hoc ID

Select an ad hoc document ID for which you want to search. This field is available when you search for ad hoc sources.

Contract ID

Select the contract ID for which you want to search. This field is available when you search for purchasing contract sources.

PO ID (purchase order ID)

Select the purchase order ID for which you want to search. This field is available when you search for purchase order contract sources.

Effective Date Used

Select an effective date on which to search. The system uses the current date as the default value. When you search on an effective date, the system checks for the current instance of the clause based on the date you enter. For example, you can locate a clause as of the effective date to locate specific versions. Then, you can locate which sections, configurators, and documents that reference the clause for this effective date.

Search Results

Use this grid to review the results of a where-used search. You can click links to view more details about how the content type uses the document element for which you searched. You can also perform additional where-used searches on the document elements identified in the results.

Source Transaction

Displays the source transaction value, ad hoc, purchase order, or purchasing contract, that you selected for the search.

Document Type

Displays the type of document element that contains the content type for which you are searching.

Content Type

Describes the type of document element that contains the content type for which you are searching.

Content ID

Displays the name for the content type.

Description

Click to access the content for an item retrieved in the search results. For example, if you are searching for a wizard definition and the content type is a document configurator, then this link accesses the Document Configurator Definition page for the document configurator you selected.

Where Used

Click to access another where-used search that enables you to navigate to view more details about the component in which the clause is used. For example, if you identify a section containing text that effects existing configurators and contracts, you can search for which configurators reference the section and, in turn, which documents have been generated from those configurators.

View

Click this button to view the document in which the content exists. The button is available for document configurator and document searches. If the user does not have access to the document the system issues an error.

More Details

Select the More Details tab.

Use this page to view additional document information. This information includes the document's version, amendments, and the amendment option. The tab is available when you search for a document or document configurator.

See Also

Where-Used Searches