Using CFCP to control local applications and services

Summary of operations

CFCP can interact with COPIAFACTS and FFEXTERN instances on the same machine where CFCP is running, in the following ways:

Desktop instances can be started and stopped

CFESERVICE (to run COPIAFACTS) and CFXSERVICE (to run FFEXTERN) can be installed and uninstalled as service applications.

CFESERVICE can be started and stopped (this will also start and stop COPIAFACTS).

CFXSERVICE can be started and stopped (this will also start and stop FEFXTERN).

COPIAFACTS can be started, stopped, paused and resumed in service mode, leaving CFESERVICE running.

FFEXTERN can be started, stopped, paused and resumed in service mode, leaving CFXSERVICE running.

COPIAFACTS can be run in management mode to modify parameters dynamically for COPIAFACTS running in service mode.

FFEXTERN can be run in management mode to modify parameters dynamically for FFEXTERN running in service mode.

Operational status and processing statistics for COPIAFACTS and FFEXTERN service and desktop instances can be viewed.

Controlling normal local desktop applications

When CFCP is run on the same machine as a COPIAFACTS or FFEXTERN instance, it can be used to control local desktop instances directly, though there is of course no need to so if the application is running on the same desktop.  This requires the absence of the ServiceOnly keyword on the $cfmsg configuration command. The typical action list items would be as follows:

Preparation for running as a Service

When preparing to run the application as a service, you must first configure it as a desktop application, using the same login credentials, and also with the required nodename on the command line of either COPIAFACTS or FFEXTERN.  Using the CFCP Action Panel to do this prior to configure it as a service ensures that the login and nodename are correctly set.

Starting the application in management mode prevents it from starting up automatically, but allows configuration.  Management mode can also be used to modify the parameters of a running service.

Note that if COPIAFACTS/FFEXTERN is running on another machine for the same node, as a desktop application, then CFCP will have no knowledge of it, and it will fail in the normal way to start two instances with the same nodename.

Installing and Uninstalling the CFESERVICE and CFXSERVICE applications

The main reason to run CFCP on a production engine or document converter node is to prepare for running these programs in service mode.

The above action will only appear if CFESERVICE.EXE (or CFXSERVICE.EXE for a Document Conerter Node) is present in the Copia folder under Program Files (or Program Files (x86)) and if the service is not in the list of installed services.

Warning: CFCP must be used to install these services. The command-line switch /install is not supported.

A dialog will be shown for you to enter the login credentials for the service. The login credentials must be the same as those you use when you configure the Application on the desktop.  As when installing a service using Windows Computer Management, necessary service logon privilege will be added to the account if not already present.

If you are using a domain login, CFCP will not be able to verify whether or not your account has service logon privilege and will display a message to this effect. You may need to get a network administrator to add SeServiceLogon privilege to your domain login account.  The procedure is documented at https://technet.microsoft.com/en-us/library/cc794944(v=ws.10).aspx.
On the server, select the indicated item and add the account to be given this right.

On the server, select the indicated item and add the account to be given this right.

When the service is installed and not running an action menu item will be present to uninstall it.  You might need to do this if you wanted to run a different CopiaFacts nodename on the machine, because the service is installed configured for a specific node name.

Starting and Stopping the CFESERVICE and CFXSERVICE applications

Normally these services should run continuously and start (Automatic - Delayed) with Windows.  If you stop the service, you will not currently be able to restart it from another machine using CFCP.  However you can use CFCP as described in the next topic to pasue, stop, resume or start the application only, leaving the service running.

Starting the service will also start the CopiaFacts Engine or Document Converter which is being run in service mode, after first terminating any instance of the same application which is found to be already running.

Stopping the service will shut down the CopiaFacts Engine or Document Converter which is being run in service mode.  If you use NET STOP or the Services Plugin to stop the service, the running application will be terminated and calls may be lost.  Instead you can use CFCP (or Windows utilities) to pause the application before stopping it, or in the case of a COPIAFACTS instance you can do a controlled shutdown using CFCP.