From ICIHelp8.2
Revision as of 09:27, 11 April 2019 by IDT-3 (Talk | contribs)

Jump to: navigation, search

Searching Agreements and Requests

You can search Agreements and Requests using Advanced search or from their respective pages (Agreements Page, Requests Page). You may want to search Agreements and Requests for one of the following reasons:

  • View its details
  • See its status
  • Copy an existing Agreement
  • Make changes to it

The process for searching any entity (Agreements, Contract Types, Requests, Clauses, and so on) is identical. ICM provides the type ahead feature for search facets so that the results displayed are filtered while you are typing, thus enabling you to quickly arrive at the desired value. You can type in the text box between the search facet drop-down and the list of facet values, and ICM will display all the matching values which start with the typed content. The type ahead feature works as the Contains operator for the sake of consistency and ease-of-use. 

This search is case-insensitive and ICM displays all the values of the specified facet Attribute and not just the top 1000 values. You can filter the search facet values, select one or multiple of these by checking the relevant checkboxes, and then again select another facet attribute and continue the process to apply multiple facet filters. As soon as you select another facet attribute, the textbox is refreshed. This feature is applicable to the following data types – String, User, Auto, Email, and URL. It is enabled on all search pages, including Index pages, Advanced Search page, Lookup Search page, and so on.

Type Ahead Feature for Search Facets

You can find a specific Agreement from the Agreements Page using any of the following searches:

  • Free Text Search
  • Category Search
  • Saved Search
  • Index Page Search

Free Text Search

The operators Contains and Exactly on all search pages in the horizontal Search bar help the users in easy and quick searching. The operator Contains is the existing functionality, whereas Exactly is a new operator.

The operators in the horizontal search bar include:

1.Select the Entity to search.

2.Select any one operator to search by from the drop-down list. You must enter a minimum of 3 characters to search by. On searching using just one or two characters, ICM displays a validation message prompting you to enter at least 3 characters. These fields are case-insensitive, hence characters may be entered in upper and/or lower case.

Free Text Search with Operators

The following operators are available:

  • Contains: displays all the Agreements where the entered value appears anywhere in the free text search results. If you enter a string (multiple words), ICM considers the exact string including the spaces entered between these words. The functionality is the same as the existing one and you can perform a search using * or other wildcard search characters as well as the AND, OR operators manually. The default behavior among the entered words will remain as AND.
  • Exactly: works the same way asContains of the Custom Keyword search discussed above. The only difference is that Exactly in Free Text search searches for the exact match across Attributes of Agreements, user-defined Associations and system-defined Associations, whereas in Custom Keyword, it searches only in that specific Attribute. If you enter a string (multiple words), ICM considers the exact string including the spaces between these words. The functionality is the same as the existing one and you can perform a search using * or other wildcard search characters as well as the AND, OR operators manually. The default behavior among the entered words will remain as AND.
Note: The above values are configurable as per your requirement in terms of names, their sequence in the dropdown, and their default value.

 

Category Search

To search for Requests using the Category drop-down list:

1.Click the Agreement Management tile on My Dashboard. The Agreements Page opens, which displays all the existing Agreements.

2. Use the Categories drop-down list to filter the Agreements and find the exact match that you are looking for. For example, search by Status, Created By, Date, and so on. All options that match the selected category are displayed.

3. Select the desired criteria by selecting the boxes next to that option. Agreements that match these specified criteria are displayed.

Agreements page

4. Filter your search further by typing specific keywords in the Custom Keyword field and then click Apply. You can use Boolean operators such as AND/OR or search by wildcards to filter the results. For example:

  • APP* - displays agreements only in the APPROVED and WAITING FOR APPROVAL states
  •  ?PP* - displays agreements only in the APPROVED and WAITING FOR APPROVAL states
  • APP* OR DRA* - displays agreements only in the APPROVED, WAITING FOR APPROVAL and DRAFT states

5. You can also type free text in the Refine Search Here... search box. A list of relevant agreements is displayed.

The operators Contains and Exactly on the search pages in the horizontal search bar help the users in easy and quick searching. The operator Contains is the existing functionality, whereas Exactly is a new operator.

Free Text Search operators

The operators in the horizontal search bar include:

1. Select the Entity to search.

2. Select any one operator to search by from the drop-down list. You must enter a minimum of 3 characters to search by. On searching using just one or two characters, ICM displays a validation message prompting you to enter at least 3 characters. These fields are case-insensitive, hence characters may be entered in upper and/or lower case.

The following operators are available:

  • Contains: displays all the Agreements where the entered value appears anywhere in the free text search results. If you enter a string (multiple words), ICM considers the exact string including the spaces entered between these words. The functionality is the same as the existing one and you can perform a search using * or other wildcard search characters as well as the AND, OR operators manually. The default behavior among the entered words will remain as AND.
  • Exactly: works the same way as Contains of the Custom Keyword search discussed above. The only difference is that Exactly in Free Text search searches for the exact match across Attributes of Agreements, user-defined Associations and system-defined Associations, whereas in Custom Keyword, it searches only in that specific Attribute. If you enter a string (multiple words), ICM considers the exact string including the spaces between these words. The functionality is the same as the existing one and you can perform a search using * or other wildcard search characters as well as the AND, OR operators manually. The default behavior among the entered words will remain as AND.
Note:The above values are configurable as per your requirement in terms of names, their sequence in the dropdown, and their default value.

 

Ability to Specify a Date Range on Facet Search

You can search Agreements within a specified date range using the Calendar picker in the search facets. This greatly enhances the usability of ICM for the business users.

To do this:

1. Select a date filter (such as Created Date, Expiration Date, Effective Date) from the facet search drop-down in the Categories section of the Agreement Management page.

2. Enter the specific date range and advanced date range:

  • Select the Specific Date Range to select the date in the yyyy-mm-dd format using the Calendar icon.
  • Select the Advanced Date Range and add the custom range with the following syntax indicating the duration (integer and unit).
Specify the relative time as follows:
  • now: to indicate the current time.
  • now plus (+) or minus (-): to begin your string and indicate the offset of the duration of time.
  • a number and a unit: where, the number is implied on specifying time duration. For example, d is same as 1d and M is the same as 1M.
  • Supported time units:
    • y: year, w: week of week year, d: day of the month, M: month of the year. For example: now-1y, now+2w, now-5d, now+2M.
    • h: number of hours (0~23), m: minute of the hour, s: second of the minute. For example: now-2h, now-30m, now+55s.
    Specify Date Range on Facet Search.png
     
    An elaborate Help text on the user interface is available to explain how to specify the date range.
     
    Help Text on Date Range of Facet Search.png

     

    Saved Search

    Follow these steps to use your saved searches:

    1. Click the Agreement Management tile on My Dashboard. The Agreements Page opens, which displays all the existing agreements.

    2. Click the Saved Searches drop down and select the desired saved search. Refer to Using Advanced Search for details on saving a search. The agreements that match your search criteria are displayed.

    Refer to Saved Searches for details on saving a search.

    Index Page Search

    Search functionality includes a drop-down of operators in the Custom Keyword box below the facet list. This is available on all Search pages except the Advanced Search page and helps the users in quick and efficient search. The operators include:

    • Contains: This is an existing functionality in Custom Keyword search.
    • Exactly: This is a new operator.
    • Starts With: This is a new operator.

    This is applicable for the following data types – Auto, Email, String and User.

    Index Page Search

    To perform a Search using the Custom Keyword drop-down:

    1. Select the Entity to search.

    2.Select any one operator to search by from the Custom Keyword drop-down list. You must enter a minimum of 3 characters to search by. On searching using just one or two characters, ICM displays a validation message prompting you to enter at least 3 characters. These fields are case-insensitive, hence characters can be entered in upper and/or lower case.

    The following operators are available:

    • Contains: displays all Agreements where the selected Attribute facet value contains the entered value anywhere in the Attribute value. The functionality is the same as the existing one and you can perform a search using * or any other wildcard search characters as well as the AND, OR operators manually. The default behavior among the entered words will remain as AND.
    Index Page Search - Contains operator
    • Exactly:displays all the Agreements where the selected Attribute facet value exactly contains the entered value anywhere in the Attribute value. If you enter a string (multiple words), ICM considers the exact string including the spaces between these words.
    Index Page Search - Exactly operator
    • Starts With: displays all Agreements where the selected Attribute facet value starts with the entered value. If you enter a string (multiple words), ICM considers the exact string including the spaces entered between these words.
    Index Page Search - Starts With operator
    • Let’s see some examples:
      • If you select Customer name as search facet, and enter Icertis Canada in the custom keyword box, then ICM searches Agreements where the customer name Attribute value starts withIcertis Canada, such as, Icertis Canada Products Ltd, Icertis Canada Services Ltd, and so on. ICM does not display Agreements where customer name is Icertis Europe Products Ltd, Canada Interactive Ltd or Icertis Advanced Systems Canada Ltd.
      • If you search Icertis Can*, ICM does not display any results unless there is really an Agreement with a customer name starting with Icertis Can*. Thus, ICM matches the exact entered value and checks if there is any Agreement where customer name starts with exactly the same value and will display only results that exactly match.
      • If you search using quotes, such as “Icertis” or ‘Icertis’, ICM displays Agreements where the customer name actually has “Icertis” or ‘Icertis’ values respectively. Thus, ICM does not display any results, unless there is really any Agreement where the customer name was entered with single or double quotes.
    Note: The above values are configurable as per your requirement in terms of names, their sequence in the dropdown, and their default value.

     

    Searches pinned as Favorites

    Follow these steps to search using a favorite search:

    1. Click the Agreement Management tile on My Dashboard. The Agreements Page opens which displays all the existing Agreements.

    2. Click one of the searches defined as favorite, just below the feature tiles. Refer to Using Advanced Search for details on adding searches as favorites. The  Agreements that match the criteria  in your favorite search are displayed.

     

    Related Topics: Advanced Search  |  Saved Searches  |  Agreements Page