Services installation on application server

The following services can be installed on single or multiple instance across application servers.

Single Instance Services

  • ManagementService. The IMS Management Service seeds the configuration data to the database and creates topics in Kafka based on the configuration service.

  • SOAPIngressTransport. The IMS SOAP Ingress Transport exposes the endpoint for IEE to make calls for request response commands (two-way commands and on-demand read requests).

  • MonitoringService. The IMS Monitoring Service exposes the endpoint for the IMS UI to consume matrix data.

  • AMMCommandsEgressTransform. The IMS AMM Commands Egress Transform pulls the ESN MAC-ID mapping data from DMS and transforms it to OpenWay format and then to AMM format for request response commands (two-way commands).

  • HotReadingsQueryAPI. The IMS Hot Reading Streaming API exposes the endpoint to consume the reading data in a common Protobuf schema.

  • FileIngressTransport. IMS File Ingress Transport. It reads PBC, MDI file from folder and pass to next step. It will be used for PBC to Location flow. If this flow is not ready, you can skip the service installation.

Multiple Instance Services

The remaining services can be installed on multiple servers to boost performance:

"LogProcessorService",
"JobManagerService",
"SOAPEgressTransport",
"AMMEgressTransport",
"JMSIngressTransport",
"OWCommandsIngressTransform",   
"OWClientReadingsEgressTransform",
"AMMReadingsIngressTransform",
"ReadingsStorageService" 

Note: These component names are listed in the core and adapter installation configuration files. Remove any component names to skip installation. All of these services are recommended for environments with multiple servers.

Take the following guidelines into account:

  • The reading data processing services are SOAPEgressTransport, JMSIngressTransport, OWClientReadingsEgressTransform, AMMReadingsIngressTransform, and ReadingsStorageService. It is highly recommended to run multiple instances for these services.

  • The request response (two-way command) services are OWCommandsIngressTransform, AMMEgressTransport, AMMCommandsEgressTransform, SOAPIngressTransport, and JobManagerService. You can run multiple instances of these services, but not for the services that are unsupported for multiple instances (refer to the "Single Instance Services" section above).

  • The logger service, LogProcessorService, is highly recommended for multiple instances.