TapeTrack Documentation

Because there is more to tape management than you ever realized

User Tools

Site Tools


billing:ttstats

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:ttstats [2026/08/18 03:07] – [File Creation] Scott Cunliffebilling:ttstats [2026/08/19 02:00] (current) Scott Cunliffe
Line 35: Line 35:
 ===== File Location ===== ===== File Location =====
  
-TTSTATS files can be stored in any directory accessible to the account running the billing process. +TTSTATS files can be stored in any directory accessible to the account running the billing process.  For ease of administration, it is recommended that each billing period has a separate input directory.
- +
-For ease of administration, it is recommended that each billing period has a separate input directory.+
  
 Example Windows location: Example Windows location:
Line 66: Line 64:
 The location of the TTSTATS file is supplied to ''[[cli:tmss10logstatsprocess|TMSS10LogStatsProcess]]'' using the ''-i'' argument. The location of the TTSTATS file is supplied to ''[[cli:tmss10logstatsprocess|TMSS10LogStatsProcess]]'' using the ''-i'' argument.
  
-===== File Naming ===== 
  
-It is recommended that each TTSTATS filename contains the corresponding TapeTrack Customer-ID. 
- 
-The general filename format is: 
- 
-  Customer-ID.ttstats 
- 
-Example: 
- 
-  US01.ttstats 
- 
-The filename may also include the billing period if files need to be retained in the same directory. 
- 
-Example: 
- 
-  US01_2026-07.ttstats 
- 
-Using the Customer-ID and billing period in the filename helps prevent the wrong statistics file from being processed. 
  
 ===== File Contents ===== ===== File Contents =====
Line 107: Line 87:
   * The statistics processed by the Billing Rules.   * The statistics processed by the Billing Rules.
  
-<WRAP note> +Record Types are:
-A TTSTATS file contains activity statistics, not final invoice lines. The final descriptions, rates and totals are produced when the file is processed by ''TMSS10LogStatsProcess''+
-</WRAP>+
  
-===== Relationship to Billing Configuration =====+  * ''C'' : TapeTrack Customer-ID 
 +  * ''I'' : Inventory Total of Media-ID 
 +  * ''S'' : Storage Total - Number of Media in that Repository 
 +  * ''H'' : High Water Mark 
 +  * ''M'' : Volume Movement to the Repository ( to Repository-ID:from Repository-ID)
  
-The TTSTATS file supplies the activity and quantities. Other billing files determine how that activity is identified, priced and displayed.+<file text US01.ttstats> 
 +CUS01 
 +ILTO 20260816000446000015 
 +SLTO LIBR20260816000425000015 
 +HLTO LIBR20260816000000000015 
 +MLTO OFFSLIBR20260816000003000010 
 +SLTO OFFS20260816000018000015 
 +HLTO OFFS20260816000277000015 
 +SLTO SCRA20260816000003000015 
 +HLTO SCRA20260816000000000015 
 +MLTO LIBRSCRA20260816000000000010 
 +ILTO 20260817000446000016 
 +SLTO LIBR20260817000425000016 
 +HLTO LIBR20260817000000000016 
 +MLTO OFFSLIBR20260817000000000011 
 +SLTO OFFS20260817000018000016 
 +HLTO OFFS20260817000277000016 
 +SLTO SCRA20260817000003000016 
 +HLTO SCRA20260817000000000016 
 +MLTO LIBRSCRA20260817000000000011 
 +ILTO 00000000000446000017 
 +SLTO LIBR00000000007300000017 
 +HLTO LIBR00000000000000000017 
 +MLTO OFFSLIBR00000000000016000012 
 +SLTO OFFS00000000000236000017 
 +HLTO OFFS00000000000277000017 
 +SLTO SCRA00000000000046000017 
 +HLTO SCRA00000000000000000017 
 +MLTO LIBRSCRA00000000000001000012 
 +</file>
  
-^ File or Component ^ Purpose ^ +Breakdown of record data: **ILTO 20260816000446000015**
-| ''Customer-ID.ttstats'' | Contains the Customer's extracted activity statistics and quantities. | +
-| Customer Description Map | Maps the Customer-ID to a readable Customer or location description. | +
-| Package Map | Selects the billing package assigned to the Customer. | +
-| Billing Rules | Defines which statistics are billable and applies rates, rounding and calculations. | +
-| ''tapetrack.xslt'' | Controls how the resulting billing XML is displayed. | +
-| XMLQuickBooks Mapping | Maps approved TapeTrack billing values to QuickBooks customers and items. |+
  
-For example:+**I** Inventory **LTO** Media type  **20260816**  Date YYYYMMDD **000446** Inventory **000015** Inventory record count
  
-<code> +Breakdown of record data**MLTO LIBRSCRA20260816000003000010**
-TTSTATS: +
-11 qualifying LTO volumes stored for one day+
  
-Customer Description Map: +**M** Movement **LTO** Media type **LIBR** To repository **OFFS** From repository **** Date **000003** Movement count **000010** Movement record count
-US01 New York Data Center+
  
-Package Map: +<WRAP note
-US01 STANDARD +TTSTATS file contains activity statistics, not final invoice lines. The final descriptions, rates and totals are produced when the file is processed by [[cli:TMSS10LogStatsProcess]]. 
- +</WRAP>
-Billing Rules: +
-Round storage quantity up to the next 10 +
-Charge $0.01 per volume per day +
- +
-Result: +
-20 billed volumes × $0.01 = $0.20 +
-</code+
- +
-===== Processing the File ===== +
- +
-Use the ''-i'' argument to supply a TTSTATS file to [[cli:tmss10logstatsprocess|TMSS10LogStatsProcess]]. +
- +
-Example: +
- +
-  TMSS10LogStatsProcess -i US01.ttstats -M customer_map.txt -P package_map.txt -c default.ttsdef -X tapetrack.xslt > Billing_US01.xml +
- +
-Where: +
- +
-^ Argument ^ Value ^ Description ^ +
-| ''-i'' | ''US01.ttstats'' | Specifies the Customer statistics input file. | +
-| ''-M'' | ''customer_map.txt'' | Specifies the Customer Description Map. | +
-| ''-P'' | ''package_map.txt'' | Specifies the Package Map. | +
-| ''-c'' | ''default.ttsdef'' | Specifies the Billing Rules. | +
-| ''-X'' | ''tapetrack.xslt'' | Specifies the XML stylesheet. | +
-| Standard output | ''Billing_US01.xml'' | Receives the calculated billing XML. | +
- +
-If the files are stored in different directories, specify their complete paths. +
- +
-Example: +
- +
-  TMSS10LogStatsProcess ^ +
-  -i "C:\TapeTrack\Billing\Input\US01.ttstats"+
-  -M "C:\TapeTrack\Billing\Config\customer_map.txt"+
-  -P "C:\TapeTrack\Billing\Config\package_map.txt"+
-  -c "C:\TapeTrack\Billing\Config\default.ttsdef"+
-  -X "C:\TapeTrack\Billing\Config\tapetrack.xslt"+
-  > "C:\TapeTrack\Billing\Output\Billing_US01.xml" +
- +
-===== Processing Result ===== +
- +
-''TMSS10LogStatsProcess'' reads the statistics and applies the selected billing configuration. +
- +
-The resulting XML may contain: +
- +
-<code xml> +
-<?xml version="1.0" encoding="ISO8859-1"?> +
-<?xml-stylesheet type="text/xsl" href="tapetrack.xslt"?> +
-<tapetrack_data> +
-  <item> +
-    <customer>US01</customer> +
-    <itemcode>New York STORAGE_OFFSITE</itemcode> +
-    <description>LTO Vault Storage Charge</description> +
-    <count>60</count> +
-    <cost>0.01</cost> +
-    <total>0.60</total> +
-  </item> +
-</tapetrack_data> +
-</code> +
- +
-In this example: +
- +
-^ Value ^ Source ^ +
-| Customer activity and quantity | ''US01.ttstats''+
-| Customer description | Customer Description Map | +
-| Billing package | Package Map | +
-| Item code, description and rate | Billing Rules | +
-| XML presentation | ''tapetrack.xslt''+
- +
-===== Validation ===== +
- +
-The TTSTATS file should be validated before production billing is generated. +
- +
-Check that:+
  
-  * The filename identifies the correct Customer. 
-  * The file was created for the correct billing period. 
-  * The extraction start and end dates are correct. 
-  * The file is not empty. 
-  * The file was created successfully by ''TMSS10LogStatsExtractDB''. 
-  * The Customer-ID matches the Customer Description Map. 
-  * The Customer-ID matches the Package Map. 
-  * Expected billing activity is present. 
-  * The file has not already been invoiced. 
-  * The billing service account can read the file. 
-  * The generated billing XML contains reasonable quantities. 
  
-A billing control record should identify: 
  
-^ Control ^ Example ^ 
-| Customer-ID | ''US01'' | 
-| Billing period | ''2026-07-01 to 2026-07-31'' | 
-| TTSTATS filename | ''US01_2026-07.ttstats'' | 
-| Extraction date | ''2026-08-01'' | 
-| Billing XML filename | ''Billing_US01_2026-07.xml'' | 
-| Processing status | Approved | 
-| QuickBooks invoice | Invoice number or import reference | 
  
 ===== File Handling ===== ===== File Handling =====
Line 250: Line 159:
   - Review the Journal activity.   - Review the Journal activity.
   - Correct the source data or extraction settings where appropriate.   - Correct the source data or extraction settings where appropriate.
-  - Run ''TMSS10LogStatsExtractDB'' again.+  - Run [[cli:TMSS10LogStatsExtractDB]] again.
   - Replace the incorrect extract with the newly generated file.   - Replace the incorrect extract with the newly generated file.
   - Reprocess the billing XML.   - Reprocess the billing XML.
Line 264: Line 173:
 Check that: Check that:
  
-  * ''TMSS10LogStatsExtractDB'' completed successfully.+  * [[cli:TMSS10LogStatsExtractDB]] completed successfully.
   * The Customer had Journal activity during the selected date range.   * The Customer had Journal activity during the selected date range.
   * The output directory exists.   * The output directory exists.
Line 283: Line 192:
 An empty file may be valid when the Customer had no relevant activity. It should be investigated before being excluded from billing. An empty file may be valid when the Customer had no relevant activity. It should be investigated before being excluded from billing.
  
-==== Incorrect Customer Is Processed ==== 
  
-Check that: 
- 
-  * The correct TTSTATS file was supplied using the ''-i'' argument. 
-  * The filename corresponds to the Customer-ID contained in the file. 
-  * The correct Customer Description Map was used. 
-  * The correct Package Map was used. 
-  * A file from another billing period or environment was not selected. 
  
 ==== Billing Quantities Are Incorrect ==== ==== Billing Quantities Are Incorrect ====
Line 311: Line 212:
 | 11 | Round up to the next 10 | 20 | | 11 | Round up to the next 10 | 20 |
  
-==== No Billing XML Is Produced ==== 
- 
-Check that: 
- 
-  * The ''-i'' argument specifies a valid TTSTATS file. 
-  * The process account has permission to read the file. 
-  * The Customer exists in the Customer Description Map. 
-  * The Customer exists in the Package Map. 
-  * The assigned package exists in the Billing Rules. 
-  * The statistics match at least one Billing Rule. 
-  * ''TMSS10LogStatsProcess'' completed without errors. 
- 
-Redirect diagnostic messages to an error file. 
- 
-Windows example: 
- 
-  TMSS10LogStatsProcess -i US01.ttstats -M customer_map.txt -P package_map.txt -c default.ttsdef > Billing_US01.xml 2> Billing_US01_error.txt 
- 
-Review ''Billing_US01_error.txt'' for file, mapping and configuration errors. 
  
 ==== Charges Are Duplicated ==== ==== Charges Are Duplicated ====
Line 344: Line 226:
  
   * Generate a new TTSTATS file for every billing period.   * Generate a new TTSTATS file for every billing period.
-  * Use the Customer-ID and billing period in the filename. 
-  * Store each billing period in a separate directory. 
   * Do not manually edit generated TTSTATS files.   * Do not manually edit generated TTSTATS files.
-  * Record the extraction start and end dates. 
-  * Review extraction logs before processing billing. 
-  * Prevent the same file from being processed twice. 
-  * Retain the TTSTATS file with its billing XML and invoice reference. 
   * Restrict write access to authorized billing administrators.   * Restrict write access to authorized billing administrators.
-  * Archive completed billing files as read-only records.+  * Archive completed billing files as read-only records if required.
  
 ===== Security ===== ===== Security =====
Line 362: Line 238:
   * TapeTrack administrators.   * TapeTrack administrators.
   * Authorized billing staff.   * Authorized billing staff.
-  * The service account running ''TMSS10LogStatsExtractDB''+  * The service account running [[cli:TMSS10LogStatsExtractDB]]
-  * The service account running ''TMSS10LogStatsProcess''.+  * The service account running [[cli:TMSS10LogStatsProcess]].
  
 The file should not be publicly accessible or stored in an unsecured shared directory. The file should not be publicly accessible or stored in an unsecured shared directory.
Line 374: Line 250:
   * [[billing:package_map|Package Map]]   * [[billing:package_map|Package Map]]
   * [[billing:billing_rules|Billing Rules]]   * [[billing:billing_rules|Billing Rules]]
-  * [[billing:tapetrack_xslt|TapeTrack XML Stylesheet]]+  * [[billing:stylesheet|TapeTrack XML Stylesheet]]
   * [[billing:billing_process|Billing Process]]   * [[billing:billing_process|Billing Process]]
   * [[billing:billing_xml|Billing XML]]   * [[billing:billing_xml|Billing XML]]
billing/ttstats.1787022427.txt.gz · Last modified: 2026/08/18 03:07 by Scott Cunliffe