Skip to main content

Service layer queries screen

The Service Layer Queries screen lists all parameterised queries configured for a client connection.

N
Written by Niyaz

Open Service Layer Queries in ERP Manager to view parameterised queries configured for a client connection.

Service layer queries list with a client connection filter and empty-state message.

List screen

Control

What it does

Client connection

Filters the list to queries belonging to the selected client connection. A client connection is required on the list screen.

Create

Opens the Create Service Layer Query form.

Clear filters

Resets the Client connection filter and is visible when no queries match the current filter.

Rows per page

Sets the number of rows displayed per page. Options: 5, 10, 25, 50.

When no queries exist for the selected connection, the screen displays the message “No Service Layer Queries found using the current filters.”.

Create service layer query form

Create Service Layer Query form with query, connection, header, and response controls.

Query definition

Control

What it contains

Name

Contains the name for the query.

Description

Contains an optional free-text description.

SQL Query

Contains the parameterised SQL statement.

Parameters

Control

What it does

+ Add parameter

Adds a named parameter entry to the Params list. Each parameter corresponds to a placeholder in the SQL query.

Connection and headers

Control

What it does

Client connection

Specifies the ERP client connection against which the query runs. A client connection is required on the create form.

+ Add value

Adds a header key-value pair. The control is disabled until a client connection is selected.

Response handling

Control

What it does

Decode json

When enabled, the response body is parsed as JSON before further processing.

Nested JSON path

Defines the path into a nested JSON structure from which data is extracted. The control is visible when Decode json is enabled.

Notes

On the empty create form, + Add value and Save are disabled. After the required fields are completed, Save becomes available.

For exact labels of the parameter name, type, and default value fields, consult the + Add parameter interaction in ERP Manager.

Related

Did this answer your question?