EDI Resource (Magic xpi 4.14)
EDI resources contain the following parameters (the parameters in bold are mandatory):
|
|
Server URL
|
This is the URL for the EDI server.
|
Security
|
This is the Security Type to authenticate with the EDI server. Currently, only OAuth2 security type is supported.
|
Access Token URL
|
The Access Token endpoint is used by the application in order to get an Access Token.
Enter the Access Token URL or click (ellipsis button) to open the Environment Variable List. Here, the user can select an environment variable to use as an Access Token URL.
|
User
|
Enter the username to authenticate with the EDI resource. Alternatively, click (ellipsis button) to open the Environment Variable List. Here, you can select an environment variable for the username.
|
Password
|
Enter the password to authenticate with the EDI resource. Alternatively, click (ellipsis button) to open the Environment Variable List. Here, you can select an environment variable for the password.
|
Client ID
|
The ID of the application that asks for authorization. Client ID is generated at the time of client registration process at the Authorization server.
Enter the Client Id or click (ellipsis button) to open the Environment Variable List. Here, the user can select an environment variable to use as a Client ID.
|
Grant Type
|
Grant Type refers to the way an application gets an access token. The supported Grant Type for EDI is password.
|
Scope
|
Scope is an option, in case some Authorization server has defined scope and expecting Scope to be sent while retrieving the OAuth 2 Access.
Enter the Scope or click (ellipsis button) to open the Environment Variable List. Here, the user can select an environment variable to use as a Scope.
|
OAuth Access Token Status
|
Indicates whether a access token was successfully obtained when the OAuth 2 authorization process was performed. The possible values are:
-
Missing (Default)
-
Available
|
Use Proxy
|
Select the Yes option from the drop-down menu to use the EDI connector with the proxy server.
|
Proxy Address
|
Enter the address for the proxy server. Alternatively, click (ellipsis button) to open the Environment Variable List. Here, you can select an environment variable for the proxy address.
|
Username for Proxy
|
Enter the username to authenticate with the proxy server. Alternatively, click (ellipsis button) to open the Environment Variable List. Here, you can select an environment variable for the username.
|
Password for Proxy
|
Enter the password to authenticate with the proxy server. Alternatively, click (ellipsis button) to open the Environment Variable List. Here, you can select an environment variable for the password.
|
EDI resources also give you following buttons:
|
|
Validate
|
Click this button to verify whether the connection to the EDI server is valid. On clicking the button, the connection to the server will be established using the OAuth/Access Token.
|
OAuth Token
|
Click this button to retrieve the OAuth/Access Token from the EDI server.
The process uses Grant Type as Authorization code where the following parameters will be used.
-
Access Token URL
-
User
-
Password
-
Client Id
-
Grant Type
-
Scope (Optional)
Once this operation is complete the OAuth Access Token Status parameter (above) will be set to Available.
|
(Since version: 4.13.1)