Product Search

Basic and advanced search queries in the Product Catalog help you quickly filter and find products and agreements. You can search by fields such as name, type, status, and category. In advanced searches, you can use Boolean operators and wildcards. The mini search field at the top of each page provides quick access to different products from anywhere in the Product Catalog.

Mini Search for Products

The mini search for products enables you to do a quick search on the Product Name from any page in the Product Catalog. You can enter the exact name or a partial name.

If you enter a partial name, the mini search finds up to 10 product names that contain the string you entered. Boolean operators and wildcards do not work with this type of search. Select a product from the search results list to open the corresponding Product Information page.


Using Search

The Search field enables you to perform basic and advanced searches for products on the Products page and for agreements on the Agreements page.

To search, enter a search string in the Search field, then click Search or press Enter.

The Search drop-down menu displays the top five most suitable results and the Products or Agreements table displays all search results. If you don't enter a search string, all product or agreement records are displayed in the table. If there is only one search result, the Product Information or Agreement Information page displays product or agreement details.

Note: Search is not case-sensitive, so entering the string Sub or sub will find the same results.

In addition to the five most suitable results, the search menu also displays the following:

  • Browsing History—Select from your five most recent queries.
  • Recently Viewed—Select from up to five recently viewed products or agreements, shown by ID and name.
  • Quick Search—Perform a quick search for recently created products or agreements, or those in Draft status.

Searching for Recently Created Items

This quick search displays all products or agreements created in the last 10 days. The following query is used:

created_on:>now-10d

You can replace the default value of 10 to change the number of days. For example, enter 14 instead of 10, then click Search to find items created in the last two weeks.

Searching for Draft Items

This quick search displays all products or agreements in Draft status. The following search string is used:

status:DRAFT

Basic Search

A basic search looks for your search string in all fields listed in the table below. If your search string is found anywhere in those fields, then that product or agreement record is returned in the results. This type of search can return many records.

Search For Fields Searched
Products Product Name
Type
Status
Category
Internal Name
External Name
SKU
Agreements Agreement Name
Period Type
Status
Renew Action
Adjustment Category

Advanced Search

An advanced search looks for your search string in specific product or agreement fields and can therefore return more specific results. The search string can consist of terms, wildcards, and operators. You can also use signs such as greater than (>), less than (<), plus (+), and minus (-).

Terms can include single words or phrases. Use quotation marks when you want to search for a specific phrase. For example, the search term one time finds one time, one-time, One-Time, and one timer; however, "one time" finds one time, one-time, and One-Time, but not one timer.

Using Wildcards

You can use a wildcard character to stand for part of a term. This can help you find multiple records with similar but not identical information, or when you don't remember the exact term.

Character Description Example
* Stands for zero or more characters. You can use it anywhere in the string. 9* finds products named 97_sub, 98_one, and 99_add.
? Stands for a single character in a specific position in the string. 9?_prod finds products named 97_prod, 98_prod, and 99_prod.

Using Operators

You can combine multiple terms with Boolean operators to form a more complex query. Operators must be in CAPITAL letters in search strings. You can use the following operators:

Operator Description Example
AND Finds records that contain both terms. 1 AND month finds records that include both 1 and month.
OR Finds records that contain either term. If you don't include an operator between two terms, the OR operator is used by default. 1 OR month finds records that include 1 or month, such as 1 Month, 1 Year, Sub-1, month end. 1 month finds the same records.
NOT Excludes records that contain the term after NOT. 1 NOT month finds records that include 1 but not month, such as 1 Year and Sub-1, but not 1 month.

Searching by Date

You can search for products and agreements by associated dates. The following date formats are supported:

  • mm/dd/yyyy—For example, 06/30/2021
  • yyyy-mm-dd—For example, 2021-06-30
  • yyyy-mm-dd hh:mm:ss—For example, 2021-06-30 11:59:59

Queries can include any of the following keywords:

Keyword Description
d Days
H, h Hours
m Minutes
M Months
now Current date
s Seconds
w Weeks
y Years

For example:

Query Description
product_from:2020-01-01 Finds products with an Introduction Date of January 1, 2020.
product_from:<now Finds products with an Introduction Date earlier than now.
product_from:>2020-01-01 Finds products with an Introduction Date after January 1, 2020.
product_from:[2020-01-01 TO 2021-01-01] Finds products with an Introduction Date that ranges from January 1, 2020 to January 1, 2021.
product_from:{* TO 2021-01-01} Finds products with an Introduction Date before January 1, 2021.
product_from:{now TO 2022-01-01} Finds products with an Introduction Date that ranges from now to January 1, 2022.

Searching for Products

You can perform an advanced search for products by entering key-value pairs, consisting of a search key and the value you're looking for, separated by Boolean operators. You can combine several search keys in a single query, for example:

  • type:SUBSCRIPTION AND status:ACTIVE
  • product_category_name:“Default Category” AND product_from:01/01/2021
  • product_sku:“TES-1-B-1” OR product_name:“Sample Product”

Queries can include any of the following search keys. Possible values are listed where applicable.

Product Search Keys

Table Column Search Key Possible Values
Product Name product_name
Type type SUBSCRIPTION
ONETIME
ADDON
Status status ACTIVE
DRAFT
DEACTIVATED
Category product_category_name
Introduction Date product_from
SKU product_sku
Internal Name internal_name
External Name external_name

Searching for Agreements

You can perform an advanced search for agreements by entering key-value pairs, consisting of a search key and the value you're looking for, separated by Boolean operators. You can combine several search keys in a single query, for example:

  • end_action:SERVICE_ONLY AND agreement_period_type:MONTH
  • status:ACTIVE AND end_action:DEACTIVATE_SERVICE
  • adjustment_category_name:“Default Category” OR adjustment_category_name:“Sample Category”

Queries can include any of the following search keys. Possible values are listed where applicable.

Agreement Search Keys

Table Column Search Key Possible Values
Agreement Name name
Status status Active
Draft
Suspended
Period Type agreement_period_type Month
Day
Renew Action end_action RENEW_AGREEMENT
SERVICE_ONLY
CPQ_MANAGED
DEACTIVATE_SERVICE
Adjustment Category adjustment_category_name