Validation options for the Online Editor services

To make sure that you deployed the Online Editor services successfully, you need to check the status of each service both in the Windows Services Manager and through health monitoring endpoints.

Check the status of each service in the Windows Services Manager

On the machine on which you installed the Online Editor services, go to the Services panel and check the status of the Online Editor services (SDL BCM Service, SDL Editor Service, SDL Editor Service Router, and SDL Verification Service):
  • If each service has the Started status, call the health monitoring endpoints to make sure that everything is alright.
  • If one of the services is not running, stop the Editor Service Router, and then the Editor Service and the BCM Service will stop automatically. After the three services have stopped, stop the Verification Service as well. Then, start the BCM Service, wait for the Editor Service and the Editor Service Router to start automatically, and then start the Verification Service manually.

Call the health monitoring endpoints

Perform a GET call to each of the following health monitoring endpoints. You can do this from your browser as well:
ServiceEndpointStatus
BCM Service<oe_host>:<bcm_port>/bcms/health
  • If the service is working properly, the status is UP (<Status>UP</Status>).
  • If the service is not working properly, the status is DOWN (<Status>DOWN</Status) or the page is not displayed.
Editor Service<oe_host>:<oe_port>/api/es/health
Editor Service Router<oe_host>:<oe_router_port>/api/esrouter/health
Verification Service<oe_host>:<vs_port>/api/verification/health
In this context, <oe_host> refers to the fully qualified domain name of the machine on which the Online Editor services are deployed (for example, oe.mydomain.com).
  • If the health monitoring endpoint for each service returns the UP status, you have successfully deployed the Online Editor services.
  • If one of the services is not running, stop the Editor Service Router, and then the Editor Service and the BCM Service will stop automatically. After the three services have stopped, stop the Verification Service as well. Then, start the BCM Service, wait for the Editor Service and the Editor Service Router to start automatically, and then start the Verification Service as well. When finished, call all the endpoints again. All the services need to be working properly for the deployment to be successful.

Check the correct versions of the services were deployed

Perform a GET call to each of the following endpoints. You can do this from your browser as well:
ServiceEndpointVersion
BCM Service<oe_host>:<bcm_port>/bcms/info5.3.25
Editor Service<oe_host>:<oe_port>/api/es/info1.50.35
Editor Service Router<oe_host>:<oe_router_port>/api/esrouter/info2.0.41
Verification Service<oe_host>:<vs_port>/api/verification/info2.1.3
In this context, <oe_host> refers to the fully qualified domain name of the machine on which the Online Editor services are deployed (for example, oe.mydomain.com).

What to do next

Grant the appropriate permissions to your WorldServer user types.