Server-side Filtering for Generic Inquiries
Server-side Filtering for Generic Inquiries
By default, queries that filter on general inquiry columns will not be processed server-side. In order to enable server-side filtering for these columns, you must first explicitly set them as filter columns in the Acumatica UI.
To expose a general inquiry column as a filter:
- Navigate in the Acumatica UI to the sidebar and select More Items > Customization > Generic Inquiry. The configuration page for your generic inquiry appears.
- Click the magnifying glass icon in the Inquiry Title field. Select the generic inquiry that you have exposed as a table.
- Click PARAMETERS. Perform the following steps for each column for which you want to enable server-side filtering.
- Click + (Add Row).
- Ensure the checkbox in the Active column is checked.
- Provide a name for the parameter in the Name column.
- Click the dropdown in the Schema Field column. Choose the general inquiry column for which you want to enable server-side filtering.
- Click CONDITIONS. Perform the following steps for each column for which you want to enable server-side filtering.
- Click + (Add Row).
- Ensure the checkbox in the Active column is checked.
- Leave the Condition column set to Equals.
- Click the dropdown in the Data Field column. Choose the general inquiry column for which you want to enable server-side filtering. This should match the column chosen in the Schema Field column on the PARAMETERS tab.
- Click the dropdown in the Value 1 column. Choose the parameter you created earlier for this column.
- Click the Save icon to submit these changes.
- Navigate in the sidebar to Integration > Web Service Endpoints (expand the Integration page with Show More to find this, if needed).
- Select the endpoint in which you have exposed the general inquiry as an object.
- Expand the node for the general inquiry object's endpoint in the ENDPOINT tree structure, then select its child entity (Result), which you created earlier.
- Click the FIELDS tab. Perform the following steps for each column for which you want to enable server-side filtering.
- Select the Mapped Object field associated with the column, then click its magnifying glass icon.
- Double-click Filter to set "Filter" as the mapped object.
- Click the Save icon to submit these changes. Server-side filtering for these columns is now enabled.