Please enable JavaScript to view this site.

CopiaFacts™ Reference Manual

CopiaFacts System Configuration

Each remote node will be part of a separately-licensed CopiaFacts system, and can run on a physical machine or, for FoIP delivery, a virtual machine.

To configure Remote Delivery, the first step is to establish a folder at each system for the faxable TIF files. This folder will be named on a $environment command in FAXFACTS.CFG, and the variable name identifies the type of system:

$environment node RDO_FOLDER folderpath ; originating system

$environment node RDD_FOLDER folderpath ; delivery system

For an originating system, the path would normally be common to multiple CopiaFacts nodes; on a delivery system the path should preferably be a local folder on each node, because most of the supported fax interfaces require the TIF to be in a local folder. However if the TIF is located on a file-server node on the delivery system, the sending node will copy it to a local folder as usual.

The principal CopiaFacts folder variables such as FFBASE are expanded on this command.

Each participating node must also have an incoming and an outgoing MSMQ defined.  This is done using the new configuration commands:

$rd_in_qname node qname

$rd_out_qname node qname

These commands will be ignored if remote delivery has not been established by one of the $environment commands above, and are required commands when remote delivery has been established.

The queue is expected to be a local private queue, so that the COPIAFACTS server engine can be isolated from WAN communications, as described in Remote Delivery Workflow.

Channel Numbers

It is strongly recommended that channel numbers should be assigned so that all channels are unique across a group of originating and delivery nodes.  The channel number used is identified in an $attempt_record command, and the use of duplicated channel numbers could cause confusion, because attempt records will be written in the FS file at both locations.

Selection of Destinations for Remote Delivery

Fax destinations for remote delivery will be selected by means of $action_phone commands in the job instance UJP on launch. For an entire job or for an individual item, the action code can instead be set on an ACTION_CODES variable if no other $action_phone commands are used.  The initial allocation of action codes is the range 150 to 159.  The specific action code value will not be distinguished by CopiaFacts but is available for user applications to control routing or other features.  If multiple CopiaFacts systems are configured as originating systems for common delivery systems, their action code ranges will be different.

$action_phone lookuppath 150 fax partial

The partial keyword allows selection of a destination by means of an initial substring such as the country code.

In case of an interruption of WAN transmissions, the remote operations on a node can be suspended and resumed by setting Special Debug Flag to a value of 1 or 0 on the Options/Options tab in COPIAFACTS or by running CFUTIL SETFLAGS.  This will suppress the processing of the $action_phone command and faxes will be sent locally on the originating machine.  The SETFLAGS method cannot be used if the originating node is running as a Windows service; in this case COPIAFACTS would need to be run in 'maintenance mode' to update the service flags.

This $action_phone command should not appear on a delivery system.

Control of Remote Deliveries

For an FS file image arriving at the delivery node in the RD_IN queue, a temporary working copy of the content will be made to control the transmission and the original FS content will be retained during the transmission attempt(s).  In the copy:

•the $fax_user command will be replaced with the pathname of the default user profile on the delivery node.  This should be set for each node on the Delivery System with either a node-specific or an * $default_profile command. Note that the first command matching the channel-group is used.

•the $fax_filename commands, and $fax_cover, will be replaced with the pathname of the delivery-ready TIF file in a local folder

The temporary copy of the FS content can be displayed in the trace on the delivery node for diagnostic purposes. The single TIF file  can be deleted from the local RDD_FOLDER using CFHK on the delivery system.

Fax Header Lines

Fax header lines will normally be applied at the delivery node, and should be specified there in the user profile command which controls remote delivery.  If no header is to be applied on the delivery node, $fax_header none should be specified there.

Any fax header lines to be added at the originating node must be specified on a FAX_HEADER_RD variable, which overrides the applicable $fax_header command for remote deliveries only.  If this variable is not assigned, any fax header normally specified for the originating node is suppressed.

Outbound ANI and Fax CSID

To control the Outbound ANI of a remote delivery, the variables OB_ANI or OB_TF_ANI should be set in the FS file.  In a job administration environment these variables will be defined in the FS file on launch.  If not supplied, the default value from $outbound_ani in the controlling user profile on the delivery node will be used.  For BladeWare, the default value will be that preceding the @ in the in the CFSIP_CALLINGNUM variable on the destination machine.

The Fax CSID for remote delivery will be that in the $fax_csid FS command, overriding that in the controlling user profile on the delivery node.  The $fax_csid command should therefore be set on an $fs_template command in the instance UJP on the originating node, so that it is replicated in the FS on launch.