Creating Client

The first thing you need to do is create a client through the WhiteGlove interface, specifying the following required fields on the client creation screen:

• ClientCode

• ClientName

• CargoWise (CW1) Code

• City

• Country

After that, you can see the screen with access tokens.

IMPORTANT

These tokens are used for authorization in the Public API, put them in a safe place for reuse, because you can only see these tokens once.

Then provide the following information to the WMS and IHub support teams to create and configure the client:

• ClientCode

• ClientName

• AccessToken

• Environment or link to Public API for environment

Obtain an access key from the IHub team support for your new client and paste it into the IHubConfiguration table (see below: how to insert access token).

Anchor
insert_access_token insert_access_token

How to insert access token from IHub

The first step is to get the OrganisatoinId from the ClientCode, this can be done with the following SQL (replace ClientCode to real one):

SELECT 
  OrganisationId 
FROM 
  [OrganisationRegistry].[Organisations] 
WHERE 
  Code = 'ClientCode' 
  AND ROLE = 'CLIENT'

After that, you need to insert the accessToken from IHub into the IHubClientSettings table as follows (replace OrganizationId and IHubAccessToken with real ones):

INSERT INTO [WarehouseGateway].[IHubClientSettings] 
  (ClientId, AccessToken, CreatedDate, LastModifiedDate) 
VALUES 
  (
    'OrganisatoinId', 
    'IHubAccessToken', 
    GETUTCDATE(), 
    GETUTCDATE()
  );

IHub configuration

To fully create and set up a client for WhiteGlove, you need to follow the steps below on IHub:

1. Create the client

2. Configure Client (see below: configuration and service assignments)

3. Send token from IHub for access to WhiteGlove team (Settings → Api Credentials menu item)

Anchor
ihub_clien_configuration ihub_clien_configuration

IHub Client Configuration

To set up a client for White Glove the IHub support should do the next steps:

1. Assign services

2. Configure services

Anchor
assign_services assign_services

Services to assign to a new WhiteGlove client

Go to the Client Setup → Assign Services menu item and configure services as follows

Anchor
ihub_service_settings ihub_service_settings

IHub Service Settings

Go to the Settings → Service Settings menu item to configure services

IMPORTANT

In the URL field you must replace {API_URL} to API Url for environment as follows:

DEV - https://api-whiteglove-dev.seko360.com

UAT - https://api-whiteglove-uat.seko360.com

PROD - https://api-whiteglove.seko360.com

You also need to replace the {ApiToken} with a real one from the WhiteGlove team

Push Delivery Arrive

General Settings:

For the URL, you must select POST and enter the following value:

{API_URL}/Booking/arrive?Token={AccessToken}

Map The Message:

IMPORTANT

Unwrap Responses and Response checkboxes must be checked

In the advanced mapping editor must be as follows:

{
  "BookingReference": "{{DeliveryArrive.HBRef}}",
  "Date": "{{DeliveryArrive.ArrivedDate}}"
}

Push Dispatch Confirmation

General Settings:

For the URL, you must select POST and enter the following value:

{API_URL}/Booking/dispatch?Token={AccessToken}

Map The Message:

IMPORTANT

Unwrap Responses and Response checkboxes must be checked

In the advanced mapping editor must be as follows:

{
  "BookingReference": "{{Dispatch.SalesOrderReference}}",
  "GoodsDispatchedDate": "{{Dispatch.DispatchDate}}",
  "GoodsDispatch": [
{{ for item in List.DispatchLineItem }}
    {
      "Sku": "{{item.ProductCode}}",
      "ProductColour": {{ if (item.ProductColour) }}"{{item.ProductColour}}"{{ else }}null{{end}},
      "ProductDescription": {{ if (item.ProductDescription) }}"{{item.ProductDescription}}"{{ else }}null{{end}},
      "ProductGrossWeight": {{ if (item.ProductGrossWeight) }}{{ item.ProductGrossWeight }}{{ else }}null{{end}},
      "ProductSize": {{ if (item.ProductSize) }}"{{item.ProductSize}}"{{ else }}null{{end}},
    },
{{ end }}
  ]
}

Push Goods Received Notice Confirmation

General Settings:

For the URL, you must select POST and enter the following value:

{API_URL}/Booking/receipt?Token={AccessToken}

Map The Message:

IMPORTANT

Unwrap Responses and Response checkboxes must be checked

In the advanced mapping editor must be as follows:

{
  "BookingReference": "{{ GRN.HBRef}}",
  "ConfirmedDate": {{ if (GRN.ConfirmedDate) }}"{{ GRN.ConfirmedDate }}"{{ else }}null{{end}},
  "Receipts": [
{{ for item in List.GRNLineItem }}
    {
      "Sku": "{{ item.ProductCode }}",
      "Quantity": {{ item.Quantity}}
    },
{{ end }}
  ]
}