AvaTax for Communications Custom Sort utility user manual

Command Line Usage

customsort -cfg customsort.cfg [-log logfile] [-data datapath] [-work workpath] [-ext extension] [-?]

Arguments

-cfg customsort.cfg : Required. Custom sort configuration to be used.

-log logfile* : EZTax log file to be processed (DEF: EZTax.log).

*The full path for the log file must be specified.

-data <path> : Data directory; overrides config file value.

-work <path> : Working directory; overrides config file value.

-ext <ext> : Result file extension without ‘.’; overrides reserved config file extension.

-summarize <sumfile> : Log file is summarized into sumfile. On large log files, this option can substantially speed up the sorting process.

-out <fname> : Output base filename; overrides config file. This option can be used when there is a need to set the output files from a script so that different sorts can share the same configuration file.

-? : Display usage and exit

Examples

customsort -cfg customsort.cfg

customsort -cfg customsort.cfg -log mylogfile.log

customsort -cfg customsort.cfg -log mylogfile.log -data path/to/data

customsort -cfg customsort.cfg -log mylogfile.log -work path/to/workingdirectory customsort -cfg customsort.cfg -log mylogfile.log -ext csv

customsort -cfg customsort.cfg -log mylogfile.log -summarize quicksort.log customsort -cfg customsort.cfg -log mylogfile.log -out mysort

Output (in working directory)

Taxation Reports - Sorted and summarized taxation reports per configuration options

Metrics Report - Custom sort processing metrics

Status file - Processing status and any errors that might have occurred

Usage

The Custom Sort Utility can be called in AFC SaaS Standard to allow clients to produce taxation reports which are sorted and summarized using client-specified fields and/or options based on the transactions contained within the ftp.zip input file. The resulting report is a CSV file that can then be opened and edited within a spreadsheet program such as Microsoft Excel. In order for the custom sort feature to be applied, a configuration file – customsort.cfg – must be either be persisted in your account or embedded in the input zip file (ftp.zip) along with the transaction input file in the Extended AFC SaaS Standard format.

To make the Custom Sort Config file a persisted file, please contact submit a support case for further assistance. Persisting the file is the preferred method of generating the Custom Sort report.

To embed the Custom Sort Config file, place the customsort.cfg file into the ftp.zip file along with an Extended Format input file.

AFC SaaS Standard Custom Sort Example

///////////////////////////////////////////////////////////////////////////////////// 
//// ext_srtcomma20l.cfg //// 
OUTPUT_FILENAME_FORMAT: EZtax_{%y%m%d} 
BASE: srtcomma20l 
FIELD: P_CODE 
FIELD: CUST_NO 
FIELD: INV_NO 
OPTION: NBA_FILE 
OPTION: NCA_FILE 
OPTION: NO_DELETE_LOG 
OPTION: HEADER 
CALCULATED_VALUE_PRECISION: 6 
DEFAULT_EXT: csv 
DELIMITER: ',' 

EZtax_160405.rpt
    Custom Sort Processing Metrics
    ---------------------------------------------------------------------------
        Start Time : Tue Apr 05 10:53:57 2016
        End Time : Tue Apr 05 10:53:57 2016
    
    Taxes Input Metrics
    ---------------------------------------------------------------------------
        Records: 22 File: C:\BILLSOFTONLINE\KML\KML\EZTax\EZTax.log

    Taxes Output Metrics
    ---------------------------------------------------------------------------
        Summarized Records : 19 File: EZtax_160405_ssf.csv 
        Non-billable Records : 3 File: EZtax_160405_nba.csv 
        Non-compliance Records : 0 File: EZtax_160405_nca.csv 
        Total Summarized Records : 22
    ---------------------------------------------------------------------------
    End of Report

Output (in working directory)

Taxation Reports -

Compliance, non-compliance (as applicable) and non-billable (as applicable) custom sort reports located in the Report zip file. Examples: {output_filename_format}_ssf.csv, {output_filename_format}_nca.csv, {output_filename_format}_nba.csv

Note: {output_filename_format} is defined in customsort.cfg.

Metrics Reports -

Custom Sort report metrics located in the Report zip file.  Example: {output_filename_format}.rpt

Note: {output_filename_format} is defined in customsort.cfg.

Usage

AFC SaaS Pro provides the ability to dynamically generate a custom report containing the transactional data available in the database for a specified timeframe. The general process is as follows:

Note: Prior to the first time executing the CreateReport API call, please submit a support case. If not already established, an FTP account needs to be created and the FTP credentials provided.

Please refer to TM_00116_AFC SaaS Pro Telecom Developer Manual and TM_00117_AFC SaaS Pro SAU Developer Manual for further information.

Base Format: srtcomma20l

Example that will produce ssf/nba/nca in the same format as srtcomma20l utility.

///////////////////////////////////////////////////////////////////////////////////// 
//// base_srtcomma20l.cfg //// 
OUTPUT_FILENAME_FORMAT: EZtax_{%y%m%d} 
BASE: srtcomma20l 
OPTION: NBA_FILE 
OPTION: NCA_FILE 
OPTION: NO_DELETE_LOG 
OPTION: NO_HEADER 
CALCULATED_VALUE_PRECISION: 6 
DEFAULT_EXT: ssf 
DELIMITER: ',' 
DATA_DIR: C:\BillSoft\EZTax\Data 
WORKING_DIR: E:\Logs\customsort 

Base Extended Format: srtcomma20l

Example that will produce ssf/nba/nca similar to srtcomma20l, but with the jurisdiction Address, Company Identifier and Invoice Number added to the report, and a column header row added. Additional, all calculated values will be rounded to 2 decimal places.

///////////////////////////////////////////////////////////////////////////////////// 
//// ext_srtcomma20l.cfg //// 
OUTPUT_FILENAME_FORMAT: EZtax_{%y%m%d} 
BASE: srtcomma20l 
FIELD: ADDRESS 
FIELD: COMPANY_IDENTIFIER 
FIELD: INV_NO 
OPTION: NBA_FILE 
OPTION: NCA_FILE 
OPTION: NO_DELETE_LOG 
OPTION: HEADER 
CALCULATED_VALUE_PRECISION: 2 
DEFAULT_EXT: ssf 
DELIMITER: ',' 
DATA_DIR: C:\BillSoft\EZTax\Data 
WORKING_DIR: E:\Logs\customsort 

Base Format: srtcomma20l-p

Example that will produce ssf/nba/nca in the same format as srtcomma20l with the -p cmd line option.

///////////////////////////////////////////////////////////////////////////////////// 
//// base_srtcomma20l_p.cfg //// 
OUTPUT_FILENAME_FORMAT: EZtax_{%y%m%d} 
BASE: srtcomma20l-p 
OPTION: NBA_FILE 
OPTION: NCA_FILE 
OPTION: NO_DELETE_LOG 
OPTION: NO_HEADER 
CALCULATED_VALUE_PRECISION: 6 
DEFAULT_EXT: ssf 
DELIMITER: ',' 
DATA_DIR: C:\BillSoft\EZTax\Data 
WORKING_DIR: E:\Logs\customsort 

Extended Format: srtcomma20l-p

Example that will produce ssf/nba/nca similar to srtcomma20l with the –p cmd line option, but with Pcode, Company Identifier and Invoice Number added to the report, and a column header row added. Additional, all calculated values will be rounded to 2 decimal places.

///////////////////////////////////////////////////////////////////////////////////// 
//// ext_srtcomma20l_p.cfg //// 
OUTPUT_FILENAME_FORMAT: EZtax_{%y%m%d} 
BASE: srtcomma20l 
FIELD: P_CODE 
FIELD: COMPANY_IDENTIFIER 
FIELD: INV_NO 
OPTION: NBA_FILE 
OPTION: NCA_FILE 
OPTION: NO_DELETE_LOG 
OPTION: HEADER 
CALCULATED_VALUE_PRECISION: 2 
DEFAULT_EXT: ssf 
DELIMITER: ',' 
DATA_DIR: C:\BillSoft\EZTax\Data 
WORKING_DIR: E:\Logs\customsort 

Base Format: srtcomma20ld

Example that will produce ssf/nba/nca in the same format as the srtcomma20ld utility.

///////////////////////////////////////////////////////////////////////////////////// 
OUTPUT_FILENAME_FORMAT: EZtax_{%y%m%d} 
BASE: srtcomma20ld 
OPTION: NBA_FILE 
OPTION: NCA_FILE 
OPTION: NO_DELETE_LOG 
OPTION: NO_HEADER 
CALCULATED_VALUE_PRECISION: 6 
DEFAULT_EXT: ssf 
DELIMITER: ',' 
DATA_DIR: C:\BillSoft\EZTax\Data 
WORKING_DIR: E:\Logs\customsort 

Base Format: ezlogcust

Example that will produce reports in the same format as the ezlogcust utility.

///////////////////////////////////////////////////////////////////////////////////// 
OUTPUT_FILENAME_FORMAT: EZtax_{%y%m%d} 
BASE: ezlogcust 
OPTION: NBA_FILE 
OPTION: NCA_FILE 
OPTION: NO_DELETE_LOG 
OPTION: NO_HEADER 
CALCULATED_VALUE_PRECISION: 6 
DEFAULT_EXT: rpt 
DELIMITER: ',' 
DATA_DIR: C:\BillSoft\EZTax\Data 
WORKING_DIR: E:\Logs\customsort 

Base Format: ezlogcustpts

Example that will produce reports in the same format as the ezlogcustpts utility.

///////////////////////////////////////////////////////////////////////////////////// 
OUTPUT_FILENAME_FORMAT: EZtax_{%y%m%d} 
BASE: ezlogcustpts 
OPTION: NBA_FILE 
OPTION: NCA_FILE 
OPTION: NO_DELETE_LOG 
OPTION: NO_HEADER 
CALCULATED_VALUE_PRECISION: 6 
DEFAULT_EXT: rpt 
DELIMITER: ',' 
DATA_DIR: C:\BillSoft\EZTax\Data 
WORKING_DIR: E:\Logs\customsort 

Fully Defined Format: srtcomma20l-p

Example of a fully defined configuration file that will produce reports in the format of srtcomma20l with the -p cmd line option. Similar to srtcomma20l, this sample uses filelocs.txt and deletes the log when complete.

///////////////////////////////////////////////////////////////////////////////////// 
//// srtcomma20l_p.cfg //// 
OUTPUT_FILENAME_FORMAT: EZtax_{%y%m%d} 
BASE: none 
FIELD: ADDRESS 
FIELD: TAX_TYPE 
FIELD: TAX_LEVEL 
FIELD: TAX 
FIELD: TAX_AMOUNT 
FIELD: SALE_AMT 
FIELD: EXEMPT_SALE_AMT 
FIELD: REFUND_UNCOLLECT 
FIELD: NET_TAXABLE 
FIELD: MINUTES 
FIELD: LINES 
NORPT: BILLABLE 
OPTION: NBA_FILE 
OPTION: NCA_FILE 
OPTION: DELETE_LOG 
OPTION: NO_HEADER 
CALCULATED_VALUE_PRECISION: 6 
DEFAULT_EXT: ssf 
DELIMITER: ',' 

Fully Define Format: ezlogcust

Example of a fully defined configuration file that will produce reports in the format of ezlogcust. Similar to ezlogcust, this sample uses filelocs.txt and deletes the log when complete.

Note that CUST_NO leads off the list as a NORPT and appears again at the end of the list as a FIELD. This is to mimic the ezlogcust functionality that used the customer number as the first item in the sort, but output it as the last column in the report.

///////////////////////////////////////////////////////////////////////////////////// 
//// ezlogcust.cfg //// 
OUTPUT_FILENAME_FORMAT: EZtax_{%y%m%d} 
BASE: none 
NORPT: CUST_NO 
FIELD: ADDRESS 
FIELD: TAX_TYPE 
FIELD: TAX_LEVEL 
FIELD: TAX 
FIELD: CALC_TYPE_DESC 
FIELD: TAX_AMOUNT 
FIELD: SALE_AMT 
FIELD: EXEMPT_SALE_AMT 
FIELD: REFUND_UNCOLLECT 
FIELD: NET_TAXABLE 
FIELD: MINUTES 
FIELD: LINES 
FIELD: LOCATIONS 
NORPT: BILLABLE 
FIELD: CUST_NO 
OPTION: NBA_FILE 
OPTION: NCA_FILE 
OPTION: NO_DELETE_LOG 
OPTION: NO_HEADER 
CALCULATED_VALUE_PRECISION: 6 
DEFAULT_EXT: rpt 
DELIMITER: ','