Component RRTs

Component RRT ID

The RRT ID for this component is RFC.

Reserved Replacement Tag Names (RRTN)

For each captured fax, the component generates the following RRTNs:

RRTN Description
Sender Name The name of the sender of the fax.
Sender Fax Number The fax number of the sender of the fax.
Receiver Name The name of the receiver of the fax.
AutoForwardCount The number of times that the fax has been forwarded using the AutoForward feature. This number is tracked for each fax in order to prevent infinite forwarding loops. By default the maximum number of allowed AutoForward events is 5.
BFTFilename The file name of the binary file transfer information file if it exists. Binary file transfers have been replaced by the fax image attachment, but this property remains available for backwards compatibility.
BFTFileSize The size of the binary file transfer information file if it exists. Binary file transfers have been replaced by the fax image attachment, but this property remains available for backwards compatibility.
BillingCode1 The Billing Code 1 field.
CoverSheetSizeInBytes The size of the fax cover sheet in bytes.
FaxDisposition An integer that indicates the disposition of the fax. This property has been replaced by information in the FaxStatus property, but remains available for backwards compatibility.
FaxErrorCode The Fax error code.
FaxFilename The name of the image file associated with the incoming fax. The image file is stored in the image folder on the fax server.
FaxID ID assigned to the fax by the fax hardware when the fax is scheduled to be sent.
FaxPagesInFront The number of fax pages in the queue preceding the current fax.
FaxRecordDateTime%Year The year the fax was created.
FaxRecordDateTime%Month The month the fax was created.
FaxRecordDateTime%Day The day the fax was created.
FaxRecordDateTime%Hour The hour the fax was created.
FaxRecordDateTime%Minute The minute the fax was created.
FaxRecordDateTime%Second The second the fax was created.
FaxStatus The status of the fax.
FaxTerminationStatus An integer indicating the termination status of the fax.
FCSFilename The name of the fax cover sheet image in the server's image folder.
FromFaxNumber Sender's personal fax number.
FromGeneralFaxNumber Sender's general fax number.
FromGeneralVoiceNumber Sender's general voice telephone number.
FromName Sender's name.
FromVoiceNumber Sender's personal voice telephone number.
GenerateCompletionEvent Specifies whether or not to generate a completion event once the fax has been sent.
Handle The handle is used internally by the RightFax system to identify each unique object. If you specify a value without specifying a property name, the system will assign that value as the object Handle.
HasBFT Indicates whether or not the fax will use binary file transfer. The property returns True if the fax has BFT; it returns False if it does not. Binary file transfers have been replaced by the fax image attachment, but this property remains available for backwards compatibility.
HasCoversheet Indicates whether or not the fax has a cover sheet. It is only valid for outgoing faxes.
HasHotlink Indicates whether or not the fax has a hotlink.
HasPDF Indicates whether or not the fax has a rich PDF document associated with it.
HideFromWeb Hides the fax from the certified delivery Web interface when the recipient deletes it. (The original fax cannot be deleted from the fax database by the recipient, so it is hidden instead.)
ImageSizeInBytes The size of the fax body in bytes.
InputFilename The name of the file that appears in the outgoing folder.
IsApproved Indicates whether or not the fax has been approved.
IsBillingCodesVerified Indicates whether or not the BillingCode attachment has been checked against the list of valid billing codes.
IsBroadcastFax Specifies whether or not the fax is a broadcast fax.
IsCallbackRequested Indicates whether or not the sender requests a call from the recipient.
IsCertifyDelivered Indicates whether or not the fax was sent via certified delivery.
IsCoversheetConversionNeeded Specifies whether or not the cover sheet for the fax needs to be converted to a TIFF format image file.
IsCoversheetFine Specifies whether or not the cover sheet is in Fine mode. True indicates that the cover sheet is in Fine mode (200x200 dots per inch resolution); False indicates that it is in normal mode (100x100 dots per inch resolution).
IsDeleted Specifies whether or not the fax has been deleted.
IsDeletedAfterAnySend Specifies whether or not the fax will be deleted from the server after the Send event, no matter it has been successfully sent or not.
IsDeletedAfterSuccessfulSend Specifies whether or not the fax will be deleted from the server after a successful Send event.
IsFaxAutoForwarded Specifies whether or not the fax was automatically forwarded.
IsFaxBodyAutomaticallyPrinted Specifies whether or not the fax was automatically printed.
IsFCSCompleted Specifies whether or not the fax cover sheet has been completed.
IsFineMode Specifies whether or not the body of the fax is in Fine mode. True indicates that the fax is in Fine mode (200x200 dots per inch resolution); False indicates that it is in normal mode (100x100 dots per inch resolution).
IsForwarded Specifies whether or not the fax was manually forwarded.
IsGatewayGenerated Specifies whether or not the fax was generated by the RightFax e-mail gateway.
IsGenericFlag1On Specifies whether or not the user customizable API flag Generic1 is on.
IsHeld Specifies whether or not the fax is being held for preview before being sent by the user.
IsInDelaySend Specifies whether or not the fax is being held until the date and time specified by the DelayFaxSendDateTime property.
IsInitialized Specifies whether or not the fax was initialized.
IsINLJob Specifies whether or not the fax is an INL job.
IsLCRTimeDelayed Specifies whether or not the fax was delayed because of a least-cost routing rule.
IsNeedingApproval Specifies whether or not the fax is being held until it is approved.
IsPrinted Specifies whether or not the fax was successfully printed.
IsProductionFax Specifies whether or not the fax was generated by the RightFax Production module.
IsReceived Specifies whether the fax is an incoming or outgoing fax. True indicates that the fax was received (incoming). False indicates that the fax was sent (outgoing).
IsViewed Specifies whether or not the fax was viewed.
LastHistoryChangeDateTime%Year The year and time that the most recent history element was added to this fax.
LastHistoryChangeDateTime%Month The month and time that the most recent history element was added to this fax.
LastHistoryChangeDateTime%Day The day and time that the most recent history element was added to this fax.
LastHistoryChangeDateTime%Hour The hour and time that the most recent history element was added to this fax.
LastHistoryChangeDateTime%Minute The minute and time that the most recent history element was added to this fax.
LastHistoryChangeDateTime%Second The second and time that the most recent history element was added to this fax.
MaximumRetries This property specifies the maximum number of times the system should attempt to deliver the fax if the phone number is not responding. If this is set to 1, the system will stop after the first failed attempt.
NeedsPDFConversion Indicates whether or not the fax needs to be scanned for embedded codes before conversion.
NeedsPrescan Indicates whether or not the fax requires PDF conversion. When PDF conversion is complete, this property is automatically set to False.
OriginalBFTFilename The name of the binary file transfer file before it was renamed by the fax server. Binary file transfers have been replaced by the fax image attachment, but this property remains available for backwards compatibility.
OriginalFCSFilename The name of the original file that was converted to use as the fax cover sheet. This is the name as it appears in the server folder. The converted file name is accessible through the FCSFilename property.
OwnerID The UserID for the owner of the fax.
Priority The priority of the fax.
RemoteID The ID of Sender's fax machine. This applies only to received faxes.
SecureCSID The secure caller subscriber identification of Sender's fax machine, if any. This applies only to received faxes.
SendTime The total length of transmission time it took to send or receive the fax. This is available for all received faxes. It is only available for sent faxes after successful completion.
StatusDescription The current status of the fax in text format.
ToCityState Specifies the city and state of the recipient.
ToCompany Specifies the recipient's company name.
ToEmailAddress Specifies an e-mail address for the document destination.
ToFaxNumber Specifies the telephone number of the recipient's fax machine.
ToName Specifies the recipient's name.
TotalLinkCount The total number of links associated with this fax. Links are generated when a RightFax user sends or forwards a fax to another RightFax user. Rather than duplicate the image file of the fax for each user, the system creates a link to a single instance of the image.
TotalPages The total number of pages in the fax. The fax must be converted for this to be valid.
ToVoiceNumber Specifies the telephone number of the recipient.
TypeOfPrintJob Specifies the type of data in the print job.
UniqueID Specifies the unique ID for this specific print job.
UserComments A comment text added to the fax by the fax sender.
UseSmartResume Indicates whether or not the fax will use the Smart Resume feature of the RightFax system.