Health Check

General information

These Mambu Process Orchestrator (MPO) processes allow you to run health checks and validate the working of the connector. Before running these health checks, please make sure the following steps have been carried out:

  1. Create custom fields for clients and groups.
  2. Install and configure the connector.

Defined test cases

  1. Check connectivity between Mambu Process Orchestrator (MPO) and Mambu
    Test case name - mambuConnectivity.
    The Mambu connectivity test makes a GET API call to check the provided Mambu credentials and permissions.

  2. Check connectivity between MPO and ComplyAdvantage
    Test case name - complyAdvantageConnectivity.
    The ComplyAdvantage connectivity test makes a GET API call to verify ComplyAdvantage credentials.

  3. Check configured custom fields in Mambu
    Test case name - mambuCustomFields.
    The custom fields sanity test makes a GET API call to check that the required custom fields are defined in Mambu.

Successful response

An example of a successful test case response:

{
    "complyAdvantageConnectivity": {
        "Result": "Passed",
        "Message": "Connectivity between MPO and ComplyAdvantage is successful!"
    },
    "mambuConnectivity": {
        "Result": "Passed",
        "Message": "Connectivity between MPO and Mambu is successful!"
    },
    "mambuCustomFields": {
        "Result": "Passed",
        "Message": "All Config Custom Fields Set and Id exist in Mambu"
    }
}
ParameterTypeDescription
ResultstringThe result of the health check. Values can be Failed, Passed, or Error. An error is returned when the test case did not complete or is missing information.
MessagestringA message confirming the success of the test case.

Fail response

If the test case fails, the test case result is Failed and the message describes the issue.

{
    "mambuCustomFields": {
        "Result": "Failed",
        "Message": "Config Custom Fields Set/Id do not exist in Mambu",
        "Process": "96647",
        "NOT_Found_CustomFieldsId": {
            "_ComplyAdvantage_AML_Clients": [
                "aml_searchIdXX"
            ]
        },
        "NOT_Found_CustomFieldsSet": {
            "XX_ComplyAdvantage_AML_Groups": [
                "aml_groupSearchVersion"
            ]
        }
    }
}
ParameterTypeDescription
mambuCustomFieldsobject
mambuCustomFields.ResultstringThe result of the health check. Values can be Failed, Passed, or Error. An error is returned when the test case did not complete or is missing information.
mambuCustomFields.MessagestringA message detailing why the test case failed.
mambuCustomFields.ProcessstringThe process ID, only supplied for error and failed statuses.
mambuCustomFields.
NOT_Found_CustomFieldsId
objectResponse from Mambu signaling the custom field set that is missing a custom field.
mambuCustomFields.
NOT_Found_CustomFieldsId._ComplyAdvantage_AML_Clients[]
arrayThe missing custom field.
mambuCustomFields.
NOT_Found_CustomFieldsSet
objectResponse from Mambu signaling the custom field set that is missing a custom field.
mambuCustomFields.
NOT_Found_CustomFieldsSet.XX_ComplyAdvantage_AML_Groups[]
arrayThe missing custom field.

Error response

In case of an error, the test case result is Error and the message describes the issue.

{
    "mambuCustomFields": {
        "Result": "Error",
        "Message": "Mambu config or Customisation config error in custom fields verification:  Param: config, Conv_id: 502520 is not state type",
        "Process": "96647"
    }
}
ParameterTypeDescription
mambuCustomFieldsobject
mambuCustomFields.ResultstringThe result of the health check. Values can be Failed, Passed, or Error. An error is returned when the test case did not complete or is missing information.
mambuCustomFields.ProcessstringThe process ID, only supplied for error and failed statuses.