Setting up the TMW No-Touch Processortmws.tmwsystems.com/learningcenter/TMWS/docs/TMW... · The TMW...

TMW No-Touch Processor 1 12/2016 TMW.Suite Back Office © 2016 TMW Systems, Inc. All Rights Reserved.

Setting up the TMW No-Touch Processor The TMW No-Touch Processor automates the procedures for invoicing and settling trips in TMW.Suite Back Office. Although the TMW.Suite Back Office queues automate much of the processing for invoicing and settlements, the TMW No-Touch Processor can further automate processing. You can configure the amount of automation you want to allow.

For example, you could create an automated process for rating invoices from orders that are ready for billing and then save them in the On Hold status. Or you could automate the process for taking orders all the way through printing the invoices. The automated process is configurable based on your TMW.Suite Back Office queues and view definitions.

The TMW No-Touch Processor is a Windows Service that runs in the background on a given machine. There is no user interface beyond the installer and general setup such as establishing INI paths, user credentials, and so on.This document guides you through the steps required to install and set up the TMW No-Touch Processor for TMW.Suite Back Office.

General requirements ................................................................................................................................................. 2 Quick setup guide ....................................................................................................................................................... 2 Installing the TMW No-Touch Processor ................................................................................................................ 3

Downloading the application files .................................................................................................................... 3 Installing the application .................................................................................................................................... 4 Applying SQL to your database ........................................................................................................................ 7

Configuring the TMW No-Touch Processor ........................................................................................................... 8 Editing the configuration file ............................................................................................................................. 8

Setting a path to your INI files .................................................................................................................. 12 Using QuickDesigner to add the no-touch flag to the profiles.................................................................... 12

Adding the no-touch flag to a company profile for invoicing ............................................................. 13 Adding the no-touch flag to a resource profile for settlements ........................................................... 14

Marking companies and resources for no-touch processing ....................................................................... 15 Setting up restriction sets for no-touch invoicing ......................................................................................... 17 Understanding how to use command line arguments for no-touch processing ...................................... 20

Registering the permanent command line parameters ......................................................................... 21 Editing the Windows Service ........................................................................................................................... 22 Activating the logging service ......................................................................................................................... 24

Setting up the TMW No-Touch Processor


General requirements Before you install the TMW No-Touch Processor, check that these requirements have been met:

• You must have TMWSuite, TMW.Suite Operations, and TMW.Suite Back Office installed. For installation information about those applications, see the respective guides.

• You must be logged into the system where you want to install TMW No-Touch Processor, and have administrator rights for that system.

• You must have SQL Server System Administrator rights. The installation of the TMW No-Touch Processor includes the manual application of a SQL script to your TMW database. You must have a SQL Server administrator login and password to apply it.

Quick setup guide Setup includes downloading and installing the software and then configuring it to run on your system. The following provide a quick reference of the steps required for setting up and configuring the TMW No-Touch Processor.

1. Download the application files

2. Install the TMW No-Touch Processor files

3. Apply SQL to modify your database

4. Edit the configuration file

5. Add the no-touch flag in the profiles

6. Mark companies and resources for no-touch processing

7. Set up restriction sets (Invoicing only)

8. Register the permanent command line parameters

9. Set up the Windows Service



Installing the TMW No-Touch Processor The steps to install the TMW No-Touch Processor include:

• Downloading the application files

• Installing the application

• Applying SQL to your database

Downloading the application files This process assumes that you have already downloaded and installed the correct version of TMW.Suite Back Office.

1. Download the TMW No-Touch Processor installation file from the Build Delivery section of TMW ClientCenter (http://www.tmwcare.com). This install file is located on the same page as the TMW.Suite Back Office install file. Note: For more information about downloading files from ClientCenter, see: Guide: ClientCenter User Guide | Chapter: Build delivery

2. In ClientCenter, use the Line of Business, Product, and Build lists to locate the TMW.Suite Back Office build that you are using. The download name for the build is TMWSuite Back Office.

Notes: 1. You must install the version of the TMW No-Touch Processor that is associated with the

TMW.Suite Back Office version you are using. 2. When you update to a new version of TMW.Suite Back Office, you must uninstall your

current version of the TMW No-Touch Processor and then install the new version that is associated with the updated version of TMW.Suite Back Office.

http://www.tmwcare.com/

http://tmws.tmwsystems.com/learningcenter/TMWS/docs/ClientCenter/CC-Doc-User/02.BuildDelivery.pdf



3. Click View Details to go to the Software Delivery Files page and download the install file for the TMW No-Touch Processor. Note: As of build 17.25.3, the install file is named WindowsServiceInstaller. In a future build this will be renamed to NoTouchProcessingInstaller.

4. When prompted to run or save the installation file, save it to your desktop or Downloads folder.

Installing the application After you download the installation files, you can install the application on your machine. Follow these steps.

1. Open the installation .zip file you downloaded and saved.

2. Double-click the .msi file. The Welcome to the TMW No-Touch Processor Setup Wizard opens.



3. Click Next to continue. The Select Installation Folder window opens.

4. Do one of the following:

• To accept the installation folder, click Next.

• To change the installation folder, click Browse.

1) In the Browse for Folder window, locate the appropriate folder.

2) Click OK.

5. Select one of the following radio buttons:

• Everyone If other users will be accessing the application from this computer.

• Just me If you will be the only person accessing the application from this computer.



6. Click Next.

The Confirm Installation window opens.

7. Click Next. The Installing window displays momentarily.



8. When the Installation Complete window opens, click Close.

After installation is complete, your install directory will have all the following:

• The necessary .dll files to run the service

• A SQL folder containing a copy of TMWBackOfficeDBMods.sql file

• The TMWBackOffice_NoTouchProcessor.exe executable file.

Applying SQL to your database To ensure that your database is correctly modified, you must apply the TMWBackOfficeDBMods.sql file to your database. This file was installed in the SQL folder in the same directory as the other TMW No-Touch Processor files.

To apply the SQL file to your database, follow these steps.

1. In Windows Explorer, access the folder and double-click the TMWBackOfficeDBMods.SQL file.

2. Apply the SQL to your database. Note: For instructions, consult your Microsoft SQL Server Management Studio or SQL Server Enterprise Manger help system. If you need further assistance, contact your TMW Support representative.



Configuring the TMW No-Touch Processor Configuration of the TMW No-Touch Processor includes:

• Editing the configuration file

• Using QuickDesigner to add the no-touch flag in the profiles

• Marking companies and resources for no-touch processing

• Setting up restriction sets for no-touch invoicing

• Setting up the Windows Service

Editing the configuration file The TMWBackOffice_NoTouchProcessor.exe.config file is located in the folder where you installed the application files. You can set several important parameters in the <appSettings> section of this configuration file. Do not make changes in other sections of the configuration file.

The configuration file consists of keys (i.e., settings) and values, which are the options associated with those keys. For example, you use the OrdersAvailableInterval key to specify how often the service will poll the database for orders that are eligible for invoicing.

<add key="OrdersAvailableInterval" value="5000" /> Key Value

Key Definition

OrdersAvailableInterval Specifies how often the service polls the database for orders that are eligible for invoicing.

The value is in milliseconds (e.g., 5000 = 5 seconds).

The default value is 5000.

OrdersAvailableStartTime The earliest time during the day that the system can poll for available orders. Works with the OrdersAvailableEndTime setting to specify the times when the service is active.

The default value is 2:00:00 AM.

OrdersAvailableEndTime The latest time during the day that the system can poll for available orders. Works with the OrdersAvailableStartTime setting to specify the times when the service is active.

The default value is 11:00:00 PM.



BadAvailableOrderRetryTimespan If the service fails to process an order that is Available for invoicing, this is the amount of time that the service waits before attempting to process the order again. The value is in hh:mm:ss format (e.g., 01:05:00 = 1 hour and 5 minutes)

The default value is 00:05:00.

InvoicesOnHoldInterval Specifies how often the service polls the database for On Hold invoices that are eligible to be Ready To Print. The value is in milliseconds (e.g., 5000 = 5 seconds).


InvoicesOnHoldStartTime The earliest time during the day that the system can poll for invoices On Hold. Works with the InvoicesOnHoldEndTime setting to specify the times when the service is active.


InvoicesOnHoldEndTime The latest time during the day that the system can poll for invoices On Hold. Works with the InvoicesOnHoldStartTime setting to specify the times when the service is active.


BadInvoiceOnHoldRetryTimespan If the service fails to process an On Hold invoice, this is the amount of time that the service waits before attempting to process that invoice again. The value is in hh:mm:ss format (e.g., 01:05:00 = 1 hour and 5 minutes).


InvoicesReadyToPrintInterval Specifies how often the service polls the database for Ready To Print invoices and attempts to print them. The value is in milliseconds (e.g., 5000 = 5 seconds).


InvoicesReadyToPrintStartTime The earliest time during the day that the system can poll for invoices to be printed. Works with the InvoicesReadyToPrintEndTime setting to specify the times when the service is active.




InvoicesReadyToPrintEndTime The latest time during the day that the system can poll for invoices to be printed. Works with the InvoicesReadyToPrintStartTime setting to specify the times when the service is active.


InvoicesReadyToPrintTimeout If the printing of an invoice is delayed, this represents the amount of time the system will wait before moving to the next invoice in the print queue. The system will continue performing the original print job, but do so in the background. This allows for the service queue to not be bound by the speed of the printer.

The value is in an hh:mm:ss format (e.g., 00:02:00 = 2 minutes)

The default value is 00:02:00

BadInvoiceReadyToPrintRetryTimespan If the service fails to print an invoice, this is the amount of time that the service waits before attempting to print the invoice again. The value is in hh:mm:ss format (e.g., 01:05:00 = 1 hour and 5 minutes).


TripsReadyToSettleInterval Specifies how often the service polls the database for trips that are ready to settle and attempts to compute pay details for them. The value is in milliseconds (e.g., 5000 = 5 seconds).


TripsReadyToSettleStartTime The earliest time during the day that the system can poll for trips that are ready to settle. Works with the TripsReadyToSettleEndTime setting to specify the times when the service is active.


TripsReadyToSettleEndTime The latest time during the day that the system can poll for trips that are ready to settle. Works with the TripsReadyToSettleStartTime setting to specify the times when the service is active.




BadTripsReadyToSettleRetryTimespan If the service fails to settle a trip, this is the amount of time that the service waits to attempt to settle that trip again. The value is in hh:mm:ss format (e.g., 01:05:00 = 1 hour and 5 minutes).


TTS50Location The path to the directory containing your TTS50.ini file.

The default value is C:\Program Files (x86)\TMW Systems, Inc\TMW No-Touch Processor\TTS50.ini.

TTSLocalLocation The path to the directory containing your TTSLocal.ini file

The default value is C:\Program Files (x86)\TMW Systems, Inc\TMW No-Touch Processor\TTSLocal.ini.

PlugginsLocation Not functional

UseSqlCaching Not functional

LogLevel Sets the minimum level of logging based on the Importance value on each log message.

• Failure Logs error messages having an Importance value of Critical.

• Warning (default) Logs error messages having an Importance value of High or Critical.

• BasicDiagnostic Logs error messages having an Importance value of Informational, High, or Critical.

• VerboseDiagnostic

Logs error messages having an Importance value of Informational, High, or Critical.



Setting a path to your INI files By default, the TMW No-Touch Processor assumes that your TTS50.ini and TTSLocal.ini files are in the same directory as the TMWBackOffice_NoTouchProcessor.exe. If your INI files are in a different directory, you must tell the system where the files are located. You can do this in one of two ways:

• Make entries in the TMWBackOffice_NoTouchProcessor.exe.config file. For example, <add key="TTS50Location" value="C:\[path]\TTS50.ini" /> <add key="TTSLocalLocation" value="C:\[path]\TTSLocal.ini" />

• Use command-line arguments You can use the -G, -L command line arguments to specify the TTS50 and TTSLocal file paths. For more information, see Setting command line arguments

Using QuickDesigner to add the no-touch flag to the profiles Before you can use no-touch processing, you must use QuickDesigner to add the IsNoTouchBillingEligible check box to the appropriate profiles. The check box allows you to flag specific Bill To companies and/or resources for no-touch processing.

• For invoicing, you add the check box to the company profile.

• For settlements, you add the check box in the appropriate resource profile: driver, tractor, or carrier.

This illustration shows the check box in the Carrier profile.



Adding the no-touch flag to a company profile for invoicing To use the TMW No-Touch Processor for invoicing, you must add the no-touch flag to the company profile. To add the no-touch flag, follow these steps.

1. Open the company profile.

2. Launch QuickDesigner.

3. In the Add New Item window, specify the following:

• Control: Type: Checkbox

• Field Group: CompanyInfoBindingSource

• Field: IsNoTouchProcessingEligible



Adding the no-touch flag to a resource profile for settlements To use the TMW No-Touch Processor for settlements, you must add the no-touch flag to the resource profile. To add the no-touch flag, follow these steps.

1. Open the profile for the type of resource: driver, tractor, or carrier.

2. Launch QuickDesigner.

3. In the Add New Item window, specify the following:

• Control: Type: Checkbox

• Field Group: bindingSource

• Field: IsNoTouchProcessingEligible



Marking companies and resources for no-touch processing You select the IsNoTouchBillingEligible check box to specify that an entity is eligible for no-touch processing.

• For invoicing, you select the check box in the Bill To company's profile. This illustration shows the check box selected in a company profile.



• For settlements you select the check box in the profile of the appropriate driver, tractor, or carrier. This illustration shows the check box selected in a carrier profile.



Setting up restriction sets for no-touch invoicing To use no-touch processing for invoicing, you must set up a restriction set that specifies whether a Bill To company's invoices will be processed by the feature. You set up restriction sets in the No Touch Billing Maintenance window.

1. Go to Tools > Setup > No-Touch Processing > Billing Maintenance. The No Touch Billing Maintenance window opens.

2. Click Add. A blank row is added.

3. Make entries in these fields. Field definitions A red asterisk (*) indicates that an entry is required.

Applies To Select the Bill To company.

Note: If you set this to UNKNOWN, the view is available for all Bill To companies.

*Invoice Orders Board Select the board the system will use to filter Available orders to be invoiced.

Notes:

1. The default option is Orders Ready for No-Touch Billing.

2. Any board that has a Board Type of NTBSCR is displayed.

*Invoices on Hold Board

Select the board used to filter On Hold invoices to be set to Ready to Print.

Notes:

1. The default option is Invoices On Hold for No-Touch Billing.

2. Any board that has a Board Type of NTCSCR is displayed.

*Print Invoices Board Select the board used to filter Ready To Print invoices to be printed.

Notes:

1. The default option is Invoices Ready To Print for No-Touch Billing.

2. Any board that has a Board Type of NTDSCR is displayed.



End Invoice Status Select the invoice status at which the no-touch process will stop. Options include:

• OnHold for Audit

• On Hold

• Ready To Print

• Printed

Eligibility Date Specify the date type used to determine if the order is eligible for processing. Options include:

• Order Ship Date

• Order Delivery Date

• Order Final Date

Eligibility Lag Days Specify if any days should be added to the eligibility date when determining if the order is eligible for processing.

Note: Used with the Eligibility Date column. It specifies a timespan (in days) that must pass after the eligibility date before an order is eligible for no-touch invoicing. For example, if Order Ship Date is the Eligibility Date, and Eligibility Lag Days is set to 5, an order with a ship date of 1/5/2017 is not eligible until 1/10/2017.

Eligibility Terms Specify the payment term restriction for this board, if any. Options include:

• PPD Prepaid

• COL Collect

Note: These terms are from the CreditTerms label.

Require Fuel Surcharge

Select this check box to limit the invoices processed to those that have a Fuel Surcharge invoice detail.



Eligibility Ref Types

If you want, specify a reference number type restriction that will limit the invoices processed to those with the specified reference number type(s).

Clicking the Ref #s button for any configuration record on the grid, displays a popup reference type editor. You can use the editor to specify multiple reference number type requirements. The button is highlighted in red when one or more reference number requirements are present for the given configuration record.

Notes:

1. This restriction only applies to the Invoice Orders queue.

2. When multiple reference numbers are listed, the invoice must contain all the specified reference numbers.

3. The system will look at all reference numbers tied to an order, not just the first one written directly to a given orderheader record.

This illustration shows a sample restriction set.

4. Click Save.

5. Repeat Steps 2-4 for each additional Bill To company.



Understanding how to use command line arguments for no-touch processing You must set up a command line argument that the Windows Service will use to call the TMWBackOffice_NoTouchProcessor.exe. The following table explains the commands and arguments available for use with no-touch processing.

Parameter Description

sc config Command for accessing the Service Controller's configuration utility

Service name Enter TMWNTProcessor Notes: 1. The service name identifies the Windows Service, in this case, the

TMW No-Touch Processor. The name is visible on the service's property window.

2. You can use the sc getkeyname command at the command

prompt to retrieve the service name. See your Microsoft documentation for more information.

binPath= Enter the path to the TMWBackOffice_NoTouchProcessor.exe file followed by the applicable command line arguments. You must enter a space between the binPath parameter and its argument. You should also use double quotes around the entire argument. Note: The binPath= parameter tells the Service Controller what should occur when the TMWNTProcessor Windows Service is started. In this case, it launches the installed TMWBackOffice_NoTouchProcessor.exe file, and it pass the command line arguments you specify.

You can add the following command line arguments after the binPath argument.

Command line argument Description

-U Enter your TMW.Suite Back Office username.

-P Enter your TMW.Suite Back Office password.

-G Enter the path to the TTS50.ini file.

-L Enter the path to the TTSlocal.ini file.

–inv Run the no-touch process for invoicing.

-stl Run the no-touch process for settlements.



Registering the permanent command line parameters You must permanently register the command line parameters to be passed to the service upon startup. This string shows a sample command line argument for the TMW No-Touch Processor Windows Service:

sc config < enter the service name> binPath= "<enter the path to the EXE>\TMWBackOffice_NoTouchProcessor.exe -U <enter the TMW login> -P <enter the TMW password> -G <enter the path to TTS50>\TTS50.ini -L <enter the path to TTSlocal>\TTSlocal.ini –inv -stl "

To permanently register the command line parameters, follow these steps.

1. Open the command prompt as an administrator.

2. Enter the command.

3. Press ENTER. When it completes the command, the system displays SUCCESS message.

4. Close and reopen TMW.Suite Back Office



Note: For more information about using the SC.exe command to manage Windows Services from the command line, see the following Microsoft TechNet web pages:

SC.exe: https://technet.microsoft.com/en-us/library/bb490995.aspx

sc getkeyname: https://technet.microsoft.com/en-us/library/cc742082.aspx

sc config: https://technet.microsoft.com/en-us/library/cc990290.aspx

Editing the Windows Service When you ran the TMW No-Touch Processor installer, the system automatically created the Windows Service named TMW No-Touch Processor Service. Although the service was installed, you must edit it before using the feature.

The Windows service for the TMW No-Touch Processor periodically polls the database to check whether any invoices and/or settlement records are ready for processing.

Note: A Windows Service is an application type that runs in the system background without a user interface. In the Services window, you can edit a service's properties, and you can start, stop, pause, resume, or disable the service.

To edit the Windows Service, follow these steps.

1. Open the Services window and navigate to the TMW No-Touch Processor Service.

Note: See your Windows documentation for information about accessing or using Windows Services.

https://technet.microsoft.com/en-us/library/bb490995.aspx

https://technet.microsoft.com/en-us/library/cc742082.aspx

https://technet.microsoft.com/en-us/library/cc990290.aspx



2. Right-click on the TMW No-Touch Processor Service service. Then select Properties. The TMW No-Touch Processor Service Properties window opens. Note: The service name for the No-Touch Processor is TMWNTProcessor.

3. On the Log On tab, select Local System account.



4. Click Apply.

5. Click OK.

6. Right-click on the TMW No-Touch Processor Service service. Then select Refresh.

7. Close the Services window.

Activating the logging service As an option, you can set up TMW No-Touch Processor to log all of its messages to a database table named TMWSystemWideLogging.

The logged information can be useful for troubleshooting why a given order or invoice is not processing as expected.

If this setup is not performed, the no-touch service will not write any log messages.

To activate the logger, paste the following INI settings into the TTS50.ini file you will be using with the TMW No-Touch Processor. Be sure to include the section names, such as [LOGGER].

[LOGGER]

AppenderSetupCount=1

AppenderSetup0=DBLog

ActivationRulesCount=1

[Logger/AppenderSetup-DBLog]

AppenderClassName=DatabaseLogAppender

TableName=TMWSystemWideLogging

FieldMappingsCount=13

FieldMappings0=AppID

FieldMappings1=KeyWord1

FieldMappings2=KeyWord2

FieldMappings3=Importance

FieldMappings4=TMWUser

FieldMappings5=AppVersion

FieldMappings6=MiscDataDef

FieldMappings7=MiscData1




FieldMappings11=LogDate

FieldMappings12=Message



FieldMappings-AppID=%[AppID]

FieldMappings-KeyWord1=%[IF KeywordCount>0 THEN ToList(Keywords).Item(0) ELSE "Unknown" ENDIF]

FieldMappings-KeyWord2=%[IF KeywordCount>1 THEN ToList(Keywords).Item(1) ELSE "Unknown" ENDIF]

FieldMappings-Importance=%[Importance]

FieldMappings-TMWUser=%[TMWUser]

FieldMappings-AppVersion=%[AppVersion]

FieldMappings-MiscDataDef=%[ "1:" & IF AdditionalData().Keys.Count >0 THEN ToList(AdditionalData().Keys).Item(0) ELSE "Unknown" ENDIF & ", 2:" & IF AdditionalData().Keys.Count >1 THEN ToList(AdditionalData().Keys).Item(1) ELSE "Unknown" ENDIF& ", 3:" & IF AdditionalData().Keys.Count >2 THEN ToList(AdditionalData().Keys).Item(2) ELSE "Unknown" ENDIF& ", 4:" & IF AdditionalData().Keys.Count >3 THEN ToList(AdditionalData().Keys).Item(3) ELSE "Unknown" ENDIF]

FieldMappings-MiscData1=%[IF AdditionalData().Values.Count >0 THEN ToList(AdditionalData().Values).Item(0) ELSE "Unknown" ENDIF]




FieldMappings-LogDate=%[Timestamp]

FieldMappings-Message=%[message]

[LOGGER/ACTIVATIONRULES0]

MatchAppIdsCount=1

MatchAppIds0=.NB

AppenderSetupNamesCount=1

AppenderSetupNames0=DBLog

RequiredKeywordsCount=1

RequiredKeywords0=NoTouchBatchProcess

OptionalKeywordsCount=0

NeededOptionalCount=0

Setting up the TMW No-Touch Processortmws.tmwsystems.com/learningcenter/TMWS/docs/TMW... · The TMW...

Documents

Transcript of Setting up the TMW No-Touch Processortmws.tmwsystems.com/learningcenter/TMWS/docs/TMW... · The TMW...