Telus TPM Documentation

This is an old revision of the document!

---

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.

---

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

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

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

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

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

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

Refer to the Legend for specifics on how to perform And, Or, Not, Prefix, or Grouping searches. Click on the Legend dropdown arrow to open the legend.

The Contract Search system utilizes advanced full text search technology, enabling comprehensive content discovery through partial term matching and intelligent text analysis.

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

---

The Contract Search system automatically applies claimable status filtering to optimize results for standard business operations:

• 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

---

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

---

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.

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:

1. Configure Product Search: Set criteria type to Product Number with exact operator
2. Enter Product Identifier: Input specific product number in criteria value field
3. Apply Contractee Filter: Add contractee name for enhanced result precision
4. 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

---

Contract Access and Navigation

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

Comprehensive Search Field Directory Field Discovery Method: Hover over any search criteria section to display complete list of available searchable parameters for that category.

Search Categories and Available Fields

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

Product and Grouping Parameters:

• Product Identification: Product Name, Product Number
• Grouping Structure: Grouping Description, Grouping Code
• Application: Enables precise product-based contract identification

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

---

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.

The following are lists of fields that can be searched on immediately without needing a complete data refresh:

Contract Sequence

Contract Version ID

Contract Type

Contract Name

Contract State

Contract Template Description

---

State Modified Column

This column displays in all Contract Search grids (Draft, Expiring, etc) and displays the last date that the contract was modified or the last date of a state change.