Knowledge Base

Welcome to the SmarterCommerce documentation portal

What can we help you find?

Sitefinity Health Check Integration

The Sitefinity CMS Health Check service enables you to assess the core components of your Sitefinity CMS application. Once you enable the service, you can run background checks on whether the site is operational, responsive, and set up properly.

To enable the “Health Check” service follow the next steps:

Add the following line to the web.config file <appSettings> node:
<add key="sf:HealthCheckApiEndpoint" value="restapi/health"/>

Find the Health Check configuration in Sitefinity Backend / Administration/Settings/Advanced/System/Health check service:

Turn ON the Enable Health check service and Enable logging of health check tasks options

Turn ON Enable HTTP status codes if a HTTP Code 500 needs to be returned when the check does not pass (Optional)

Enter a token value in the Authentication Key field to execute a security validation. The token must be included in the web service request as a part of the HTTP Headers under the key name authKey (Optional)

Create the following SmarterCommerce checks as follows:

SmarterCommerce Database
Health check Name: SmarterCommerce Database
Groups: scdb,sc
Type: Premier.CMS.SmarterCommerceDBCheck

JDE XML Interoperability
Health check Name: JDE XML Interoperability
Groups: jde,jdexml
Type: Premier.CMS.JDEXMLInteropCheck

JDE Database
Health check Name: JDE Database
Groups: jde,jdedb
Type: Premier.CMS.JDEDBCheck

Settings decription:

Enable health check: determinates the check availability

Name: check name

Timeout: execution time limit fot the check. When the check reaches the limit it will stop and return a timeout message.

Critical: defines wheter this check affects the end result of the overall health check.

Groups: used to filter the checks to excecute. Value must be passes as part of the request query string: https://www.mysitefinity/restapi/health?type=jde

Type: Must matches the DLLs embedded SmarterCommerce check types
Note: only the Type must be register as the image. The other values are up to the client.
Once everything is in place, a json object will be returned when a request is performed towards the web.config URL:

For more details:

https://www.progress.com/documentation/sitefinity-cms/112/overview-health-check-service

This Section Also Contains

Bring It All Together

We bring together digital commerce, retail and call center channels with a united approach that leverages the power of onmi-channel while prioritizing JD Edwards connectivity.

CONNECT WITH AN EXPERT