Location Settings
Overview
In the Settings section, you can configure the following non-carrier-specific settings:
Setting |
Description |
Automated Export System |
Enable and configure AES for Parcel carriers, such as UPS, FedEx and DHL Global. |
Box Size |
Add, edit, delete universal (non-carrier-specific) box types that your company uses to ship packages. |
Cut Off Times |
Add, edit, delete cut off time records for use by Parcel. A cut off time for a carrier tells Parcel when to begin a new shipping day for that carrier. |
Currency Codes |
Add, edit, delete currency codes for use when shipping international packages. |
Handling Type |
Add, edit, delete handling types. Handling types are the container types (such as barrel, bin, case, pallet, skid) used for LTL and TL shipments. |
Customs Filing Module Integration |
Enable and configure CFM with Parcel. |
Control Tower Integration |
Enable to configure CT FTP with Parcel. |
Export Integration |
Enable and configure Export Integration with Parcel. |
Export Mode of Transport Mapping |
Set the values that Export uses to represent the Mode of Transport for a shipment. |
Export Messages |
This table allows you to enter status messages to be returned by Export. |
LTL Class |
Add, edit, delete the National Motor Freight Classification (NMFC) Codes and a descriptions for the tariff for the NMFC Classes in the drop-down list. |
Notification Service Config |
Add, edit, delete e-mail notification records for use by Parcel. |
Printer Map |
Add, edit, delete printers for use by Parcel. |
Shipper Defaults |
Configure Shipper Default settings for this location. |
Unit of Measure (Item) |
Add, edit, delete unit of measure codes for use when shipping international packages. |
Address Validation |
Configure information used to validate addresses in Parcel. |
Connect Configuration |
Configure information if you are using the Integration Adapter (see section Connect Configuration Overview) to access Parcel. |
Automated Export System
U.S. Exporters use the Automated Export System (AES) to electronically declare international exports to the U.S. Census Bureau to help compile export and trade statistics. This information is shared with other Federal agencies involved in monitoring and validating exports.
For U.S. origins (including Puerto Rico) you can enable the following Parcel carriers under a specific Location for use with AES:
-
UPS
-
FedEx
-
DHL Global
To enable a parcel carrier for AES:
-
Configure the fields on this screen according to the following table:
In this box...
Do this...
United Parcel Service
To enable a UPS carrier for AES for this location, select this check box.
Federal Express
To enable a FedEx carrier for AES for this location, select this check box.
DHL Global
To enable a DHL Global carrier for AES for this location, select this check box.
-
Click SAVE to save the configuration or click CANCEL to exit this screen without saving.
Box Size
Use the Box Size screen in the Settings section of a location to add, edit, generic (non-carrier-specific) box types that your company uses to ship packages.
You can use these pre-defined box types to save time while processing packages. Using box types saves time because you do not have to type in the dimensions for the box; you can select the box type on the Parcel Warehouse screen.
Note: The box type appears in the Packaging list on the Parcel tab of the Warehouse page and on Step 3 of the Desktop application.
Add a Box Type
-
Click ADD icon at the top of the screen. The Add Record dialog box appears.
-
Complete the boxes as follows:
In this box...
Do this...
Name
Type a name for the box type.
Description
Type a short description for the box type.
The Description appears in the Packaging list on the Parcel tab of the Warehouse page and on Step 3 of the Desktop application.Length
Type the length of the box type.
Width
Type the width of the box type.
Height
Type the height of the box type.
Non-Conveyable
If the box type cannot go through a conveyor system, select the check box.
If the box type is conveyable or machinable, clear the check box.Unit of Measure
Type the unit of measure used for the dimensions.
-
Click SAVE to save the new box type. Otherwise, click the CANCEL to cancel the new box type.
Edit a Box Type
-
Click EDIT icon in the left column in the row containing the record that you want to edit.
-
A dialog box appears. Edit the fields as needed.
-
Click SAVE at the bottom of the dialog box to save the changes.
Delete a Box Type
-
Click DELETE icon in the left column in the row containing the record that you want to delete.
-
A confirmation dialog box appears. Click OK to delete the record. Or click CANCEL to keep the record.
Cut Off Times
Use the Cut Off Times screen in the Settings section of a location to add, edit, delete cut off times for use by Parcel.
A cut off time for a carrier tells Parcel when to begin a new shipping day for that carrier. For example, if DHL allows you to ship until 2 AM tomorrow but still considers the ship date to be today, you can set the cut-off for DHL to be 2 AM. Parcel will then use the previous day's ship date for DHL packages processed from midnight until 2 AM.
Add a Cut Off Time Record
-
Click the ADD icon at the top of the screen. The Add Record dialog box appears.
-
Complete the boxes as follows:
In this box...
Do this...
Carrier
Type the name of the carrier that this cut off time range applies to. Type ALL if it applies to all carriers.
Service
Type the name of the carrier's service that this cut off time range applies to. Type ALL for all services.
Specific Day
If this cut off time range applies only to a specific day of the week, select that day from the list.
Specific Date
If this cut off time range applies only to a specific date, type that date in this format: yyyymmdd.
Start Time
Type the start time of this cut-off time range. Use the 24-hour format. For example, for midnight, type 0000.
Caution: For this feature to work correctly, it is important to enter 0000 for this value and not 2400.End Time
Type the end time of this cut-off time range. Use the 24-hour format. For example, for 2 a.m., type 0200.
Caution: The latest value that can be used for end time is 2359 (24-hour equivalent of 11:59 p.m.)Day Increment
Type a positive or negative number to indicate the number of days to increment the ship date to when in the cut off time range.
For example, if DHL allows you to use the previous day's ship date for packages processed between midnight and 2 a.m., type -1 (a negative sign, then a 1).New Time
Type the time to use as the ship time for packages processed within this cut off time range.
-
Click SAVE to save the new cut off time record. Otherwise, click CANCEL to cancel the new record.
Edit a Cut Off Time Record
-
Click EDIT icon in the left column in the row containing the record that you want to edit.
-
A dialog box appears. Edit the fields as needed.
-
Click SAVE at the bottom of the dialog box to save the changes.
Delete a Cut Off Time Record
-
Click DELETE icon in the left column in the row containing the record that you want to delete.
-
A confirmation dialog box appears. Click OK to delete the record. Or click CANCEL to keep the record.
Currency Codes
Use the Currency Codes screen in the Settings section of a location to add, edit, delete currency codes for use when shipping international packages.
Add a Currency Code
-
Click the ADD icon at at the top of the screen. The Add Record dialog box appears.
-
Complete the boxes as follows:
In this box...
Do this...
Currency
Type the name of the currency; for example, Canadian Dollar.
Code
Type the three-character code for the currency; for example, CAD for Canadian Dollar.
-
Click SAVE to save the new currency code. Otherwise, click CANCEL to cancel the new currency code.
Edit a Currency Code
-
Click EDIT icon in the left column in the row containing the record that you want to edit.
-
A dialog box appears. Edit the fields as needed.
-
Click SAVE at the bottom of the dialog box to save the changes.
Delete a Currency Code
-
Click the DELETE icon in the left column in the row containing the record that you want to delete.
-
A confirmation dialog box appears. Click OK to delete the record. Or click CANCEL to keep the record.
Handling Type
Use the Handling Type screen in the Settings section of a location to add, edit, delete handling types. Handling types are the container types (such as barrel, bin, case, pallet, skid) used for LTL and TL shipments.
Add a Handling Type
-
Click ADD icon at the top of the screen. The Add Record dialog box appears.
-
Complete the boxes as follows:
In this box...
Do this...
Display Group
Type the description for the Handling Type as it will appear in the Parcel user interface.
Unit
Type the three-character code for the Handling Unit; for example, PLT is the code for Pallet.
Description
Type the description of the Handling Type; for example, "Pallet" is the description for PLT.
Note: Description appears in the LTL Packaging Type, LTL Type, and Handling Type lists on the Parcel tab of the Warehouse page.Weight
Type the default Weight for the Handling Type if applicable. This value enables Parcel to calculate Total Weight for the shipment.
-
Click SAVE to save the new handling type. Otherwise, click the CANCEL to cancel the new handling type.
Edit a Handling Type
-
Click the EDIT icon in the left column in the row containing the record that you want to edit.
-
A dialog box appears. Edit the fields as needed.
-
Click SAVE at the bottom of the dialog box to save the changes.
Delete a Handling Type
-
Click DELETE icon in the left column in the row containing the record that you want to delete.
-
A confirmation dialog box appears. Click OK to delete the record. Or click CANCEL to keep the record.
Customs Filing Module Integration
The Customs Filing Module (CFM) functions with Parcel for export Customs filing. CFM processes international shipments originating in the United States through the Automated Export System (AES). CFM first validates the Customs data for an international shipment, and then submits this data to AES and polls for responses, returning status messages accordingly.
The CFM module operates in conjunction with Parcel as a plugin to the Orchestration Layer (OL). Thus, to use the CFM module with Parcel, you must first install the Orchestration Layer, CFM, the CFM plugin to the Orchestration Layer, and the AES application that allows you to connect to AES. (Note that each application has a separate installer; for more information, see the following general procedure and the installation guides for these applications.) Next, you must enable and configure OL under Global Settings. Finally, enable and configure CFM under the location where you want to use CFM.
Installing CFM Components
Note: Installation documentation for each component except the AESDirect VPN connection is included with your Parcel distribution, including hardware and software requirements.
Install the required CFM components in the following order.
-
The Orchestration Layer. This application facilitates communication between Parcel and CFM via XML. See the Orchestration Layer Installation Guide for information.
-
The Customs Filing Module. See the CFM Installation and Configuration Guide.
-
The Customs Filing Module plugin adapter. See the Customs Filing Module 1.0 Orchestration Layer Plugin Installation Guide for information.
-
AESDirect VPN software. This application enables transmission of Customs data to AES for processing and the return of status messages. You obtain this application and installation instructions when you set up the required account with AES. See the AESDirect Web site for more information.
Configuring CFM with Parcel
Warning: Check to ensure that you do not activate both Export and the Customs Filing Module (CFM) for the same location. You can, however, use Export for one location and CFM for a different location.
Caution: The CFM module operates in conjunction with Parcel as a plugin module to the Orchestration Layer (OL). To use the CFM module with Parcel, you must enable and configure OL under Global Settings. See the section Global Settings >Orchestration Layer Integration.
The following settings are available from the Export Integration option in the Web Admin tool left panel for each Location.
This field... |
Is for this data... |
Process International Shipments via CFM |
Select this check box to enable processing on International shipments via the Customs Filing Module for this location. This check box is de-selected (cleared) by default. |
Print Notification Type for Ship and Continue |
From the drop-down list, select the notification type to be used in Ship and Continue mode for this location:
|
Notification Template / Text |
Type the template name to be used when generating Label or Notification Text to be printed when generating a document.
|
Enable Transaction Reference Generation |
Select this check box to generate a sequential transaction reference string for each CFM transaction.
|
Optional Reference Prefix |
Optionally, type a prefix to prepend to CFM reference numbers. |
Reference Sequence Start |
Type the starting number for the sequential numeric portion of the Transaction Reference or accept the default of 1. |
Reference Sequence End |
Type the ending number for the sequential numeric portion of the Transaction Reference or accept the default of 9999999999. |
Tenant ID |
Type the Tenant ID to be used for CFM and Customs Management - AES integration. |
Username |
Type the Username to be used for Customs Management - AES integration. |
Password |
Type the Password to be used for Customs Management - AES integration. |
Terminal ID |
Type the Terminal ID to be used for CFM and Customs Management - AES integration. |
Click SAVE to save the values entered or click CANCEL to cancel this operation.
Control Tower Integration
CT SFTP Configuration
The following settings are available from the Control Tower SFTP Configuration to transmit and receive data.
This field... |
Is for this data... |
Customer Code |
Enter the Customer Code for which the export is configured. |
Export File Upload |
|
SFTP Server Name |
Enter the SFTP server address for uploading the exported Billing and Expense Data files. |
SFTP Port Number |
Enter the port number of SFTP server for uploading the exported Billing and Expense Data files. |
SFTP Username |
Enter the user name of SFTP server for uploading the exported Billing and Expense Data files. |
SFTP Password |
Enter the password of SFTP server for uploading the exported Billing and Expense Data files. |
SFTP connection timeout |
Enter the SFTP connection timeout in seconds, Default value is 90 secs. |
Transport Order Upload Folder |
Enter the CT SFTP Transport order upload folder name. |
Status Upload Folder |
Enter the CT SFTP status upload folder name. |
Status Download Folder |
Enter the CT SFTP status download folder name. |
Import Status File |
Select this check box to enable the status import from CT. This check box is selected by default. |
Click SAVE to save the values entered or click CANCEL to cancel this operation.
Export Integration
Location Configuration
The Location Configuration screens are used to enable Export Integration at the location level, as well as providing the ability to specify the Export Integration notification template for the location.
Warning: Check to ensure that you do not activate both Export and the Customs Filing Module for the same location.
These settings are available from the Export Integration option in the Web Admin tool left panel for each Location.
This field... |
Is for this data... |
Process International Shipments via Export |
Select this check box to enable processing on International shipments via Export for this location. This check box is de-selected (cleared) by default. |
Print Notification Type for Ship and Continue |
From the drop-down list, select the notification type to be used in Ship and Continue mode for this location:
|
Notification Template Text |
Type the template name to be used when generating Label or Notification Text to be printed when generating a document.
|
Export Send Only |
Select this check box to have the Export Integration process only send data to Export but not wait for or process any returns from Export. |
Click SAVE to save the values entered or click CANCEL to cancel this operation.
Export Mode of Transport Mapping
Export uses the following values to represent the Mode of Transport for a shipment. In this way, Export Integration provides a method for linking these to each Parcel Carrier Service that supports International shipments. This screen is in editable table form but should not be modified without consulting e2open, LLC. It is intended to be used as a reference.
Field |
Data Name |
Carrier |
Parcel Internal Carrier Code. |
Service |
Parcel Service Code. |
Numeric Code |
Export Numeric Code. |
Alpha Code |
Export Alpha Code. |
Export Messages
Export uses two values to represent the Mode of Transport for a shipment. Export Integration provides a method for linking these to each Parcel Carrier Service that supports International shipments.
Edit the table as you would any table in the Web Admin tool. See the section
Conventions
.
This field... |
Is for this data... |
Export Status |
Export Status. |
Message |
Display Message. |
LTL Class
LTL Class is determined by the National Motor Freight Classification (NMFC) tariff. The NMFC class of your freight is used to calculate how much an LTL carrier charges for a shipment. Use the Parcel LTL Class screen to specify NMFC classes, codes, and descriptions.
Note: NMFC Classes and Codes are readily available online. The following table provides one example.
Add LTL Class
-
Click ADD icon at the top of the screen. The Add Record dialog box appears.
-
Complete the boxes as follows:
In this box...
Do this...
NMFC Code
Type the numeric NMFC code for the item; for example: 80460
Description
Type the description of the item; for example, "Steel storage cabinets, no glass, set up" (without quotation marks).
NMFC Class
From the drop-down list, select the NMFC Class of the item; for example: 150 (Steel Storage Cabinets)
Note: There are 18 NMFC Classes listed. -
Click SAVE to save the new currency code. Otherwise, click CANCEL to cancel the new currency code.
Edit an LTL Class
-
Click EDIT icon in the left column in the row containing the record that you want to edit.
-
A dialog box appears. Edit the fields as needed.
-
Click SAVE at the bottom of the dialog box to save the changes.
Delete an LTL Class
-
Click DELETE icon in the left column in the row containing the record that you want to delete.
-
A confirmation dialog box appears. Click OK to delete the record. Or click CANCEL to keep the record.
TMS Integration
TMS Integration FTP/File Share Details
TMS Integration enables Parcel shipping capabilities in the Transportation Management System (TMS). In this integration, TMS serves as the user interface (UI) for the Parcel system.
The TMS Integration screen is set up at the location level for entering and updating information for the FTP Server and/or File Sharing Details for the relevant manifest files and reports (CLOSE and UPLOAD).
The following settings are available in the Web Admin tool left panel under each Location.
Field |
Data |
File Transfer Type |
Select the File Transfer Type from the drop-down list. Options are:
|
Parcel FTP Details |
|
Server |
Enter the FTP/File Share Server URL or IP address. |
Port |
Enter the Port Number used to connect to the FTP/File Share Server. |
Username |
Enter the Username used to access the FTP/File Share Server. |
Password |
Enter the Password used to access the FTP/File Share Server. |
Close Status Destination Path |
Enter the Close Status Destination Mailbox Folder Path Located on the FTP/File Share Server. |
Documents Destination Path |
Enter the Documents Destination Mailbox Folder Path located on the FTP/File Share server. |
Click SAVE to save the values entered or click CANCEL to cancel this operation.
Notification Service Config
Use the Notification Service Config screen in the Settings section of a location to add, edit, or delete e-mail notification records for use by Parcel.
Notifications are e-mails that are automatically sent when a certain event occurs in Parcel such as the closing of a certain carrier or the uploading of a certain carrier's manifest.
This screen is meant to configure notifications in response to system-level events as opposed to shipment-level events. If you want to send an e-mail to the recipient of a shipment to notify them of when the shipment is sent, delivered, or delayed, you would do that while processing the shipment in Parcel.
Add a Notification Service Record
-
Click ADD icon at the top of the screen. The Add Record dialog box appears.
-
Complete the boxes as follows:
In this box...
Do this...
Carrier
Type the name of the carrier that this notification applies to. Type ALL if it applies to all carriers.
Service
Type the carrier's service name abbreviation that this notification applies to. Type ALL if it applies to all services.
Request
Type the code for the request (system-level event) that should trigger this notification. Requests include:
SHIP - for when a package is shipped
VOID - for when a shipment is voided
CLOS - for when a carrier is closed
UPLD - for when the end-of-day file is uploaded to the carrier.
To see the complete list of request codes and descriptions, click this link: Notification Request APIsType Name
From the drop-down list, select the type of notification. Currently, only notification via email is supported.
Template Part 1
Type or copy and paste the filename of the template to use for the subject area of the e-mail message. Notification templates are located in the following directory: ..\Flagship\bin\DocTemplates.
For instructions on creating templates, click this link: Creating Notification TemplatesTemplate Part 2
Type or copy and paste the file name of the template to use for the body area of the e-mail message. Notification templates are located in the following directory: ..\Flagship\bin\DocTemplates.
For instructions on creating templates, click this link: Creating Notification TemplatesDefault Email
Type the default e-mail address to which to send the email notification.
Template Type
From the drop-down list, select the type of template to use for the email message:
-
HTML
-
Text |
Click SAVE to save the new record. Otherwise, click CANCEL to cancel the new record.
-
Edit a Notification Service Record
-
Click EDIT icon in the left column in the row containing the record that you want to edit.
-
A dialog box appears. Edit the fields as needed.
-
Click SAVE at the bottom of the dialog box to save the changes.
Delete a Notification Service Record
-
Click DELETE icon in the left column in the row containing the record that you want to delete.
-
A confirmation dialog box appears. Click OK to delete the record. Or click CANCEL to keep the record.
Printer Map
Use the Printer Map screen in the Settings section of a location to add, edit, or delete printers for use by Parcel. The settings on this screen override any carrier-specific settings in the carrier Shipper Defaults screens.
Client-based Printing using the Location Settings Printer Map
When you configure a printer using the Add Record or Edit Record screens under Location > Settings > Printer Map, this activates a Parcel feature called Client-based Printing. This feature configures a local printer to print from a local client (workstation) that is accessing Parcel. When you create a shipment and click Ship, the Parcel server returns the label printing information to the Parcel client in the form of a file type specific to the local printer, and the client then sends this output file directly to the local printer.
Notes:
-
This feature requires you to let Parcel install KPrint ActiveX. The first time you log in, you are prompted to allow Parcel to automatically install KPrint ActiveX (as well as ScaleX). KPrint is a collection of Java classes that allows the user to generate print layouts within the Standard Widget Toolkit (SWT) framework for Java. After Parcel installs KPrint ActiveX, if you have not done so, you must also configure your Internet Explorer (IE) browser to enable ActiveX controls. For information about configuring IE to allow ActiveX, see the Help topic Logging In.
-
To enable Client-based printing, you must also activate the Enable Dynamic Printer check box on the Advanced Tab of the Location > Shipper Defaults screen. For more information on this screen, see the section Advanced Tab .
-
For Hazmat printing, some parameter values have different requirements. See the Notes in the following table.
Add a Printer
-
Click ADD icon at the top of the screen. The Add Record dialog box appears.
-
Complete the boxes as follows:
In this box...
Do this...
Printer IP Address
Type the name of the computer that the Parcel application (browser-based UI/Web GUI) is installed on, like this: WORKSTATIONNAME For example: MARLSMITH4
Note: This configuration assumes that the location from which printing is done has network domain access to this printer.Printer Name
Type the network name and location of the printer like this: \\SERVERNAME\PRINTERNAME
For example: \\GOYALE\LEXMARK
Note: For hazardous materials (hazmat, dangerous goods) printing, type only the share name of the printer like this: PRINTERNAME
For example: LEXMARK
The following cases obtain:
Local document printer: \\\printer name
Local label printer: printer name
Network label or document printer: \\Network\printer namePrinter Port
Type the TCP/IP port number through which the printer is connected to Parcel. In TCP/IP, there is an IP address and a port (for example, 10.10.1.160, port 1200).
Notes:-
If the printer is a PNG printer, then type "png" (no quotation marks, all lower case) in this field.
-
For hazmat printing only, type the server name with no slashes; for example: GOYALE
-
Currently, this field allows a maximum of eight characters.
Printer Type
From the drop-down list, select the type of printer you are configuring. Currently supported printers are as follows:
-
Windows
-
Zebra 4M
-
Monarch
-
Eltron
-
Zebra LP2443
-
Zebra LP2844
-
INTERMEC-PM4i
-
DATAMAX-4208/PRODIGY
-
ProdigyMax E Class
Label Printer
From the drop-down list, select Yes if the printer is a label printer or No if the printer is not a label printer.
Printer IP Ext
To identify a printer that is loaded with a specific type of label or document stock (for example, FedEx Ground OP-900 LL multi-ply form for hazardous materials shipments), type the IP extension for that printer. Valid values are as follows:
-
IATA_HAZMAT – For the IATA Shipper's Declaration for Dangerous Goods form.
-
FEDEX_OP900 – For the FedEx Ground OP 900 LL multi-ply form for hazardous materials shipments.
-
UPS_HAZMAT – For the UPS Laser Compatible 8-part Hazardous Materials Shipping Paper.
-
UPS_HAZMAT_CB – For the UPS Cross Border Ground Dangerous Goods Shipping Paper.
Note: When you select the corresponding form from the drop-down list for a carrier, if you have a printer configured with the above IP extension(s), Parcel automatically sends the form to be printed on that printer.
Profile
If you want to apply a group of settings (a profile that you previously set up) to this printer, type the profile name. You can create profiles in the printer profile table in the didb database.
Click SAVE to save the new printer configuration. Otherwise, click CANCEL to cancel the new printer configuration.
-
Edit a Printer
-
Click EDIT icon in the left column in the row containing the record that you want to edit.
-
A dialog box appears. Edit the fields as needed.
-
Click SAVE at the bottom of the dialog box to save the changes.
Delete a Printer
-
Click DELETE icon in the left column in the row containing the record that you want to delete.
-
A confirmation dialog box appears. Click OK to delete the record, or click CANCEL to keep the record.
Input Validation Expression
Use the Input Validation screen in the Settings section of a location to add, edit, delete a custom expression for validating a particular type of input data in Parcel.
Add an Input Validation Expression
-
Click ADD icon at the top of the screen. The Add Record dialog box appears.
-
Complete the boxes as follows:
In this box...
Do this...
Validation Name
Type the name of the input validation expression; for example: "isNumber" (without quotation marks).
Custom Validation Expression
Type the custom validation expression; for example: /^0-9+(\.0-9+)?$/
-
Click SAVE to save the new currency code. Otherwise, click CANCEL to cancel the new currency code.
Edit an Input Validation Expression
-
Click EDIT icon in the left column in the row containing the record that you want to edit.
-
A dialog box appears. Edit the fields as needed.
-
Click SAVE at the bottom of the dialog box to save the changes.
Note: You can also edit fields on this screen directly by clicking directly on the field. This action causes the field to be displayed in direct edit mode. Click the disk icon to save changes.
Delete an Input Validation Expression
-
Click DELETE icon in the left column in the row containing the record that you want to delete.
-
A confirmation dialog box appears. Click OK to delete the record. Or click CANCEL to keep the record.
Shipper Defaults
General Tab
Use the General tab to configure the following settings for the location.
Note: These are the default location-level settings for shipments using the Parcel UI.
Top Section
In this box... |
Do this... |
Add Charge |
Select the check box to add the custom charge (next box) to every order (i.e., handling charge) in addition to the freight charge. If checked, the fee is applied to non-revenue orders processed in the Parcel Server as well as revenue orders. |
Customer Charge |
Type the fee that will be added to every order (in addition to the freight charge) if the Add Charge check box above is selected (checked).
|
Business Number |
Type the federal government assigned Business Number (BN) of the person or company that exports the goods or causes them to be exported. This number is printed in the B13A Canada Customs form, if entered by the Shipper. |
Business Number RM |
Type the federal government assigned Business Number (BN), including the six digit RM account identifier, of the person or company that exports the goods or causes them to be exported. This number is printed in the B13A Canada Customs form, if entered by the Shipper. |
Place of Exit |
Type the place of exit through which the goods are expected to leave Canada. |
Is Exporter |
Select the check box, if the responsible party is the exporter of the shipments. |
Date/Currency Format (Required Field) |
From the drop-down list, select the type of the date and currency format to use in the shipping application and on labels and documentation printed from the Parcel Server. The choices are:
|
Blind Company Name |
Type the company name to print on labels and documentation for shipments processed from this location instead of the company name that appears in the Ship From box in the shipping application. |
Default INTL Currency |
From the drop-down list, select the default currency unit to use on the INTL tab of the Warehouse screen; for example: "Chilean Peso". |
Unit of Weight (Required Field) |
Select the unit of weight to use for shipments processed from this location. The choices are pounds and kilograms:
|
Is WMS |
Select the check box if the location is running the Optum Move Warehouse Management System. |
Auto Multi Piece |
From the drop-down list, select Yes or No to indicate if auto multi-piece is allowed. |
Unit of Measurement (Required Field) |
From the drop-down list, select the unit of measure for measuring parcels. The choices are as follows:
|
Customer Charge Type |
From the drop-down list, specify whether customer charge is to be a fixed amount or a calculated percentage. |
Location Currency |
From the drop-down list, select the Location Currency that you want Parcel to display on the UI, as well as to record in the System of Record (SOR) database.
|
Dangerous Goods Section
In this box... |
Do this... |
Emergency Response Contact |
Type the contact in case of emergency.
|
Emergency Response Phone |
Type the phone number to contact in case of emergency.
|
Disable ORM-D |
To disable the Other Regulated Materials Domestic (ORM-D) dangerous goods/hazardous materials classification for specific types of services, select one the following options from the drop-down list:
|
Click SAVE in the lower-right corner of the screen to save the settings for this location. Otherwise, click CANCEL to cancel the settings specified.
Field Customization Tab
Use the Field Customization tab to configure settings for the location.
Among the configurable fields on this tab are the following Mapping fields:
-
Reference One Mapping
-
Reference Two Mapping
-
Reference Three Mapping
-
Reference Four Mapping
-
Reference Five Mapping
Use these fields to specify a mapping to an API key. (The "No Mapping" option indicates that no API key is to be mapped.) The drop-down lists of values for the above Mapping fields provide the options listed in the following table:
This option... |
Maps to the API key... |
No Mapping |
No key. |
Customer Reference Number |
CUSTOMERREFERENCENUMBER |
Pro Number |
PRONO |
Sales Order Number |
SALESORDERNUMBER |
Purchase Order Number |
PURCHASEORDERNUMBER |
Contract Number |
CONTRACTNO |
Consignee Reference Number |
CONREF |
Commercial Invoice Number |
COMMERCIAL_INVOICE_NUMBER |
Note: The fields Reference1, Reference2, Reference3, Reference4, and Reference5 map to a completely different set of API keys than the fields Reference One, Reference Two, Reference Three, Reference Four, and Reference Five.
The following settings are configurable for the location.
In this box... |
Do this... |
Customer Code Alias |
Type the text to replace 'Customer Code' field on the user interface. |
Address 2 Alias |
Type the text to replace 'Address 2' field on the user interface. |
Address 3 Alias |
Type the text to replace 'Address 3' field on the user interface. |
Reference One Alias |
Type the text to replace 'Reference1' field on the user interface. |
Reference1 Default Value |
Type the default value to display in the Reference1 text box. |
Lock Reference1 |
Select 'Yes' or 'No' to indicate whether the Reference1 field is non-editable. The default value specified in Reference1 Default Value field is displayed and used while processing a shipment. |
Reference1 Is mandatory |
Select 'Yes' or 'No' to specify whether the Reference1 field is mandatory. |
Reference One Mapping |
Select a value to map to the corresponding API key (see previous table) or select "No Mapping" not to map to a key. |
Reference Two Alias |
Type the text to replace 'Reference2' field on the user interface. |
Reference2 Default Value |
Type the default value to display in the Reference2 text box. |
Lock Reference2 |
Select 'Yes' or 'No' to indicate whether the Reference2 field is non-editable. The default value specified in Reference2 Default Value field is displayed and used while processing a shipment. |
Reference2 Is mandatory |
Select 'Yes' or 'No' to specify whether the Reference2 field is mandatory. |
Reference Two Mapping |
Select a value to map to the corresponding API key (see previous table) or select "No Mapping" not to map to a key. |
Reference Three Alias |
Type the text to replace 'Reference3' field on the user interface. |
Reference3 Default Value |
Type the default value to display in the Reference3 text box. |
Lock Reference3 |
Select 'Yes' or 'No' to indicate whether the Reference3 field is non-editable. The default value specified in Reference3 Default Value field is displayed and used while processing a shipment. |
Reference3 Is mandatory |
Select 'Yes' or 'No' to specify whether the Reference3 field is mandatory. |
Reference Three Mapping |
Select a value to map to the corresponding API key (see previous table) or select "No Mapping" not to map to a key. |
Reference Four Alias |
Type the text to replace 'Reference4' field on the user interface. |
Reference4 Default Value |
Type the default value to display in the Reference4 text box. |
Lock Reference4 |
Select 'Yes' or 'No' to indicate whether the Reference4 field is non-editable. The default value specified in Reference4 Default Value field is displayed and used while processing a shipment. |
Reference4 Is mandatory |
Select 'Yes' or 'No' to specify whether the Reference4 field is mandatory. |
Reference Four Mapping |
Select a value to map to the corresponding API key (see previous table) or select "No Mapping" not to map to a key. |
Reference Five Alias |
Type the text to replace 'Reference5' field on the user interface. |
Reference5 Default Value |
Type the default value to display in the Reference5 text box. |
Lock Reference5 |
Select 'Yes' or 'No' to indicate whether the Reference5 field is non-editable. The default value specified in Reference5 Default Value field is displayed and used while processing a shipment. |
Reference5 Is mandatory |
Select 'Yes' or 'No' to specify whether the Reference5 field is mandatory. |
Reference Five Mapping |
Select a value to map to the corresponding API key (see previous table) or select "No Mapping" not to map to a key. |
Cost Center Alias |
Type the text to replace 'Cost Center' field on the user interface. |
Cost Center Value |
Type the default value to display in the Cost Center text box. |
Lock Cost Center |
Select 'Yes' or 'No' to indicate whether the Cost Center field is non-editable. The default value specified in Cost Center Default Value field is displayed and used while processing a shipment. |
Cost Center Is mandatory |
Select 'Yes' or 'No' to specify whether the Cost Center field is mandatory. |
Notes Alias |
Type the text to replace 'Notes' field on the user interface. |
Notes Value |
Type the default value to display in the Notes text box. |
Lock Notes |
Select 'Yes' or 'No' to indicate whether the Notes field is non-editable. The default value specified in Notes Default Value field is displayed and used while processing a shipment. |
Notes Is mandatory |
Select 'Yes' or 'No' to specify whether the Notes field is mandatory. |
ToHold Label |
From the drop-down list, select one of the following values:
|
Click SAVE in the lower-right corner of the screen to save the settings for this location. Otherwise, click CANCEL to cancel the settings specified.
Advanced Tab
Use the Advanced tab to configure the following settings for the location:
In this box... |
Do this... |
Rate Shop Display Order |
From the drop-down list, select a value to indicate sorting of the Rate result in increasing or decreasing order:
|
Validate Special Services on Rate Shop |
Select this check box to enable the validate normalized Special Services on Rate Shop.
|
Enable Dynamic Printer |
Select this check box to enable the dynamic printer usage functionality. On enabling this, the Workstation menu becomes available for setting a printer for a workstation for use with Parcel's
Client-based printing
feature.
|
Weight Polling Interval |
Type the number of seconds for the default interval at which Parcel polls the scale weight when the Piece Weight field on the Warehouse screen is set to automatically update the weight registered on the scale connected to Parcel; for example: 5
|
Ship to hold on PSHP error |
Select this check box to activate the following option: if a Pre-ship (PSHP) operation returns an error for a shipment, Parcel automatically processes the shipment To Hold.
|
Add hold data to shipment |
Select this check box to add data From Hold to the SHIP/PSHP message if the Shipment ID is specified.
|
Close Manifest and Upload Documents |
Select 'Yes' or 'No' to indicate whether to upload carrier manifests and generate end of day files during a manifest close request. |
Click SAVE in the lower-right corner of the screen to save the settings for this location. Otherwise, click CANCEL to cancel the settings specified.
Notes:
-
A TNT Express carrier does not print a label with PSHP requests.
The following services are not supported for PSHP/CSHP requests: - DHL Global Break Bulk Express (BBX) - FedEx COD - UPS WorldEase |
Reports Tab
Use the Shipper Defaults Reports tab to format the Jasper Reports and specify the Jasper Report Server information for the location.
Note: The following types of Jasper Reports are available by selecting Ship > Reports:
-
Carrier Manifests
-
ExpressCheque
-
Shipment Status
-
Shipment Cost Analysis
-
Trailer ID
For more information on Reports, see the following Help topic: Preparing for Carrier Pickup - Viewing, Printing, and Exporting Reports
Top section (report format)
In this box... |
Do this... |
Report Format |
Accept the default selection for the file format to use for Jasper Reports. Currently only PDF format (the default selection – "Portable Document Format") is supported. |
Report Requestor |
Accept the default "Parcel" as the application requesting the Jasper Report. |
Report Version |
Accept the Default "3.5" for the Jasper Report version. |
Report Server section
In this box... |
Do this... |
IP Address |
Type the IP address of the Jasper Reports Server if different from the default: 127.0.0.1. Otherwise, accept the default. |
Port |
Type the Port Number of the Jasper Reports Server if different from the default: 12345. Otherwise, accept the default. |
Location |
Type the path name where the Jasper Reports server is located if different from the default: ..\java |
Name |
Type the name of the Jasper Reports server or accept the default: "Service Reporting Server" |
Level |
Type the level for which the Jasper Reports are to be produced:
|
Waiting Time |
Type the number of seconds that Parcel should wait after submitting a report request to the Jasper Server before timing out the request. |
Is Report Printed |
This check box is selected (checked) by default. Deselect (uncheck) this check box if you do not want the Jasper Reports to be printed. |
Is Report Debug |
Select this check box if you want create the debug request and response files.
|
Debug Request Filename |
Type the path where you want to store the XML tracking debug request file. You can edit the path but do not edit the file name, which is displayed in this box by default: .\request.xml |
Debug Response Filename |
Type the path where you want to store the XML tracking debug request file. You can edit the path but do not edit the file name, which is displayed in this box by default: .\response.xml |
Signatory's Declaration Statement |
Type the Commercial Invoice Signatory's Declaration Statement |
Commercial Invoice Declaration Statement |
Type the Commercial Invoice Declaration Statement(prints at the bottom of the main page) |
Document and Forms section
Note: This is applicable only for Parcel New UI Application.
In this box... |
Do this... |
Hide Document Selection Pop Up After Ship |
Select this checkbox to hide the document pop-up window after processing the shipment.
|
Select Document for auto Print section
In this box... |
Do this... |
Commercial Invoice |
Select this checkbox to auto print the Commercial Invoice to the configured printer after processing the shipment.
|
Shipper's Letter of Instruction |
Select this checkbox to auto print the Shipper's Letter of Instruction to the configured printer after processing the shipment.
|
Certificate of Origin |
Select this checkbox to auto print the Certificate of Origin to the configured printer after processing the shipment.
|
USMCA Certificate |
Select this checkbox to auto print the USMCA Certificate to the configured printer after processing the shipment.
|
Customs Invoice |
Select this checkbox to auto print the Customs Invoice to the configured printer after processing the shipment.
|
Canada Export Declaration (B13A) |
Select this checkbox to auto print the Canada Export Declaration (B13A) to the configured printer after processing the shipment.
|
Click SAVE in the lower-right corner of the screen to save the settings for this location. Otherwise, click CANCEL to cancel the settings specified.
Labels Tab
Use the Labels tab to specify whether you want to suppress (not print) a label with the operations listed in the following table.
For this operation... |
Specify this... |
PSHP |
To suppress label printing with Pre-ship (PSHP) operations, select (check) this check box.
|
CSHP Update |
To suppress label printing with Confirm Ship (CSHP) Update operations, select (check) this check box.
|
CSHP Confirm |
To suppress label printing with Confirm Ship (CSHP) Confirm operations, select (check) this check box.
|
TOHOLD |
To suppress label printing with TOHOLD operations, select (check) this check box.
|
Click SAVE in the lower-right corner of the screen to save the settings for this location. Otherwise, click CANCEL to cancel the settings specified.
Notes:
-
A TNT Express carrier does not print a label with PSHP requests.
-
The following services are not supported for PSHP/CSHP requests: - FedEx COD - UPS WorldEase
Proxy tab
Parcel supports the use of proxy servers with the Parcel server. The proxy server can be any one of the following Internet Protocol types:
-
HTTP – Internet non-secure socket layer.
-
HTTPS – Internet secure socket layer (SSL).
-
FTP – Non-secure file transfer protocol
-
SFTP – Secure file transfer protocol
Fields for HTTP, HTTPS, FTP Protocols
The proxy tab is divided into four sections according to the previous proxy server types . The following server types have identical fields: HTTP, HTTPS, FTP. These are listed and described in the following table:
In this box... |
Enter this information... |
Address |
The IP address of the proxy server. Parcel uses this address to connect to the proxy server. Optionally, you can also include the port number for the connection to the proxy server as follows: <IP_Address:Port_Number>; for example: 10.10.98.10:1080 |
Username |
Type the username for logging in to the proxy server to be used for HTTP, HTTPS, or FTP requests. |
Password |
Type the password for logging in to the proxy server to be used for HTTP, HTTPS, or FTP requests. |
Fields for the SFTP Protocol
The proxy tab is divided into four sections according to the previous proxy server types . The last section is for the SFTP protocol as described in the following table:
In this box... |
Enter this information... |
Address |
The IP address of the proxy server. Parcel uses this address to connect to the proxy server. Optionally, you can also include the port number for the connection to the proxy server as follows: <IP_Address:Port_Number>; for example: 10.10.98.10:1080 |
Protocol Type |
From the drop-down list, select one of the following protocol types:
|
Username |
Type the username for logging in to the proxy server to be used for SFTP requests. |
Password |
Type the password for logging in to the proxy server to be used for SFTP requests. |
Custom Service Provider
Use the Custom Service Provider tab to enter custom service provider details in the following table.
This details are printed in the B13A Canada Customs Form.
In this box... |
Enter this information... |
Company/Name |
Type the custom service provider company name or person's name. |
Contact Name |
Type the custom service provider contact name. |
Address 1 |
Type the custom service provider street address details. |
Address 2 |
Type any additional street address information for the custom service provider, such as suite or floor number. |
Address 3 |
Type any additional street address information for the custom service provider, such as suite or floor number. |
City |
Type the custom service provider city address details. |
State |
Type the custom service provider state address details. |
Zip |
Type the custom service provider ZIP code or postal code details. |
Country |
Type the custom service provider country name details. |
Country Code |
Type the custom service provider country code details. |
Phone |
Type the custom service provider phone number details. |
Click SAVE in the lower-right corner of the screen to save the settings for this location. Otherwise, click CANCEL to cancel the settings specified.
Tracking Module Integration
SFTP/FileShare Configuration
The following settings are available from the Tracking Module SFTP/FileShare Configuration to transmit and receive data.
This field... |
Is for this data... |
File Transfer Type |
Select the File Transfer Type from the drop-down list. Options are:
|
SFTP Server Name |
Enter the SFTP server address for uploading data to support Tracking Module Integration. |
SFTP Port Number |
Enter the port number of SFTP server for uploading data to support Tracking Module Integration. |
SFTP Username |
Enter the user name of SFTP server for uploading data to support Tracking Module Integration. |
SFTP Password |
Enter the password of SFTP server for uploading data to support Tracking Module Integration. |
SFTP connection timeout |
Enter the SFTP connection timeout in seconds.
|
Tracking Extract Upload Folder |
Enter the Tracking extract data upload folder name. |
Click SAVE to save the values entered or click CANCEL to cancel this operation.
Unit of Measure (Item)
Use the Unit of Measure (Item) screen in the Settings section of a location to add, edit, delete unit of measure codes for use when shipping international packages.
Add a Unit of Measure Code
-
Click ADD icon at the top of the screen. The Add Record dialog box appears.
-
Complete the boxes as follows:
In this box...
Do this...
Carrier
Type the name of the carrier that uses the unit of measure; for example, DHL. If the unit of measure is used by all carriers, type ALL.
Code
Using up to three characters, type the code for the unit of measure (UOM). For example, DZN is the code for dozen.
Description
Type a short description of the code; for example, the full name of the unit of measure, as in "square centimeters" (without quotation marks) if the UOM code is CMK.
-
Click SAVE to save the new code. Otherwise, click CANCEL to cancel the new code.
Edit a Unit of Measure Code
-
Click EDIT icon in the left column in the row containing the record that you want to edit.
-
A dialog box appears. Edit the fields as needed.
-
Click SAVE at the bottom of the dialog box to save the changes.
Delete a Unit of Measure Code
-
Click DELETE icon in the left column in the row containing the record that you want to delete.
-
A confirmation dialog box appears. Click OK to delete the record. Or click CANCEL to keep the record.
Address Validation
Use the Address Validation screen in the Settings section to configure information used to validate addresses in Parcel.
To configure Address Validation, complete the following boxes.
Top section
In this box... |
Do this... |
Type |
From the list, select the address validation type. Valid values are as follows:
|
Count |
Type the number that is the default number of addresses to validate. The default is 1. |
Uppercase |
Select this check box to automatically convert all text that a user types into the user interface into all uppercase. |
CSZip section
To configure Parcel to work with City, State, ZIP address validation, complete the CSZip section as follows:
In this box... |
Do this... |
Address Limit |
Type the maximum number of suggested addresses that you want to be returned after address validation finds that the address is invalid. |
City Char No |
Type the number of characters that you want to match in the city name of the suggested results.
|
Group One section
To configure Parcel to work with Group One address validation, complete the Group One section as follows:
In this box... |
Do this... |
Account ID |
Type the Group One account ID for this location. You get this ID from Group One. |
Password |
Type the password for Group One. You get this from Group One. |
IP Address |
Type the IP address of the Group One server. |
Port |
Type the port number of the Group One server. |
Path |
Type the path to the Group One server. |
Connection Timeout |
Type the number of milliseconds to wait for the Group One server to respond before timing out. |
Connection Type |
From the list, select one of the following values for the type of connection used to communicate with the Group One server:
|
Warning Level |
Type a value indicating the percentage of confidence below which (and above the error level) a warning will be generated. Group One generates the confidence level when returning results.
|
Error Level |
Type a value indicating the percentage of confidence below which an error will be generated. Group One generates the confidence level when returning results.
|
Postal Code Correction |
Group One returns nine-digit postal codes. Select this check box to validate only the first five digits of the postal code. |
Address Logic |
Specify address returned priority if multiple non-blank address lines are present or multiple address types are on the same address line.
|
Postal Code Correction |
Select this check box to automatically correct the postal code when Group One detects an incorrect postal code. |
Correct Flag |
Select this check box to set the corrected address to the current address. |
Is Residential |
Select this check box if you want residential addresses to be validated. |
Is DPV |
Select this check box if the address check should include Delivery Point Validation. |
Is APO |
Select this check box if the address check should include an APO/FPO check. |
Click SAVE in the lower-right corner of the screen to save the address validation settings for this location. Otherwise, click CANCEL to cancel the address validation settings for this location.
Rate Description
Use the Rate Description screen in the Settings section of a location to add, edit, delete API RATE keys and Rate Descriptions for use in the Rate popup window for shipments.
Notes:
-
This table is automatically populated with an extensive list of standard charges for all carriers. When the user processes a shipment, and then clicks the Rate link in the Warehouse screen message bar, the Rate popup window displays the subset of these charges applicable to the carrier and service selected for the shipment.
-
Rate keys are saved in the di_map table.
Add a Rate Key
-
Click ADD icon at the top of the screen. The Add Record dialog box appears.
-
Complete the boxes as follows:
In this box...
Do this...
Carrier
Type the name of the carrier that uses the rate; for example, UPS or DHL Global. If the unit of measure is used by all carriers, type ALL.
Display Order
Type a number from 0 to 7 to indicate the relative order in which the charge listed in the RateDescription field field appears in the Rate popup window displayed when the user clicks the Rate link in the Warehouse screen message bar for a shipment.
Note: Charges are displayed in reverse order; for example, a charge with a value of 7 for Display Order appears higher in the list than a charge with a value of 4. Charges with the same Display Order value are displayed in the relative order in which they appear in the table.RateDescription
Type the descriptive name of the rate; for example: "Residential Charge" (without quotation marks). This is the term for the charge that is displayed in the Rate popup window.
DiKey
Type the name of the Rate API key; for example: CHG_RESIDENTIAL
-
Click SAVE to save the new currency code. Otherwise, click CANCEL to cancel the new currency code.
Edit a Rate Key
-
Click EDIT icon in the left column in the row containing the record that you want to edit.
-
A dialog box appears. Edit the fields as needed.
-
Click SAVE at the bottom of the dialog box to save the changes.
Delete a Rate Key
-
Click DELETE icon in the left column in the row containing the record that you want to delete.
-
A confirmation dialog box appears. Click OK to delete the record. Or click CANCEL to keep the record.
Connect Configuration (Integration Adapter)
Introduction
Integration Adapter is used by Parcel to connect with the customer application for processing shipments.
The process that is used to connect
Parcel
with the customer application and make shipments is described below:
-
A shared folder is used to share the shipping information among the customer application and Parcel. This shared folder can be either on the customer server machine or the Parcel machine.
-
Integration Adapter as well as the customer application have Read and Write privileges on the shared folder.
-
The customer application saves a connect input file in the shared folder. The connect input file contains shipping information required to process the shipment by Parcel .
-
Integration Adapter scans the shared folder for connect input file(s) at a regular time interval. It can scan and process multiple shared folders simultaneously. However, it allows only one shared folder per Delivery Contract (DC).
-
The scan interval can be configured for each DC by using the General tab (see the section General Tab) of the Connect Configuration screen.
-
Integration Adapter uses the Domain/Login user name and password to connect to the shared folder. This is also configurable using the General tab of the Connect Configuration screen. Integration Adapter checks the connection to the shared folder at every scan interval. If the connection is severed, it tries to re-establish the connection.
-
After the connection is established and input file(s) are found in the shared folder, Integration Adapter initiates the processing of the input file(s). It reads and parses the shipping information records from the input file.
-
After processing the shipping records, the processed shipments and the status of the shipping process (success or failure) is returned in a connect output file to the shared folder.
-
Integration Adapter maintains a connect log file for each DC to store the information regarding the imported, exported and processed connect files.
For more information on how the Integration Adapter (Connect) works with the
Parcel
system, open this IData - Example.
Note: The data type for certain IA server fields is updated. The following fields in the didb.iafields table are now alphanumeric: "billtoacctnumber", "bill_to", and "to_cust_num".
Connect Configuration Settings
Connect Configuration Overview
Connect can be configured by using the Connect Configuration screen, located under Settings section of the location added (off the System > Settings > Location menu).
Parcel allows configuring one shared folder per Delivery Contract (DC). In case of multiple contract installation,
Parcel
maintains each contract as a separate DC.
The Connect Configuration screen contains various tabs as described in the table below:
Use this tab... |
to... |
General |
Configure the general settings for Integration Adapter. |
Connect Input |
Configure the format for the connect input file. |
Non Consolidated Real Time Output |
Configure the format for the connect output file. |
Manifest |
Configure the format for the manifest file. |
Disabling Connect for a particular location
The connect functionality for a particular location can be enabled/disabled by activating the Disable Connect check box on the General tab. If the check box is activated, connect functionality is not available for that location.
General Tab
The General tab of the Connect Configuration screen allows you to configure various settings that controls the working procedure of Connect for a particular DC.
Configuring General Settings
To configure the general settings, complete these steps:
-
In the top section check box and radio buttons, supply the information for the general settings as described in the table below:
Select this...
To...
Disable connect configuration
Disable this feature for the location under which this Connect Configuration screen is displayed. When this check box is selected, all the tabs on the Connect Configuration screen become disabled and no value is accepted.
Error in Auto mode
This setting describes the action to be taken on receiving an error during processing of a shipment record in Auto mode. Select an option from the following:
Add shipment to hold and return an error code in the Connect Output file
Return an error code in the connect output file -
Under the Share Settings section supply the information for the shared folder settings as described in the table below:
In this box...
Do this...
Scan Interval (in sec)
Type the time interval (in seconds) after which Integration Adapter scans the shared folder for the connect input files.
Execute external batch
Follow these steps:
-
Select this check box if you want Integration Adapter to execute an external batch file or other program during every scan cycle.
-
Type the full path where the batch/program file is located.
Connect host directory
Type the full path where the shared folder is located.
Domain\Login User Name
Type the user name to access the shared folder.
Password
Type the password to access the shared folder.
-
-
Under the Purging Files section supply the information as described in the table below:
In this box...
Do this...
Purge days for Host backup shipping files
Type the number of days before which Integration Adapter deletes the backup files.
Note: If the number of days is set to Zero (0), backup files need to be deleted manually.Purge days for connect log files
Type the number of days before which Integration Adapter deletes the connect log files.
Note: If the number of days is set to Zero (0), the connect log files need to be deleted manually.Purge days for unconsolidated connect output files
Type the number of days before which Integration Adapter deletes the unconsolidated connect output files.
Note: If the number of days is set to Zero (0), the unconsolidated connect output files need to be deleted manually.Purge days for consolidated connect output files
Type the number of days before which Integration Adapter deletes the manifest or consolidated connect output files.
Note: If the number of days is set to Zero (0), the manifest or consolidated connect output files need to be deleted manually. -
After supplying the information for all the settings click the buttons described in the table below to take appropriate actions:
Click this button... |
To... |
CLEAR |
Clears all the fields on all the tabs. |
RESET |
Restores the values of the fields on the screen on all the tabs if changes done are not saved. |
SAVE |
Save the settings information. |
Connect Input Tab
The Connect Input tab of the Connect Configuration screen allows you to:
-
Disable/enable the Connect Input functionality
-
Configure the format for the input file as:
-
ASCII fixed length format
-
ASCII variable length format
-
Disabling/Enabling Connect Input Functionality
To disable the Connect Input functionality for a particular DC, select the Disable input check box. To enable it, de-select the Disable input check box.
Note: When the Connect Input functionality is disabled, all the shipments are processed through the E-Ship Server application. The shared folder is used only for providing the output and manifest files to the customer application.
Configuring Input File Format as ASCII Fixed Length
To configure the input file format as ASCII Fixed Length, complete these steps:
-
Supply the ASCII fixed length format details for the connect input file as described in the table below:
Note: Input file format can only be configured if Connect input is not disabled (the Disable input check box at the top of this tab is not activated).
In this box...
Do this...
File format
Select 'ASCII Fixed Length' from the drop-down list. The possible values are:
-
ASCII Fixed Length
-
ASCII Variable Length
Delimiter
This box is disabled if the ASCII fixed length file format is selected.
File extension
Type the extension for the connect input file.
Note: Following extensions cannot be used:-
LOG
-
BAK
-
MAN
Skip first record
Select the check box to skip the header (first) record in the input file.
Field selection - Fixed Length
Follow these steps and specify the field information for the input file:
-
Select the check box in the Select column respective to the field you want to include in the input file.
-
To map the selected fields in the Connect Input file:
-
Type the Start Position of that field in the input record.
-
Type the Length of that field in the input record.
-
After specifying all the format details click the buttons described in the table below to take appropriate actions:
Click this button... |
To... |
CLEAR |
Clears all the fields on all the tabs. |
RESET |
Restores the values of the fields on the screen on all the tabs if changes done are not saved. |
SAVE |
Save the settings information. |
Configuring Input File Format as ASCII Variable Length
To configure the input file format as ASCII Variable Length, complete these steps:
-
Supply the ASCII variable length format details for the connect input file as described in the table below:
In this box... |
Do this... |
File format |
Select 'ASCII Variable Length' from the drop-down list. The possible values are:
|
Delimiter |
Select the delimiter used to separate the fields. The possible values are:
|
File extension |
Type the extension for the connect input file.
|
Skip first record |
Select the check box to skip the header (first) record in the input file. |
Field selection |
Follow these steps and specify the field information for the input file:
|
After specifying all the format details click the buttons described in the table below to take appropriate actions:
Click this button... |
To... |
CLEAR |
Clears all the fields on all the tabs. |
RESET |
Restores the values of the fields on the screen on all the tabs if changes done are not saved. |
SAVE |
Save the settings information. |
Non Consolidated Real Time Output Tab
The Non Consolidated Real Time Output tab of the Connect Configuration screen allows you to:
-
Disable/enable the Connect Output functionality
-
Configure the format for the output file as:
-
ASCII fixed length format
-
ASCII variable length format
Disabling/Enabling Connect Output Functionality
To disable the Connect Output functionality for a particular DC, select the Disable output check box. To enable it, de-select the Disable output check box.
Note: When the Connect Output functionality is disabled, the shared folder is used only for creating shipments and printing labels. Output and manifest files are not provided to the customer application.
Configuring Output File Format as ASCII Fixed Length
To configure the output file format as ASCII Fixed Length, complete these steps:
-
Supply the ASCII fixed length format details for the connect output file as described in the table below:
In this box...
Do this...
File format
Select 'ASCII Fixed Length' from the list. The possible values are:
-
ASCII Fixed Length
-
ASCII Variable Length
Delimiter
This box is disabled if the ASCII fixed length file format is selected.
File extension
Type the extension for the connect output file.
Note: Following extensions cannot be used:-
LOG
-
BAK
-
MAN
Output piece records
Select the check box if one output record corresponding to each piece is to be added in the output file.
Note: If the check box is unchecked, only the shipment record is added in the output file.Field selection - Fixed Length
Follow these steps and specify the field information for the output file:
-
-
Select the check box in the Select column respective to the field you want to include in the output file.
-
To map the selected fields in the connect output file:
Type the Start Position of that field in the output record.
Type the Length of that field in the output record. -
After specifying all the format details click the buttons described in the table below to take appropriate actions:
Click this button...
To...
CLEAR
Clears all the fields on all the tabs.
RESET
Restores the values of the fields on the screen on all the tabs if changes done are not saved.
SAVE
Save the settings information.
Configuring Output File Format as ASCII Variable Length
To configure the output file format as ASCII Variable Length, complete these steps:
-
Supply the ASCII variable length format details for the connect output file as described in the table below:
In this box... |
Do this... |
File format |
Select 'ASCII Variable Length' from the list. The possible values are:
|
Delimiter |
Select the delimiter used to separate the fields. The possible values are:
|
File extension |
Type the extension for the connect output file.
|
Output piece records |
Select the check box if one output record corresponding to each piece is to be added in the output file.
|
Create header record |
Select the check box if header record is to be added in the output file. |
Delimit text field with |
Type the character which separates the text fields. |
Field selection - Variable Length |
Follow these steps and specify the field information for the output file:
|
-
After specifying all the format details click the button as described in the table below to take appropriate actions:
Click this button... |
To... |
CLEAR |
Clears all the fields on all the tabs. |
RESET |
Restores the values of the fields on the screen on all the tabs if changes done are not saved. |
SAVE |
Save the settings information. |
Manifest Tab
The Manifest tab of the Connect Configuration screen allows you to:
-
Disable/enable the Manifest Output functionality
-
Configure the format for the manifest file as:
-
ASCII fixed length format
-
ASCII variable length format
Disabling/Enabling Manifest Output
To disable the Manifest Output functionality for a particular DC, select the Disable manifest output check box. To enable it, de-select the Disable manifest output check box.
Note: When the Manifest Output feature is disabled, the shared folder is used only for creating shipments and printing labels. The manifest output files are not provided to the customer application.
Configuring Manifest File Format as ASCII Fixed Length
To configure the manifest file format as ASCII Fixed Length, complete these steps:
-
Supply the ASCII fixed length format details for the manifest file as described in the table below:
Note: Manifest file format can only be configured if the manifest output is not disabled.In this box...
Do this...
File format
Select 'ASCII Fixed Length' from the list. The possible values are:
-
ASCII Fixed Length
-
ASCII Variable Length
Delimiter
This box is disabled if the ASCII fixed length file format is selected.
File extension
Type the extension for the connect output file.
Note: The only extension supported for the manifest file is 'MAN'.Output piece records
Select the check box if one manifest output record corresponding to each piece is to be added in the manifest file.
Note: If the check box is unchecked, only the shipment record is added in the manifest file.Field selection - Fixed Length
To specify the field information for the manifest file, follow these steps:
-
Select the check box in the Select column respective to the field you want to include in the manifest file.
-
To map the selected fields in the manifest file:
-
Type the Start Position of that field in the manifest record.
-
Type the Length of that field in the manifest record.
-
-
After specifying all the format details click the buttons described in the table below to take appropriate actions:
Click this button... |
To... |
CLEAR |
Clears all the fields on all the tabs. |
RESET |
Restores the values of the fields on the screen on all the tabs if changes done are not saved. |
SAVE |
Save the settings information. |
Configuring Manifest File Format as ASCII Variable Length
To configure the manifest file format as ASCII Variable Length, complete these steps:
-
Specify the ASCII variable length format details for the manifest file as described in the table below:
In this box...
Do this...
File format
Select 'ASCII Variable Length' from the list. The possible values are:
-
ASCII Fixed Length
-
ASCII Variable Length
Delimiter
Select the delimiter used to separate the fields. The possible values are:
-
Tab
-
Comma
-
Pipe
File extension
Type the extension for the connect output file.
Note: The only extension supported for the manifest file is 'MAN'.Output piece records
Select the check box if one manifest output record corresponding to each piece is to be added in the manifest file.
Note: If the check box is unchecked, only the shipment record is added in the manifest file.Create header record
Select the check box if header record is to be created in the manifest file.
Delimit text field with
Type the character which separates the text fields.
Field selection - Variable Length
Specify the field information for the manifest file.
-
-
From the available field list (list on the left), select the fields you want to include in the manifest file. Then, click >>.
-
The fields selected are moved to the list on the right.
-
If you want to remove some of the fields from the selected field list (list on the right), select those fields and click <<.
To arrange the order of the fields as in the manifest file, follow these steps:
In the list on the right, select the field you want to move upwards and click UP. You need to click UP as many times as required to move the field to the desired position.
In the list on the right, select the field you want to move downwards and click DOWN. You need to click DOWN as many times as required to move the field to the desired position. -
After specifying all the format details click the buttons described in the table below to take appropriate actions:
Click this button...
To...
CLEAR
Clears all the fields on all the tabs.
RESET
Restores the values of the fields on the screen on all the tabs if changes done are not saved.
SAVE
Save the settings information.