EDI - XML (Magic xpi 4.14)
The EDI connector connects to the EDI Cloud service and provides an option of only submitting and receiving the documents, for the clients subscribing to the EDI service.
The connector design does not support building or converting the EDI documents. Contact the sales team to avail this service or to enquire about additional information.
The step configuration dialog box contains the following fields:
|
|
|
|
Connection
|
|
Resource Name
|
The name of the resource that you selected in the connector's Properties pane. The resources are defined in the Settings dialog box's Resources section.
|
|
Operation
|
|
Mode
|
Select Mode from the drop-down menu.
Sends the EDI Message to the EDI Server for the selected Partner and Document Type. The Document Type schema is generated using the Refresh Schema button. Once the schema is generated user can enter the values for each element on the Data Mapper configuration for this step.
After the message is delivered, the EDI server will send the Partner ID back in response.
Gets the message status for the Message Id. The Message Id can be provided on the Data Mapper configuration for this step.
The supported Message Status are listed in the table given below:
|
Status Code
|
Message
| |
0
|
Successfully Processed
| |
1
|
Received from Magic xpi, Message in queue.
| |
2
|
Received from Magic xpi, Pending processing
| |
3
|
Received from Partner
| |
4
|
Error in Processing, will be retried
|
Gets all the message present on the EDI Server. On the Data Mapper configuration for this step user can provide additional filter criteria.
The filters available are:
· Folder: Enter the folder name from which the messages should be fetched.
· Partner: Enter the Partner Name for which the messages should be fetched.
· Start Date/End Date: Provide the time range using Start Date and End Date for filter messages in the given time period.
· Max Rows: Provide the maximum number of messages to be retrieved in a single request.
|
|
Partner Name
|
This button is available only when the Send EDI Message operation is selected.
Click  (ellipsis button) to open the Partner Name list. Select the required Partner Name for which the message has to be posted.
|
|
Document Type
|
This button is available only when the Send EDI Message operation is selected.
Click (ellipsis button) to open the Document Type list. Select the required Document Type from the list.
Only outbound type of documents are available for selection.
|
|
Result Options
|
|
Success
|
This button is available only when the Send EDI Message operation is selected.
Click (ellipsis button) to open the Variables List. Select a variable, where you want to store the connector's success or failure status.
|
|
Message ID
|
This button is available only when the Send EDI Message operation is selected.
Click (ellipsis button) to open the Variables List. Select a variable to store the Message ID of the EDI message submitted.
|
|
Error Response
|
This button is available only when the Send EDI Message operation is selected.
Click (ellipsis button) to open the Variables List. Select a variable to store the Error Response from the EDI sever when the Send EDI Message operation fails.
|
|
Message Status
|
This button is available only when the Get Message Status operation is selected.
Click (ellipsis button) to open the Variables List. Select a variable to store the Message Status.
|
|
Status String
|
This button is available only when the Get Message Status operation is selected.
Click (ellipsis button) to open the Variables List. Select a variable to store the Status String.
|
|
Status Details
|
This button is available only when the Get Message Status operation is selected.
Click (ellipsis button) to open the Variables List. Select a variable to store the Status Details.
|
|
Success
|
This button is available only when the Get All Messages operation is selected.
Click (ellipsis button) to open the Variables List. Select a variable to store the Success status.
|
|
Response
|
This button is available only when the Get All Messages operation is selected.
Click (ellipsis button) to open the Variables List. Select a variable to store the Response status.
|
The EDI Configuration dialog box contains the following additional button:
|
|
|
|
Refresh Schema
|
This button is available only when the Send EDI Message operation is selected.
Retrieves the schema for the selected Document Type.
When you click Refresh Schema, the current schema is overwritten. A message dialog opens, and clicking OK confirms the update and the overwrite. Clicking Cancel exits the process without updating the schema.
|
|
|
The EDI configuration folder for each partner under the Magic xpi project is created using the GUID. To find the partner name to which the GUID belongs to, open the PartnerName.txt file under this folder.
For example, the PartnerName.txt under the <Magic xpi Project path>\<Project Name>\EDI\EDI_1\b9d18cf4-f786-4ffd-ab69-db23c3bed730 folder will have the following content:
Demo: Example partner
|
