Health Check

Health checks can be used to test that all aspects of the connector are configured correctly. This includes connectivity between nCino, Mambu Process Orchestrator (MPO) and Mambu, the validity of deposit product configurations in both systems, as well as credentials. Typically you will run these checks after upgrading the connector to a new version.

Defined test cases

  1. Check connectivity between MPO and nCino.
    Test case name - nCinoConnectivity
    The nCino connectivity test makes a GET API call to check:

    • The refresh token has been created.
    • The nCino credentials are verified.
  2. Check connectivity between MPO and Mambu.
    Test case name - mambuConnectivity
    The Mambu connectivity test makes a GET API call to check the provided Mambu credentials and permissions.

  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.

  4. Check configured deposit products in Mambu.
    Test case name - mambuProducts
    The deposit products test uses the response from the previous connectivity test in Mambu to check that the same deposit products defined in the configuration also exist in Mambu.

  5. Check configured deposit products in nCino.
    Test case name - nCinoProducts
    The deposit products test uses the response from the previous connectivity test in nCino to check that the same deposit products defined in the configuration exist in nCino.

  6. Validate nCino endpoints.
    Test case name - nCinoEndpoints
    The validate nCino endpoints test makes a GET API call for each endpoint used in the connector to check that the nCino package in Salesforce is properly installed.

  7. Check refresh token.
    Test case name - nCinoRefreshToken
    The refresh token test compares the current date with the nextRefreshDate parameter as set in nCino Config in the Setup > nCino Setup folder. A check is made to ensure the refresh token is properly updated in nCino.

Configuration

Before running the health checks please make sure the following steps have been carried out:

  1. Configure products in both Mambu and nCino.
  2. Install and configure the nCino Deposit Lifecycle Management connector.

If you need help with either of these steps, contact your Customer Success Manager.

Test case result examples

Success response

If a test succeeds, the test case result is Passed and the message describes the result.

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.
{
"mambuConnectivity": {
    "Result": "Passed",
    "Message": "Connectivity between MPO and Mambu is successful!"
},
"mambuCustomFields": {
        "Result": "Passed",
        "Message": "All Config Custom Fields Set and Ids exist in Mambu"
},
"mambuProducts": {
    "Result": "Passed",
    "Message": "All Config Deposit Product keys exist in Mambu"
},
"nCinoConnectivity": {
    "Result": "Passed",
    "Message": "Connectivity between MPO and nCino is successful!"
},
"nCinoEndpoints": {
    "Result": "Passed",
    "Message": " nCino package in Salesforce is properly installed."
},
"nCinoProducts": {
    "Result": "Passed",
    "Message": "All Config Deposit Product keys exist in nCino"
},
"nCinoRefreshToken": {
    "Result": "Passed",
    "Message": "RefreshToken has been properly updated."
}

Error response

In case of error, such as, test could not be completed or was missing information, the test case result is Error and the message describes the issue.

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 failure of the test case.
ProcessstringThe process ID - only supplied for error and failed statuses.
{
    "nCinoProducts": {
        "Result": "Error",
        "Message": "Something went wrong with nCino connectivity or config SD. Deposit product list from nCino could not be retrieved.",
        "Process": "64214"
    }
}

Fail response

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

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 failure of the test case.
ProcessstringThe process ID - only supplied for error and failed statuses.
{
    "mambuConnectivity": {
        "Result": "Failed",
        "Message": "Mambu connectivity failed: INVALID_TENANT_ID ",
        "Process": "64211"
    }
}