TapeTrack Documentation

Because there is more to tape management than you ever realized

User Tools

Site Tools


billing:customer_map

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
billing:customer_map [2026/08/18 02:12] – [File Location] Scott Cunliffebilling:customer_map [2026/08/18 03:45] (current) – [See Also] Scott Cunliffe
Line 1: Line 1:
 ====== Customer Description Map ====== ====== Customer Description Map ======
  
-The Customer Description Map file maps a TapeTrack [[definitions:customer-id|Customer-ID]] to a readable Customer name, location, account name, or other billing description.+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 map is used by [[cli:tmss10logstatsprocess|TMSS10LogStatsProcess]] when processing TapeTrack statistics (.ttstats) files for billing.
Line 37: Line 37:
   /etc/tapetrack/billing/customer.txt   /etc/tapetrack/billing/customer.txt
  
-The location of the file is supplied to ''TMSS10LogStatsProcess'' using the ''-M'' argument.+The location of the file is supplied to ''[[cli:tmss10logstatsprocess|TMSS10LogStatsProcess]]'' using the ''-M'' argument.
  
  
Line 58: Line 58:
 | ''US02'' | Los Angelas Data Center| | ''US02'' | Los Angelas Data Center|
  
-customer_map.txt 
-<code> 
-# Customer-ID  QuickBooks Customer FullName 
-US01 New York Data Center 
-US02 Los Angelas Data Center 
-</code> 
- 
- 
- 
- 
- 
-When a billing record contains Customer-ID ''US01'', the billing processor can use the description ''Los Angeles'' in the resulting billing information. 
  
-===== Example Customer Description Map =====+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 three TapeTrack Customers.+The following example contains two TapeTrack Customers.
  
-<file text customer.txt>+<file text customer_map.txt>
 # #
 # TapeTrack Billing Customer Description Map # TapeTrack Billing Customer Description Map
 # #
 # Format: # Format:
-# CUSTOMER-ID=Customer Description+# CUSTOMER-ID Customer Description
 # #
  
-US01=Los Angeles +US01 New York Data Center 
-US02=New York +US02 Los Angeles Data Center
-US03=Florida+
 </file> </file>
  
Line 94: Line 81:
   * The purpose of the file.   * The purpose of the file.
   * The expected mapping format.   * The expected mapping format.
-  * The date of the last approved change. 
-  * The person or team responsible for maintaining the file. 
   * Any customer-specific mapping requirements.   * Any customer-specific mapping requirements.
  
-===== Running TMSS10LogStatsProcess ===== 
  
-Use the ''-M'' argument to supply the Customer Description Map to [[cli:tmss10logstatsprocess|TMSS10LogStatsProcess]]. 
  
-Example: 
  
-  TMSS10LogStatsProcess -i US01.ttstats -M customer.txt -P package.txt -c default.ttsdef > Billing_US01.xml 
  
-Where: 
  
-^ Argument ^ Value ^ Description ^ 
-| ''-i'' | ''US01.ttstats'' | Specifies the TapeTrack statistics input file. | 
-| ''-M'' | ''customer.txt'' | Specifies the Customer Description Map file. | 
-| ''-P'' | ''package.txt'' | Specifies the Package Map file. | 
-| ''-c'' | ''default.ttsdef'' | Specifies the Billing Rules configuration file. | 
-| Standard output | ''Billing_US01.xml'' | Receives the calculated billing XML. | 
- 
-If the files are not stored in the current working directory, specify their complete paths. 
- 
-Example: 
- 
-  TMSS10LogStatsProcess ^ 
-  -i "C:\TapeTrack\Billing\Input\US01.ttstats" ^ 
-  -M "C:\TapeTrack\Billing\Config\customer.txt" ^ 
-  -P "C:\TapeTrack\Billing\Config\package.txt" ^ 
-  -c "C:\TapeTrack\Billing\Config\default.ttsdef" ^ 
-  > "C:\TapeTrack\Billing\Output\Billing_US01.xml" 
- 
-===== Example Processing Result ===== 
- 
-For the following Customer Description Map entry: 
- 
-  US01=Los Angeles 
- 
-And a billing statistic for offsite storage, the resulting XML may contain billing information similar to: 
- 
-<code xml> 
-<?xml version="1.0" encoding="ISO8859-1"?> 
-<?xml-stylesheet type="text/xsl" href="tapetrack.xslt"?> 
-<tapetrack_data> 
-  <item> 
-    <customer>US01</customer> 
-    <itemcode>Los Angeles STORAGE_OFFSITE</itemcode> 
-    <description>LTO Vault Storage Charge</description> 
-    <count>60</count> 
-    <cost>0.01</cost> 
-    <total>0.60</total> 
-  </item> 
-</tapetrack_data> 
-</code> 
- 
-The Customer Description Map supplies the readable value ''Los Angeles''. The Billing Rules supply the item description and unit rate, while the ''.ttstats'' file supplies the activity quantity. 
- 
-===== Customer Map and Package Map ===== 
- 
-The Customer Description Map and Package Map perform different functions. 
- 
-^ File ^ Mapping ^ Purpose ^ 
-| Customer Description Map | Customer-ID to customer description | Identifies the customer or location displayed in the billing output. | 
-| Package Map | Customer-ID to billing package | Selects the rate package that applies to the customer. | 
-| Billing Rules | Package and statistic to billing calculation | Defines the item code, description, rate, rounding and calculation. | 
- 
-Example relationship: 
- 
-<code> 
-Customer Description Map: 
-US01=Los Angeles 
- 
-Package Map: 
-US01=STANDARD 
- 
-Billing Rules: 
-STANDARD + STORAGE_OFFSITE = $0.01 per volume per day 
-</code> 
- 
-Together, these files mean: 
- 
-  * The Customer is ''US01''. 
-  * The readable description is ''Los Angeles''. 
-  * The Customer uses the ''STANDARD'' billing package. 
-  * Offsite storage is charged at the rate defined for that package. 
- 
-===== Creating a New Mapping ===== 
- 
-Before adding a new Customer Description Map entry: 
- 
-  - Confirm the TapeTrack Customer-ID. 
-  - Confirm the approved customer or location description. 
-  - Confirm the required QuickBooks customer name or identifier. 
-  - Check that the Customer-ID is not already mapped. 
-  - Add the new entry to the Customer Description Map. 
-  - Confirm that the Customer is also present in the Package Map. 
-  - Test the mapping with a sample ''.ttstats'' file. 
-  - Review the generated XML before using the mapping in production. 
- 
-Example: 
- 
-  US04=Chicago 
- 
-<WRAP important> 
-The Customer-ID in the map must match the Customer-ID stored in TapeTrack and contained in the ''.ttstats'' file. 
-</WRAP> 
- 
-===== Modifying an Existing Mapping ===== 
- 
-When changing an existing Customer Description Map entry: 
- 
-  - Confirm that the change has been approved. 
-  - Make a backup copy of the current map file. 
-  - Update only the description on the right side of the mapping. 
-  - Do not change the TapeTrack Customer-ID unless the Customer-ID has also changed in TapeTrack. 
-  - Generate a test billing XML file. 
-  - Confirm the new description matches the corresponding QuickBooks customer. 
-  - Retain the previous file for audit and rollback purposes. 
- 
-Example change: 
- 
-<code> 
-Before: 
-US01=Los Angeles Data Centre 
- 
-After: 
-US01=ACME Los Angeles 
-</code> 
- 
-Changing a customer description does not change the statistics, billing package or billing rates. It changes the customer description used by the billing output. 
- 
-===== Validation ===== 
- 
-The Customer Description Map should be validated before every production billing run. 
- 
-Check that: 
- 
-  * Every billed Customer-ID has a corresponding map entry. 
-  * No Customer-ID appears more than once. 
-  * Customer descriptions are accurate and approved. 
-  * Customer descriptions match the intended QuickBooks customer records. 
-  * There are no unwanted spaces around the Customer-ID. 
-  * The file contains no spelling errors. 
-  * The file is readable by the billing service account. 
-  * The correct version of the file is being used. 
-  * Test billing XML contains the expected customer descriptions. 
- 
-A validation table can be maintained for each billing run. 
- 
-^ Check ^ Expected Result ^ 
-| Customer-ID exists in TapeTrack | Customer record is present. | 
-| Customer-ID exists in Customer Description Map | One mapping is present. | 
-| Customer-ID exists in Package Map | One billing package is assigned. | 
-| Customer description is approved | Description matches the billing profile. | 
-| QuickBooks customer exists | Mapping resolves to the intended QuickBooks customer. | 
-| Test XML is correct | Customer and item descriptions display as expected. | 
  
 ===== Troubleshooting ===== ===== Troubleshooting =====
Line 287: Line 125:
 </WRAP> </WRAP>
  
-==== TMSS10LogStatsProcess Fails ==== 
- 
-Run the command again while redirecting diagnostic messages to an error file. 
- 
-Windows example: 
- 
-  TMSS10LogStatsProcess -i US01.ttstats -M customer.txt -P package.txt -c default.ttsdef > Billing_US01.xml 2> Billing_US01_error.txt 
- 
-Review ''Billing_US01_error.txt'' for: 
- 
-  * File-not-found errors. 
-  * Access or permission errors. 
-  * Invalid map entries. 
-  * Missing billing configuration. 
-  * Invalid Billing Rules syntax. 
- 
-===== Change Control ===== 
- 
-The Customer Description Map forms part of the billing configuration and should be subject to change control. 
- 
-Each change should record: 
- 
-  * Customer-ID. 
-  * Previous description. 
-  * New description. 
-  * Reason for the change. 
-  * Effective billing date. 
-  * Requesting person. 
-  * Approving person. 
-  * Date tested. 
-  * Test result. 
- 
-A production change should not be applied until the Customer Billing Profile has been reviewed and approved. 
  
 ===== Recommended Practices ===== ===== Recommended Practices =====
Line 326: Line 131:
   * Use one authoritative Customer Description Map for each billing environment.   * Use one authoritative Customer Description Map for each billing environment.
   * Do not maintain uncontrolled copies.   * Do not maintain uncontrolled copies.
-  * Back up the file before making changes. 
-  * Use comments to document the file and its owner. 
-  * Validate every Customer-ID before processing invoices. 
   * Keep descriptions consistent with QuickBooks.   * Keep descriptions consistent with QuickBooks.
-  * Test changes before the production billing run. 
-  * Retain the map used for each billing period with the billing output. 
   * Restrict write access to authorized billing administrators.   * Restrict write access to authorized billing administrators.
  
Line 350: Line 150:
   * [[cli:tmss10logstatsprocess|TMSS10LogStatsProcess]]   * [[cli:tmss10logstatsprocess|TMSS10LogStatsProcess]]
   * [[master:customer|Adding and Maintaining Customers]]   * [[master:customer|Adding and Maintaining Customers]]
-  * [[definitions:customer-id|Customer-ID]] 
   * [[billing:package_map|Package Map]]   * [[billing:package_map|Package Map]]
   * [[billing:billing_rules|Billing Rules]]   * [[billing:billing_rules|Billing Rules]]
billing/customer_map.1787019135.txt.gz · Last modified: 2026/08/18 02:12 by Scott Cunliffe