TransDocs Integration Setup

MoversSuite integrates with TransDocs allowing files to transfer through UniGroup queues into and out of the MoversSuite application. MoversSuite utilizes the MoversSuite API Service and the MoversSuite Queue Service to process the document requests.

MoversSuite orders must have the following attributes to enable upload and download capabilities for TransDocs files:

• Orders must be registered with UniGroup and booked in MoversSuite

• Orders must be “Van Line” authority as set through the Authority field in Move Information and Order Information (Revenue Entry)

• Document files are in Tagged Image File Format (TIF or TIFF), e.g. “sample.tif”, or Portable Document Format (PDF), e.g. “sample.pdf”. Only TIF or TIFF files will download into MoversSuite

• Document Type must match to an External Code support by TransDocs

• For automatic uploads to occur: Document Type must match the Shipment Type of the order as defined within Document Type (Auto-Upload) Setup and set for the order within the Shipment Type field in Move Information and Order Information (Revenue Entry)

The following table describes the setup needed to enable TransDocs integration.

NOTE

UniGroup TransDocs is an optional, add-on module that purchased in addition to existing MoversSuite licensing.

Setup Area

Description

Document Type Setup

Document Type records for the UniGroup interface (see XML Interface Setup) must be defined with an External Code supported by UniGroup and mapped accordingly.

The application references the Document Type when uploading and downloading documents automatically. Additionally, users will reference this Document Type field through the following:

Attach File

Document Management Viewer

Properties

Re-Processing Document

Third Party Application Error Management

Suggestion: See the note for the Description setting within Document Type Setup regarding useful naming conventions.

For automatic uploading of documents to be in effect, the Auto Upload Shipment Type must match the Shipment Type set for the order in Move Information. See Document Type (Auto-Upload) Setup for more information.

Queue Service Setup

Verify the queue service setting are correct and functioning.

Optionally, add Queue Service Message Type Items for the services you wish to receive a copy of the message exchanged between the process and the MoversSuite Queue Service. The type of messages related to TransDocs includes:

UniGroup TransDocs Download

UniGroup TransDocs Error Download

UniGroup TransDocs Upload

Queue Service Server Setup

TRANSDOCS DOWNLOAD:

Create an entry for a download from the UniGroup TransDocs system. This record points MoversSuite to the request, retry, and error file locations.

Field	Value
Queue Service System	MoversSuite Queue Service
Queue Server Name	UniGroup TransDocs Download
Discard All Bad Messages	(unchecked)
Inactive	(unchecked)

Create three Queue records underneath this one record as specified below.

Define a Request Queue:

Field	Value
Queue Role	Request Queue
Queue Type	IBM Messaging
IBM Messaging Queue	U99999.XMLA.AGT_IMAGE_FEED.DOWNLOAD
Queue Manager Name	UPQX
Channel Name
Connection Name
Default Receive Format	MQHRF2 (TransDocs)
Use Message Grouping	(unchecked)
Transport Type	TCP/IP
Encoding	ASCII

Define a Retry Queue:

Field	Value
Queue Role	Retry Queue
Queue Type	Microsoft Folder
Path to the Microsoft Messaging Queue	.\private$\mss_transdocs_retry

Define an Error Queue:

Field	Value
Queue Role	Error Queue
Queue Type	Microsoft Messaging
Path to the Microsoft Messaging Queue	.\private$\mss_transdocs_error

TRANSDOCS UPLOAD:

Create an entry for an upload from the UniGroup TransDocs system. This record points MoversSuite to the request, retry, and error file locations.

Field	Value
Queue Service System	MoversSuite Queue Service
Queue Server Name	UniGroup TransDocs Upload
Discard All Bad Messages	(unchecked)
Inactive	(unchecked)
Parent Folder for File System Queues

Create four Queue records underneath this one record as specified below.

Define a Request Queue:

Field	Value
Queue Role	Request Queue
Queue Type	Microsoft Messaging
Path to the Microsoft Messaging Queue	.\mss_transdocsupload_request

Define a Mirror Queue:

Field	Value
Queue Role	Request Queue
Queue Type	IBM Messaging
IBM Messaging Queue	U99999.XMLA.AGT_IMAGE_FEED.UPLOAD
Inactive	(unchecked)
Queue Manager Name	UPQX
Channel Name
Connection Name
Default Receive Format	-none-
Use Message Grouping	(checked)
Transport Type	TCP/IP
Encoding	ASCII

Define a Retry Queue:

Field	Value
Queue Role	Retry Queue
Queue Type	Microsoft Messaging
Path to the Microsoft Messaging Queue	.\private$\mss_transdocsupload_retry

Define an Error Queue:

Field	Value
Queue Role	Error Queue
Queue Type	Microsoft Messaging
Path to the Microsoft Messaging Queue	.\private$\mss_transdocsupload_error

XML Interface Setup

Verify that the “UniGroup Queues” interface is defined. You will link TransDocs data to this interface through XML System Setup.

XML System Setup

Use this setup to define the system options for the TransDoc processes under the “UniGroup Queues” system.

Locate the XML System Setup record for the UniGroup Interface and Internal/External System values of “UniGroup Queues.”

Create two XML System Option records under the UniGroup Queues record:

TransDocsUploadQueue

Enter the physical location of the folder containing the TransDocs upload request, example: .\private$\mss_transdocs_upload_request

AutoUploadDocumentDisabled

Set this flag to a value of“True” to disable auto upload of documents to TransDocs. A value of “False” allows documents to auto upload to TransDocs (default).

Define XML System Data Type Map records for processing the TransDocs documents.

Field	Value
XML System Date Type	Documents
Name	TransDocs
Clear previous XML errors before reprocessing	(unchecked)

If using PSI:Capture, then create a second entry as noted below.

Field	Value
XML System Date Type	Documents
Name	PSI:Capture
Clear previous XML errors before reprocessing	(unchecked)

See XML System Setup (UniGroup) and PSI:Capture Integration Setup for related setup information.

RELATED TOPICS:

PSI:Capture Integration Setup

UniGroup Download Setup and Administration

UniGroup Upload Setup and Administration

XML System Setup (UniGroup)