Passing runtime parameter to Datamapper Service REST API

OL Connect Enterprise
1

Hi all,

Im just started using the REST api via JS and want to pass runtime parameters to datamapper service where the datamapper field will apply the value from the runtime parameter.

… var params = {
“parameters”: {
“extraData”: “Hello world”
}
}
var url = “/rest/serverengine/workflow/datamining/”+mapperID+“/”+dataID +“?validate=”+(isValidate?true:false)
var xhttp = new ActiveXObject(“Microsoft.XMLHTTP”);
xhttp.open(“POST”, url, false);
xhttp.setRequestHeader(‘Content-Type’, ‘application/json’);
xhttp.send(JSON.stringify(params));

The datamapper runs per normal but when I get the values using this endpoint

/rest/serverengine/entity/datarecords/values

The parameter is not getting applied to the job number field is instead pulling the default value.

image
image744×141 6.93 KB

What am I doing wrong?

Thank you in advance.
E

2

Hello @edanting,

Please try it but with your own defined runtime parameter. ExtraData has a special meaning in OL Connect and I am not sure what will happen when you use it like automation.parameters.extraData for a field.

Example:

var params = {
	"parameters": {
		"sample": "Hello World!"
	}
};
// [...]
xhttp.send(JSON.stringify(params));
3

Hi Marten,

I have tried this and didn’t work. I added “range”, the range param actually works and it retrieves number of records based on value. The mapper also have set runtime params to have var1, and still no go.

{
“range”: 1,
“parameters” { “var1”: “Hello world!” }
}

Is it possible json structure is different for the datamapper?

Thanks

Note: The “extraData” as runtime parameter in workflow actually works when using the plugin. Since the Connect plugins are just a bunch of script to call the REST api endpoints, I imagine it shouldnt be an issue in my understanding.

4

And to add, after I run the datamapper with the runtime parameters set.

I use this EP to get the Identifiers (record Ids)

“/rest/serverengine/entity/datasets/” + dataSetID

I then acquire an array of Identifiers to pass to EP

“/rest/serverengine/entity/datarecords/values”

image
image600×356 17.1 KB

The payload returns record fields and values which seem to not applying the runtime parameter value.

5

Doing Process Data Mapping (JSON) instead of Process Data Mapping should work.

Following is the JavaScript code I applied to the Run Script task to test this.

Important: Please note that this is not production ready code.

var connectInfo = JSON.parse(Watch.GetConnectToken()),
	configId = Watch.GetVariable("configId"),
	dataFileId = Watch.GetVariable("dataFileId"),
	url = "",
	xhr = new ActiveXObject("Msxml2.ServerXMLHTTP.6.0");

url = connectInfo.protocol + "://" + connectInfo.host + ":" + connectInfo.port; // Origin
url += "/rest/serverengine/workflow/datamining/" + configId; // Path

xhr.open("POST", url, false);
xhr.setRequestHeader("auth_token", connectInfo.token);
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send('{"identifier": "' + dataFileId + '", "parameters": {"jobNo": "test"}}');
1 Like
6

Ah right. It worked! Thanks Marten.

I guess the other EP is bugged. Since the documentation should allow for the optional parameters.

Another question, it seems like I get a 500 error if I dont provide the runtime parameter? Is this normal behaviour? I was hoping if the runtime parameter isnt provided, the debug/default value get use instead.

7

What does the JSON data look like when this happens?

Update — I am able to reproduce something similar. The reason why this is happening is because the source of a runtime parameter value must be set in the automation tool, e.g. OL Connect Workflow, the moment the runtime parameter is defined on the datamapper side via the Parameters pane.
A possible solution would most likely be to apply a script like the below one on the datamapper side to allocate a (default) value to the record field “jobNo”:

var jobNo = ""; // Default value

if ("jobNo" in automation.parameters) {
	jobNo = automation.parameters.jobNo;
}

jobNo;
8

I see, the moment I add a runtime parameter in Parameters pane.
It is required that I pass a parameter through Workflow or REST API.

Thank you for that workaround! I remove all my the runtime params and just check for the existence of them instead before consuming them.

I should be able to continue now :slight_smile: Thank you

1 Like