Skip to main content

Test your integration

Your integration should be tested through both scenarios in the following order:

Test your integration API responses

In addition to any unit testing you have included in your integration build, it's advised that you thoroughly test your integration against numerous requests to ensure it functions as expected under all conditions before you deploy.

Maxsight is available through an API as well as the UI, which is why it's key to test different types of requests that may vary from those sent from the Maxsight UI.

The following tests are recommended to be performed, though this isn't an exhaustive list as all integrations operate slightly different:

  • Requests containing more than expected data fields.

  • Requests containing fewer than expected data fields.

  • Requests missing required input. For example, missing config fields or missing a date of birth, and so on.

  • Requests with invalid data types in input. For example, an array instead of a string.

  • Requests containing invalid credentials or credentials lacking appropriate permissions.

  • Requests where no matches/results are found, or equivalent for your integration, for example in screening when the searched entity can't be found.

  • Requests receiving an ERROR result, or equivalent for your integration.

  • Requests receiving a PARTIAL result, or equivalent for your integration.

  • Requests receiving a FAIL result, or equivalent for your integration.

  • Requests receiving a PASS result, or equivalent for your integration.

Test your integration in Maxsight

You must test your integration in Maxsight to ensure it behaves as expected and can run without error. Also, this is your opportunity to ensure all data is displayed as you would expect.

Note

Ensure you have necessary institution permissions from the institution admin to be able to create data providers and smart policies.

To test your integration in Maxsight:

  1. Log in to your institution at one of the two Maxsight environment URLs. To learn more about Maxsight environments, see Testing Maxsight:

    • https://eu.maxsight.com

    • https://stg-eu.maxsight.com

  2. Select Policy builder and choose Data providers from the navigation menu.

  3. Select + New data provider and select the appropriate entity type. You can tell which applicable entity you should be using based on your check type.

  4. Add your integration URL and secret key, and select Run Validation. To learn more, see How to run the validation suite against your integration.

    Remember to include a trailing / at the end of your integration URL.

    Partner_Experience_test_in_maxsight_run_validation.png
    Partner_Experience_test_in_maxsight_run_validation_passed.png
  5. Select Check configuration from the navigation and choose + New check configuration. Select your associated check type from the drop-down list and select Create.

  6. Select your newly created check, and in the Default box, check the box with the data provider you added in step three, and select Save.

    Partner_Experience_test_in_maxsight_select_data_provider.png
  7. Select Tasks from the navigation and choose New compliance task. Select the appropriate entity type based on your check type.

  8. Select your newly created compliance task. For both Acceptance Checks and Automatic Checks, select + Add Check and select the check you added in step five, and then select Add checks.

    Partner_Experience_test_in_maxsight_add_checks.png
  9. Select Workflows from the navigation and choose + New workflow. Select the appropriate entity type based on your check type. Select Edit name to change the name of your workflow.

  10. Select your newly created workflow and move the cursor anywhere in the gray area until you see the box with the plus. You may need to move the cursor for the box to appear. Once you see this box, select the screen, choose Task element, and then select Add tasks element.

    Partner_Experience_test_in_maxsight_smart_policy_box.png
    Partner_Experience_test_in_maxsight_smart_policy_task_element.png
  11. Select the pen icon of your new task box and select Add a new task. Select the compliance task you created in step seven and select Add task.

    Partner_Experience_test_in_maxsight_smart_policy_pen_icon.png
    Partner_Experience_test_in_maxsight_smart_policy_add_a_new_task.png
  12. Hover over the gray area again until the box with a plus symbol is visible and select the screen. Select Outcome element, and then for outcome type, choose Automatic approval, and then select Add outcome element.

    Partner_Experience_test_in_maxsight_smart_policy_add_outcome_element.png
  13. Select and hold the start dot and drag it to your Add tasks box. Select and hold the dot from the Add tasks box and drag it to your Automatically approve when all tasks complete box. When complete, the boxes are connected by arrows. To save your workflow, select Save.

    Partner_Experience_test_in_maxsight_smart_policy_connected_elements.png
  14. Select Assessments from the navigation and select + New assessment.

  15. Select your newly created assessment. Check the Entities will follow the selected workflow for this assessment box and the Entities can carry out this assessment multiple times box.

    Partner_Experience_test_in_maxsight_add_product.png
  16. In the Workflow box for the applicable entity, either Individual policy or Company policy, select your workflow you created in step nine and select Save assessment.

  17. Select User management from the main navigation and choose Roles.

  18. Select the Compliance Officer role and select Assessments. If not already configured, grant your new assessment created in step 14 the Read and write permission and select Save changes.

    If you don't have the permissions to do this, speak to an admin user of your institution.

    Partner_Experience_test_in_maxsight_add_permissions.png
  19. Select Entity management from the main navigation and select + New entity. Fill out the details as necessary, and in the Assessment drop-down, make sure your new assessement is selected and select Create entity.

    If you can't see your assessement, cancel the entity creation, refresh your browser, and try again. If your assessement still isn't visible, repeat step 18 and ensure you have set the right permissions.

  20. Select the option to go to the entity and in the entity overview page, select your task from the menu.

    Partner_Experience_test_in_maxsight_profile_page_select_task.png
  21. On the task page, you can see the outcome of the check using your integration. Validate that the check ran as expected, the data is present and displayed where expected, and that any embedded links or iFrames work as expected.

    Partner_Experience_test_in_maxsight_task_page_passed.png
  22. Repeat steps 19-21 for multiple entities to ensure you have completed a sufficient range of sufficient scenarios for your integration.

Additional information