Use the RESPONSEUTILLIB function library to retrieve/extract specific values from the response XML for a component request, generated as part of the flow run. The library covers data retrieval routines for in the returned response XML.

This section provides a list of functions in the library, along with the usage details.

This function stores the complete web service response body into a global variable specified against the Output Variable Name column. The output variable is used as input to the COREVALIDATEVARIABLELIB and COREVERIFYCONDITIONVARIABLELIB, which can be used to bypass or skip component as part of a run based on certain conditions.

Usage:

Input Parameters:

Takes the xpath of an element as input and outputs the value of the xpath in the response into a global variable specified against the OP Variable Name column. If there are multiple occurrences of the element, the corresponding values will be returned as a comma separated list and stored in to the variable specified against the OP Variable Name column.

Usage:

Input Parameters:

This function helps to retrieve specific values from a reoccurring list in the response, based on certain condition that can be applied on other elements in the same list. It takes the xpath of an element whose value needs to be retrieved, the xpath of an element whose value needs to be compared and a filter condition for comparison operation as inputs and outputs the value/values of the xpath in the response that corresponds to the filter condition into a global variable specified against the OP Variable Name column. If there are multiple occurrences of the element satisfying the provided condition, then the corresponding values will be returned as a comma separated list and stored in to the output variable.

The first parameter holds the xpath of the element whose value has to be retrieved.

The second parameter holds the xpath of the element within the repeated list, whose value needs to be compared for a specific condition.

The third parameter holds the comparison condition.

Example:

 

Input Parameters:

 

Example:

Consider the following XML as the response XML for a component in a flow:

To retrieve all the bacthJobId values, where the batchParameterValue is "K1-STAGING" the function call would be as follows:

 

The "==" operator in the 3rd input parameter to the function performs an "is equal to" comparision with the specified value.

The following are the supported operators for comparison operation:

This is an extension of the setVariableFromReponseListWithFilter function that helps to retrieve specific values from a reoccurring list in the response, based on a condition that can be applied on other elements in the same list, but, instead of a single condition that was allowed in the setVariableFromReponseListWithFilter function, this function allows users to provide two conditions.

This function takes the xpath of an element whose value needs to be retrieved, the xpath of the elements whose values need to be compared and two filter conditions corresponding to those xpath elements for comparison operation as inputs. The function outputs the value/ values of the xpath in the response that corresponds to the filter conditions into a global variable specified against the OP Variable Name column. If there are multiple occurrences of the element satisfying the provided conditions, then the corresponding values will be returned as a comma separated list and stored in to the output variable.

The first parameter holds the xpath of the element whose value has to be retrieved.

The second parameter holds the xpath of the element within the repeated list, whose value needs to be compared as the first condition.

The third parameter holds the comparison condition corresponding to the second parameter. The fourth parameter holds the xpath of the element within the repeated list, whose value needs to be compared as the second condition.

The fifth parameter holds the comparison condition corresponding to the fourth parameter (the second condition to be evaluated).

Example:

 

Input Parameters:

 

See the setVariableFromResponseListWithFilter function for details on valid comparison conditions and their usage.

This is a supporting util function for the setVariableFromResponseListWithFilter and setVariableFromResponseListWithFilters functions, which takes the a comma separated list of values and returns the value in the list corresponding to the index provided as the second input to the function.

Example:

Input Parameters:

If an XML response to a component request has multiple occurrences of a group of list elements that should be retrieved and used in later components in the same flow, this function can be used to retrieve the groups of XML elements and their values.

The function retrieves a set of the XML group elements under the provided parent element's xpath. The occurrences of reoccurring groups to be retrieved for the given xpath can specified using the startIndex and endIndex parameters. The output of the function is a group of list elements in XML format that can be stored in to a global variable.

The other functions in this library can be used to extract specific values from the output variable containing the repeating list groups.

Example:

 

Input Parameters:

 

Output Parameters:

 

Example:

Consider the following XML as the response XML for a component in a flow:

 

To retrieve the group of elements under the batchJobExtraParameter for the second and third occurrence of the group, call the function using the following input parameters:

 

Output XML String:

If an XML response to a component request has multiple occurrences of a group of list elements to be retrieved and used in later components in the same flow, this function can be used to retrieve the groups of XML elements and their values.

The function retrieves a first set of the XML group elements under the provided parent element's xpath. The output of the function is a group of list elements in XML format that can be stored in to a global variable.

Use the other functions in this library to extract specific values from the output variable containing the XML string.

Example:

 

Input Parameters:

 

Output Parameters:

 

Example:

Consider the following XML as the response XML for a component in a flow:

 

To retrieve the first group of elements under the batchJobExtraParameter, call the function using the following input parameters:

 

Output XML String:

If an XML response to a component request has multiple occurrences of a group of list elements to be retrieved and used in later components in the same flow, use this function to retrieve the groups of XML elements and their values.

The function retrieves a set of the XML group elements under the provided parent element's xpath. The occurrences of reoccurring groups to be retrieved for the given xpath can be specified using the numberOfOccurrences parameter. The output of the function is a group of list elements in XML format that can be stored in to a global variable.

Use the other functions in this library to extract specific values from the output variable containing the repeating list groups.

Example:

 

Input Parameters:

 

Output Parameters:

 

Example:

Consider the following XML as the response XML for a component in a flow:

 

To retrieve the group of elements under the batchJobExtraParameter for first 2 occurrences of the group, call the function using the following input parameters:

 

Output XML String:

If an XML response to a component request has multiple occurrences of a group of list elements to be retrieved and used in later components in the same flow, use this function to retrieve the groups of XML elements and their values.

The function retrieves all sets (occurrences) of the XML group elements under the provided parent element's xpath. The output of the function is a group of list elements in XML format that can be stored in to a global variable.

Use the other functions in this library to extract specific values from the output variable containing the repeating list groups.

Example:

 

Input Parameters:

 

Output Parameters:

 

Example:

Consider the following XML as the response XML for a component in a flow:

 

To retrieve the group of elements under the batchJobExtraParameter for all the occurrences of the group, call the function using the following input parameters:

 

Output XML String:

If an XML response to a component request has multiple occurrences of a group of list elements to be retrieved and used in later components in the same flow, use this function to retrieve the groups of XML elements and their values.

The function retrieves the last set (occurrence) of the XML group elements under the provided parent element's xpath. The output of the function is a group of list elements in XML format that can be stored in to a global variable.

Use the other functions in this library to extract specific values from the output variable containing the repeating list groups.

Example:

 

Input Parameters:

 

Output Parameters:

 

Example:

Consider the following XML as the response XML for a component in a flow:

 

To retrieve the group of elements under the batchJobExtraParameter for the last occurrence of the group, use this function to call the following input parameters:

 

Output XML String:

If an XML response to a component request has multiple occurrences of a group of list elements to be retrieved and used in later components in the same flow, use this function to retrieve the groups of XML elements and their values.

The function retrieves a set of the XML group elements under the provided parent element's xpath. The occurrences (starting from the end of reoccurrence group) of reoccurring groups to be retrieved for the given xpath can specified using the numberOfLastNOccurrences parameter. The output of the function is a group of list elements in XML format that can be stored in to a global variable.

The other functions in this library can be used to extract specific values from the output variable containing the repeating list groups.

Example:

Input Parameters:

 

Output Parameters:

 

Example:

Consider the following XML as the response XML for a component in a flow:

 

To retrieve the group of elements under the batchJobExtraParameter for last 2 occurrences of the group, call the function using the following input parameters:

 

Output XML String:

If an XML response to a component request has multiple occurrences of a group of list elements to be retrieved based on some conditions to be applied on the elements in the group, to be used in later components in the same flow, use this function to retrieve the groups of XML elements and their values.

The function retrieves a set of the XML group elements under the provided parent element's xpath subject to a specified condition. The condition based on which the reoccurring groups are to be retrieved for the given xpath can specified using the corresponding xpath and the conditional parameters. The output of the function is a group of list elements in XML format that can be stored in to a global variable.

The other functions in this library can be used to extract specific values from the output variable containing the repeating list groups.

Example:

 

Input Parameters:

 

Output Parameters:

 

Example:

Consider the following XML as the response XML for a component in a flow:

 

To retrieve the group of elements under the batchJobExtraParameter parent element, whose sequence is greater than 20, call the function using the following input parameters:

 

Output XML String:

If an XML response to a component request has multiple occurrences of a group of list elements whose group count needs to be determined, use this function to retrieve the number of occurrences of the groups of XML elements. The output of the function is the number of occurrences of the group that can be stored in to a global variable.

Example:

Input Parameters:

Output Parameters: