Custom B&OM service hosts
This section describes tools for managing customBatch & Output Management service hosts.
To run KCM B&OM processes without using KCM Studio, you can add custom KCM B&OM service hosts.
Log files for KCM Studio and all KCM B&OM services, including custom service hosts, are written to the folder which resides in: <deploy root>\KCM\Work\<version>\Output Management\Logs.
For more information on KCM B&OM and its processes, see the Kofax Communications Manager B&OM Getting Started Guide.
Adding custom service hosts
This section describes how to add custom B&OM service hosts using the AddOutputManagementService.exe tool.
You can find the tool in the <deploy root>\KCM\Programs\<version>\Management\Output Management folder.
The tool works as follows:
- A new executable for the new service is created in the <deploy root>\KCM\Programs\<version>\Management\Output Management folder, with the following name: CCM_OM_SVC_<Identifier>.exe.
- A configuration file is created next to the service. If required, you can customize it.
- A new service won't be started automatically.
- By default, service events for the new service are logged to the CCM_OM_<Identifier>_<Version>_wcf.svclog file, and all other messages are logged to the CCM_OM_<Identifier>_<Version>_log.txt file. If starting the service fails, the log files contain information about the failure.
New services added using this tool will execute selected processes in a given system. They depend on the standard KCM B&OM Core service to run.
Types of custom services
Custom services can be either Auto or Manual:
-
StartOutputManagement.exe tool only starts the custom services that are Auto.
-
StopOutputManagement.exe tool stops all services and sets them to disabled, but also remembers if the service was Auto or Manual. This affects the next start.
-
ListOutputManagementServices.exe tool shows the current state of each service.
To change the state of a service, use the Windows service manager to set the start mode to either Auto or Manual. This can be done both for running services and for stopped services.
Parameters
The following table lists the parameters that you need to add custom service hosts.
| Parameter | Required / Optional | Description |
|---|---|---|
| Service!Identifier | Required |
Identifier for the new service. The value is used for identifying the service within the B&OM installation. Also, the value is part of the name, default display name, and default description of the Windows service. |
| Service!Mode | Optional. The default value is Auto. |
Defines the type of the service. Possible values are:
|
| Service!DisplayName | Optional |
Overrides the default generated display name of the new Windows service. Default is KCM<Version> - Output Management - <Identifier>. |
| Service!Description | Optional |
Overrides the description of the new Windows service generated by default. Default is the same value as the Service!DisplayName parameter has. |
| Service!Password | Required |
The password for the service user. |
| System!Name | Required. |
The name of the B&OM system for the new service to use. You can view the name in the System Administration section in KCM Studio. |
| Process!Name | Optional. Must be used if AliasTable!Name is omitted. Both parameters cannot be specified at the same time. |
A name for B&OM process for the new service to execute. You can view the name in the Object Viewer pane in KCM Studio. |
| AliasTable!Name | Optional. Must be used if Process!Name is omitted. Both parameters cannot be specified at the same time. |
A name for B&OM alias table, which should contain one or more B&OM processes. The service executes each process contained in this alias table. The names of the keys defined in the alias table are not taken into account. You can view the name of the alias table in the Object Viewer pane in KCM Studio. |
Listing custom service hosts
You can get an up-to-date list of custom B&OM service hosts in the current Batch & Output Management installation using the tool ListOutputManagementServices.exe.
This list contains the identifiers, names, display names, and current status of each service.
This tool doesn't require any parameters. You can find it in the <deploy root>\KCM\Programs\<version>\Management\Output Management folder.
Removing custom service hosts
To remove custom B&OM service hosts, use the RemoveOutputManagementService.exe tool.
You can find it the <deploy root>\KCM\Programs\<version>\Management\Output Management folder.
You must stop the service before you remove it. Removal does not require a restart of B&OM or other parts of KCM. After the service is removed, some custom configuration settings applied to its .config file are lost (for example, log level settings). Service log files are preserved.
Parameters
The following table lists the single parameter that you need to remove custom service hosts.
| Parameter | Required / Optional | Description |
|---|---|---|
| Service!Identifier | Required |
Identifier of the service to remove. A list of services can be retrieved using the ListOutputManagementServices.exe tool (see the previous section). |