Skip to main content

How To Configure Enactor Services Status Details

Introduction​

In the Enactor application, numerous application types are intricately interconnected, facilitating real-time communication and data transmissions. These applications may deploy across diverse hardware and across different locations. Seamless communication among these applications is the pivotal element ensuring the smooth flow of the overall Enactor system. The major key factor that helps these communications across all applications is the Enactor Web Services.

The purpose of this guide is to outline the different types of services used across the Enactor system, how these services support day-to-day activities, and how to manage them using the Estate Manager maintenance screens.

Most Enactor Retail Web Services are implemented based on Simple Object Access Protocol (SOAP) and Hypertext Transfer Protocol (HTTP), and some use JavaScript Object Notation (JSON) over HTTP.

info

Not all services within the applications need to be actively running at all times. Some services can be toggled off to align with the specific requirements of the end user. This guide provides an in-depth explanation of these services, their purpose, and how end users can manage them using the available maintenance options in the Estate Manager application.

Overview​

The following common configurations should be applied in order to maintain the services in the Enactor application:

  1. Service Type Maintenance - Service types are generated by pinpointing the fundamental components of the application's functionality that will operate as background services, taking into account the available runtime contexts within the application.

  2. Service Definition Maintenance - Used to configure the service types according to the device, the region or optionally the cluster nodes in which the service types are associated. Configuring the background service to autostart while the device services are started is done using the Service Definition Maintenance.

  3. Service Status Maintenance - Used to manage the services that have been configured. Each background service is listed by name with an indication of status and current activity. The page is dynamic and updates periodically to reflect changes in status.

Configuration Steps​

Service Type​

Service types are established by identifying essential elements of the application function to operate as background services, considering the available application runtime contexts. The Service Type Maintenance page, shown below, lists the configured service types. These service types are defined according to an implementation, which could be a built-in or custom class or process.

Navigate to Service Type Configuration using the search or the path:

Service Type Configuration navigation path in Estate Manager

The Service Type property designates an interface that outlines the properties expected by the implementation within the service definition passed to it during execution. In most cases, except for a few of the built-in implementations, the expected interface is of type serviceDefinition.

note

For service type values other than serviceDefinition, this property identifies further configuration details required (subject to environmental context) by the implementation and passed to the implementation when the service is started. This configuration must be provided in the service definition and these details are usually captured in an additional Service Definition Maintenance tab. Additional configuration requirements for bespoke implementations can only be accommodated by also customising the Service Definition Maintenance page.

Service Type Maintenance screen showing configured service types and their implementations

Service Definition​

The service definition configuration specifies the device type, region and optionally also a cluster node in which an associated service type should execute. A software implementation identified by a service type may be applied in different device type contexts (i.e. the same service function identified by the service type may be used by different service device types). The background service implementation of a service definition is prescribed by the service type that underpins it. The service definition configuration also specifies whether the background service should autostart when the device services are started.

Navigate to Service Definition Configuration using the search or the path:

Service Definition Configuration navigation path in Estate Manager

Service Status​

The Service Status Maintenance feature offers continuous monitoring capabilities for the list of background services deployed on physical machines. In this maintenance, there will be a list of services along with their current active status. This information is updated in real-time, allowing you to track the ongoing activities associated with these services. Essentially, Service Status Maintenance serves as a comprehensive dashboard providing relevant information about the services.

Navigate to Service Status Maintenance using the search or the path:

Service Status Maintenance navigation path in Estate Manager

Service Status Maintenance screen showing list of background services with status and current activity

As a feature of this maintenance, it allows control of the services using the Stop, Start, Pause or Resume icons for selected services. Options are also present in the page collectively to Stop All Services or Start All Auto-Start Services.

ConfigurationDescription
ApplicationThe web server which the background service is deployed on
StatusThe current status of the service
NameBackground service name
Current ActivityBackground service current activity

Service List and Functions​

The following section elaborates on the standard background services available in the Enactor application, which can be monitored via the Service Status Maintenance screen.

Account Balance Update Monitor​

Used to update account balances of accounts such as CustomerLoyaltyAccount, CustomerDepositAccount, CustomerCreditAccount, EmployeeAccount, and others.

Alert Dispatcher​

Controls the sending and dispatching of alerts from the Estate Manager.

Alert Monitor​

Controls the receiving of alerts to the Estate Manager by monitoring the Estate Manager logs for alert-configured messages.

BP Activity Deadline Controller​

Used to monitor expired BP tasks and move the business process on when it encounters such expired tasks.

Broadcast Status Monitor​

Updates the broadcast status of the Estate Manager.

Business Process Event Handler​

Monitors events and then triggers a business process to respond to that event.

Business Process In Processor​

Monitors a queue and creates or moves on the business process depending on the message on the queue.

Business Process Results Processor​

When a BP task is run as a scheduled job and the result is put on a queue, this service reads that particular queue and moves on the business process appropriately.

Campaign Runner​

The Campaign Runner service picks the campaigns that are in the "Pending Activation" or "Pending Re-Activation" state and initiates the configured business process for each campaign item.

Card Authorisation Server​

When doing card authorisation, the card authorisation server (or the Payment Gateway) looks up an acquirer connection for the obtained acquirer. It also checks if that acquirer connection is available under AuthorisationServerConfig. If found, it looks up the corresponding IP addresses in PaymentModule/PaymentModuleAuthorisationConfig.xml. Uses the Enactor Web Card Authorisation Runtime Context.

Card Authorisation Server WRP​

When doing card authorisation, the card authorisation server (or the Payment Gateway) looks up an acquirer connection for the obtained acquirer. It also checks if that acquirer connection is available under AuthorisationServerConfig. If found, it looks up the corresponding IP addresses in PaymentModule/PaymentModuleAuthorisationConfig.xml. Uses the Web Retail Processing Runtime Context.

CardAuthorisation - Card Identity Token Service​

Submits the tokens written to the OutboundCardIdentityTokens queue to a process named ProcessOutboundCardIdentityToken. The process calls the corresponding endpoint in the payment portal using the InvokeRestServiceAction. The process then waits for the response (with a timeout) and returns the response with a SUCCESS outcome in successful scenarios. Otherwise, FAIL or RETRY is returned as the outcome.

Cash Management Transaction Processing​

Multi-threaded Cash Management Transaction Processing where the processing of cash management session totals in the Estate Manager is done.

Cash Management Transaction Processing (Single Threaded)​

note

Not required if "Cash Management Transaction Processing" is already running. This process runs as a single thread. Use this if there are problems with the multi-threaded service.

Customer Manager Document Processor​

Takes incoming CRM transactions to the Estate Manager and processes them.

Configured Process Service​

A Configured Process Service allows you to turn one or more application processes into a background service.

CRM Document Processor​

Takes incoming CRM transactions to the Estate Manager and processes them.

CRM Email Message Event Processor​

Processes email-based events and as a result records these email contact history entries against a customer.

Diary Entry Runner​

Creates scheduled jobs which are processes run by the scheduled job background service.

Diary Entry Runner - Orders​

Creates scheduled jobs for Order Management processes which are then run by the scheduled job background service.

Document Processor​

Takes incoming retail transactions to the Estate Manager and processes them.

EM CM Transactions To Secondary CM Queue Consumer​

This service listens to the CM transactions and then copies them to the secondary CM transaction tables.

EM Business Process Deadline Controller​

Used to monitor expired BP tasks and move the business process on when it encounters such expired tasks.

EM Inventory Process Invoke Request Consumer​

Queue consumer to process inventory BP requests.

EM Process Invoke Results Consumer​

Queue consumer to process messages from BP results.

EM Report Definition Queue Consumer​

Queue consumer to deploy report definitions.

EM Retail Process Invoke Request Consumer​

Queue consumer to process retail BP requests.

EM System Events To Secondary SE Queue Consumer​

This service listens to the system events and then copies them down to the secondary system events tables.

EM System Resource Monitor​

A service used to monitor the disk capacity and memory of the devices within the Enactor estate. For example, it is possible to monitor the disk and memory available on the Estate Manager server.

EM Task Activation Service​

Loads batches of tasks to be activated and submits them to the Task Activation Controller.

EM Transaction To RJ Queue Consumer​

Required for getting the Estate Manager transactions to the RJ exporting process.

EM Transaction To SecondaryRTA Queue Consumer​

A service which keeps a table populated called SecondaryRetailTxArchives with copies of retail transactions as they are populated into the main RetailTransactionArchive table.

Email Internal Router​

Routes email internally via the application.

Email Receiver​

Receives emails to the Estate Manager.

Email Sender​

Sends emails from the Estate Manager.

Estate Manager Document Extractor​

The service fires a job that connects to the RJ Estate Manager database to extract retail baskets from the RJ database. The job extracts the data from the RJ DocsIn database table in RJ format XML. The data is then transformed into Enactor format basket XML and written into the Enactor InboundDocuments table where it is processed via transaction processing.

Estate Manager Document Processor​

Takes incoming retail transactions to the Estate Manager and processes them.

Estate Manager Message Extractor​

Reads messages from RJ and then sends them into Enactor inbound documents.

EstateMonitor​

Runs the processes of the Estate Monitor maintenance of the Estate Manager.

File Business Process Launcher​

Used to initiate business processes based on importing files in the file system.

File Document Importer​

Used to feed Enactor basket/transaction XML into inbound documents.

Human Task Activation Controller​

Monitors human tasks that contain an activation delay and starts the human task when that delay has been reached.

HTTP File Download Service​

note

This is a managed service and does not have a service definition. After a restart you may not see this service running until there has been a download request.

Index Update Scheduler​

Creates a new scheduled job to create a new index.

  • Product Search Solr Base - Index Incremental Update is for incrementally updating the indexes for product data only.
  • Product Search Solr All Indexes - Incremental Update is for incrementally updating the indexes of both product and all supporting data.
  • Product Search Solr Indexes Rebuild - Starts building the indexes again from scratch, replacing all existing indexes.

Inventory Document Processor​

Takes incoming inventory transactions to the Estate Manager and processes them.

Inventory Business Process Jobs Processor​

Queue consumer to process inventory BP requests.

Key Date Processor​

Part of CRM. Monitors key dates and triggers processes based on those configured key dates of customers.

Message Service HTTP Listener​

Writes documents to the inbound documents queue or messages to other queues.

Offline Transaction Resolver​

Used to remove P2PE encrypted data from transactional baskets and replace with a token from the payment gateway. Only applies to transactions that do not have a token for P2PE data, i.e. offline transactions.

Order Manager Document Processor​

Takes incoming order management transactions to the Estate Manager and processes them.

Order Manager Jobs Processor​

Queue consumer to process Order Manager BP requests.

Payment Service Notifications Resolver​

Listens for notifications from Adyen and updates Enactor transactions as appropriate.

Queue Consumer Service - Core​

Processes responses from other machines in the estate and is part of the business process engine.

Queue Consumer Service - CMTransactionsToSecondaryCMTransactions​

This service listens to the CM transactions and then copies them to the secondary CM transaction tables.

Queue Consumer Service - Inventory Server​

Receives instructions from the BP engine to execute server processes on the inventory system.

Queue Consumer Service - Reconciliation Data​

Used to receive sales figures from the POS up to the Estate Manager, which are then recorded in the Estate Manager.

Queue Consumer Service - Retail Server​

Receives instructions from the BP engine to execute server processes on the retail system.

Queue Consumer Service - Save Card Identity Token Service​

Stores the provided CardIdentityToken asynchronously through a local database queue. A queue consumer reads from that queue and invokes payment portal services to store the token in the background.

Queue Consumer Service - SystemEventsToSecondarySystemEvents​

This service listens to the system events and then copies them down to the secondary system events tables.

Queue Consumer Service - TransactionToRJ​

Used to send transactions to RJ from the Estate Manager.

Queue Consumer Service - TransformedRT​

Used to transform transactions flowing out of the Estate Manager to the file system based on the TransformRetailTransactionToFile transform. Once transformed, the output is written to ${Common.ApplicationDataHome}/Exports/TransformedRetailTransactions.

QueueConsumerService - ReportDefinitionDeployment​

Used to send the definitions of the reports around the estate.

QueueConsumerService - TransactionToSecondaryRTA​

This service listens to the transactions and then writes them down to the secondary Retail Transaction Archive table.

Received Transactions Monitor​

This application allows the monitoring of transaction numbers received at the Estate Manager from each device in the estate. It enables missing transactions to be identified and can be filtered by date and source. The Received Transaction Number Status Viewer application on the Estate Manager is used to view this.

Reconciliation Data Receiver​

Receives the tender figures from the POS.

ReconciliationDataProcessor​

Processes the POS tender figures to produce the values for the Estate Manager.

RestaurantTxProxyMessageProcessor​

This service relates to the Hospitality Consumer Application that currently runs on iOS. Processes the messages sent from the Consumer Application SaaS server to the Estate Manager.

RestaurantTxUpdatesProcessor​

This service relates to the Hospitality Consumer Application that currently runs on iOS. Processes the messages sent from the Estate Manager to the Consumer Application SaaS server.

Retail Business Process Jobs Processor​

Queue consumer to process retail BP requests.

RMI Process Service Manager​

Allows the running of remote application processes.

RMI Remote Web Service Manager​

Allows the remote running of web services.

Scheduled Job Process​

Manages all the scheduled jobs that are run for the runtime context of Enactor Web Retail Processing such as DataBroadcastProcessor, ProcessBroadcastNotifications, Export Entity, Collate Location, Set Item Prices, UpdateIndexJob, and others.

Scheduled Job Process - Core​

Manages all of the scheduled jobs that are run for the runtime context of Enactor Web Core such as AwaitItemsAvailable, AwaitItemsSubmitted, and others.

Scheduled Job Process - Orders​

Manages all the scheduled jobs that are run for the runtime context of Enactor Web Order Processing such as Initiate Fulfilment, Fulfil Items, Send Order Confirmation, Set Order In Progress, Order Submitted, and others.

Scheduled Report Job Process​

Manages all of the scheduled jobs that are run for the runtime context of Enactor Web Reports such as the GenerateReportJob.

Sequence Number Status Monitor​

Used by the Estate Manager to work out the missing sequence numbers.

Sequence Number Status Monitor V2​

Used by the Estate Manager to work out the missing sequence numbers. This has a different implementation than V1 and it is not being used currently.

Server Queue Connector​

Used for general messaging. Part of the messaging system that allows copying messages to and from local and remote queues.

Server Queue Connector - Core​

Queues that are related to Core and are required for business processes.

Server Scheduled Report Job Process​

Manages all of the scheduled jobs that are run for the runtime context of Enactor Web Reports such as the GenerateReportJob.

Stock Levels File Importer​

Enables the importing of CSV files to adjust inventory levels in the Estate Manager.

System Resource Monitor​

A service used to monitor the disk capacity and memory of the devices within the Enactor estate. For example, it is possible to monitor the disk and memory available on the Estate Manager server.

Task Activation Service​

Loads batches of tasks to be activated and submits them to the Task Activation Controller.

Update Service​

Used to update the status of the existing services.

Voucher Document Processor​

Takes incoming voucher transactions to the Estate Manager and processes them.

XML File Importer​

Monitors the directories on the file system and imports any new files that are added to that directory.

  • Service type - XMLFileImporter
  • Source - /imports/XMLImports
  • No operational role defined

XML File Importer Employee​

Monitors the Employee folder in the file system and imports any new employee files that are added to that directory.

note

Name needs to match the service type in the service definition.

XML File Importer Organisation​

Monitors the Organisation folder in the file system and imports any new organisation files that are added to that directory.

note

Name needs to match the service type in the service definition.

XML File Importer Price​

Monitors the Price folder in the file system and imports any new price files that are added to that directory.

note

Name needs to match the service type in the service definition.

XML File Importer Product​

Monitors the Product folder in the file system and imports any new product files that are added to that directory.

note

Name needs to match the service type in the service definition.

XML File Importer Product Other​

Monitors the Product Other folder in the file system and imports any new product other files that are added to that directory.

note

Name needs to match the service type in the service definition.

XML File Importer Selling Code​

Monitors the Selling Code folder in the file system and imports any new selling code files that are added to that directory.

note

Name needs to match the service type in the service definition.

XML File Importer Users​

Monitors the Users folder in the file system and imports any new user files that are added to that directory.

note

Name needs to match the service type in the service definition.