- Contents
Interaction Designer Help
Get Fax File
This Fax tool retrieves a fax file so that it can be sent via email. Creates a copy of the fax file to a location so that it can be attached to an email sent by the Send Fax Mail tool. When a handler containing the Get Fax File tool ends, the copy of the file is removed from the output directory. See Fax tools for more information.
Inputs
Fax Id
The identifier for the fax to be converted to a file.
Export File Type
Integer representing the type of file that the fax will be converted into.
Integer Corresponding File Type
0 Tiff Group 3
1 Tiff Group 4
2 DCX
3 PNG
4 I3F (default)
5 PDF
Outputs
Fax File Id
The identifier for the fax file that this tool created. The fax file created is a temporary copy and is deleted when the handler exits.
Fax File Path and Name
This information is used by the Send Fax Mail tool to find and attach the file. The fax file created is a temporary copy and is deleted when the handler exits.
Exit Paths
Success
The Success exit path is taken if the fax was retrieved.
Failure
The Failure exit path is taken if the fax file was not created successfully. This can occur when a Fax Id is not valid.