Skip to content

Commit

Permalink
[DOCS-7420] Enable Advanced Search in Attribute Search (#1255)
Browse files Browse the repository at this point in the history
* [DOCS-7124] Update Content Accelerator install configuration steps
* [DOCS-7420] Enable Advanced Search in Attribute Search
* [DOCS-7420] Add missing image files
* Update user-guide.md

Include review suggestions

* [DOCS-7420] UA review for user-guide.md

---------

Co-authored-by: Adelaide Nxumalo <[email protected]>
  • Loading branch information
Prosune and anxumalo authored Dec 15, 2023
1 parent 1238390 commit 77e349d
Showing 1 changed file with 65 additions and 1 deletion.
66 changes: 65 additions & 1 deletion content-accelerator/latest/using/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -1145,7 +1145,10 @@ you to search for all possible documents in the repository.
* The red box labeled `1` outlines the object type selector box. Here, you can choose between searching for Claim Folders or Claim Documents. Currently, we are searching for claim documents, as 'Claim Documents' is selected in the dropdown.
* The orange box labeled `2` outlines the saved search input box. Before searching, you can select a pre-saved search from the dropdown list. A saved search stores the values of the previous form into an easy-to-remember text the user can define. This can save you from reentering all the criteria for searches you use everyday. To save a new search, type in the criteria for the search, execute the search, click the plus icon within the saved search input box, and input what you would like your search to be called. You can manage your saved searches from the User Preferences page.
* The dark blue box labeled `3` outlines the full text search box. This field consists of two parts, the input box and the search button. The input box is where you enter any text that could match any property. The returned claims will have at least one property that matches the input text exactly. The button on the right of the box will execute the search. Additionally, the search button at the bottom of the form and the enter key will also execute the search.
* The pink box labeled `4` outlines the attribute search tab. Within this tab, you can add criteria for properties you wish to search. Some properties' criteria can be selected from a dropdown or date picker. Others, such as Claim Number, need to be entered in manually. The results will return all items that match any part of the criteria for the respective property. If the property you wish to search on does not appear, check the more fields section at the bottom of the attribute search tab. Note that not all claim properties will appear in the form.
* The pink box labeled `4` outlines the attribute search tab. Within this tab, you can add criteria for properties you wish to search. Some properties' criteria can be selected from a dropdown or date picker. Others, such as Claim Number, need to be entered in manually. The results will return all items that match any part of the criteria for the respective property. If the property you wish to search on does not appear, check the more fields section at the bottom of the attribute search tab. You can enable advance search capabilities in Attribute Search. See the next section for additional information on enabling [Advanced Search capabilities with Attribute Search](#advance-search-capabilities-with-attribute-search).

> **Note:** Not all claim properties will appear in the form.
* The light blue box labeled `5` outlines the filters tab. After a search has already been run, this tab will populate with filters based on the result.

![Img Txt]({% link content-accelerator/images/aca-userguide-claims-mgmt7.png %})
Expand All @@ -1154,6 +1157,67 @@ you to search for all possible documents in the repository.

* The purple box labeled `6` is where you can submit your search form, executing the search. This can also be done by clicking the search button in the full text search input box or by hitting the enter key while within the form. Clicking the reset button empties all previous entered criteria in the form without running another search.

### Advance Search capabilities with Attribute Search

Attribute Search includes the option to configure Advanced Search capabilities within the search form. To enable advanced capabilities in attribute search, navigate to the Attribute Search config in the Alfresco Content Accelerator Admin. By default, the values are set to `Disabled`:

To enable advanced capabilities in attribute search, complete the following steps.

1. Navigate to the Attribute Search config in the Alfresco Content Accelerator Admin and set the value of the Show Advanced Search parameter to Enabled. By default, the value is set to Disabled.

![Advanced Search configuration]({% link content-accelerator/images/aca-show-advanced-search-config.png %})

2. After you enable Advanced Search, you can enable the following configuration settings:

* Enable Any/All Search
* Enable Like/Exact/Not Search

![Advanced Search additional configuration]({% link content-accelerator/images/aca-show-advanced-search-options-config.png %})

When the **Enable Any/All Search** setting is enabled, you can configure either of the following settings.

| Settings | Search operator |
| -------- | --------------- |
| ANY of these values | If you select this option, search is performed based on the `OR` operator |
| ALL of these values | If you select this option, search is performed based on the `AND` operator |

If the **Enable Any/All Search** setting is disabled, `AND` operation is the default operation.

When you enable the **Like/Exact/Not Search** setting, an additional control is added to the Attribute Search form. The control includes an advanced operator selection drop-down. This drop-down is only available to properties with control type `TextBox`, `AutoComplete`, and `DropDown`.

The list of operators included in the drop-down is based on the associated property data type. The following table lists the data types and the operators associated with it.

| Data type | Operators |
| --------- | --------- |
| String | `LOGIC_LIKE`, `OPERATOR_EQUALS`, `OPERATOR_NOT_EQUALS` |
| Integer or Double | `OPERATOR_LESS_THAN`, `OPERATOR_EQUALS`, `OPERATOR_GREATER_THAN`, `OPERATOR_NOT_EQUALS` |

The operators listed above are described below:

* `LOGIC_LIKE` - Performs a wildcard (%) search
* `OPERATOR_EQUALS` - Performs a exact (=) value search
* `OPERATOR_NOT_EQUALS` - Performs a not exact (-) value search
* `OPERATOR_LESS_THAN` - The search returns results less than (<) the provided search term.
* `OPERATOR_GREATER_THAN` - The search will return results greater than (>) the provided search term.

If the **Like/Exact/Not Search** setting is disabled, the default operation depends on the object type. The following table lists the default operation based on the object types.

| Object | Default operation |
| ------ | ----------------- |
| **AutoComplete** and **DropDown** | Exact search with case sensitivity |
| **RadioButton** and **Cascading** | Exact search |
| **TextBox** | The search depends on values set using “Make Search Exact” and “Case Sensitive Search” and if these values are not set, a wildcard search is performed. |

> **Note:**
>
> * Advanced Search is deprecated in Content Accelerator 3.6. Though it is still available, Advanced Search feature in Attribute Search, described above, is expected to replace Advanced Search in future releases.
>
> * By enabling “Like/Exact/Not Search”, you override the settings for “Make Search Exact” and “Case Sensitive Search” for any property (if configured).
>
> * On a Property or Full text search, when any value is enclosed in double quotes, it is considered an exact search.
>
> * Popular special characters can be searched on Property and  Full text searches. How special characters are treated depends on tokenization and search index configuration. For additional information, see the [Alfresco Search Services documentation]({% link search-services/latest/index.md %}) and [Apache Solr Reference Guide](https://solr.apache.org/guide/solr/latest/index.html){:target="_blank"}.
#### Search Results Pane

Here you can navigate the results, change how the results are displayed, further filter the results down, and perform actions on some or all of the results.
Expand Down

0 comments on commit 77e349d

Please sign in to comment.