TapeTrack Documentation

Because there is more to tape management than you ever realized

User Tools

Site Tools

Trace: • barcode-interpretation-definition • securesync • sort_sequence • add_volume_container_inventory • tools_global_view • media • inventory_right_menu • date_birthday • addtranslation • logon_window
cookbook:billing_process_temp

Differences

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

Link to this comparison view

Next revision		Previous revision
cookbook:billing_process_temp [2026/08/17 02:16] – created Scott Cunliffecookbook:billing_process_temp [2026/08/19 05:12] (current) – [Generate the Invoice XML] Scott Cunliffe
Line 14: Line 14:
  
   - TapeTrack records operational activity in the journal database.   - TapeTrack records operational activity in the journal database.
-  - ''TMSS10LogStatsExtractDB'' extracts activity for the billing period into a Customer-specific ''.ttstats'' file. +  - [[cli:TMSS10LogStatsExtractDB]] extracts activity for the billing period into a Customer-specific ''.ttstats'' file. 
-  - ''TMSS10LogStatsProcess'' applies the billing definition and mapping files and creates an XML invoice file.+  - [[cli:TMSS10LogStatsProcess]] applies the billing definition and mapping files and creates an XML invoice file.
   - The TapeTrack QuickBooks Interface imports the XML file and creates an invoice in QuickBooks Desktop.   - The TapeTrack QuickBooks Interface imports the XML file and creates an invoice in QuickBooks Desktop.
  
Line 33: Line 33:
  
   * A functioning TapeTrack Framework Server with journal activity for the Customer.   * A functioning TapeTrack Framework Server with journal activity for the Customer.
-  * ''TMSS10LogStatsExtractDB''. +  * [[cli:TMSS10LogStatsExtractDB]]. 
-  * ''TMSS10LogStatsProcess''.+  * [[cli:TMSS10LogStatsProcess]].
   * A billing definition file, normally with the ''.ttsdef'' extension.   * A billing definition file, normally with the ''.ttsdef'' extension.
-  * A Customer description map and, when package-based rules are used, a package map.+  * A [[billing:customer_map|Customer description map]] and, when package-based rules are used, a [[billing:package_map|package map]].
   * The TapeTrack QuickBooks Interface on a Windows computer with access to QuickBooks Desktop.   * The TapeTrack QuickBooks Interface on a Windows computer with access to QuickBooks Desktop.
   * QuickBooks Customers and Items that match the values which will be produced by the billing rules.   * QuickBooks Customers and Items that match the values which will be produced by the billing rules.
  
-The billing administrator should also have an approved contract or rate schedule that defines:+The billing administrator should have an approved contract or rate schedule that defines:
  
   * Which storage locations and media types are billable.   * Which storage locations and media types are billable.
Line 49: Line 49:
   * The QuickBooks Customer name or ListID and Item names.   * The QuickBooks Customer name or ListID and Item names.
  
-===== Create the Customer in TapeTrack ===== 
  
-Create the Customer before configuring its billing rules. 
- 
-  - In TapeMaster, right-click the Server Node in the Customer Tree. 
-  - Select ''Add Customer''. 
-  - Enter a unique [[object:customer#customer-id|Customer-ID]] of up to four alphanumeric characters. 
-  - Enter the Customer Description. 
-  - Add the required [[object:media|Media Types]]. 
-  - Add the required [[object:repository|Repositories]]. 
-  - Click ''Save''. 
- 
-See [[master:customer|Adding and Maintaining Customers]] for the complete Customer creation procedure. 
- 
-<WRAP warning> 
-The Customer-ID is permanent after creation. Select it carefully and record how it maps to the corresponding QuickBooks Customer. 
-</WRAP> 
  
 ===== Define the Customer Billing Profile ===== ===== Define the Customer Billing Profile =====
Line 71: Line 55:
 Create and approve a billing profile before editing the billing configuration. Create and approve a billing profile before editing the billing configuration.
  
-^ Setting ^ Customer value ^ Example ^ +^ Setting                         ^ Customer value                   ^ Example                         ^ 
-| TapeTrack Customer-ID | //Required// | ''A099'' | +| TapeTrack Customer-ID           | //Required//                     | ''US03''                        | 
-| TapeTrack Customer Description | //Required// | ''ACME Data Services'' | +| TapeTrack Customer Description  | //Required//                     | ''North Carolina Data Center''  | 
-| QuickBooks Customer reference | //Required// | ''ACME Data Services'' | +| QuickBooks Customer reference   | //Required//                     | "North Carolina Data Center"    | 
-| QuickBooks reference type | FullName or ListID | ''FullName'' | +| QuickBooks reference type       | FullName or ListID               | ''FullName''                    | 
-| Billing package | Optional | ''STANDARD'' | +| Billing package                 | Optional                         | ''STANDARD''                    | 
-| Billable Media-ID values | //Required// | ''LT'', ''LTO'' | +| Billable Media-ID values        | //Required//                     | ''LT'', ''LTO''                 | 
-| Billable Repository-ID values | //Required// | ''COV'', ''RVLT'' | +| Billable Repository-ID values   | //Required//                     | ''LIBR'', ''RACK''              | 
-| Storage basis | Total, high-water, or low-water | ''High-water'' | +| Storage basis                   | Total, high-water, or low-water  | ''High-water''                  | 
-| Rounding increment | Contract value | ''50'' | +| Rounding increment              | Contract value                   | ''10''                          | 
-| Minimum quantity | Contract value | ''0'' | +| Minimum quantity                | Contract value                   | ''0''                           | 
-| Included threshold | Contract value | ''0'' | +| Included threshold              | Contract value                   | ''0''                           | 
-| Maximum quantity | Contract value | ''0'' for no cap | +| Maximum quantity                | Contract value                   | ''0'' for no cap                | 
-| QuickBooks Item names | //Required// | ''A - Storage:QBROTATIONBOX'' | +| QuickBooks Item names           | //Required//                     | ''A - Storage:QB_BOX''          | 
-| Fixed charges | Optional | Monthly account fee |+| Fixed charges                   | Optional                         | Monthly account fee             |
  
 Store the approved profile with the billing configuration so that a later rule change can be traced to a contract requirement. Store the approved profile with the billing configuration so that a later rule change can be traced to a contract requirement.
Line 97: Line 81:
 <file - Customer.ttmap> <file - Customer.ttmap>
 # TapeTrack Customer-ID    QuickBooks Customer name # TapeTrack Customer-ID    QuickBooks Customer name
-A099                      ACME Data Services+US03                      North Carolina Data Services
 </file> </file>
  
-When ''TMSS10LogStatsProcess'' is run with the ''-M'' option, ''$CUSTOMER'' contains the Customer-ID from the ''.ttstats'' file and ''$CUSTOMER2'' contains the mapped description.+When [[cli:TMSS10LogStatsProcess]] is run with the ''-M'' option, ''$CUSTOMER'' contains the Customer-ID from the ''.ttstats'' file and ''$CUSTOMER2'' contains the mapped description.
  
 <WRAP important> <WRAP important>
Line 108: Line 92:
 ==== Package Map ==== ==== Package Map ====
  
-Create a package map when the billing definition filters rules by package. The package assigned to the Customer must match the package filter in the applicable billing rules.+Create a [[billing:package_map|package map]] when the billing definition filters rules by package. The package assigned to the Customer must match the package filter in the applicable billing rules.
  
-If the Customer does not use package-based filtering, confirm whether the site's standard package map or wildcard rules should apply.+If the Customer does not use package-based filtering, confirm whether the site's standard [[billing:package_map|package map]] or wildcard rules should apply.
  
 ===== Configure Billing Rules ===== ===== Configure Billing Rules =====
Line 152: Line 136:
 </code> </code>
  
-The following example bills Customer ''A099'' for high-water storage of ''LT'' media in repository ''COV'', rounded to the next 50 units:+The following example bills Customer ''US03'' for high-water storage of ''LT'' media in repository ''LIBR'', rounded to the next 50 units:
  
-<file - A099.ttsdef> +<file - US01.ttsdef> 
-AddStorageChargeItem("*", "A099", "LT", "COV", +AddStorageChargeItem("*", "US01", "LTO", "OFFS", 
-                     50, 0, 0, 0, 1, +                     10, 0, 0, 0, 1, 
-                     "$CUSTOMER2", "A - Storage:QBROTATIONBOX", +                     "$CUSTOMER2", "A - Storage:QB_RACKSTORAGE", 
-                     "LT media storage", 0, 0);+                     "LTO media storage", 0, 0);
 </file> </file>
  
Line 164: Line 148:
  
   * ''*'' allows any package.   * ''*'' allows any package.
-  * ''A099'' restricts the rule to one Customer. +  * ''US01'' restricts the rule to one Customer. 
-  * ''LT'' and ''COV'' select the Media-ID and Repository-ID. +  * ''LTO'' and ''OFFS'' select the Media-ID and Repository-ID. 
-  * ''50'' rounds a non-zero quantity up to the next group of 50.+  * ''10'' rounds a non-zero quantity up to the next group of 10.
   * Model ''1'' selects real high-water storage.   * Model ''1'' selects real high-water storage.
   * ''$CUSTOMER2'' outputs the mapped QuickBooks Customer name.   * ''$CUSTOMER2'' outputs the mapped QuickBooks Customer name.
Line 188: Line 172:
 | Storage | Daily total | Real high-water | Real low-water | 3 = slot total; 4 = slot high-water; 5 = slot low-water | | Storage | Daily total | Real high-water | Real low-water | 3 = slot total; 4 = slot high-water; 5 = slot low-water |
 | Movement | Total movements | Movement high-water | Movement low-water | Not applicable | | Movement | Total movements | Movement high-water | Movement low-water | Not applicable |
-| Inventory | Total inventory | Inventory high-water | Inventory low-water | Not applicable |+| Inventory | [[billing:terms|Total inventory]] | [[billing:terms|Inventory high-water]] | [[billing:terms|Inventory low-water]] | Not applicable |
 | Journal | Total quantity | Journal high-water | Journal low-water | Not applicable | | Journal | Total quantity | Journal high-water | Journal low-water | Not applicable |
  
Line 214: Line 198:
 Create a dedicated test output directory and run the extractor for a known date range. The following command is a template; replace every value in angle brackets with the value required by the installed environment: Create a dedicated test output directory and run the extractor for a known date range. The following command is a template; replace every value in angle brackets with the value required by the installed environment:
  
-<code> +<file bat runExtraction.bat> 
-TMSS10LogStatsExtractDB \ +TMSS10LogStatsExtractDB  -h <journal-database-home> -R <date-range> -o <test-output-directory> -c US03 -C <customer-translation-map> 
-  -h <journal-database-home> \ +</file>
-  -R <date-range> \ +
-  -o <test-output-directory> \ +
-  -c A099 \ +
-  -C <customer-translation-map> +
-</code>+
  
 Use ''-H'' when the contract bills the maximum snapshot count observed during each day. Use ''-m'' only when the agreed process requires billing a Volume in multiple locations on the same day. Use ''-H'' when the contract bills the maximum snapshot count observed during each day. Use ''-m'' only when the agreed process requires billing a Volume in multiple locations on the same day.
Line 229: Line 208:
 </WRAP> </WRAP>
  
-The extractor creates ''A099.ttstats''. Confirm that:+The extractor creates ''US03.ttstats''. Confirm that:
  
   * The first line is a ''C'' record for the expected Customer-ID.   * The first line is a ''C'' record for the expected Customer-ID.
Line 243: Line 222:
 Process the Customer statistics file with the approved definition and maps: Process the Customer statistics file with the approved definition and maps:
  
-<code> +<file bat runCreateXML.bat> 
-TMSS10LogStatsProcess \ +TMSS10LogStatsProcess -i <test-output-directory>/US03.ttstats -c <billing-definition>.ttsdef -M Customer.ttmap -P <package-map>.ttmap > <test-output-directory>/US03.xml 
-  -i <test-output-directory>/A099.ttstats \ +</file>
-  -c <billing-definition>.ttsdef \ +
-  -M Customer.ttmap \ +
-  -P <package-map>.ttmap \ +
-  > <test-output-directory>/A099.xml +
-</code>+
  
 Omit ''-P'' only when package mapping is not required. The ''-N'' option suppresses the XML declaration, stylesheet reference, and ''<tapetrack_data>'' wrapper and should not be used for a normal standalone QuickBooks import file. Omit ''-P'' only when package mapping is not required. The ''-N'' option suppresses the XML declaration, stylesheet reference, and ''<tapetrack_data>'' wrapper and should not be used for a normal standalone QuickBooks import file.
cookbook/billing_process_temp.1786932996.txt.gz · Last modified: 2026/08/17 02:16 by Scott Cunliffe