CFESERVICE (COPIAFACTS engine)

Description

CFESERVICE is a Windows Service application that runs the COPIAFACTS engine in service mode.  Although the service is expected to operate on Windows XP and Server 2003, it has not been tested and is not supported on these operating systems or earlier.

The COPIAFACTS program runs normally except that no user interaction is available and pop-up dialogs are suppressed.

While COPIAFACTS is running as a service, you may modify the configuration parameters by logging in to the same user account and running COPIAFACTS in management mode (with the -m command-line flag) and with the same required node name on the command line. This must be done on the same machine that will be running the service.  You can run COPIAFACTS locally from CFCP to help ensure that the command-line parameters are correct.

It is very important that you run COPIAFACTS in desktop mode and test all operations and settings, before running it as a service.  This must be done in the the same user account that you will be using for the service operations and with the correct nodename on the command line. If you omit this step the service will not work.

Preparation

In order to run COPIAFACTS as a service, you must adjust your configuration as follows:

You must install the CopiaFacts service components.

The CopiaFacts Message Center service (CFMSG) must be installed and running on the machine where the FAXFACTS\CALLBACK folder resides.  CFESERVICE will not start if it cannot communicate with CFMSG.

You must run the CopiaFacts Control Panel (CFCP) to install CFESERVICE for the selected node.  If you have been using STARTCOPIA to start COPIAFACTS automatically, CFCP will offer to remove this setting.

You must remove options or batch files called from OMACHECK to restart COPIAFACTS on unscheduled shutdown.  CFESERVICE will do the restart automatically, and will generate a notification message if specified.  After repeated restarts, the restarts will be abandoned.

Starting

The Service, and thereby COPIAFACTS, may be started and stopped using the standard NET verbs.  However we recommend that you use CFCP instead to control the COPIAFACTS application.  Unless CFESERVICE is left running, you will not currently be able to control and monitor COPIAFACTS from a different machine.  The CFCP actions allow COPIAFACTS to be suspended and resumed, but the CFESERVICE continues to run.

CFESERVICE always starts COPIAFACTS with a fixed node name on the command line.

On Windows Startup, the service is by default set to automatic, delayed start.  This allows the network to become available so that the service can access the CopiaFacts Application Data Area and the CFMSG service which runs on the same machine.

Stopping

If COPIAFACTS terminates for any other reason than being intentionally closed, CFESERVICE will attempt to restart it up to three times, with a warning message being written to the Windows event log.  This should happen quickly enough to prevent OMACHECK from detecting it.  After three attempts an error message is written to the Windows event log.

If the service is stopped manually using NET STOP CFESERVICE, it will attempt to do a controlled shutdown of COPIAFACTS.  If the controlled shutdown takes longer than three minutes, an immediate shutdown is started.

If an immediate shutdown takes longer than 45 seconds, the COPIAFACTS process is forcibly terminated.  Currently these timings are not adjustable.

On Windows Shutdown, the service is set to terminate COPIAFACTS immediately.  To do a controlled shutdown, use CFCP or stop the service manually. When stopping the service manually, use NET STOP CFESERVICE, because if you kill the process it will not be able to update its status or shut down the COPIAFACTS application it is controlling.