CreateEnvelope

This Fax tool creates a fax envelope for the fax. A fax envelope must be created for each fax recipient. See Fax tools for more information.

Inputs

Fax ID

The fax to be sent to the address in this envelope.

Note: All other inputs should be ignored because they will be overwritten by the inputs to the Queue Fax for Send tool step.

Recipient Fax Number

The fax recipient’s phone number. A comma causes a two-second pause. Any numbers that follow the "/" symbol are dialed after the call is connected (used to dial an extension, for example).

Recipient Company Name

The fax recipient’s company name.

Recipient Name

The fax recipient’s name.

Sender Name

The sender’s name.

Sender's Fax Number

The sender's fax number.

Sender’s Telephone Number

The sender’s telephone number.

Sender’s Company Name

The sender’s company name.

Notify sender when fax is sent

Set this to true if you want the sender to be notified if the fax was sent successfully.

Email address to notify if fax when fax is sent

The sender’s email address.

Notify sender if fax fails

Set this to true if you want to sender to be notified if the fax was not sent successfully.

Email address to notify if fax cannot be sent

The sender’s email address, or some other address to notify if the fax was not sent successfully.

Cover Page Comments

Comments to add to the cover page.

Page Header Message

Header information for the cover page.

Cover page Type

Only Interaction Fax cover page documents (with a file extension of .i3c) are valid in this release. This may change in future releases.

Cover page Name

The base name (no path or extension) of a file in the CoverPages subdirectory under the IC resources directory. So, if you have a cover page file called I3Confidential.i3c, you would place it on the CoverPages directory under the IC resources directory and type the name "I3Confidential" in this parameter.

Fax Workstation Group Name

The fax station on which to send the fax.

Number of Retries to Attempt

The number of times CIC will attempt to send the fax.

Delay between retries

How long to wait (in seconds) between retries.

Maximum BPS to attempt

The maximum BPS to attempt. Usually you should set this to 0.

Send Type

The category of time when the fax should be sent.

Scheduled Time

The time the fax should be sent if the Send type is one.

Time of day low rates begin

The begin time a fax should be sent if the Send Type was two.

Time of day low rates end

The latest time a fax should be sent if the Send Type was two.

Login name user or handler that created this fax

The network user id of the person or handler sending the fax.

Outputs

Fax Envelope ID

The identifier of the newly created envelope. This can be used with Queue Fax For Send to initiate a fax send.

Exit Paths

Success

The Success exit path is taken if the envelope was created successfully.

Failure

The Failure exit path is taken if the envelope was not created successfully. This can occur when a Fax ID is not valid.