TapeTrack Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Customer Description Map ======

The Customer Description Map file maps a TapeTrack [[object:customer|Customer-ID]] to a readable Customer name, location, account name, or other billing description.

The map is used by [[cli:tmss10logstatsprocess|TMSS10LogStatsProcess]] when processing TapeTrack statistics (.ttstats) files for billing.

The Customer Description Map allows the billing output to include the Customer description, such as ''New York Data Center'' instead of just US01.

The Customer Description Map does not define billing rates or determine which billing package applies to the Customer.

===== Purpose =====

The Customer Description Map provides a consistent relationship between the TapeTrack Customer-ID and the description required in billing reports or invoice output.

The file can be used to:

  * Display a readable customer or location name in the billing output.
  * Associate a TapeTrack Customer-ID with an accounting-system customer.
  * Improve the readability of billing XML and reports.
  * Prevent internal Customer-IDs from being used as customer-facing descriptions.
  * Maintain consistent customer descriptions across billing periods.
  * Assist with mapping TapeTrack billing data to QuickBooks Desktop.


===== File Location =====

The Customer Description Map can be stored in any directory accessible to the account running the billing process.

For ease of administration, it is recommended that all approved billing configuration files are stored in a dedicated directory.

Example Windows location:

  C:\Program Files\TapeTrack\TapeTrack Framework Server\etc\billing\customer.txt

Example Linux location:

  /etc/tapetrack/billing/customer.txt

The location of the file is supplied to ''[[cli:tmss10logstatsprocess|TMSS10LogStatsProcess]]'' using the ''-M'' argument.


===== File Format =====

The Customer Description Map is a plain-text file.

Each mapping contains:

  * The TapeTrack Customer-ID on the left.
  * The customer description on the right.

The general format is:

  CUSTOMER-ID  Customer Description

Example:
^ Customer-ID ^ Customer Description ^
| ''US01'' | New York Data Center |
| ''US02'' | Los Angelas Data Center|


When a billing record contains Customer-ID ''US01'', the billing processor can use the description ''New York Data Center'' in the resulting billing information.

The following example contains two TapeTrack Customers.

<file text customer_map.txt>
#
# TapeTrack Billing Customer Description Map
#
# Format:
# CUSTOMER-ID Customer Description
#

US01 New York Data Center
US02 Los Angeles Data Center
</file>

Lines beginning with a hash character (''#'') are comments and are ignored during processing.

Comments should be used to document:

  * The purpose of the file.
  * The expected mapping format.
  * Any customer-specific mapping requirements.







===== Troubleshooting =====

==== Customer Description Is Missing ====

Check that:

  * The ''-M'' argument has been included.
  * The specified Customer Description Map file exists.
  * The billing account has permission to read the file.
  * The Customer-ID is present in the map.
  * The Customer-ID matches the value in the ''.ttstats'' file.
  * The mapping does not contain an unwanted leading or trailing space.

==== Incorrect Customer Description ====

Confirm that:

  * The correct Customer Description Map file was used.
  * The Customer-ID is not duplicated.
  * The mapping points to the intended customer.
  * An old copy of the file is not being referenced by the billing script.
  * The description matches the approved customer billing profile.

==== Incorrect QuickBooks Customer ====

The Customer Description Map may be correct while the XMLQuickBooks mapping is incorrect.

Check both mappings:

  - TapeTrack Customer-ID to billing description.
  - Billing description or Customer-ID to QuickBooks customer.

<WRAP note>
The Customer Description Map and XMLQuickBooks mapping are separate configuration stages. Updating one does not automatically update the other.
</WRAP>


===== Recommended Practices =====

  * Keep the file in a controlled billing configuration directory.
  * Use one authoritative Customer Description Map for each billing environment.
  * Do not maintain uncontrolled copies.
  * Keep descriptions consistent with QuickBooks.
  * Restrict write access to authorized billing administrators.

===== Security =====

The Customer Description Map does not normally contain passwords or authentication details. However, it may contain customer names and accounting identifiers.

Access should therefore be restricted to:

  * TapeTrack administrators.
  * Authorized billing staff.
  * The service account that runs the billing process.

The file should not be publicly accessible or stored in an unsecured shared directory.

===== See Also =====

  * [[cli:tmss10logstatsprocess|TMSS10LogStatsProcess]]
  * [[master:customer|Adding and Maintaining Customers]]
  * [[billing:package_map|Package Map]]
  * [[billing:billing_rules|Billing Rules]]
  * [[billing:billing_process|Billing Process]]
  * [[billing:xmlquickbooks_mapping|XMLQuickBooks Mapping]]

{{tag>billing customer map configuration quickbooks}}