How to resolve issue with Correlator id when using executeAsync() without Midserver

[raghu59]

Issue- 

A frequently encountered challenge when using  executeAsync() is how to process the response coming back from the 3rd party and correlate to the source. This is because the correlation identifier set on the outbound request is not propagated to the corresponding input record in the ECC Queue — consequently, it becomes unfeasible to identify the originating source record and process the response without an alternative correlation strategy

Sample Requirement - 

Whenever an incident is created, an outbound call (asynchronous) should be triggered to the 3rd party and description of the incident should be updated with the response from the 3rd party. 

Solution -

1) Create BR on the incident table as below (on Insert)-

2) Create another BR on ecc_queue table with the required conditions like

Agent - RestClient

Queue- Input

State- Ready

Source - <3rd party URL>

3) The actual issue is correlating the Input to the Output record as the Correlation value for Output is populated by using below code in the BR - 

restMessage.setEccCorrelator(correlator); but in the input record, this Correlation value is empty.

4) To resolve this, we can use the link between Input and output record i.e 'Response to' column in the ECC Queue BR -

var correlator = current.response_to.getRefRecord().getValue('agent_correlator');

- Adding the below BR scripts used for this integration just for the reference - 

BR on Incident table - 

(function executeRule(current, previous /*null when async*/) {

var correlator = current.number;

try {

// ── Step 1: Build REST Message ──

var restMessage = new sn_ws.RESTMessageV2();

restMessage.setHttpMethod('GET');

restMessage.setEccCorrelator(correlator);

restMessage.setEndpoint(

'https://api.ipify.org?format=json'

);

// ── Step 2: Execute the call ──

var response = restMessage.executeAsync();

}

catch(ex) {

gs.error(

'[IPifyBR] Error: ' + ex,

'IPifyBR'

);

}

})(current, previous);

BR on ECC Queue table - 

(function executeRule(current, previous) {

try {

// ── Step 1: Get raw XML payload ──

var payloadXML = current.getValue('payload');

if (!payloadXML) {

gs.error(

'[ECC_BR] Payload is empty',

'ECC_BR'

);

return;

}

// ── Step 2: Parse XML ──

var xmlDoc = new XMLDocument2();

xmlDoc.parseXML(payloadXML);

// ── Step 3: Get status code ──

// From <parameter name="http_status_code"

// value="200"/>

var statusNode = xmlDoc.getNode(

'//parameters/parameter' +

'[@name="http_status_code"]'

);

var statusCode = statusNode

? statusNode.getAttribute('value')

: null;

gs.log(

'[ECC_BR] Status Code: ' + statusCode,

'ECC_BR'

);

// ── Step 4: Get response body ──

// From <output>{"ip":"148.139.1.10"}</output>

var outputNode = xmlDoc.getNode(

'//result/output'

);

var body = outputNode

? outputNode.getTextContent()

: null;

gs.log(

'[ECC_BR] Body: ' + body,

'ECC_BR'

);

// ── Step 5: Process response ──

if (statusCode == '200' && body) {

// Parse the JSON inside the output

// body = {"ip":"148.139.1.10"}

var parsed = JSON.parse(body);

var ip = parsed.ip;

gs.log(

'[ECC_BR] IP Address: ' + ip,

'ECC_BR'

);

// ── Step 6: Update the incident ──

// Find the incident using correlator

// or whatever reference you stored

// var correlator = current.getValue(response_to.agent_correlator);

var correlator = current.response_to.getRefRecord().getValue('agent_correlator');

var gr = new GlideRecord('incident');

gr.addQuery(

'number',

correlator

);

gr.setLimit(1);

gr.query();

if (gr.next()) {

gr.setValue(

'description',

'Public IP captured: ' + ip

);

gr.update();

gs.log(

'[ECC_BR] Updated incident: ' +

gr.getValue('number'),

'ECC_BR'

);

} else {

gs.error(

'[ECC_BR] No incident found ' +

'for correlator: ' + correlator,

'ECC_BR'

);

}

} else {

gs.error(

'[ECC_BR] Bad response — ' +

'Status: ' + statusCode +

' | Body: ' + body,

'ECC_BR'

);

}

} catch(ex) {

gs.error(

'[ECC_BR] Error: ' + ex,

'ECC_BR'

);

}

})(current, previous);