Module 1 of 4: Transflo Express Batch Import Service

The TRANSFLO® Express Batch Import Service provides the ability to submit third-party transactions that include Index field data for document typing so that output is received that includes document types for each document recognized as well as the index field data submitted.

This service adds the ability to pick up network folder transactions for TRANSFLO® Express processing in the format of a batch either with or without index field data.

This document is intended to be used as a sample for internal TRANSFLO® Software Developers, Engineers, and Architects of TRANSFLO® Express customers.

This non-visual component requires all customer and service configuration to be done directly in the XML and configuration files.

Pegasus TransTech reserves the right to make updates and improvements to this information without notice.

Install the Transflo Express Batch Import Service

To install the TRANSFLO® Express Batch Import Service:

1. Launch TRANSFLO® Express Batch Importer Service Setup.exe from the installation location.

The Welcome window for the TRANSFLO® Express Batch Importer Service Setup Wizard opens.

2. Click Next.

The Select Destination Location window opens.

3. To accept the default path, click Next (If necessary, you can click Browse and select a different location for the installation.)

The Ready to Install window displays the installation settings.

4. Click Install

A confirmation window indicates successful installation of the components.

5. Click Finish.

Configure the Transflo Express Batch Importer

This file allows you to configure global settings for the import service, log file, web service, and transaction zip size.

  1. The default location is:

C:\Program Files\Pegasus TransTech\BatchImporter\BatchImporter.exe.config

If necessary, update the values for the following settings:

PollingIntervalSeconds

Set the value for the number of seconds that should elapse between pollings of the service.

LogDirectory

Set the value to indicate the location of log files generated by the application.

LogFlush

Set the value to True or False to indicate whether log files should be flushed periodically.

LogLevel

Set the value to an integer between 0 and 4 to indicate the degree of logging required.

The available log levels are:

0 - No Logging

1 - Errors Only

2 - Errors and Warnings

3 - Detailed

4 - Trace

WebServiceUrl

Set the value to the web service URL address for the external source for batches.

UserName

Set the value for the user name required to access the external source.

Password

Set the value for the password required to access the external source.

MaxZipSize

Set the value for the maximum transaction ZIP file size in megabytes.

The default is 20 megabytes, which means that batches over that size are rejected.

 

Customer Configuration File

This file allows you to configure individual customer information by creating a node for each customer.

Note: For the Batch Importer to read an XML file, the format must conform to the following requirements:

  • XML encoding must be UTF-8. The component will not read the XML in UTF-8 BOM.

  • The following header must be at the top of the file contents: <?xml version="1.0"?>

The default location of the Customer configuration file is:

C:\Program Files\Pegasus TransTech\BatchImporter\CustomerConfig.xml

This file provides a template that can be used to configure customer settings.

The attributes in the first section are required if ZIP files need to be read from a file system folder.

The attributes in the second section are required if ZIP files need to be read from an FTP site.

In the first section, configure values for settings for each specific customer:

Name

Set the value for the customer name, which can be any alphanumeric string. Although not technically required, the value should be unique because it is primarily used to search through log files.

Scac

Set the value to the code defined in TFX for external sources, which usually matches the fleet ID.

UseFTP

Set the value to N to search the file system or Y to search an FTP server. (Y is not currently supported.)

NumberOfZipsPerCycle

Set the maximum number of ZIP files to extract in every polling interval.

SourceDirectory

Set the location of the folder from which files are extracted.

ErrorDirectory

Set the location of the folder to which failed files are saved.

ArchiveDirectory

Set the location of the folder to which successful files are saved.

DaysToKeepArchive

Set the number of days to retain successful files in the archive folder.

HeaderFileName

Set the name of the XML file that contains the information for reading the ZIP files.

ExtractIndexFields

Set the value to Y to require extracting index fields from the XML header file defined in the HeaderFileName.

If the header file cannot be found, the batch fails.

Setting the value to N removes the requirement to have access to a valid HeaderFileName.

ServiceType

Set the value of the service type for billing purposes for this customer.

This value prefaces the confirmation number with the service type code.