The HylaFAX communication point supports sending messages (Faxes), deleting Fax jobs, and polling the HylaFAX server for Fax status information. Refer to www.hylafax.org for details on HylaFAX. Refer to Published Properties for a list of properties associated with this communication point.
Supported Communication Modes: All.
Input Mode Properties
Property |
Description |
|---|---|
FAX Server Address |
The hostname or IP address of the fax server used to send messages. |
User Name |
The username for authenticating with the fax server. |
Password |
Optional password for authenticating with the fax server. |
Passive Mode Connection |
Options: |
Status Polling Interval |
How often (in milliseconds) to poll the HylaFAX server for job status information. The HylaFAX communication point maintains an internal list of statuses so it only generates messages for jobs which have an "accepted" status. A sample fax status message in XML format, generated by the HylaFAX communication point, is as follows: <?xml version="1.0"?>
<job-status id="12">
<messageID>4323646347636C000.1.3</messageID>
<connectionID>conn_374</connectionID>
<status code="F">NO CARRIER</status>
</job-status>
|
Statuses to Accept |
A list of statuses to accept (and generate status change messages for) from the HylaFAX server. |
The following status codes may be returned from the HylaFAX server:
Status |
Description |
|---|---|
? |
Undefined State |
T |
Suspended Job |
P |
Pending Job |
S |
Sleeping Job |
B |
Blocked Job |
W |
Waiting Job |
R |
Running Job |
D |
Done (successful) |
F |
Failed |
Output Mode Properties
Property |
Description |
|---|---|
FAX Server Address |
The hostname or IP address of the fax server used to send messages. |
User Name |
The username for authenticating with the fax server. |
Password |
Optional password for authenticating with the fax server. |
Passive Mode Connection |
Options: |
Fax Number |
The fax number for the message destination. This property can also reference a message property, which means that its value can be set at runtime to a value within the message. |
Paper Size |
The message paper size (default: |
Kill Time |
The time (in milliseconds) the message is queued before being rejected. This property can also reference a message property, which means that its value can be set at runtime to a value within the message. |
Maximum Dial Attempts |
The maximum number of times that the fax number is to be dialed before giving up. |
Maximum Tries |
The maximum number of attempts to send the fax once the connection to the recipient machine has been made. |
Bidirectional, In->Out and Out->In Mode
The configuration properties for the Hylafax communication point in Bidirectional, In->Out and Out->In modes are a combination of the properties described above.
Refer to Out->In and In->Out Properties for general details on a communication point's In->Out and Out->In modes.
Published Properties
The following published properties are added to status messages generated from the communication point:
JobID- the HylaFAX Job Identifier.ResponseMessageID- this is the ID of the Rhapsody message that this status message is about.ResponseCode- the HylaFAX status code for this job.StatusMessage- the textual message/description of the ResponseCode.
Optional Message Properties
The following message properties can be added to messages sent to the HylaFAX communication point and it will perform different actions depending on what properties are set. If no properties are set, then the message is faxed as usual.
DeleteJobID- deletes the corresponding job from the HylaFAX server.InterruptJobID- interrupts the corresponding job from the HylaFAX server.KillJobID- kills the corresponding job from the HylaFAX server.SuspendJobID- Suspends the corresponding job from the HylaFAX server.
The properties are searched in the above order and the first one encountered is the one that is actioned. All others following will be ignored.