GLG: Carrier User Guide for Integration Onboarding

ONE's partners (carriers) can initiate the onboarding process. The following instructions pertain to the onboarding and integration certification process that carrier users navigate upon logging in to the ONE system. These instructions assume that carrier users have not begun the integration onboarding process at all. Some users may be at different steps shown on this page.

QA Test Environment

Complete the following steps to complete onboarding and integration certification:

  1. Log in to the ONE QA test system.
    The Carrier NEO Dashboard displays with the Onboarding Tasks widget. If the widget shows no results, then your invitation has not yet been approved. Otherwise, you will see that subtasks are available.

    images/download/attachments/131839673/2022-07-21_17-01-24-version-1-modificationdate-1664914384000-api-v2.png



  2. Click the arrow to expand the sub-task list.
    The ProdOnboard Partner is listed as the first sub-task.

  3. Click the ProdOnboard Partner link.
    The ProdOnboard Partner screen displays all sub-tasks and their current states, along with the state of the overall onboarding process.

    images/download/attachments/131839673/2022-07-21_17-02-42-version-1-modificationdate-1664914384000-api-v2.png



Step 1: Validate the Contact Information

  1. Click the Validate Contact Information link.
    The Validate Contact Information screen displays the contact information provided previously when initiating the onboarding process with ONE. This information may be updated.

    images/download/attachments/131839673/2022-07-21_17-03-57-version-1-modificationdate-1664914384000-api-v2.png



  2. Validate or update the contact information as necessary. Fields with an asterisk ( * ) are required.

  3. Click the Save and Confirm button.
    A green success bar displays.

  4. Click the ProdOnboard Partner tab (or click the X button to close the current perspective) to return to the ProdOnboard Partner screen.

  5. Click the Refresh icon to refresh the information on the page.
    The state for the Validate Contact Information task is updated to Completed.

Step 2: Choose the Format

  1. Click the Choose Format link.
    The Choose Format page displays.

    images/download/attachments/131839673/2022-07-26_13-44-12-version-1-modificationdate-1664914384000-api-v2.png



  2. In the * Format field, select one of the options: EDI X12 or JSON Over REST.
    Users can later add the other option if necessary.

  3. Click the Save button.
    A confirmation popup displays.

    images/download/attachments/131839673/2022-07-21_17-08-06-version-1-modificationdate-1664914384000-api-v2.png



  4. Click the OK button.
    A green success bar displays.

  5. Click the ProdOnboard Partner tab (or click the X button to close the current perspective) to return to the ProdOnboard Partner screen.

  6. Click the Refresh icon to refresh the information on the page.
    The state for the Choose Format task is updated to In Progress.

Step 3: Integration Configuration

Step 3a: Configure the Integration Path for JSON Over Rest

  1. Click the Integration Configuration arrow and the arrow for the connection formats to open sub-tasks. The screenshot below shows both options for demonstration purposes; users have to configure each format separately.

    images/download/attachments/131839673/2022-07-22_18-28-05-version-1-modificationdate-1664914384000-api-v2.png



  2. Click the Create Connection link for a JSON Over Rest connection.
    The New Integration Subscription page displays.

    images/download/attachments/131839673/2022-07-21_17-24-55-version-1-modificationdate-1664914384000-api-v2.png



  3. The * ID, * Category, * Outbound Interface, and *Outbound Interface Version fields are all pre-populated. Fields with an asterisk ( * ) are required.

  4. Click the Active checkbox to make the subscription inactive or active.

  5. Click the Add new destination link in the * Destinations table to create a customized subscription destination.
    The New Message Destination popup displays with email selected as the default destination type. At this time, HTTP should be selected for JSON integration connections.

    images/download/attachments/131839673/2022-07-21_17-29-58-version-1-modificationdate-1664914384000-api-v2.png