Appendix B: Server Configuration Files - Fax Agent Installation and Setup Guide - Foundation 24.1 - Foundation 24.1 - Ready - Perceptive Content - external

TRUE

FALSE

Specifies whether outbound faxing is enabled.

TRUE = Outbound faxing is enabled.

FALSE = Outbound faxing is disabled.

The default is FALSE.

Specifies the holding directory for the received image file and creates subdirectories for each enabled channel

Example: C:\inserver\fax

Specifies the number of channels supported by the fax board.

The default is 1.

Specifies the channels dedicated to inbound faxing. This setting uses an integer that enables or disables the channels for the specified fax board's channels; every bit in this integer represents one channel.

1 = enable

0 = disable

Examples:

0000000C means enable channel 2 and 3.

00000003 means enable channel 0 and 1.

FFFFFFFF means enable all channels.

0000000F means enable channels 0, 1, 2, and 3d.

3FFFFFFFFFFF means 46 channels (Two TR1034 boards).

7FFFFF means 23 channels.

00 means no channel enabled.

000F means 4 channels (leading 0's can be omitted) The default is 00 (no enabled channels).

Specifies how often, in seconds, Fax Agent searches the directory.

The default is 1.

TRUE

FALSE

Specifies whether Fax Agent deletes the fax images from the temporary directory after they are processed by the system.

TRUE = Delete the temporary files.

FALSE = Retain the temporary files.

The default is TRUE.

TRUE

FALSE

Specifies whether to use Fax Agent capture profiles. If set to TRUE, Fax Agent uses the settings in the Capture section and ignores the settings in the Queue, Key Mapping, and Barcode sections.

The default is FALSE.

PCG

DCG

PG

CG

DG

Specifies the order of priority for capture profiles.

P = Fax sender's phone number determines capture profile.

C = Channel determines capture profile.

D = Direct Inward Dial (DID) determines capture profile.

G = The general.capture.profile setting determines the capture profile.

Profilename1^

Profilename2^

Specifies the capture profile for the fax sender's phone number. You can have multiple strings up to 1024 characters.

For example: 9135551111:Triage

Profile^9135552121:ER Profile

Profilename1^

Specifies the capture profile for the specified fax sender's DID. You can have multiple strings up to total length of 1024 characters.

For example: 9135551111:Triage

Profile^9135552121:ER Profile

Specifies capture profiles for the different receiving channels, where <nn> is the two-digit channel. Use an integer from 1 to 10.

TRUE

FALSE

Specifies whether Fax Agent captures a batch of faxed documents as one document or many documents.

TRUE = Fax Agent creates a unique document from each fax page.

FALSE = Fax Agent creates one document from the entire fax.

The default is FALSE.

TRUE

FALSE

Specifies whether Fax Agent routes faxed documents to a workflow queue.

TRUE = Fax Agent routes documents to a queue.

FALSE = Fax Agent does not route documents to a queue.

The default is FALSE.

PCG

DCG

PG

CG

DG

Specifies the order of priority for routing faxes to queues.

P = Fax sender's phone number determines queue.

C = Channel determines queue.

D = Direct Inward Dial (DID) determines queue.

G = The general.output.queue setting determines the queue.

Queuename1^

Specifies the queue for the fax sender's phone number. You can have multiple strings up to 1024 characters.

For example: 9135551111:Triage

Queue^9135552121:ER Queue

Specifies the queue for the specified fax sender's DID. You can have multiple strings up to total length of 1024 characters.

For example: 9135551111:Triage

Queue^9135552121:ER Queue

Specifies destination queues for the different receiving channels, where <nn> is the two-digit channel. Use an integer from1 to 10.

;%08d

;%8d

;<>

;[]

Specifies the type of serial number Fax Agent uses to assign a unique ID to each fax.

;%08d = 8 bits and retain the leading zero.

;%8d = 8 bits or less and omit the leading zero.

;<> = variable section.

;[] = fixed section.

drawer

folder

tab

f3

f4

f5

<text>

DEFAULT

faxsender.phone#

faxsender.DID

<text>

UNIQUEID

DATE/TIME

UNDEFINED

SERIALNUMBER

BARCODE

Specifies the document key Fax Agent uses for the drawer.

<text> = A literal string of text up to 15 characters.

DEFAULT = the default drawer specified in Perceptive Content.

The default drawer is DEFAULT.

Specifies the index key Fax Agent uses for the folder, tab, and fields 3 through 5.

faxsender.phone# = fax sender's phone number.

faxsender.DID = Fax sender's DID.

<text> = A literal string of text up to 15 characters.

UNIQUEID = An ID generated by Perceptive Content.

DATE/TIME = The date and time Perceptive Content stores the fax.

UNDEFINED = Key mapping is not used.

SERIALNUMBER = Fax Agent generates one serial number for each fax, based on serial.number.format section.

BARCODE = The instance of the barcode is used as the folder key. For example, the fifth barcode found is BARCODE5.

Valid doc type

DEFAULT

Specifies the document key Fax Agent uses for the doc type.

<text> = A valid doc type.

DEFAULT = The default doc type identified in Perceptive Content.

The default document type is DEFAULT.

TRUE

FALSE

Specifies whether each page of the fax is a unique document in the systemmag.

TRUE = Each page of the fax is a unique document (depending on key setup).

FALSE = The entire fax is a single document (depending on key setup).

The default is FALSE.

TRUE

FALSE

Specifies whether to use the same index keys for all pages after a unique barcode. This setting overrides multi.doc.mode.

TRUE = Ignore the multi.doc.mode value and divide each fax session into small batches separated by barcodes.

FALSE = Use the multi.doc.mode value for key mapping.

The default is FALSE.

• bar_c39
• bar_2of5
• bar_c128
• bar_cb
• bar_upc_a
• bar_ean
• bar_93
• bar_upc_e
• bar_ean_suppl

1

0

Specifies which barcode type Fax Agent recognizes.

1 = Fax Agent recognizes the barcode.

0 = Fax Agent ignores the barcode.

Specifies the level Fax Agent uses to log errors for troubleshooting.

Typically, you want to set minimal logging unless you are debugging an issue. If you increase the logging, verify that you set the logging level back down after you finish debugging. Failure to do so can greatly affect performance and hard disk space.

0 = Logging is off.

1 through 6 = Logging is on. The higher the number, the more verbose logging. For example, 1 offers minimal logging, whereas 6 offers logging that contains the most information.

The default is 0.

Specifies whether to log communication between Perceptive Content Server and Fax Agent.

0 = Logging is off.

1 through 6 = Logging is on. The higher the number, the more verbose the logging. For example, 1 offers minimal logging, whereas 6 offers logging that contains the most information.

The default is 0.

TRUE

FALSE

Specifies whether Fax Agent logs errors for troubleshooting Brooktrout.

TRUE = Logging is on.

FALSE = Logging is off.

The default is FALSE.

Specifies whether Fax Agent logs fax success errors for outbound faxes separately instead of as a fixed logging level.

0 = Logging is off.

1 through 6 = Logging is on. The higher the number, the more verbose the logging. For example, 1 offers minimal logging, whereas 6 offers logging that contains the most information.

The default is 3.

Specifies whether Fax Agent logs fax failure errors for outbound faxes separately instead of as a fixed logging level.

0 = Logging is off.

1 through 6 = Logging is on. The higher the number, the more verbose the logging. For example, 1 offers minimal logging, whereas 6 offers logging that contains the most information.

The default is 0.

TRUE

FALSE

Specifies whether you installed Fax Agent on a different computer than Perceptive Content Server.

TRUE = Fax Agent and Perceptive Content Server are installed on different machines.

FALSE = Fax Agent and Perceptive Content Server are on the same system.

The default is FALSE.

Specifies how often, in seconds, Fax Agent verifies its connection to Perceptive Content Server.

Specifies how many seconds Fax Agent waits for successful login before terminating the connection.

The default is 60.

Specifies how many seconds Fax Agent waits for successful login before terminating the connection.

The default is 60.

If remoted is enabled, this setting specifies the port number of the Perceptive Content Server.

The default is 0.

1

0

Specifies whether Fax Agent forces the server to validate the user ID and password.

1 = Fax Agent forces the server to validate user ID and password.

0 = Fax Agent does not force the server to validate user ID and password.

The default is 0.

Specifies how many seconds Fax Agent continue to try to reconnect to Perceptive Content Server after a lost connection.

The default is 120 seconds.

Specifies the authentication token to use for authentication with Perceptive Content Server.

Specifies the URL of the SMTP server.

Examples

outbound.fax.smtp.server.url=smtp://<hostname>:< port> when communicating over SMTP.

outbound.fax.smtp.server.url=smtps://<hostname>:<port> when communicating over SMTPS.

TRUE

FALSE

Specifies whether Fax Agent should validate certificates used during secure communication with the SMTP server.

TRUE = Enable certificate validation.

FALSE = Disable certificate validation.

TRUE

FALSE

Specifies whether Fax Agent should use STARTTLS when communicating with the SMTP server.

TRUE = Enable STARTTLS

FALSE = Disable STARTTLS.

TRUE

FALSE

Specifies whether outbound faxing is enabled.

TRUE = Outbound faxing is enabled

FALSE = Outbound faxing is disabled

The default is FALSE.

Specifies the channels you dedicate to outbound faxing. This setting uses an integer that enables or disables the specified fax board's channels, every bit in this integer represents one channel.

1 = enable

0 = disable

Examples:

0000000C means enable channel 2 and 3.

00000003 means enable channel 0 and 1.

FFFFFFFF means enable all channels.

0000000F means enable channels 0, 1, 2, and 3d.

3FFFFFFFFFFF means 46 channels (Two TR1034 boards).

7FFFFF means 23 channels.

00 means no channel enabled.

000F means 4 channels (leading 0's can be omitted) The default is 00 (no enabled channels).

Specifies the number of unsuccessful attempts of sending a fax before Fax Agent identifies the fax as failed.

The default is 0.

Specifies the IP address or DNS name of the email server.

Specifies the email server port.

The default is 25.

TRUE

FALSE

Specifies whether Fax Agent includes a TIF file as a cover page for faxes.

TRUE = Fax Agent uses a TIFF file.

FALSE = Fax Agent does not use a TIFF file.

Specifies the path and filename of the TIFF file Fax Agent uses as a cover page, if outbound.fax.coverpage.enabled is set to TRUE.

Specifies the location in x and y coordinates on the cover page for the attention text added by the user once fax out is initiated.

The default is 0,0.

Specifies the location in x and y coordinates on the cover page for the page count text.

The default is 0,0.

Specifies the location in x and y coordinates on the cover page for the comments text added by the user once fax out is initiated.

The default is 0,0.

TRUE

FALSE

Specifies whether the agent uses the IP address in the mq.agent.ip.address.override setting of this same configuration file to connect to Message Queuing Agent. If FALSE, the agent uses the settings in inow.ini. For example, use these settings when the agent is behind a firewall or on a different subnetwork than Perceptive Content Server.

The default is FALSE.