Please enable JavaScript to view this site.

CopiaFacts Reference

Extract DX Log File Data to XLSX file

CATDX
CATDX dxtypes|all nodelist|all startdate [enddate] [folder=path] [outputfile.xlsx]

This program concatenates one or more daily DX extracted data files into a single XLSX Excel spreadsheet. The fields are set up as specified by the DX_ and DXH_ variables in FAXFACTS.CFG.  Note that if you still use an older version of Excel with the Microsoft Office Compatibility Pack, you will be limited to 64 thousand rows in the spreadsheet.

If no parameters or no dates are entered, the program starts up in visual mode and allows selection of the options and dates.

The dxtypes parameter is a comma-separated list of one or more two-letter codes for the data extraction type (eg FC for DX_FAX_COMPLETE).  When multiple types are selected, they are placed on separate worksheets in the generated XLSX file.  To select all the extraction types for which DX_ $var_def commands are present, use the keyword all.

The nodelist parameter is a comma-separated list of one or more COPIAFACTS node names. To concatenate data for all engine nodes, use the keyword all.

The third and fourth parameters specify a date or date range.  The only permitted date formats are:

MM/DD/YYYYThis format matches that used in all dates in CopiaFacts command files
YYYYMMDDThis format corresponds to the naming convention for the daily transaction log.
MM/YYYYSpecifies the start of a month if the first date, or the end of a month if the second date, or the whole month if the only date.
YYYYMMSpecifies the start of a month if the first date, or the end of a month if the second date, or the whole month if the only date.

See the examples below.

For special purposes you may also add a parameter folder=foldername at any position on the command-line to override the use of the FAXFACTS\XDATA folder for both the input files and the output XLSX file.  For example this allows you to analyze a group of .TAB files which you have archived to a location other than the XDATA folder.

A parameter with file extension .xlsx on the command line will override the output file name.  Any path on the parameter is ignored and the output will always be written in the scan folder.

Interactive selection of Data Extraction files

When no command-line date parameters are given, a dialog appears with calendars to allow date range selection:

Use click and shift-click to select the date range.  You can select the start or the end date first.  Your selections for Data Extraction Type and Nodes are retained from one run of CATDX to the next.  You cam also create multiple XLSX files with different parameters successively without needing to restart the program. However if you change the FAXFACTS.CFG variables you will need to restart CATDX.

In interactive mode, the pop-up which confirms the completed extraction allows you to open the file in Excel if you wish:

Output Filename

The output filename consists of the following elements, separated by underscore characters:

DXThe literal DX
typesA hyphen-separated list of types (e.g. FC-EC) or the keyword ALL
nodesA hyphen-separated list of nodes (e.g. M1-M2-M3) or the keyword ALL
datesThe start and end dates of the analysis, in Y_M_D sequence.  If the year or the month is common to the start and end dates, this element is omitted from the end date.  If the range is whole months the days element is omitted.

The output file is written into the scanned folder.

Command-line examples:

CATDX all M2 20120101              ; one day

CATDX all M2 20120101 20120106     ; one week

CATDX all M2 02/01/2013 02/28/2013 ; all of February 2013

CATDX all all 201303 Mar2013.xlsx  ; all of March 2013, file override

CATDX all all 03/2013              ; all of March 2013

CATDX FC M2 03/2013 folder=c:\save ; March 2013 and folder override

CATDX all all 201301 201303         ; January to March 2013

CATDX all all 01/2013 03/2013       ; January to March 2013

RUNDATE -1m "CATDX all all %%Y%%m"  ; all of last month (batch file syntax)

RUNDATE -1m "CATDX all all %Y%m"    ; all of last month (command line syntax)