Modify Fax Agent service initialization settings - Fax Agent Installation and Setup Guide - Foundation 24.1 - Foundation 24.1 - Ready - Perceptive Content - external

Fax Agent Installation and Setup Guide

Platform
Perceptive Content
Product
Fax Agent Installation and Setup Guide
Release
Foundation 24.1
License

To change the initialization settings for the Fax Agent service, complete the following steps.

  1. On the computer on which Fax Agent is installed, navigate to the inserverFax.ini file within the Perceptive Content shared etc directory $(IMAGENOWDIR6)\etc, and open the file with a text editor.
  2. In the [General] section, complete the following substeps.
    1. Verify that faximp.directory is set to the \fax folder in the Fax Agent installation directory, unless you want to specify different holding directories for your incoming faxes.
    2. Set supplied.channels to the same number of channels supported by your fax board model.
    3. Set enabled.channels to the number (in hexadecimal) of inbound channels you are using.
      Note:
      • The numbers you provide for the inbound channels must be in hexadecimal. For more information on determining the correct hexadecimal number, see Appendix C.
      • You cannot use the same channels for both inbound and outbound faxing. You must decide on the number of inbound channels needed and specify it here. For more information, see details on configuring [Outbound] settings later in this section.
    4. If you do not want the received fax images deleted after they are processed into the system, set source.objects.delete to FALSE.
    5. If you purchased the barcode add-on module, and you want Fax Agent to recognize barcodes to index documents, set use.capture to FALSE. When use.capture is set to TRUE, you direct Fax Agent to use the settings in the [Capture] section instead of the settings in the [Queue], [Serial Number], [Key Mapping], and [Barcode] sections.
  3. If you do not want Fax Agent to recognize barcodes to index documents, in the [Capture] section, configure the following settings for capture profiles for faxes.
    1. Modify capture.priorities.mode to use the priority you want.
      For example, capture.priorities.mode=PCG sets the priority of the modes as they appear.
      • P = Phone.capture.profile (Fax sender's phone number assigned to a capture profile).
      • C = Channel.capture.profile (Receiving channel assigned to a capture profile).
      • G = General.capture.profile (A capture profile used for all channels).
      • D = DID.capture.profile (Direct Inward Dial (DID) assigned to a capture profile).
    2. For each of the properties general.capture.profile, phone.capture.profile, DID.capture.profile, and channel.xx.profile, list the appropriate capture profile.
      Note: You create capture profiles in Management Console under Capture. Settings and availability for Caller ID, DID, and channels for capture profiles depend on your phone line configuration, features, and your fax board model.
    3. If you want to treat each page of a fax as a unique document, change multi.doc.mode to TRUE.
  4. If you purchased the barcode add-on module, and you want Fax Agent to recognize barcodes to index faxes, configure the following settings.
    1. In the [Queue] section, configure the following settings if you want to send faxes to a workflow queue.
      1. Set route.to.queue.enabled to TRUE.
      2. Modify queue.priorities.mode to use the priority you want. For example, queue.priorities.mode=PCG sets the priority of the modes as they appear.
        • P = Phone.to.queue (Fax sender's phone number assigned to queue).
        • C = Channel.xx.TO (Receiving channel assigned to a queue).
        • G = General.output.queue = Fax Start (A queue used for all channels).
        • D = DID.to.queue (Fax sender's DID assigned to a queue).
      3. For each of the properties general.output.queue, phone.to.queue, DID.to.queue, and channel.xx.to, specify the appropriate queue.
      Note: You create queues in the Management Console under Workflow. Settings and availability for Caller ID, DID, and channels for routing documents depend on your phone line configuration, features, and your fax board model.
    2. In the [Serial Number] section, specify the type of unique ID you want Fax Agent to assign to each fax.
    3. In the [Key Mapping] section, configure the following settings to assign fax values to document keys (DocKeys) that override your fax header values.
  5. Set Drawer to use any existing drawer.
  6. Modify any of the remaining document key settings to use any of the options described in the inserverFax.ini file to fit your needs.
    • In the [Barcode] section, set trigger.on.barcode to TRUE. Enabling this option lets you fax into Perceptive Content a group of pages with or without barcodes and sort the pages by either the individual barcode value or barcode failed in combination with a unique_ID. Specify the barcodes you want Fax Agent to detect by entering 0 to ignore a barcode or 1 to recognize a barcode.
  7. In the [Logging] section, specify the level of logging between 0 (no logging) and 6 (logging with the most information). Use minimal logging unless you are debugging an issue.
  8. If you installed Fax Agent on a different computer than Perceptive Content Server or you did not use the Windows installer, in the [Remote] section, change the following settings.
    1. Set remoted to TRUE.
    2. For server.ip.address, specify the IP address of the Perceptive Content Server.
    3. For server.ip.port, specify the port number of the Perceptive Content Server.
    Note: Consult Product Support before you change values for properties heartbeat.interval, socket.login.timeout, socket.default.timeout, force.server.validation, or reconnect.interval.
  9. If you want to enable outbound faxes, in the [Outbound] section, set outbound.fax.enabled to TRUE and change the following settings.
    1. Specify one or more outbound.enabled.channels to dedicate to outbound faxes. These channels only process outbound faxes. For example, if you have an eight-channel board, you may want to set up two channels for outbound faxes, leaving six for inbound faxes. If you are sending more outbound faxes than your specified outbound enabled channels, the faxes are simply queued at the outbound channel and processed as the channel becomes available.
      Note: The numbers you provide for the outbound channels must be in hexadecimal. For more information on determining the correct hexadecimal number, see Appendix C.
    2. Set outbound.fax.retries to the number of times you want to retry sending the outbound fax before identifying the fax as a failed attempt.
    3. Set outbound.fax.smtp.server.url to the URL of your email server. Fax Agent uses the SMTP protocol and SMTPS protocol to send outgoing emails.
    4. Set outbound.fax.smtp.validate.certificates to TRUE if using SMTPS or have set the outbound.fax.smtp.use.starttls setting to TRUE.
    5. Set outbound.fax.smtp.use.starttls to TRUE if using STARTTLS on the SMTP server.
    6. Set outbound.fax.smtp.username to a valid username if your SMTP server has basic authentication enabled.
    7. Set outbound.fax.smtp.password to a valid password if your SMTP server has basic authentication enabled.
    8. Set outbound.fax.coverpage.enabled to TRUE if you have a cover page to send with the transmission or FALSE if not.
    9. If you enable the cover page for outbound.fax.coverpage, type the name of the TIF image file you want to use as a cover page for all outbound faxes. This fax must reside on the file system on the Fax Agent server, for example, in the Fax Agent installation directory you would type \fax_Cover.tif.
    10. . Supply offsets as x, y coordinates to set the location of text (using Arial 12 point font) placed on the cover page for the attention, page count, and comments section through outbound.fax.coverpage.attention.offset, outbound.fax.coverpage.pagecount.offset, and outbound.fax.coverpage.comments.offset.
    11. Set outbound.fax.prefix.number with any prefix you need to set before dialing out.
  10. If you installed Fax Agent behind a firewall or on a different subnetwork than Perceptive Content Server, under [Message Queuing], change the following settings.
    1. Set mq.agent.ip.address.override to TRUE.
    2. Set mq.agent.ip.address.override to the appropriate IP address for Fax Agent to connect to Message Queuing Agent.
  11. . Save and close the file, then restart the Fax Agent service using Windows Computer Management by completing the following substeps.
    1. On the Windows Desktop, right-click the My Computer shortcut and select Manage.
    2. In the Computer Management dialog box, click Services and Applications.
    3. Click Services.
    4. In the right pane, locate and select the service titled Fax Agent.
    5. In the upper left-hand corner of the right pane, click Start.