CFMSG (CopiaFacts Message Center)

CopiaFacts Internal Messaging Service

CFMSG /install | /uninstall
net start CFMSG

Description

This service performs CopiaFacts internal inter-process messaging tasks. It is a pre-requisite for running COPIAFACTS and FFEXTERN as service applications, and for using the CopiaFacts Control Panel (CFCP).

The service must be run only on the fileserver on which resides the CALLBACK folder and its subfolders.

Installation

CFMSG is installed as a service automatically when you install the executable from CopiaServiceInstall8200xx.exe.  It can also be installed as a service by running CFMSG /install, or uninstalled as a service by CFMSG /uninstall.

The service will be configured to start automatically, delayed. You should aim to keep it running at all times.

Incoming Messages Configuration

CFMSG creates and writes a CFMSG.INI file (in the FAXFACTS  folder) to specify the IP address and the port on which it will listen for incoming messages.  The CFMSG.INI will contain as a minimum the following data (for example):

[CFMSG]

IP=192.168.1.11

Port=54321

The initial IP value is derived from the FFCFG.INI file.  If you move the COPIA share to a different machine, you should run COPIAINSTALL to create another FFCFG.INI file with the new IP address, before installing or starting the CFMSG service on the new machine and allowing it to update CFMSG.INI.  Currently, the specification only supports IPv4 addresses.

The initial starting Port value is set to 54321. The range of eight ports starting 54321 (default) should be opened in your firewall for local communication between nodes. If you need to change the starting port value for the purposes of configuring your firewall, you can edit FFCFG.INI to add or edit:

[FFCONFIG]

MessagePort=xxxxx

where xxxxx is the port you wish to use, and restart the CFMSG service. It may take a couple of minutes for the communicating applications to re-synchronize.

Other sections of this INI file may used by enabled CFMSG sub-tasks.  You should not edit the Port and IP values in CFMSG.INI manually, because the values will be overwritten when CFMSG is next started.

Outgoing Message Configuration

Outgoing messages are sent on the same adapter and port as is specified for incoming messages. You can use the $cfmsg command to override this. with a first parameter of CFMSG.

Starting and Stopping

When you plan to upgrade CopiaFacts, you should shut down CFESERVICE and CFXSERVICE on each machine before shutting down CFMSG, and restart CFMSG first after upgrading.  You can use NET START and NET STOP or the Services tool in Computer Management to do this.

If any start-up problems occur, details will be reported in the CopiaFacts Windows Event Log and in the trace file (see below) if enabled.

Firewall Considerations

Normally, CFMSG uses the first specified port (default 54321). The next three (default 54322/3/4) are used by the CFESERVICE, COPIAFACTS and COPIAFACTS in management mode on a node, if running, and the next three (default 54325/6/7) by the CFXSERVICE, FFEXTERN, and FFEXTERN in management mode on a node, if running.  The last port in the block of eight (default 54328) is used by CFCP.  You can change the default of 54321 as described above, and you can override the network adapters selected by each communicating node, using the $cfmsg configuration command.  These ports need to be open for communication within your network.

If you need to use CFCP from outside your network to communicate with the CFMSG service, port 54321 (or as overridden) needs to be opened for access from outside your network.  We suggest that you enable access through your firewall from specific locations only.  In a NAT environment, you also need to forward this port to the machine on which the CFMSG service is running.  The IP address setting for CFMSG should remain as a local NAT address in this case, for use by local machines.

       Trace Information   In case of problems, the program can write trace information by adding CFMSG in FFTRACE under File/Applications.  To enable tracing, run FFTRACE as administrator, and enable CFMSG in File/Applications.  A file named CFMSG.FTx will be written in your normal trace folder defined by FFTRC.  FFTRACE does not need to be running in this case.