Skip to main content
Avalara Help Center

TM_00563_AFC Sessions Reports Summary

Available Session Reports

Transaction Count Report

The license report / transaction count report provides a breakdown of all transactions processed. Similar to the TSR report, it will append new entries to the end of the file, and is written out when the session is closed.

Transaction/Service Report

By default, all clients receive the Transaction/Service Jurisdiction Report (TSR). This is the main revenue report and includes original revenue generated for jurisdictions. However, this report does not provide local level details for jurisdictions due to memory issues.

Audit Transaction/Service Report

By default, all clients receive the Audit Transaction/Service Jurisdiction Report (TSR). This report is produced in addition to the original TSR. Similar to the original TSR, the report contains the main revenue report and includes original revenue generated for jurisdictions. However, this report does not provide local level details for jurisdictions due to memory issues. This audit version of the TSR is in CSV format and includes two additional columns, Start Date and End Date, which contain a timestamp for the report as well as headers for each of the columns of data.

Reconciliation Report

The Reconciliation Report contains the same columns as the TSR and an extra column for any tax inclusive charge calculations. This report is only produced upon the request of the client.

Audit Reconciliation Report

The Audit Reconciliation Report contains the same columns as the Audit TSR and an extra column for any tax inclusive charge calculations. This audit version of the reconciliation report is in CSV format and includes two additional columns, Start Date and End Date, which contain a timestamp for the report as well as headers for each of the columns of data.

No Tax Log Report

This report contains Transaction/Service data that was processed but did not generate any taxes.

Creating Session Reports

The session reports are created based on settings which are defined in EZTax.cfg. EZTax.cfg is an optional configuration file used to modify the operation of the AvaTax for Communications (AFC) Engine. Users can change following settings in EZtax.cfg in order to change the default settings for this report.

Please reference the table below as well as the AFC Configuration Guide document for additional details on the configuration options and settings for each.

 

Configuration Options

Settings

Comments

Log No Tax Transactions

lognotaxtrans=off (default)

lognotaxtrans=on

 

Reconciliation Report

reconcilerpt=on reconcilerpt=off (default) reconcilerep=bybdl

bybdl adds the bundle package and bundle id to the report.

Audit Reconciliation Report*

Taxing Authority Report/Trans-serv Report

transservrpt=on (default)

transservrpt=off transservrpt=bybdl

bybdl adds the bundle package and bundle id to the report.

Audit Trans-serve Report*

Transaction Count Report

licenserpt=off (default)

licenserpt=detailed

licenserpt=summary

Detailed report adds t/s pair breakdown to counts.

* The same settings apply to the audit versions of the session reports as long as the setting is on for the regular version of the session report.

Locating Session Reports

Please follow the steps provided below in order to locate the various session reports described in this document.

Step

Action/Result

1

Determine the expected number of reports.

  • There will be a session report for each session on each server.
  • Number of reports = Number of servers * Number of sessions per server
  • Example: Given 20 servers with AFC On-Prem installed, and each server having 4 sessions, the number of session reports would be 80.

2

Multi-Server

  • Make a list of all servers with AFC On-Prem installed
  • For each server, follow the Multi-session instructions

3

Multi-Session

4

Locate Session Working\Output Directory

A user should be able to locate this report in their AvaTax for Communications (AFC) working directory most commonly in C:\BillSoft\EZTax\exe. The file will be named the same as the log file with the extension license.rpt. If logging is disabled, the status file name will be used. The report will not be created and/or updated until the session is terminated.

For example, if the log is EZTax.log, the report will be named EZTax.license.rpt and if the log is EZTax9.log then the report will be named EZTax9.license.rpt.

Note: The working directory is referenced in the status files; however, if the working directory is blank, go to the application start up directory. It is defined in one of these two locations.

File Name

Description

EZTax.tsr

Transaction/Service Jurisdiction Report. By default, all clients will receive the tsr report.

EZTax_audit.tsr.csv

EZTax.rtr

Reverse Transaction/Service Jurisdiction Report (as applicable). Produced if client has requested the rtr report.

EZTax_audit.rtr.csv

EZTax.license.rpt

Detailed version of the Transaction Count Report. Provides a count of transactions processed by transaction/service pair.

EZTax.ntl

Transaction/Service data that was processed but did not generate any taxes.

Additional Option Steps:

  • The session report pulls the output directory from one of the following in the order listed
    • The session taxation log table output by the engine to store tax results.
    • If the taxation log is disabled, then the status file output for each session will be used.
  • Determine how the implementation of the AFC On-Prem engine sources the log file and status file path. It will be one of the following:
    • Path pulled from filelocs.txt. This file, if used, will be located in one of the following locations:
      • The startup directory for the application that initializes the session.
      • The working directory passed into the session initialization API.
    • Path pulled from file list passed into the session initialization API.
    • If the path is not specified, the working directory will be used.

Additional Notes:

  • All sessions must be closed prior to locating and retrieving the session report(s).
  • The status file will show the working directory used as well as the log file (if enabled). If the working directory is blank (not specified), then the application working directory is the default working directory being used. (Filenames will mimic those or how it is defined in the status file.)

The session report will be named [logname].ext in which logname refers to the name of the AFC transaction log file, minus the extension, and will be output to the same directory as the log file.

Example of Naming Convention:

(Based on the assumption that the billing system has two sessions with log files named SessionA.log and SessionB.log.)

The output from a normal run would be as follows:

SessionA.log

SessionA.sta

SessionA.tsr

SessionA.ntl

SessionA.rtr

SessionA.license.rpt

SessionB.log

SessionB.sta

SessionB.tsr

SessionB.ntl

SessionB.rtr

SessionB.license.rpt

  • Was this article helpful?