Show TOC

ESFLocate this document in the navigation structure

ESF ( <command interface> ).

ESF ( <command interface> , <target system> ).

The ESF command is used to test business objects using the Generic Client Proxy (GCP) or the Local Client Proxy (LCP). More information: Testing ESF Business Objects Using GCP and Testing ESF Business Objects Using LCP.

Command Interface

The command interface contains the name of the business object to be tested and other details. Only some fields of the command interface can be parameterized (see below). The command interface is different for the GCP and LCP variants of the ESF command. You can change between GCP and LCP by changing the value of REPLAY_CLIENT and then refreshing the command interface. You might, however, have to further edit the command interface.

Interface for GCP

Node

Subnode

Description

REPLAY_CLIENT

Value ` GCP´.

RESET_ESF

Value X or blank. If X is set, the connection between the eCATT ESF Proxy and the Generic Client Proxy is reset, in effect starting a new session.

BUSINESS_OBJECT

BO_NODE_IMPORT

eCATT reference to object. This is parameterizable (the parameter is generated automatically during recording).

BO_NODE_EXPORT

eCATT reference to object. This is parameterizable (the parameter is generated automatically during recording).

SERVICE

NAME

This contains the relevant ESF action. Possible values: QUERY, CLEANUP, INSERT_ROW, MODIFY, CREATE, DELETE, NAVIGATION, ACTION, SAVE, or CHECK.

PARAMETER

The fields under this depend on the service. For example: QUERY would have fields for the selection parameters. The following are parameterizable: ACTION_PARAMETERS, SELECT_OPTIONS, SORTING_CRITERIA, and MAX_RESULT_ROWS.

IMPORT_TEXT

Contains the data for the service MODIFY. You can parameterize this.

GET_CHECK

You can parameterize this. You can specify line and column restrictions to reduce the data returned in the EXPORT_DATA node.

You can parameterize the COLUMN_SELECTION node to perform gets and checks.

EXPORT_DATA

You can parameterize this. If the field is parameterized, the parameter is filled with the business object's records at runtime.

Use GET_CHECK to limit the number of records.

MESSAGES

Contains the recorded messages from the business object.

SYSTEM_MESSAGES

Contains the recorded general system messages.

BUSINESS_OBJECT

Depending on the command interface, the object node BUSINESS_OBJECT can contain the following nodes:

  • BO_NODE_IMPORT

  • BO_NODE_EXPORT

For example, a query creates a business object. The command interface has a node BO_NODE_EXPORT

with a parameter that references the new instance of the BO. A navigation starts from the BO and results in a new BO. This command interface has a BO_NODE_IMPORT node with a parameter referencing the original BO instance and a BO_NODE_EXPORT node with a parameter referencing the destination BO instance.

GET_CHECK

You can specify a table of instructions defining GETs and CHECKs. Data will be searched in accordance with the values specified in LINE_SELECTION. If COLUMN_SELECTION is empty, the whole record will be transferred from the target system. If COLUMN_SELECTION is supplied, values will be transferred from that column and from the SEL_NAME column.

Example

This example is based on a query that produces a list of flights:

GET_CHECK[1]

LINE_SELECTION

LINE_SELECTION[1]

SEL_NAME 'AIRLINE'

SEL_ACTION '='

SEL_VALUE 'LH'

LINE_SELECTION[2]

SEL_NAME 'CONNECTION'

SEL_ACTION '<>'

SEL_VALUE 0400

COLUMN_SELECTION

COLUMN_SELECTION[1]

MODE 'G'

COLUMN_NAME ' CONNECTION'

RETURNING

COLUMN_SELECTION[2]

MODE 'G'

COLUMN_NAME 'FLIGHT_DURATION'

RETURNING E_DURATION

        


            

The line selection restricts the returned records to those where the AIRLINE equals 'LH' and the CONNECTION does not equal 0400. Further, the records contain only the fields NODE_ID (this field is always included), AIRLINE and CONNECTION (these fields are used in the LINE_SELECTION), and FLIGHT_DURATION - the fields specified in COLUMN_SELECTION.

The RETURNING field contains the table parameter E_DURATION which is filled with the values from the FLIGHT_DURATION column.

Example

This example is based on a query that produces a list of flights:

GET_CHECK[1]

LINE_SELECTION

LINE_SELECTION[1]

SEL_NAME 'AIRLINE'

SEL_ACTION '='

SEL_VALUE 'LH'

GET_CHECK[2]

LINE_SELECTION

LINE_SELECTION[1]

SEL_NAME 'AIRLINE'

SEL_ACTION '='

SEL_VALUE 'AA'

COLUMN_SELECTION

COLUMN_SELECTION[1]

MODE 'G'

COLUMN_NAME 'FLIGHT_DURATION'

RETURNING E_DURATION

        


            

The line selection restricts the returned records to those where the AIRLINE equals 'LH' or 'AA'. The RETURNING field contains the table parameter E_DURATION, which is filled with the values from the FLIGHT_DURATION column only for those records where AIRLINE equals 'AA'.

Example

This example is based on a query that produces a list of flights:

COLUMN_SELECTION

COLUMN_SELECTION[1]

MODE 'C'

COLUMN_NAME 'FLIGHT_DURATION'

CHECK_ACTION '<'

CHECK_VALUE 400

RETURNING

STATUS

        


            

The value entered in the CHECK_VALUE field is compared against the value of the flight duration for each record returned. If the check is successful for all records, STATUS has the value PASSED, otherwise STATUS takes the value FAILED.

Interface for LCP

Node

Subnode

Description

REPLAY_CLIENT

Value ` LCP´.

RESET_ESF

Value X or blank. If X is set, the connection between the eCATT ESF Proxy and the Generic Client Proxy is reset, in effect starting a new session.

BUSINESS_OBJECT

BO_NAME

Name of the business object

BO_NODE_NAME

Name of the node, such as 'ROOT'.

SERVICE

Name of the service, such as 'QUERY'.

IMPORT

LCP

You can ensure that the command uses the same LCP as a preceding command by parameterizing this field and assigning the parameter to the corresponding EXPORT node of the preceding command.

EXPORT

LCP

You can ensure that the following command uses the same LCP by parameterizing this field and assigning the parameter to the corresponding IMPORT node of the following command.