Get Criteria of Search Form

Summary

Retrieve the original search criteria if the current record list was created from the search results generated by Customine’s search form.

How to Use

First, execute one of the following actions on the record list page to display the search form.

When a Kintone user enters search criteria in this search form and clicks the “Search” button, a record list is displayed with the results based on those criteria. In the “record list in the searched state,” performing the “Get Criteria of Search Form” action allows you to retrieve the conditions that the user entered in the search form during their search.

The values retrieved reflect the search form at the time of the search, not the values currently entered in the displayed search form.

The retrieved value will be saved as the result of the action. You can get the search condition of each field using the field code as the key. The following example is an instance of executing “Get the conditions searched in the list screen with the search form” with action number 1.

To retrieve a specific text value as a search condition, input it as follows:
```
= $1.Text_1_1
```
To retrieve an array of the selected values from a search form featuring multiple selectable items, such as radio buttons or checkboxes, use the specifications provided below. If nothing is selected, it will be an array with zero elements.
```
= $1.Radio button_1
```
In cases where a range of minimum to maximum values is specified in a search form, such as in Date fields or the Number field in “Put Keyword and Numeric Range Search Form on List Page,” you can obtain the values on the minimum and maximum of the range by appending “.from” or “.to” to the field code.
```
= $1.date_1.from & " to " & $1.date_1.to & " range was searched."
```
If there are the Related records fields within the search form, caution is required. In this case, the key will be “Field code of the Related records field. Field code in the app that the Related records field refers to.” For example, if the field code of the related record is “related_record_1” and the field code in the app that the related record refers to is “string__1_line__1”, it cannot be successfully retrieved as “$1.related_record.string__1_line__1”. In this case, specify as follows:
```
= $1["Related records.Text_1_1"]
```
- When combining “from” and “to,” additional caution is necessary. It cannot be accurately retrieved using “$1.Related records.Number.from” or “$1[‘Related records.Number.to’].” In this case, please specify as follows:
```
= $1["Related records.Number"].from
```
```
= $1["Related records.Number"].to
```
In the case of “Put Multiple Fields Search Form on List Page,” it is special and cannot be retrieved even if the field code is used as a key. In this case, specify a special key of “$customine”.
```
= $1["$customine"]
```

Parameters

There are no parameters to be set.

Restrictions

If you search outside of the Customine search form, you will be unable to retrieve any results.
- For example, the conditions for filtering the record list using the standard “Filter” function of Kintone cannot be retrieved.
If you select a record from the record list of search results using the search form and move to the record detail page, and then click the breadcrumb menu “Filter” on that record detail page to return to the list, you will not be able to retrieve the original search conditions with “Get Criteria of Search Form.”
It is impossible to retrieve the search conditions of the list page filtered by the “[Open List Page Narrowed by Conditions[” action.
The query cannot be retrieved.