Skip to main content

XTM Connect – Adobe Experience Manager 2.6

Checking the link (REST connection) between your XTM Cloud system and AEM as a Cloud Service

Note

If you are using Adobe Experience Manager 6.5 (AEM 6.5), see Checking the link (REST connection) between your XTM Cloud system and Adobe Experience Manager 6.5.

From release 2.5.2, a "health check" system has been implemented: it checks whether the REST connection between your AEM as a Cloud Service system and XTM Cloud is working properly.

For AEM as a Cloud Service, this health check system is Apache Felix health checks. See the Apache Felix health checks online help.

Apache Felix instances (AEM as a Cloud Service)

The following approach has been implemented for Apache Felix instances:

  1. Felix Health Checks are used to check the health/availability of Apache Felix instances at runtime. To enable this, a health check is configured via the HealthCheck SPI interface. HealthCheck is an OSGi service that returns a Result.

    To initiate the health check, add the following string to your AEM as a Cloud Service domain: /system/health.json?tags=xtm.

    Example:

    If your AEM as a Cloud Service domain is test-p12345-e123456.adobeaemcloud.com, the final URL should be: test-p12345-e123456.adobeaemcloud.com/system/health.json?tags=xtm.

  2. The HealthCheck Result contains a result status which can have one of these values:

    • OK.

    • WARN.

    • TEMPORARILY_UNAVAILABLE (not used by XTM International).

    • CRITICAL (not used by XTM International).

    • HEALTH_CHECK_ERROR (not used by XTM International).

    For details about these statuses, see Health check result statuses and meanings.

    The HealthCheck Result also contains one or more log-like messages that can provide more information about anything that has gone wrong.

  3. When the HealthCheck is run, its primary task is to fetch all xtm-provider-type configurations and check that the connection from each of them to XTM Cloud is working properly. If not, a WARN message (at most) is raised in the log file.

  4. If an issue occurs, check whether there is still a link between your AEM as a Cloud Service server and XTM Cloud. If not, check:

    • whether the credentials used on the connection are still correct.

    • whether the firewalls and other security arrangements have been changed. A change might cause the connection to fail.

    • whether any other changes have been made to the server configuration, which might be causing the connection to fail.

Note

The status message issued by the health check only provides hints about what might be wrong. Your company's Support team need to investigate the potential reasons for the link between your AEM as a Cloud Service server and XTM Cloud to fail.

If they cannot resolve the issue, they should contact XTM Support.

To request support, see Contacting XTM Support (AEMaaCS).