RelayFax online help

 
Export File Format

Navigation:  Faxing Options & Exporting > Exporting >

Export File Format

Print this Topic Previous pageReturn to chapter overviewNext page

The format of the comma-delimited export file is as follows:

TNUMBER

This field contains the unique identifier assigned to this fax. If image files were also exported then this value is used as the filename of the exported image file.

FSTATUS

4 = SENT, 8 = FAILED, 16 = RECEIVED

PRIORITY

Indicates the priority value assigned to this fax.  The default of 50 will be automatically assigned to incoming faxes.  Outgoing faxes can be assigned any  value between 0 and 100

RNAME

This is the name of the recipient of the fax - if known.

FAXNUMBER

If this is a SENT fax, this is the number to which it was sent.

SUBJECT

This is the subject of the fax - if known.

FROMLINE

This is the name or email of the sender of the fax.

BANNER

This is the banner string that was used when sending the fax.

COVERPAGE

This is the path to the cover page that was used when sending the fax.

SCOMPANY

This is the sender's company name setting (used in the template files).

RCOMPANY

This is the recipient's company name if known.

SFNUMBER

This is the sender's fax number setting (used in the template files).

SVNUMBER

This is the sender's voice telephone number (used in the template files)

LFAXID

This is the ID string of the local fax machine if known.

STIMEOUT

This is the timeout value used when sending the fax.

MAXRETRIES

This is the maximum potential retries available when sending the fax.

RETRYDELAY

This is the delay in seconds between subsequent attempts to retry a failed fax.

SSCHFAXY

This is the year the fax was scheduled for transmission.

SSCHFAXMO

This is the month the fax was scheduled for transmission.

SSCHFAXD

This is the day the fax was scheduled for transmission.

SSCHFAXH

This is the hour the fax was scheduled for transmission.

SSCHFAXMI

This is the minute the fax was scheduled for transmission.

SSCHFAXS

This is the second the fax was scheduled for transmission.

SSENDFAXY

This is the year the fax was scheduled for transmission.

SSENDFAXMO

This is the month the fax was scheduled for transmission.

SSENDFAXD

This is the day the fax was scheduled for transmission.

SSENDFAXH

This is the hour the fax was scheduled for transmission.

SSENDFAXMI

This is the minute the fax was scheduled for transmission.

SSENDFAXS

This is the second the fax was scheduled for transmission.

SENDRES

This is the resolution the fax was sent with - 0=LOW, 1=HIGH

RFAXID

This is the fax ID of the remote site.

SPEED

This is the baud rate of the connection (ex: 9600, 14400, etc)

RCVRES

This is the resolution the fax was received with - 1=LOW, 2=HIGH

TOTPAGES

This is the total number of pages in the fax.

PAGESSENT

This is the total number of pages sent.

HANGCODE

This is the +FHNG result of a fax transfer. The meaning of this field can depend on the type of modem you are using.

PORT

This is the port that was used during a fax transfer.

RETRIESUSED

This is the actual number of retries attempted when sending a fax.

DURATION

This is the number of seconds it took to complete the fax transfer. This number is cumulative for faxes sent over multiple tries.

CLASS

This is the fax class used 1=CLASS 1, 2=CLASS 2, 3=CLASS 2.0

ERRORCODE

This is the error or result code of the fax transfer.

0 = NO ERROR

1 = ERROR

STREET1

The sender's street address.

STREET2

The sender's secondary address, or second line of their street address.

CITY

The sender's city.

STATE

The sender's state or province.

ZIP

Sender's zip or postal code.

HOMEPHONE

This is the sender's home telephone number.

HOMEFAX

This is the sender's home fax number.

BUSPHONE

The sender's business phone number.

BUSFAX

Sender's business fax number.

BILLINGCODE

The billing code of the sender.

IMAGESIZE

This field contains the size (in bytes) of the fax image disk file.

COUNTER

Always contains a value of "1".

EXPORTIMAGE

Was fax image exported?

0 = FAX IMAGE NOT EXPORTED

1 = FAX IMAGE EXPORTED

DID

This is the Direct Inward Dial number.

ERRORSTRING

If ERRORCODE=0, this column is empty, otherwise it contains a description of the error.

RETRYDURATIONS

Contains the duration, in seconds, of each fax retry attempt. For example, if there were three attempts to deliver a particular fax, then the entry might look like this: "30,20,40." This would indicate three retry attempts with durations of 30, 20, and 40 seconds respectively. The export file's DURATION column defined above is the sum of all attempts, or the total time to transfer the fax.

See Also: