Differences

This shows you the differences between two versions of the page.

--- contract_search [2024/12/09 21:05] – tina.robles
+++ contract_search [2025/06/20 16:35] (current) – tina.robles
@@ Line 1: / Line 1: @@
 **__Contract Search__**
-To search for Contracts, click on Contract and select Contract Search.
+**Accessing Contract Search**
+__Navigation Path:__
+  * Primary Menu: Select "Contract" from the main navigation menu
+  * Function Selection: Choose "Contract Search" from the available options
+  * Purpose: Access comprehensive contract database search and retrieval capabilities
+**Functionality Overview**: The Contract Search feature provides users with advanced search capabilities to efficiently locate and access specific contracts within the system database, enabling streamlined contract management and retrieval operations.
 {{:pasted:20240808-151900.png}}
 -----
-The field search will be automatically populated with some default criteria to help limit the number of records returned and provide more relevant results.  Those default criteria are: claimable = true and end date greater than or equal to the current date of last year.  These can be removed if you wish to look at all contracts.
+__**Automated Search Parameters**__
+**System-Generated Filters**- The Contract Search interface automatically applies predefined search criteria to optimize query performance and enhance result relevance for standard business operations.
+**Default Criteria Specifications:**
+  * Claimable Status: Set to "True" to display only active, claimable contracts
+  * Date Range Filter: End date parameter configured to show contracts with end dates greater than or equal to one year prior to current date
+  * Performance Optimization: Default parameters reduce dataset size and improve search response times
+__**Customization Options**__
+**Filter Modification Capability**
+  * User Control: Default criteria can be removed or modified based on specific search requirements
+  * Expanded Search Scope: Removing default filters enables comprehensive contract database access
+  * Flexible Configuration: Users can adjust parameters to accommodate diverse search objectives
+__**Business Benefits**__
+**Efficiency Enhancement:**
+  * Relevant Results: Default filters prioritize currently active and recently expired contracts
+  * Reduced Processing Time: Optimized search parameters improve system performance
+  * User Experience: Streamlined results presentation focuses on most business-relevant contracts
+**Operational Flexibility:**
+  * Standard Operations: Default settings support routine contract management activities
+  * Comprehensive Analysis: Filter removal enables historical contract research and comprehensive auditing
 {{:pasted:20240808-151945.png}}
-To see all available fields that can be searched, hover on the field and a popup will display. Use the scroll bar to view all options.
+**__Available Search Criteria Access__**
+**Field Exploration Functionality**
+  * Activation Method: Hover cursor over any search field to display comprehensive field options
+  * Information Display: Interactive popup presents complete list of available search parameters
+  * Navigation: Utilize scroll functionality within popup to review all selectable criteria options
+__**User Interface Features**__
+**Dynamic Field Discovery**
+  * Interactive Help: Hover functionality provides immediate access to search parameter options
+  * Comprehensive Coverage: Popup displays all system-available search fields for thorough query construction
+  * User Guidance: Visual interface eliminates guesswork in field selection and search criteria development
+__**Search Optimization Benefits**__
+**Enhanced Search Capability:**
+  * Complete Visibility: Access to all available search parameters enables comprehensive query development
+  * Efficient Navigation: Scroll functionality accommodates extensive field options within compact interface
+  * User Empowerment: Self-service field discovery reduces dependency on external documentation
+**Improved User Experience:**
+  * Intuitive Design: Hover-activated help provides contextual assistance without interface disruption
+  * Comprehensive Access: Complete field visibility enables sophisticated search query construction
+  * Streamlined Workflow: Immediate field discovery accelerates search setup and execution
 {{:pasted:20240808-152029.png}}
-There are additional search criteria located in the field search dropdowns.  These search criteria are as follows: Start Date, End Date, Claimable, Contract Version ID, Contract Name, Contract Title, Direct Value, Deviated Value, Product Name and Product Number.
+__**Extended Search Parameter Library**__
+**Comprehensive Search Capabilities**- The Contract Search interface provides access to an extensive range of search criteria through dropdown field selections, enabling sophisticated query construction and precise contract identification.
+__**Available Search Parameters**__
+**Contract Identification Fields:**
+  * Contract Version ID: Unique system identifier for specific contract versions
+  * Contract Name: Primary contract designation and naming convention
+  * Contract Title: Descriptive contract title for enhanced identification
+**Temporal Parameters:**
+  * Start Date: Contract commencement date criteria
+  * End Date: Contract expiration or termination date parameters
+**Contract Status and Configuration:**
+  * Claimable: Contract eligibility status for claims processing
+  * Direct Value: Direct contract value specifications
+  * Deviated Value: Distributor-mediated contract value parameters
+**Product-Related Criteria:**
+  * Product Name: Specific product identification by name
+  * Product Number: Product identification by system number or SKU
+__**Search Functionality Benefits**__
+**Precision Targeting:**
+  * Multi-Parameter Queries: Combine multiple criteria for highly specific search results
+  * Flexible Configuration: Select relevant parameters based on specific business requirements
+  * Comprehensive Coverage: Access to both administrative and product-specific search options
+**Operational Efficiency:**
+  * Streamlined Discovery: Targeted search capabilities reduce time required for contract location
+  * Business Intelligence: Advanced filtering supports analytical and reporting requirements
+  * User Productivity: Comprehensive search options eliminate need for manual contract review
 {{:pasted:20240808-152123.png}}
-One thing to note is that field search (on the right side) and normal search (on the left side) work together as a global “and” search. You can enter some criteria into one, and other criteria into another, and it will return the contracts which match BOTH.  For example, if you wanted to search for any contracts which contained product “12345” with a direct value that is greater than $0.50, enter both of those criteria into the field search (on the right side). If you were to enter the product criteria into normal search, and direct value into field search, it would pull back any contracts that have product “12345” on them, AND any contracts that have ANY product with a direct value greater than $0.50. Not just contracts with product “12345” whose direct value was greater than $0.50 like you were looking for.
+The Contract Search interface operates with two distinct search components that function collaboratively:
+  *** Normal Search:** Located on the left side of the interface
+  * **Field Search:** Positioned on the right side of the interface
-Enter search criteria and select Search or click the Enter key on the keyboard.
+__**Search Logic and Query Behavior**__
+**Global "AND" Operation**- Both search interfaces operate in conjunction using global "AND" logic, requiring contracts to satisfy criteria from both search areas simultaneously when populated.
+**Best Practice Implementation**: For optimal search accuracy, enter related criteria within the same search interface to ensure proper logical grouping and result precision.
+__**Search Logic Examples**__
+**Recommended Approach:**
+  * Objective: Locate contracts containing product "12345" with direct value exceeding $0.50
+  * Method: Enter both criteria in Field Search (right side)
+  * Result: Returns contracts where product "12345" specifically has direct value greater than $0.50
+**Suboptimal Approach:**
+  * Configuration: Product criteria in Normal Search, direct value in Field Search
+  * Result: Returns contracts containing product "12345" AND any contracts with ANY product having direct value greater than $0.50
+  * Issue: May return irrelevant results where product "12345" exists but doesn't meet the value criteria
+__**Search Execution and Management**__
+**Query Execution:**
+  * Method 1: Click "Search" button to initiate query
+  * Method 2: Press "Enter" key for keyboard-based execution
+**Data Management:**
+  * Clear Function: Click "X" icon at the beginning of any criteria row to remove specific search parameters
+  * Reset Capability: Individual criteria removal enables selective query modification without complete search reset
-To clear data from the search criteria, click the X at the beginning of the criteria row.
 {{:pasted:20240808-152213.png}}
-On the field search, additional criteria can be added by clicking the Add Field Criteria button.  Criteria can be removed by clicking the Remove Criteria button.
+**Adding Search Parameters:**
+  * Function: Click "Add Field Criteria" button to expand search capabilities
+  * Purpose: Enables multi-parameter query construction for comprehensive contract filtering
+  * Flexibility: Supports unlimited criteria combinations for precise result targeting
+**Removing Search Parameters:**
+  * Function: Click "Remove Criteria" button to eliminate specific search parameters
+  * Application: Streamlines query refinement and modification processes
+  * Efficiency: Enables selective criteria removal without complete search reset
 {{:pasted:20240808-152230.png}}
@@ Line 34: / Line 163: @@
 {{:pasted:20240808-152256.png}}
-The contract search is a "Full Text" search.  Example:  If "Approve" is entered in the Header and search, the results will have "Approval", "Approved" as part of the contract header - in the below example the text is either in the Contract Name or Contract State column.
+The Contract Search system utilizes advanced full text search technology, enabling comprehensive content discovery through partial term matching and intelligent text analysis.
-The search results can also be filtered by entering text in box at the top of each column and clicking Enter on the keyboard.  To clear a filter, delete the text in the column search and click Enter.
+**Intelligent Text Matching:**
+  * Partial Term Recognition: Search terms automatically expand to include variations and derivatives
+  * Example Application: Entering "Approve" returns results containing "Approval," "Approved," and other related terms
+  * Content Location: Matching text appears across multiple data fields including Contract Name and Contract State columns
+  * Comprehensive Coverage: Search algorithm examines all relevant contract header information
+**Column-Level Filtering:**
+  * Filter Application: Enter specific text criteria in the search box located at the top of each results column
+  * Activation Method: Press "Enter" key to apply column-specific filters
+  * Precision Refinement: Enables targeted filtering within search results for enhanced specificity
+**Filter Management:**
+  * Clear Function: Delete text from column search box and press "Enter" to remove applied filters
+  * Dynamic Control: Real-time filter modification without requiring complete search restart
+  * Flexible Configuration: Independent filtering across multiple columns simultaneously
+**Enhanced Discovery:**
+  * Intelligent Matching: Full text capabilities reduce need for exact term knowledge
+  * Comprehensive Results: Pattern matching ensures relevant contracts are not overlooked
+  * Flexible Querying: Accommodates various search approaches and terminology preferences
+**Result Optimization:**
+  * Multi-Level Filtering: Combination of global search and column filtering provides precise result targeting
+  * User Control: Granular filtering options enable customized result presentation
+  * Efficient Navigation: Advanced filtering reduces manual review requirements
 {{:pasted:20170202-105337.png}}
 -----
-By default, only contracts in a Claimable status are returned - the default search criteria is set to Claimable equals True and the Claimable column defaults to True.  This includes contracts in Active, Approved or Expired status.  To see non-Claimable contracts, change the default search criteria to Claimable equals False or remove the default search criteria to return contracts in any claimable status.
+The Contract Search system automatically applies claimable status filtering to optimize results for standard business operations:
- The first column will still default to claimable = true, so change the filter on the grid column to false.  This will return contracts in Draft, Evaluation, Amended, Terminated or Cancelled status.  To see all contracts, select the blank option in the dropdown.
+  * Default Search Criteria: Claimable status set to "True"
+  * Column Filter Default: Claimable column configured to "True"
+  * Purpose: Prioritizes contracts available for active claims processing
+__**Claimable Contract Categories**__
+**Included Contract Statuses**: Claimable contracts encompass the following operational statuses:
+  * Active: Currently operational contracts
+  * Approved: Authorized contracts ready for implementation
+  * Expired: Concluded contracts still eligible for claims processing
+__**Non-Claimable Contract Access**__
+**Configuration for Non-Claimable Contracts:**
+  * Method 1: Search Criteria Modification
+  *   * Action: Change default search criteria to "Claimable equals False"
+  *   * Alternative: Remove claimable search criteria entirely to expand scope
+  * Method 2: Column Filter Adjustment
+  *   * Requirement: Modify grid column filter from "True" to "False"
+  *   * Result: Displays contracts in non-operational statuses
+**Non-Claimable Contract Categories:**
+  * Draft: Contracts under development
+  * Evaluation: Contracts pending review and approval
+  * Amended: Contracts undergoing modification
+  * Terminated: Contracts formally concluded
+  * Cancelled: Contracts that were discontinued
+__**Comprehensive Contract Viewing**__
+**All Contract Status Access:**
+  * Configuration: Select blank option in claimable status dropdown
+  * Result: Returns contracts regardless of claimable status
+  * Application: Enables comprehensive contract portfolio review and historical analysis
+__**Operational Benefits**__
+**Workflow Optimization:**
+  * Default Efficiency: Standard settings focus on actionable contracts
+  * Flexible Access: Multiple configuration options accommodate diverse business requirements
+  * Comprehensive Coverage: Complete contract lifecycle visibility when needed
 {{:pasted:20240808-152553.png}}
 -----
-The Contract Renewed column indicates whether a renewal exists for the Contract Family.  This displays True if the contract has a renewal and False if there is no renewal for the contract.
+__**Status Indicator Values**__
+**True Status:**
+  * Indication: Contract Family has an associated renewal agreement
+  * Business Implication: Demonstrates contract relationship continuity and ongoing business partnership
+  * Operational Value: Identifies contracts with established succession planning
+**False Status:**
+  * Indication: No renewal agreement exists for the Contract Family
+  * Business Implication: Contract represents a standalone agreement or terminal relationship
+  * Operational Consideration: May require proactive renewal planning or relationship management
+__**Contract Family Integration**__
+**Relationship Management:**
+  * Family Structure: Renewal status reflects relationships within the broader Contract Family framework
+  * Continuity Tracking: Enables identification of contract progression and business relationship evolution
+  * Strategic Planning: Supports contract lifecycle management and renewal forecasting
 {{:pasted:20240808-152616.png}}
@@ Line 51: / Line 266: @@
 -----
-When a contract is set up with a product grouping, you can find the contracts by product number using the following method:
+When contracts are configured with product grouping structures, the system enables precise contract identification through individual product number searches, providing granular access to grouped product relationships.
-  * Under the criteria filter-Criteria type=Product Number, Criteria operator=Exact, Criteria Value=(enter the product number)
-  * To further refine results, add the contractee name
+__**Search Configuration Parameters**__
+**Primary Search Criteria:**
+  * Criteria Type: Product Number
+  * Criteria Operator: Exact
+  * Criteria Value: Enter the specific product number for targeted search
+**Search Logic:** This configuration enables the system to identify contracts containing the specified product number, even when that product is part of a larger product grouping structure.
+__**Search Refinement Options**__
+**Enhanced Precision:**
+  * Additional Filter: Contractee Name
+  * Purpose: Further narrows search results to specific business relationships
+  * Benefit: Reduces result volume and improves search accuracy for targeted analysis
+**Implementation Steps:**
+  - Configure Product Search: Set criteria type to Product Number with exact operator
+  - Enter Product Identifier: Input specific product number in criteria value field
+  - Apply Contractee Filter: Add contractee name for enhanced result precision
+  - Execute Search: Process query to retrieve relevant contracts
+__**Operational Benefits**__
+**Product Grouping Navigation:**
+  * Granular Access: Locate specific products within complex grouping structures
+  * Efficient Discovery: Bypass manual grouping review for targeted product identification
+  * Relationship Mapping: Understand product-contract associations across business partnerships
+**Search Optimization:**
+  * Precise Targeting: Exact operator ensures accurate product identification
+  * Result Refinement: Contractee filtering eliminates irrelevant contract matches
+  * Operational Efficiency: Streamlined process for complex product grouping analysis
+{{:pasted:20241209-210538.png}}
 -----
-Click the hyperlink in the Contract ID field to view the Contract.
+__**Contract Access and Navigation**__
-__Search Criteria Options__:
+**Direct Contract Access:**
+  * Method: Click hyperlink within Contract ID field to access complete contract details
+  * Functionality: Provides immediate navigation to selected contract for comprehensive review
-Hover over the search criteria sections for a list of all searchable fields.  Examples are listed below:
+**Comprehensive Search Field Directory**
+Field Discovery Method: Hover over any search criteria section to display complete list of available searchable parameters for that category.
+________________________________________
-__Header__: Contract ID, Contract Name, Contract Status, Start Date, End Date, Contractee - Company Name and Company Number, Creator First Name, Creator Last Name, Contact Name, Contact Email, Contact Phone
+__**Search Categories and Available Fields**__
-__Product__: Product Name, Product Number, Grouping Description, Grouping Code
+**Administrative and Identification Fields:**
+  * Contract Identifiers: Contract ID, Contract Name, Contract Status
+  * Temporal Parameters: Start Date, End Date
+  * Contractee Information: Company Name, Company Number
+  * Creator Details: Creator First Name, Creator Last Name
+  * Contact Information: Contact Name, Contact Email, Contact Phone
-__LumpSum__: LumpSum Description, LumpSum Code, Contract LumpSum Description, Amount
+**Product and Grouping Parameters:**
+  * Product Identification: Product Name, Product Number
+  * Grouping Structure: Grouping Description, Grouping Code
+  * Application: Enables precise product-based contract identification
-__Distributor__: Company Name, Company Number, Grouping Description, Grouping Code, Address, City, State, Postal Code, Country
+**LumpSum/Fixed Payment Parameters:**
+  * LumpSum Identification: LumpSum Description, LumpSum Code
+  * Contract Integration: Contract LumpSum Description, Amount
+  * Purpose: Facilitates lumpsum-specific contract searches
+**Distribution Partner Parameters:**
+  * Company Information: Company Name, Company Number
+  * Organizational Structure: Grouping Description, Grouping Code
+  * Geographic Data: Address, City, State, Postal Code, Country
+  * Application: Enables distributor-focused contract analysis
+**Client Defined Field Search Capabilities:**
+  * Data Type Support: Boolean, numeric, date, and list value searches
+  * Boolean Values: Enter "true/false" for checkbox field states
+  * Flexible Configuration: Accommodates client-specific field requirements
+  * Custom Integration: Searches values within client-defined field structures
+__**Operational Benefits**__
+**Comprehensive Search Coverage:**
+  * Multi-Dimensional Access: Search across all contract components and relationships
+  * Flexible Querying: Diverse field options accommodate various business requirements
+  * Precision Targeting: Extensive field library enables highly specific contract identification
-__Client Defined Fields__: This section searches on the values of the Client Defined Field - so if there is a checkbox, enter true/false for checked/unchecked.  It also searches number values, date values and list values.
 -----
-NOTE: For brand new contracts that have just been entered, a wait of 2 hours maybe needed to return contracts.  This is necessary to improve performance on the search screens.  After the data refresh, all fields noted on the search criteria options list will become searchable for the new contracts.
+Newly created contracts require a system data refresh cycle of approximately two hours before becoming fully searchable across all available criteria fields.
+**Performance Optimization Rationale:**
+  * System Efficiency: Data refresh intervals optimize search screen performance and response times
+  * Resource Management: Scheduled indexing prevents system overload during peak usage periods
+  * User Experience: Balanced approach ensures consistent search performance across the platform
-The following are lists of fields that can be searched on immediately without needing a complete data refresh:
+**Complete Search Integration**: Following the data refresh cycle, all fields listed in the search criteria options become fully searchable for newly created contracts, ensuring comprehensive search capability.
+________________________________________
-Contract Sequence
+__**Immediate Search Capability Fields**__
-Contract Version ID
+The following contract fields are immediately available for search functionality without requiring data refresh cycles:
-Contract Type
+**Core Contract Identifiers:**
+  * Contract Sequence: Unique contract sequence identifier
+  * Contract Version ID: Specific version identification number
+  * Contract Type: Contract classification and category
+  * Contract Name: Primary contract designation
+  * Contract State: Current contract status
+  * Contract Template Description: Template-based contract description
-Contract Name
+**Immediate Search Requirements:**
+  * Urgent Contract Location: Utilize immediate search fields for time-sensitive contract identification
+  * Basic Contract Discovery: Core identifiers provide sufficient information for initial contract location
+  * Workflow Planning: Account for data refresh timing in contract creation and search workflows
-Contract State
+**Comprehensive Search Planning:**
+  * Advanced Queries: Schedule detailed searches after data refresh completion for full field availability
+  * Complete Analysis: Utilize two-hour window for comprehensive contract data preparation
+  * System Optimization: Understand refresh cycles support overall platform performance
-Contract Template Description
 -----
 **State Modified Column**

Telus TPM Documentation

User Tools

Site Tools

Differences

Page Tools