This section outlines the steps needed to establish a vendor account and utilize RESTful API requests for a MoversSuite customer.
PREREQUISTES:
• A vendor must have a connector established within MoversConnect. There is an ongoing cost associated with this connector. Contact the EWS Group Sales Team for pricing and additional information to get you going. You will also need to log a Help Desk Ticket with our Support Team for assistance in this process and to obtain the following items needed for setup and development:
o Vendor Name for the third party vendor providing development
o Client ID and Client Secret needed for developer to make token requests
o Connection Identifier is a 32-character GUID needed to make update requests (you may have multiple identifiers for each branch if using AgentConnect functionality)
• Additional connector is required for managing documents.
• Custom development required and maintained by vendor. Refer to the VendorConnect Developer Information topic for details.
STEPS:
Once VendorConnect is enabled on your system, EWS Group will work with your vendor to establish and test necessary connections using provided credentials. EWS Group performs the following steps to establish the necessary connections to support the VendorConnect process to add and view orders and/or to manage documents.
Step |
Description |
STEP 1 |
Establish vendor connector within MoversConnect Setup. Use MoversConnect Setup to manage and sync data between your system and the MoversSuite cloud-connector. EWS Group does provide initial setup within MoversConnect, but often you may need to verify and synchronize this data using MoversConnect Setup. |
STEP 2 |
Establish an interface for the vendor within XML Interface Setup using the Vendor Name provided by EWS Group. |
STEP 3 |
Use XML System Setup to set data type mappings for Order Information and Documents (if using) as well as defining a connector URL information if using the Third Party Applications Menu to call webhooks (if using). You can specify the following XML System Option values to set a default customer and customer address on leads added to MoversSuite: DefaultCustomerNumber DefaultAddressCode
Refer to the field description within the XML System Option topic for more information.
If managing documents: Define an XML System Data Type Map record, setting the following values: Xml System Data Type to “Document Notification” Name to the Vendor Name provided by EWS Group followed by “ Order Information”. For example, if the vendor is named Company, then set the Vendor Name to “Company Order Information”. Check the Clear previous XML errors before reprocessing.
|
STEP 4 |
Use VendorConnect Setup to manage defined vendor records and determine which branches are available to the vendor. Utilize this setup area to import, export, and refresh data for third-party vendors that you integrate with through VendorConnect. Assign Branch Items for each branch you wish to support. Branches not in this list will not be accessible through VendorConnect processes you define. For certain vendors you may also assign External Codes to match functionality from one operating center on the vendor side to a MoversSuite branch. As with branches, if employing External Codes and there is no match for the vendor, then processing will not occur or an error may be returned.
If managing documents: Verify that a second VendorConnect Setup record is available. Contact EWS Group if there is only one for order data. You will need a second one with the VendorConnect Vendor of your company name followed by “Document Notifications”, e.g., “Company Document Notifications”. Verify that the same branches assigned to the Order Information vendor are identical to those of the Document Notifications vendor. Verify that all External Code values (if using) are identical for each branch listing, as well. NOTE: The second vendor is required since there can only be one XML System Data Type Map record per interface. |
STEP 5 |
This step is only needed if managing documents: If the vendor supports document types, then establish mappings to MoversSuite document types within Document Type Setup. Mappings must exist between the two system in order to exchange documents. Establish a single Interface Item for each supported External Code. For example, if there is a MoversSuite Document Type of “Bill of Lading” defined and the vendor uses “BOL” to identify this type on their system, then add an Interface Item for the vendor and assign the External Code as “BOL”. If the vendor does not support document types, then EWS Group will provide a special code that you can assign as an External Code for each supported Document Type record. If you wish to set the created by/modified by to a particular user in MoversSuite, then you can view the Add Document User topic for details. By default, if no user is associated with your vendor interface, then the user assigned to the document is “External Application.” |
You will periodically need to manage data and perform data synchronizations and troubleshooting using the following setup areas:
RELATED TOPICS: