The Service Layer Queries screen lists the parameterised queries configured for a client connection. Use service layer queries when a basic query is not sufficient, because they accept named parameters and optional headers and can decode nested JSON responses. Open Service Layer Queries from the ERP Manager menu.
List screen
The list screen has a Client connection selector, a Create link and a Clear filters button. When no queries exist for the selected connection, the screen displays a no-results message. The message reads: No Service Layer Queries found using the current filters.
Control | Description |
Client connection | Selector marked as required. Filters the list to queries belonging to the selected client connection. |
Create | Opens the create form. |
Clear filters | Resets the Client connection filter. Appears together with the no-results message. |
Rows per page | Selector for the number of rows per page, followed by previous-page and next-page buttons. |
Create service layer query form
The Create Service Layer Query form ends with Cancel and Save actions.
Query definition
Control | Description |
Name | Text field marked as required. Holds the name for the query. |
Description | Text field marked as required, for a free-text description of the query. |
SQL Query | Holds the parameterised SQL statement. |
Parameters
Control | Description |
+ Add parameter | Available on the empty form, below the Params list. Each parameter corresponds to a placeholder in the SQL query. |
Connection and headers
Control | Description |
Client connection | Selector marked as required. Identifies the ERP client connection this query runs against. |
+ Add value | Unavailable on the empty form. Becomes available once a client connection is selected. Adds a header key-value pair. |
Response handling
Control | Description |
Decode json | Switch for decoding the response. When enabled, the response body is parsed as JSON before further processing. |
Nested JSON path | Tree control that starts at a root node. Defines the path into a nested JSON structure from which data is extracted. |
Form actions
Control | Description |
Save | Unavailable on the empty form. Becomes available after field values are changed. Stays disabled until all required fields are populated. Saves the new service layer query. |
Notes
Client connection is required on both the list screen and the create form.
Related