These instructions are for enabling and supporting the use of the TechMate Automated Process.
|
If your company has already been using the TechMate Manual Process, most of these steps were already completed when you first established the TechMate Integration. The only steps that are required are indicated in the steps below with an asterisk.
See TechMate Moving from Manual to Automated Setup for just those instructions. |
The prerequisites and steps required to use the automated process are listed below with details on each following the list.
PREREQUISTES: An account established with TechMate. Additionally, you will need the following items:
• The TechMate executable (TechMateIntegration.exe).
• List of carton and distribution codes from TechMate to identify supported items in MoversSuite, such as the code of “Dishpack,” which is mapped to a MoversSuite Item Code via XML Item Code Setup. (Step 3)
• Login credentials for each MoversSuite user(s) you wish to grant the ability to import/export. (Steps 5 and 6)
• Create a folder where the TechMate Automated Process will put the exports for retrieval by TechMate (Step 2).
STEPS:
1. Establish a TechMate vendor within XML Interface Setup.*
2. Add system record for TechMate within XML System Setup.*
3. Add supported items within XML Item Code Setup.
4. Add supported types within Note Type Setup.
5. Add TechMate credentials to supported employees through their Personnel Setup record.
6. Update sales Personnel Setup records to have them included in imports/exports.
7. Establish a TechMate Queue Service Server Setup record.*
* The only steps needed within TechMate Moving from Manual to Automated Setup. See Important note above.
STEP 1: Add a TechMate Vendor to XML Interface
Setup Area: MoversSuite Administration > Administration > XML Interface
This step supports the automated import process from TechMate.
Create a single TechMate record within XML Interface Setup. Click Click here to add a new Interface to start creating a new XML Interface Setup record.
When clicked, the New Interface screen appears. Create the following record by entering the information shown and detailed on the technical table below. When all the information in entered and added, the final record will look like the image (Figure 3).
Note that the record must be set with the Branch of the Lead. Once you add branches, you can only import from TechMate items associated to branches in the list.
If an XML Interface record for TechMate already exists, proceed to update this record with Branch Items and Van Line Items as indicated below for this TechMate Automated Process integration.
Click Save to save the new record or to save the updates.
Figure 3: XML Interface Setup record
Set the information for this record as indicated within this technical table:
Field |
Value | ||||||||||||||||||||||||
Vendor Name |
TechMate | ||||||||||||||||||||||||
Click here to add a new Van Line Item |
Click to add one or more Van Line Items using the table below to complete this setup. The Is Vanline Brand checkbox is automatically set.
| ||||||||||||||||||||||||
Click here to add a new Branch Item |
Branch: Add each branch that has leads to be uploaded to TechMate. The Branch of a lead must be set. Branches listing in the dropdown are managed within Branch Setup. | ||||||||||||||||||||||||
Authority Type: Choose an option. The option chosen will not affect the integration or process. | |||||||||||||||||||||||||
External Code: This can be left blank. Note: This field is not currently in use. |
STEP 2: Add an XML System Setup record for the TechMate Vendor
Setup Area: MoversSuite Administration > Administration > XML System
This step supports the automated import process from TechMate.
Create a single TechMate record within XML System Setup. Click Click here to add a new XML System to start creating a new XML System Setup record.
When clicked, the New XML System screen appears. Create the following record by entering the information shown and detailed on the technical table below at the bottom of this step. When all the information in entered and added, the final record will look like the image below:
Of note, the record must include an XML System Option of “TechMateExportFileLocation”. If an XML System record for TechMate already exists, proceed to update this record with XML System Option (as instructed in the table below for this TechMate Automated Process integration.)
Click Click here to add a new XML System Option and enter “TechMateExportFileLocation” for the name. The Value needs to be set to a folder path that exists on the machine that is running the API. That path is the location where MoversSuite will put an XML file within when the user saves a new Lead. Click Add.
Figure 4: XML System Setup record with the required XML System Option highlighted.
Establish the following values to create or update this XML System record:
Field |
Value | ||
Interface |
TechMate | ||
Internal System |
TechMate | ||
External System |
TM | ||
Click here to add a new XML System Option |
Click to open the Add XML System Option screen. Complete the screen as follows: | ||
Name |
TechMateExportFileLocation (enter exactly as shown) | ||
Value
|
This value is the path that is the location that MoversSuite will put an XML file in when the user saves a new Lead. The TechMate system then checks that folder for files to upload.
The is value can be whatever name you like and located whenever you choose, providing the location is on the machine that is running the API.
In our example, the value is set to: C:\TechMateExports
In our file directory, the file is located here: | ||
Click here to add a new XML System Data Type Map |
Click to open the Add XML System Data Type Map screen. Complete the screen as follows: | ||
Xml System Data Type |
Order Information | ||
Name |
TechMate Order Information | ||
Clear previous XML errors before reprocessing |
[check this option] |
STEP 3: Define supported Item Codes for Revenue Import
Setup Area: MoversSuite Administration > Administration > XML Item Code
For each supported TechMate carton code, define an XML Item Code Setup record. Set the XML Item Code to one of the supported codes listed within the TechMate Supported Carton and Distribution Codes topic and link it to a MoversSuite a Material Type or Item Code. In the example below, the TechMate Carton Code of “Carton, 1.5” is set within the XML Item Code field and it links to the Material Type of “1.5 Cubic Feet”, which is defined in MoversSuite through the Material Type Setup.
Figure 5: XML Item Code Setup sample for a carton code
Each supported code must be mapped to a Material Type or to an Item Code to avoid missing data when bringing in revenue through a Revenue Import.
If you wish the carton codes to link to Containers, Packing and Unpacking (CPU) items, then set link the XML Item Code record to a Material Type. The example above, the Material Type of “1.5 Cubic Feet” maps to a Material Type Setup record that contains the necessary Item Code mappings for each container type.
Figure 6: Material Type Setup record
Optionally, you can also link directly to an Item Code as in the example below. Avoid setting both the Item Code and Material Type when defining these records.
Figure 7: XML Item Code record for a distribution code
NOTE: Typically, carton codes link to Material Type values and distribution codes link to Item Code values directly. You can refer to each supported type through the TechMate Supported Carton and Distribution Codes topic.
Reference the Material Type Setup and the TechMate Supported Carton and Distribution Codes topics when defining the XML Item Code Setup records.
STEP 4: Add Supported Note Types
Setup Area: MoversSuite Administration > Customer Service > Note Type
There are three different types of notes that are needed for the TechMate Integration. Create a Note Type for each one needed using Note Type Setup. Each needed Note Type record is shown below:
1. TechMate Customer Note:
Enter the following for the note shown above:
Note Type |
Van Line Code |
TechMate Customer Note |
TMCustomer |
2. TechMate Estimate Note:
Enter the following for the note shown above:
Note Type |
Van Line Code |
TechMate Estimate Note |
TMEstimate |
3. TechMate Survey Note:
Enter the following for the note shown above:
Note Type |
Van Line Code |
TechMate Survey Note |
TMSurvey |
STEP 5: Update Personnel Setup records for Estimators
Setup Area: MoversSuite Administration > Personnel > Personnel’s record > Interface Mapping tab
Each estimator that needs to log into TechMate from within the MoversSuite application must have their credentials defined within Personnel Setup. Set these credentials for the TechMate interface through the Interface Mappings tab on the Personnel record.
Choose Click here to add credentials for an Interface and then choose TechMate from the dropdown. Be sure to updated Personnel records for each estimator.
Figure 8: Personnel Setup > Interface Mapping
Then you can click on the Credentials button to supply their specific TechMate login credentials. Note that the User Name is associated to the estimator’s login identifier within TechMate. These credentials are passed to the TechMate application when evoked through the Accounting Tools Menu.
Figure 9: Credentials dialog for TechMate
STEP 6: Update Personnel Setup records for Salespeople
Setup Area: MoversSuite Administration > Personnel > Personnel
If you wish to import and export identifiers for salespeople, then for each you must set their User ID within the Interface Mappings on their Personnel Setup record.
Figure 10: Personnel Setup > Interface Mapping
From the Salesperson’s Personnel Setup record > Interface Mapping tab, click Click here to add an Employee Interface Mapping.
Figure 11: Add Employee Interface Mapping dialog
Set the values on the Employee Interface Mapping for salespeople as indicated in the following table. Note that the User ID within the Add Employee Interface Mapping must match the Salesperson ID in TechMate.
Field |
Value |
Interface |
TechMate |
User ID |
Salesperson identifier from TechMate |
Labor Type |
Sales |
Branch |
Optionally select which branch you wish this salesperson to shown on orders imported or exported to TechMate. |
Use as default when Branch not defined |
Optionally set this flag to indicate a default record. |
STEP 7: Create a Queue Service Server record.
Setup: MoversSuite Administration> Queue Service > Queue Service Server Setup
This step supports the automated download process.
NOTE: Step 7 in these TechMate Automated Integration Setup instructions is different from the Step 7 in the instructions for TechMate Manual Integration Setup.
From MoversSuite Administration> Queue Service > Queue Service Server Setup, at the top of the screen click Click here to add a new Queue Service Server.
Figure 12: Click to add a new Queue Service Server Setup record
When clicked, the New Queue Service Server screen appears. Create the following record by entering the information shown and detailed on the technical table below. When all the information in entered and added, the final record will look like the image below:
Figure 13: The final Queue Service Server Setup record for TechMate
Field |
Value |
Queue Service System |
MoversSuite Queue Service |
Queue Server Name |
TechMate Xml Download |
Inactive |
Important: This must be unchecked as shown in the image above. |
After entering the values in the table above, Choose Click here to add a new Queue Service Server Queue to open the Add Queue Service Server Queue screen.
Three Queue Service Server Queues must be added. Each one is detailed below with the information that needs to be entered and an image of the corresponding record after it is added. The choice of Queue Type will determine which fields are available.
1. Request Queue:
Field |
Value |
Click here to add a new Queue Service Server Queue |
Queue Role: Request Queue (Incoming messages to be processed) |
Queue Type: File System Folder | |
Queue Folder Name: C:\TechMate\Request | |
Filter |
Auto-populates as shown |
Minimum Message Age (in Milliseconds) |
Auto-populates as shown |
Message Type |
Auto-populates as shown |
2. Retry Queue:
Field |
Value |
Click here to add a new Queue Service Server Queue |
Queue Role: Retry Queue (Holds messages for later re-processing) |
Queue Type: Microsoft Messaging | |
Path to the Microsoft Messaging Queue: .\private$\mss_TechMate_xml_retry |
3. Error Queue:
Field |
Value |
Click here to add a new Queue Service Server Queue |
Queue Role: Error Queue (Holds bad messages that cannot be processed) |
Queue Type: Microsoft Messaging | |
Path to the Microsoft Messaging Queue: .\private$\mss_TechMate_xml_error |
RELATED INFORMATION
TechMate Moving from Manual to Automated Setup