Versions Compared

Old Version 8

changes.mady.by.user Michelle Cabaya

Saved on

compared with

New Version 9

changes.mady.by.user Michelle Cabaya

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Requires X Dispatch 20.0 or newer.

Table of Contents
excludeExample

Find(BETA) allows you to create basic and advanced queries to help find information in X Dispatch. These queries can be saved along with the ability to download advanced queries that have been created by CXT Software.

Info

The Find permissions are required to use Find(BETA). SeePermissions.

In the X Dispatch toolbar, click Find (BETA).

Basic Finds and Advanced Finds

The Basic Find and Advanced Find tabs allow you to create, save, or execute saved queries.

Use Saved Query

Use the Use Saved Query section to search or select a favorite query to execute.

Field Name

Description

Find Search

Click this field to select from a drop-down or begin typing to search for a saved find.

Favorites

Click this field to select from a drop-down or begin typing to search for a favorite find.

Image Modified

Visible when using a saved query.

Click the star to save the query as a favorite.

Query Criteria

The Query Criteria section helps create a query.

For Basic Find

Use the following fields to help create a query.

Field Name

Description

Find

Select what you would like to search for.  The Basic Find allows you to pick from the following:

  • Address

  • Customer

  • Contract Stops

  • Driver

  • Order

  • Recurring Order

  • Route Stop

  • Task

Where

Select the field name of the data you would like to search for.  The list of fields will vary depending on what you have selected for Find.

Operator

Select an operator for your search criteria.  The Basic Find allows you to pick from the following:

  • Begins With

  • Contains

  • Equals

  • Does Not Equal

The following are available operators if Where are number or date values.

  • Greater Than

  • Greater Than Or Equal To

  • Less Than

  • Less Than Or Equal To

Value

Enter or select the value for the search criteria you are looking for.  Depending on what you are searching for, this field can accept a number, date, or text. 

And/Or

If you need to add additional search criteria, you can select AND or OR.  

Example

You want to only show the orders placed yesterday for a customer.

Image Modified
Image Modified
Info

Requires X Dispatch 21.0 or newer

Click the red X on the right side of the search screen for any lines of criteria you would like to remove.

Add Additional Criteria

Click to add additional search criteria.

Info

For X Dispatch 20.0 or older, you can add only 2 additional criteria for a total of 4 search criteria.

For Advanced Find

Click the Query Builder icon next to SQL Text to open the Query Builder form.

Image RemovedImage Added
Query Builder

Enter the SQL statement you would like to use for your Advanced Find in the SQL Text field. You can use the filters below to help create the SQL statement by filtering the SQL syntax, database table, and column (this is populated based on the database table selected).

Save Query

Save a query you have created or altered in the Save Query section.

Save New

If it is a new query, enter a Filter Name, select a Filter Group, and click the Save icon. If a Filter Group is not selected, the saved query will default to the Unassigned group folder.

Save Changes

To save changes to an existing query, click the Save icon.

Note

Making changes here to a saved query will overwrite the query.

Field Name

Description

Filter Name

Name of the query.

Filter Group

The group that the query is/will be assigned to.

Description

Description of the query.

Save As Favorite

If checked, the query will be saved as a Favorite.

Query Options

You can select how the Find results will be displayed.

Field Name

Description

Max Records

The maximum number of records returned in the results.

Note

Max Records is a required field, and a value between 1 and 32000 must be set for results to be returned.

Report Formats

Optional. Selected report format for the results.

Allow Text Wrap

When enabled, allow text to flow to the line below so that all the data is visible.

When disabled, text is displayed in one line and all data may not be visible.

Query Result Options

After you have run a successful query, you will have a few additional options in the icon bar above the results.

Icon

Description

Image Modified

Export the results to CSV, JSON, TEXT, XLS, or XLSX format.

Image Modified

Opens the Bulk Rate Update form to make bulk rating, or driver pay adjustments to the orders or route stops in the result set. See Bulk Rate Update.

Available when results are related to orders or route stops.

Image Removed

Image Modified

Opens the Adjust Stop Times form to make bulk changes to the Min, Max, and Preferred times of stops in the returned result set.

Available when results are related to contract or route stops.

Image Modified
Image Modified

Run associated reports for the selected Saved Query.

Available when a report is associated with the selected Saved Query.

Image Modified

Open the Email Find Results form to email the query results.

Note

You must have set up a message format with the Message Type of “Email Find Results” set up.

Image Modified

Open the Select Visible Columns form to hide and/or reorganize columns for the query results.

Info

For X Dispatch 21.0 or newer, if a Saved Query was ran, this will be applied to all future query results, exports, and subscriptions associated with the Saved Query.

Saved Query Filters

The Saved Query Filters tab allows you to view and edit saved queries.

Tip

Quick Tips:

  • Click + below the search filter to expand all folders.

  • Double click a query to open in the appropriate tab.

Filter

Type in the Filter field to search for save queries. This search uses a type ahead feature which filters the results below as you type.

How to Create a New Group Folder

Click the green + button on the right to create a new folder.

How to Edit a Group

Click on a group to edit the group name or delete a folder.

Note

All queries in the deleted group will be moved to the Unassigned group.

How to Edit a Saved Query

Tip

Quick Tip: Drag and drop saved queries into different folders to move them.

Click on a query to open the edit form.

Field Name

Description

Name

Name of the query.

Group

The group that the query is/will be assigned to.

Description

Description of the query.

Image Modified

Click this button to execute the find.

Image Modified

Click this button to subscribe to the find.

How to Activate/Deactivate a Saved Query

Info

Requires X Dispatch 21.0 or newer.

  1. Click on the query to open the edit form. Deactivated saved queries can be found in the “Deactivated” folder.

  2. Click the Activate (+) or Deactivate (-) button at the bottom of the form.

  3. Click the Save button.

Advanced Find Service

The Advanced Find Service is a list of downloadable reports and queries created by CXT Software.

Finds

CXT Software provides many free finds that can be downloaded into your X Dispatch reporting service in the Finds tab.

Field Name

Description

Title

Name of the find.

Status

  • New Version Available - There is a new version of the find.

  • Available For Download - A find that is not in your system.

  • Up-To-Date - The find is current.

Action

Image Modified

Click the download icon to download the find.

Report Formats

QuickBooks exports, driver manifests, shipping labels, and other reports can be found in the Report Formats tab.

Field Name

Description

Title

Name of the report.

Status

  • New Version Available - There is a new version of the report format.

  • Available For Download - A report format that is not in your system.

  • Up-To-Date - The report format is current.

Action

Image Modified

Click the download icon to download the report format.