Skip to main content
Skip table of contents

Cantara MuleSoft Connector Operations

The connector currently supports the following operations.

Call Function

The call function operation allows you to execute a Cantara Function service. The input payload should be a JSON string that conforms to the the Function Request format. You can retrieve a Function Request JSON payload via the Execute tab within the Cantara Administration Console. The operation will return a Function Response JSON string if the service executes correctly, otherwise it will throw a TransactionException.

On This Page

Request

FunctionRequest

JS
{
  "Parameter": [
    {
      "name": "branch",
      "value": "M30"
    },
    {
      "name": "displayLocation",
      "value": ""
    },
    {
      "name": "fileLocation",
      "value": "A1"
    }
  ],
  "name": "FormatLocation"
}

Response

FunctionResponse

JS
{
	"Parameter": [
		{
			"value": "M30",
			"name": "branch"
		},
		{
			"value": "A1.   .",
			"name": "displayLocation"
		},
		{
			"value": "A1",
			"name": "fileLocation"
		},
		{
			"value": "",
			"name": "validate"
		},
		{
			"value": "",
			"name": "mode"
		}
	],
	"Message": {
		"value": "Transaction Successful",
		"origin": "CNTR-W132140@ig-worker-test-ap-zqmz",
		"type": 0,
		"sessionId": "22748.1519819143.80",
		"cantaraSid": "f873eb11-295a-4b5d-8a25-f98189fde464"
	},
	"name": "FormatLocation"
}

Call Query

The call query operation allows you to execute a Cantara Query service. The input payload should be a JSON string that conforms to the Query Request format. You can retrieve a Query Request JSON payload via the Execute tab within the Cantara Adminstration Console. The operation will return a Query Response JSON string if the service executes correctly, otherwise it will throw a TransactionException.

Query Execution

For improved performance, the Cantara Integration Platform supports simple query results paging. In the Query Request you can specify the start index (indexed from 1) and the number of query results to return. If you return the last result from the query the result set is automatically deleted by Cantara. However, if you do not retrieve the last row, you must ensure that you run the Delete Query operation to remove the results from persistent storage on the JD Edwards Enterprise Server.


Request

QueryRequest

JS
{
	"CriteriaParameter": [
		{
			"CriteriaLiteral": [
				"253"
			],
			"name": "cycleCountNo"
		}
	],
	"name": "GetCycleCountItems",
	"handle": "",
	"startIndex": 1,
	"recordCount": 2
}

Response

QueryResponse

JS
{
	"Query": {
		"QueryRow": [
			{
				"Parameter": [
					{
						"value": "253",
						"name": "cycleCountNo"
					},
					...
					{
						"value": "        .",
						"name": "locationFormatted"
					}
				]
			},
			{
				"Parameter": [
					{
						"value": "253",
						"name": "cycleCountNo"
					},
					...
					{
						"value": "        .",
						"name": "locationFormatted"
					}
				]
			}
		],
		"handle": "lrj5a96a640013f-00004f6d-0000010c-00000000000000000000ffff0a230121",
		"size": 24,
		"startIndex": 1,
		"endIndex": 2,
		"xmlList": false
	},
	"Message": {
		"value": "Transaction Successful",
		"origin": "CNTR-W132140@ig-worker-test-ap-zqmz",
		"type": 0,
		"cantaraSid": "c58170f0-a1e1-407c-aa07-72e26886ce12"
	},
	"name": "GetCycleCountItems"
}

Delete Query

The delete query operation allows you to remove an existing query data set from the JD Edwards Enterprise Server. The input payload should be the handle of the query result set which is provided as part of the Query Response that is returned when a query is executed. The operation will return a Message JSON string if the service executes correctly, otherwise it will throw a TransactionException.


Call Report

The call report operation allows you to execute a Cantara Report service. The input payload should be a JSON string that conforms to the the Report Request format. You can retrieve a Report Request JSON payload via the Execute tab within the Cantara Administration Console. The operation will return a Report Response JSON string if the service executes correctly, otherwise it will throw a TransactionException.


Request

ReportRequest

JS
{
  "Parameter": [
    {
      "value": "400",
      "name": "NextStatusCodeFromRange"
    },
    {
      "value": "999",
      "name": "NextStatusCodeThruRange"
    },
    {
      "value": "5057",
      "name": "Documentorderinvoice"
    }
  ],
  "CriteriaParameter": [
    {
      "CriteriaLiteral": [],
      "name": "DocumentOrderInvoiceE"
    },
    {
      "CriteriaLiteral": ["00100"],
      "name": "CompanyKeyOrderNo"
    },
    {
      "CriteriaLiteral": [],
      "name": "DateTransactionJulian"
    }
  ],
  "name": "R43500_ZJDE0003"
}

Response

ReportResponse

JS
{
	"Message": {
		"value": "Transaction Successful",
		"origin": "CNTR-W132140@ig-worker-test-ap-zqmz",
		"type": 0,
		"cantaraSid": "cd761e09-7239-4ce0-a8c8-8a1cf51262c5"
	},
	"name": "R43500_ZJDE0003",
	"jobId": 48992,
	"reportName": "R43500",
	"reportVersion": "ZJDE0003"
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.