Getting Started with DeskDirector
DeskDirector Portals
Browser Support
What is the DeskDirector Admin Portal?
What is the DeskDirector Tech Portal
What is the DeskDirector Client Portal?
Desktop Portal
Managing Your Account
Admin Essentials
DeskDirector Features Overview
Logging in to DeskDirector
User Profiles & Profile Pictures
Managing Tickets with DeskDirector
Office Hours
Getting Started with the Solution Library
How Searching Works
Embedding Help Page Media
Get started with the DeskDirector Power Automate Connector
Features
Portal Customization
Forms
Service Catalogue
Communication
Email Connectors
Notifications
Email Notifications
Actionable Messages for Emails
Real-Time Chats
Email Template Engine
Surveys
Broadcasts
Generative AI
DeskDirector with Generative AI
Ticket Summary for TECH Portal
Setting up AI Service Providers
Microsoft Foundry for DeskDirector
Knowledge Bases for AI Assistants
Custom Tools for AI Assistants
AI Assistants in DeskDirector
Advanced
Login & Authentication
Contact Groups
Custom Domains
File Storage
Dashboard
Accounts
Contacts
Approvals
Tags
Task Lists
The Learning Center
Portal Deep Linking
Auditing & Analytics
Microsoft Power Automate
Actions
Solutions
Featured Solution: Teams Ticket Discussion
Power Automate Template Gallery
Featured Solution: Ticket Briefing
Power Automate Administration
DeskDirector Power Platform Connector Reference
Power Automate Connector - Setting up your first flow
Microsoft Teams App
Introducing the DeskDirector for Microsoft Team App
Installing the Microsoft Teams App (Client Mode)
Installing the Microsoft Teams App (TECH Mode)
Setting up Tags for Teams Discussions (TECH Portal)
Branding the DeskDirector Teams App
DeskDirector Teams App Notifications
Contact Groups Integration with Microsoft Teams
Setting up Content Security Policy (CSP)
Advanced topic: Setting up Tech & Client Mode in the same tenancy
Integrating Microsoft Teams with DeskDirector Tech Portal
Smart Alerts for TECH Users
Integrations
Developer Resources
Getting Started
What is the Toki Iti API
API Versions & Routes
Roles & Scopes
Authorization Options
Querying the API
How to Change an Entity Through the API
API Key Authorization
OAuth Fundamentals
Understanding OAuth for Tokity Integrations: Key Concepts
OAuth Authorization Code Flow: How an App Gets Access to Tokity
OAuth App Registration
How to Register an OAuth App to Integrate with Tokity
Choosing an OAuth App Type: Confidential vs. Public Apps and Client Secrets
OAuth Personal Secrets: What They Are and When to Use Them
OAuth Administration
Configuring OAuth Settings in Tokity
Managing OAuth Authorized Sessions and User Consent
Granting OAuth Admin Consent at the Root Level
API Response Control
Uploading Attachments (Ticket API)
The Prefer Header — Overview
Controlling Returned Data (Ticket API)
Controlling Returned Data (Form Result API)
Controlling Returned Data (Workspace API)
Workspace Ordering
How Workspace Ordering Works
Creating and Reordering Workspace Groups
Adding and Reordering Tickets in a Workspace Group
Data Sync & Notifications
Delta API: Tracking Changes Over Time
Webhooks vs. Events — Differences, When to Use Which
Verifying Webhook and Event Payloads (HMAC Signature)
Ticket Widgets
Ticket Widget: Overview
How the Widget Is Requested
Ticket Widget Anatomy and Styling
Ticket Widget Actions: Leading, Secondary and Primary
Ticket Widget: Progress Type
Ticket Widget: List Type
Ticket Widget: Description Type
Ticket Widget: Form Type
Ticket Widget: Control When a Widget Refreshes
Ticket Widget: Form Results and State Across Steps
Ticket Widget: Error Responses and Debugging
Ticket Widget: Building a Multi-Step Request
Glossary
Security
Troubleshooting
Troubleshooting via Web Developer Tools
Permissions & Access - Common Issues
Contact DeskDirector Support
Troubleshooting DeskDirector Connection Issues
Desktop Portal - Common Issues
Contact Impersonation
Approvals - Common Issues
Microsoft Teams App - Common Issues
Email & Email Delivery - Common Issues
Login & Authentication - Common Issues
DeskDirector Desktop App - Installation Issues
Table of Contents
- All Categories
- Getting Started with DeskDirector
- How Searching Works
How Searching Works
Updated
by Niamh Ferns
How Searching Works in DeskDirector
In all products DeskDirector has created, we use full-text search for all list interfaces. Compared to traditional approaches that check whether an item contains or starts with a search term, full-text searching provides better flexibility and an overall cleaner user experience.
For more info regarding this technology, you can check out this Wikipedia page.
How do indexing and tokenisation work?
For each collection, we will mark a few properties as query fields (for example, the name, description, or content). The information within will be tokenised and indexed by the database. When searching, we search based on tokens instead of a full sentence and will search against the tokenised query fields in the DeskDirector database.
Basic tokenisation splits information by spaces, special characters, and new lines. All tokens are case-insensitive.
Input string of text:
The quick brown fox jumped over the lazy dogs, Bob@hotmail.com 123432.
Output tokens:[quick] [brown] [fox] [jumped] [over] [lazy] [dog] [bob@hotmail.com] [123432]How does the system determine the most matched object?
When DeskDirector analyses search terms, it will tokenise the search string. It will match on two different criteria, and ones with the highest ratings will be returned near the top of your results.
- Any token that's exactly matched will give a rating of 2
- Any token that starts with the search term will give a rating of 1.
- A repeat match will increase its total rating.
For example, we have two users with the following names.
Jamison Knight / jknight@example.com from Euro Health CenterJamison Coon / jamison@secondcompany.com from Europtimum
Scenario:
Search term: Euro Jamison will give a rating of 4 for Jamison Knight and a rating of 3 for Jamison Coon. Since Jamison Coon only has a starts-with match with Europtimum, while Jamison Knight has an exact match with Euro.
What kind of terms can we use for different collections?
DeskDirector has put a lot of effort into analysing the important fields that should be included in the index. These are:
- Account: name, identifier
- Contact: first name, last name, primary email, secondary emails, title, email domain.
- Service Agent: first name, last name, primary email, secondary emails, identifier
- Ticket: title, initial description, identifier
Frequently Asked Questions
"How many terms can we include in a search?"
Same as many other full-text search implementations. You can include as many terms as you like. You can even type in a full sentence.
"Why can't we add sorting to the search results?"
Sorting of search results will often lead to confusion and unexpected results. For example, if sorting results by text, then higher-rated results could end up on page 2 or 4.
This is also why services like Google don't allow sorting.
"When I search contacts, there are results from different companies. How do I improve accuracy?"
You can add an email as an addition to an existing search term, or you can also add a company filter. That way, only contact from that company will be returned.
"How come there are many false positives?"
Full-text searching is likely to retrieve many documents that are not relevant to the intended search question. Such documents are called false positives. They often appear at the end of search results, where they are partially matched with search terms.