1. introduction to tmw emanifest - tmw...

19
User Guide TMW eManifest Copyright TMW Systems, Inc. | A Trimble Company 1. Introduction to TMW eManifest Introduction to TMW eManifest......................................................................................... 1 Prerequisites for using TMW eManifest......................................................................... 2 Using TMW eManifest.................................................................................................... 2 Using a Value-Added Network and X.12 Processor....................................................... 3 TMW X.12 Processor............................................................................................... 3 Contacting US and Canadian border protection agencies............................................. 4 Logging in and out............................................................................................................. 5 Setup options for logon and logoff.................................................................................. 5 Personalizing the login image.................................................................................. 6 User profile setup and password security................................................................ 9 Logging on...................................................................................................................... 10 Responding to login errors....................................................................................... 11 Viewing system details in the Logon Information window........................................ 12 Changing your password......................................................................................... 14 Logging off...................................................................................................................... 15 Viewing system details...................................................................................................... 16 On the status bar............................................................................................................ 16 In the About window....................................................................................................... 16 Identifying your database and its server location........................................................... 16 Determining your application version and INI file location.............................................. 17 Determining your application's location and license date............................................... 17 Viewing licensing information......................................................................................... 18

Upload: truongdang

Post on 22-May-2018

264 views

Category:

Documents


7 download

TRANSCRIPT

Page 1: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

User Guide TMW eManifest Copyright TMW Systems, Inc. | A Trimble Company

1. Introduction to TMW eManifest

Introduction to TMW eManifest......................................................................................... 1Prerequisites for using TMW eManifest......................................................................... 2Using TMW eManifest.................................................................................................... 2Using a Value-Added Network and X.12 Processor....................................................... 3

TMW X.12 Processor............................................................................................... 3Contacting US and Canadian border protection agencies............................................. 4

Logging in and out............................................................................................................. 5Setup options for logon and logoff.................................................................................. 5

Personalizing the login image.................................................................................. 6User profile setup and password security................................................................ 9

Logging on...................................................................................................................... 10Responding to login errors....................................................................................... 11Viewing system details in the Logon Information window........................................ 12Changing your password......................................................................................... 14

Logging off...................................................................................................................... 15

Viewing system details...................................................................................................... 16On the status bar............................................................................................................ 16In the About window....................................................................................................... 16Identifying your database and its server location........................................................... 16Determining your application version and INI file location.............................................. 17Determining your application's location and license date............................................... 17Viewing licensing information......................................................................................... 18

Page 2: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

User Guide Revised: 4/2016 TMW eManifest Copyright TMW Systems, Inc. | A Trimble Company

Introduction to TMW eManifest

TMW eManifest is a trade processing system designed to enhance national border security and expedite lawful trade between the US and Canada. As of November 2012, all loaded and empty vehicles that cross the US-Canadian border must satisfy applicable US and Canadian customs border-crossing regulations. TMW eManifest expedites border crossing by automating the processing of customs documentation.

TMW eManifest consists of modules for:

• ACE (Automated Commercial Environment) for expediting the entry of loaded or empty trucks into the US.

• ACI (Advance Commercial Information) for expediting the entry of loaded or empty trucks into Canada.

Before a truck reaches a border crossing location, you submit an eManifest electronically to US Customs and Border Protection (CBP) or the Canada Border Services Agency (CBSA). This information describes shipper and consignee, freight, tractor, trailer, instruments of trade, drivers, passengers, and the border crossing location.

When the truck reaches the border crossing location, the border protection agency will already have reviewed and approved the information. This allows the truck’s passage to be cleared with minimal delay.

Notes:

1. TMW eManifest is a licensed add-on that must be purchased separately. For details, contact TMW Sales.

2. TMW eManifest is licensed and used independently of any other EDI licensing you may already have purchased. The TMW eManifest license does not provide access to any EDI functionality other than what is described in this documentation.

3. If you are currently licensed to use TMW’s ACE add-on, your license will permit you to use the ACE features of TMW eManifest. ACI features are licensed separately.

4. The content in this guide was written for the help file that is available from within TMW eManifest. As a courtesy, TMW has made it available in PDF form.

• Go to Contents > Help

• Press the F1 key

You must have an Internet connection. Use Internet Explorer, Google, or Safari to view the help file.

1.1

Page 3: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

Introduction to TMW eManifest

User Guide Revised: 4/2016 TMW eManifest Copyright TMW Systems, Inc. | A Trimble Company

Prerequisites for using TMW eManifest

Before you can use TMW eManifest, confirm that your system meets these requirements.

• TMW eManifest will be used with a compatible dispatch system

eManifest will be available for TMWSuite, TMW Fuel Dispatch, and TMW Operations.

• You have applied necessary licensing

TMW eManifest includes ACE and ACI modules, each of which is licensed separately.

The license for TMW’s earlier ACE add-on will enable you to use the ACE portion of TMW eManifest. You must license ACI separately.

• A properly configured system

TMW eManifest pulls most information directly from the profiles of companies, commodities, personnel, and assets, based on the Order or Move ID. Some entries in these profiles are specific to TMW eManifest, so your database administrator or TMW system administrator might need to update existing profiles and label options before you can use TMW eManifest. Settings are described in General System Setup.

Related Topics:

Using TMW eManifest

Using a Value-Added Network and X.12 Processor

Contacting US and Canadian border protection agencies

Using TMW eManifest

A typical scenario for using TMW eManifest consists of the following steps.

1. In your dispatch system, you create and plan a trip that crosses the US-Canadian border.

2. To make the trip ACE or ACI compliant, you include stops at the appropriate US and/or Canadian border crossing location. If the trip does not include these stops, TMW eManifest might fail to load the trip, or it might report errors when you validate the trip.

3. Using TMW eManifest, you load the trip, create an eManifest, and pre-validate the information.

• If the border crossing is into the US, you use the ACE portion of TMW eManifest.

• If the border crossing is into Canada, you use the ACI portion of TMW eManifest.

Note: If you send an eManifest that lacks information, the documentation can be rejected by the border agency, or delays can result when the truck attempts to cross the border.

4. You transmit the eManifest(s) to the border protection agency.

5. The border protection agency reviews the submitted eManifest and approves or rejects the eManifest. If the eManifest is rejected, you must modify and resubmit the information.

6. At least one hour before the truck reaches the border crossing, you must have a completed and approved eManifest on file with CBP and/or CBSA.

1.2

Page 4: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

Introduction to TMW eManifest

User Guide Revised: 4/2016 TMW eManifest Copyright TMW Systems, Inc. | A Trimble Company

7. The truck arrives at the border crossing location specified in the eManifest and is inspected for compliance with the submitted information.

Related Topics:

Prerequisites for using TMW eManifest

Using a Value-Added Network and X.12 Processor

Contacting US and Canadian border protection agencies

Using a Value-Added Network and X.12 Processor

Normally, you will use TMW eManifest with a Value-Added Network (VAN) provider. The VAN performs these services:

• Receives, processes, and transmits your eManifests to the appropriate border protection agency

Depending on the border protection agency, you can transmit an eManifest as a complete document, or as a preliminary document with updates.

• Returns messages transmitted by the border protection agency to your company

Normally, these messages consist of receipt confirmations and acceptance/rejection notices regarding documents you have sent.

TMW recommends the use of Kleinschmidt, Inc. (http://www.kleinschmidt.com) to provide VAN services.

TMW X.12 Processor

The TMW X.12 Processor utility provides communication between your company and your selected VAN service provider. The X.12 processor must be running when you use TMW eManifest. A separate TMW X.12 Process Installation guide describes how to install and set up the X.12 Processor.

It is possible to use another VAN or no VAN at all. If your company chooses either alternative, you or your chosen VAN must assume responsibility for setting up the translation of eManifest data to the X.12 format required by the border protection agency.

Related Topics:

Introduction to TMW eManifest

Prerequisites for using TMW eManifest

Using TMW eManifest

Contacting US and Canadian border protection agencies

1.3

Page 5: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

Introduction to TMW eManifest

User Guide Revised: 4/2016 TMW eManifest Copyright TMW Systems, Inc. | A Trimble Company

Contacting US and Canadian border protection agencies

For more the latest information about ACE and ACI, visit these agency web sites:

• US Customs and Border Protection (CBP): http://www.cbp.gov/

• Canada Border Services Agency (CBSA): http://www.cbsa-asfc.gc.ca/prog/aci-ipec/menu-eng.html

Related Topics:

Introduction to TMW eManifest

Using TMW eManifest

Prerequisites for using TMW eManifest

Using a Value-Added Network and X.12 Processor

1.4

Page 6: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

User Guide Revised: 9/2014 TMW eManifest Copyright TMW Systems, Inc.

Logging in and out

You will receive your user ID and password from the system administrator. Users, groups, passwords, and access permissions are created and maintained in the System Administration application.

Setup options for logon and logoff

TMW applications provide many options to customize your applications for the way you do business. If you are a system administrator, you can change INI settings (also called switches, keys, or values) that affect all users in your company by editing your TTS50.

Related Topics:

Logging on

Logging off

1.5

Page 7: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

Introduction to TMW eManifest

User Guide Revised: 11/2015 TMW eManifest Copyright TMW Systems, Inc.

Personalizing the login image

By default, the Login dialog box shows the TMW logo.

Show me

However, you can customize it to display your company logo or other image. If you choose to use a custom logo image, it:

• Must be either a BMP or JPG file type.

• Should be 450 pixels wide and 330 pixels high, or of a similar ratio.

Note: If your image is not this proportion, the application will distort it to fill the logo window. You can crop your image or change the file type using Microsoft Photo Editor or another graphics program.

Two settings in your TTS50 allow you to specify an alternate image for the Login dialog box (splash screen).

The Logo setting

The [Misc]Logo setting in your TTS50 specifies the name of the image file to display on the Login dialog box.

1.6

Page 8: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

Introduction to TMW eManifest

User Guide Revised: 11/2015 TMW eManifest Copyright TMW Systems, Inc.

[Misc] Logo

Applies to TMWSuite, CRM Right, TMW eManifest, TMW Operations, TMW Back Office

Description This setting identifies the file name of the large bitmap used in the Login dialog box of TMW modules. The bitmap should be located in your TMWSuite executable directory.

To display an alternate image in the Login dialog box, you must make a valid

entry in both the [Directories]Bitmaps setting and the [Misc]Logo setting.

Options • TMW_D.BMP (default)

The file name of the TMW logo that displays in the Login dialog box.

• Enter the name of your logo file

Enter the name of the file you want to display in the Login dialog box.

Additional Notes 1. Image files must be either BMP or JPG file type.

2. Image dimensions should be 450 pixels wide and 330 pixels high.

3. If a valid entry is not made in both the Bitmaps setting and the Logo setting:

• TMWSuite core applications will display a blank pane (no image).

• CRM Right, TMW Operations, and TMW Back Office will display the default TMWSuite logo.

4. Fuel TMS does not support this setting.

The Bitmaps setting

The [Directories]Bitmaps setting in your TTS50 records the path to the image file that is specified by the [Misc]Logo setting.

[Directories] Bitmaps

Applies to TMWSuite, CRM Right, TMW eManifest, TMW Operations, TMW Back Office

Description This setting identifies the directory holding the TMWSuite bitmaps not supplied as part of the executables, such as, the logo displayed on the Login dialog box.

Note: The actual bitmap image used by the Login dialog box is specified by the

[Misc]Logo setting in your TTS50.

Options • .\ (default)

In the directory that contains the executable being launched, look for the

image file that is specified by the [Misc] Logo setting in your TTS50.

• [Path]

Enter the path to the directory that contains the image file specified by the

[Misc]Logo setting in your TTS50.

For example, C:\IMAGES.

1.7

Page 9: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

Introduction to TMW eManifest

User Guide Revised: 11/2015 TMW eManifest Copyright TMW Systems, Inc.

[Directories] Bitmaps

Additional Notes 1. To display an alternate image in the Login dialog box, you must make a valid

entry in both the Logo setting and the Bitmaps setting. If a valid entry is not made in both settings:

• TMWSuite core applications will display a blank pane (no image).

• CRM Right, TMW Operations, and TMW Back Office will display the default TMWSuite logo.

2. Fuel TMS does not support this setting.

1.8

Page 10: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

Introduction to TMW eManifest

User Guide Revised: 12/2012

TMW eManifest

User profile setup and password security

There are a number of other setup options that affect the login/logout process. For details, see these chapters in the System Administration guide:

• Establishing user profiles

• Using Microsoft Windows Authentication to connect to TMWSuite

1.9

Page 11: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

Introduction to TMW eManifest

User Guide Revised: 11/2015 TMW eManifest Copyright TMW Systems, Inc. | A Trimble Company

Logging on

Your company will assign you a user ID and password and determine which applications you are authorized to use.

1. Double-click on the icon or shortcut for the application. The Login dialog box opens.

Show me

2. Make the appropriate entries in these fields:

Username Enter your user ID.

Password Enter your password.

Note: For security purposes, your password displays as a series of asterisks (*****).

3. Click Logon. The "Logon Successful! Please wait..." message appears while the application loads.

Note: If the Logon is not successful, see Responding to login errors.

1.10

Page 12: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

Introduction to TMW eManifest

User Guide Revised: 11/2015 TMW eManifest Copyright TMW Systems, Inc. | A Trimble Company

Related Topics:

Logging off

Responding to login errors

If you cannot log on to an application successfully, the application will display a message that identifies the condition that led to the failure. Login error messages appear in the lower left portion of the Login dialog box.

Show me

This table lists known application error messages. The Cause and Solution column provides additional information and a simple solution if available.

For errors without a simple solution, contact your system administrator or your TMW support representative.

Error Message Cause and Solution

A password must be provided! The password field is empty.

Enter your password in the password field.

1.11

Page 13: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

Introduction to TMW eManifest

User Guide Revised: 11/2015 TMW eManifest Copyright TMW Systems, Inc. | A Trimble Company

Error Message Cause and Solution

A User Id must be provided! The username field is empty.

Enter your user ID in the username field.

Failed to connect using the entered credentials.

The application does not recognize your user ID and/or password.

Re-enter your user ID and password.

Error: TTSLocal.INI file Not found. The local.ini file is a configuration file that stores customized settings that control how data displays for a specific user. It also tells the application which server and database a user is to access. This message displays when the path to the local.ini file is incorrect.

The running application's version n.nn.nn.nn does not match the version installed in the database n.nn.nn.nn. Application will now terminate.

A version check occurs during log in. If your application version is newer or older than the database, the program will not run. The system displays an error message that defines the problem.

Click OK in the error box.

Sorry, You are not registered for this application.

The system will not allow a user to log in to an application until the user is registered for that application. The system administrator must grant authority in the user’s profile in the System Administration application.

Related Topics:

Viewing system details in the Logon Information window

Changing your password

Setup options for logon and logoff

Viewing system details in the Logon Information window

When you access the Login dialog box, the system retrieves details about your workstation, database, and application. To view this information, you can go to the Logon Information window, which is read-only. For a failed login attempt, it also displays the error message that describes the login problem. If you need to contact TMW Support because of a login error, your TMW Support representative may direct you to provide information from this window.

To view the Logon information window, click the Question mark in the upper right corner of the Login dialog box.

1.12

Page 14: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

Introduction to TMW eManifest

User Guide Revised: 11/2015 TMW eManifest Copyright TMW Systems, Inc. | A Trimble Company

The Logon Information window opens.

Show Me

• The right side of the message box contains the path to the application and the complete error message.

Note: If you cannot view the entire message in the Logon Information field, click and drag either side of the message box to expand the field.

• The left side of the message box contains three sections with information specific to your environment.

Note: Where field content exceeds field length, click the field and use the right and left arrow keys to view the complete entry.

Related Topics:

Responding to login errors

Changing your password

1.13

Page 15: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

Introduction to TMW eManifest

User Guide Revised: 11/2015 TMW eManifest Copyright TMW Systems, Inc. | A Trimble Company

Changing your password

You can use the Login dialog box to change your password at any time. The system administrator for your company determines password expiration policy. The system can be configured to generate a message to notify you when to create a new password.

Show me

Follow these steps to change your password.

1. Enter your user ID and password.

2. Select the Change Password check box, which is located below the Password field.

Show me

3. Click Logon. The Change Password dialog box opens.

Show me

4. Make the appropriate entries in these fields:

Old Enter your current password.

New Enter your new password.

1.14

Page 16: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

Introduction to TMW eManifest

User Guide Revised: 11/2015 TMW eManifest Copyright TMW Systems, Inc. | A Trimble Company

Confirm Re-enter your new password.

5. Click OK. The "Logon Successful! Please wait..." message appears while the application loads.

Related Topics:

Responding to login errors

Viewing system details in the Logon Information window

Logging off

Maintaining security in applications with sensitive personal or financial information requires understanding the difference between closing the application and logging off the system.

If you are required to enter your user ID and password every time you open an application, use any of these options to sign off the system.

• Click Exit on the toolbar.

• Go to File > Exit.

• Press ALT+F4.

• Click Close in the upper right corner of the application window.

Related Topics:

Setup options for logon and logoff

Logging on

1.15

Page 17: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

User Guide Revised: 2/2016 TMW eManifest Copyright TMW Systems, Inc. | A Trimble Company

Viewing system details

When using the application, there may be times when you need to quickly view details about your system such as the name of your database, the location of your INI files, and other system information.

On the status bar

Limited database and application information is available at all times in the status bar, located at the bottom of the application window. This bar displays the database name, application version, current system date/time, and the user ID.

In the About window

To access system information using the About window, select About from the toolbar.

Identifying your database and its server location

Under the heading Database Info in the Help About window, you can see this information:

• Server Name Displays the name of the server to which you are connected.

• Database Name

Displays the name of the database to which you are connected. Shown in parentheses to the right of the server name is the ID of the user who logged on to the application.

• Database Version

Displays the TMWSuiteTMWOperations version and build number of the database. The first four digits identify the version year, and the last four characters identify the build number.

1.16

Page 18: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

Introduction to TMW eManifest

User Guide Revised: 2/2016 TMW eManifest Copyright TMW Systems, Inc. | A Trimble Company

Related Topics:

Determining your application version and INI file location

Determining your application's location and license date

Viewing licensing information

Determining your application version and INI file location

In the Application Info section in the Help About window, you can see this information:

• Application Version

Displays the version of the application in use. Your application was coded to work in tandem with core TMW applications. However, it is built separately from them, and therefore has a different version number from them.

• Application INI File

Displays the path to the TTS50 file in use. The TTS50 is a configuration file that controls how TMW applications work. It is used to set up the system to best meet your company's needs. Knowing its location enables your system administrator or TMW Support representative to research the settings that are currently in place, as well as make any needed changes.

• Local INI File

Displays the path to the local INI file in use. The local INI file (also known as the ttslocal.ini file) is another configuration file. Its most important function is to identify the server and database that you use when you sign on.

Related Topics:

Identifying your database and its server location

Determining your application's location and license date

Viewing licensing information

Determining your application's location and license date

In the Environment Info section in the Help About window, you can see:

• Executable Location

Displays the path to the executable file for the application in use. In most cases, you will run an application using a shortcut on your desktop, or from the Windows Start menu. However, this entry in the Help About window indicates where the application and its supporting files are installed.

• License Version

Displays the date associated with the license file that was provided to your company by TMW. The license signifies that your company is authorized to use the application.

Related Topics:

Identifying your database and its server location

1.17

Page 19: 1. Introduction to TMW eManifest - TMW Systemstmws.tmwsystems.com/learningcenter/tmws/docs/TMWeManifest/eM… · TMW X.12 Processor..... 3 Contacting US and Canadian border protection

Introduction to TMW eManifest

User Guide Revised: 2/2016 TMW eManifest Copyright TMW Systems, Inc. | A Trimble Company

Determining your application version and INI file location

Viewing licensing information

Viewing licensing information

When your company purchases products from TMW, TMW supplies license files that enable use of those products. A license file consists of SQL that your system administrator must run against your database so that the application or feature can be used by people in your company. If you attempt to run an application before the SQL is applied, you will see a warning message indicating that you are not licensed and you will not be able to log on.

You can verify that the license is applied from within your TMW applications. Go to Help > About. In the About window, click More. A second window opens. It lists licenses in a table. Look for the license name in the Name column, and verify that the Value column is set to Y. Click Close in the windows.

If you have any questions regarding licensing, contact your Support Team.

Related Topics:

Identifying your database and its server location

Determining your application version and INI file location

Determining your application's location and license date

1.18