---
title: XDMS -> HyperPortal live integration user manual
slug: hyper-portal/xdms-greater-hyperportal-live-integration-user-manual
docTags: 
createdAt: 2022-12-27T15:02:20.000Z
---

 Live integration from XDMS to Hyperportal, allows XDMS to send updates into HyperPortel over the Integrations API once every few minutes. It is an alternative to the current XDMS import functionality.

## HyperPortal setup

Do not use entityId / title for XDMS mapping anymore. Migrate all the needed entities / entitity type properties to have xdmsExternalRef. (i.e. Language / Country / Gender). Remember to migrate involved processes, computed expressions and other logic that relies on entityId / title.

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/FwjdN-CF7I5TZLaDuRvNZ_image.png)

Generate API key in the Settings. And set its usage plan to "Unlimited" in API gateway.

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/mzeaAsZlP7B_91A7qgBOq_image.png)

Add Hyper Integrations Permissions to all involved Entities. Including Entity type Properties.

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/UsS81uJKnWQ0hmF2m6NTM_image.png)

Add Hyper Integration Permissions read / write for all mapped properties & title. Read only permission for entityId.

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/0yw1dyjUp854F4UyrtAY8_image.png)

# XDMS setup

## Environment settings

Make Dev request to set up Integration with Hyper on XDMS side - Kristien Vaerenbergh - kristien.vaerenbergh\@xpower.be

Enable CDC and CDC policies - Koen van Petergem - koen.vanpetegem\@xpower.be

Enable mapping on needed tables (cust / rel-contact / mach / etc.) Kenny Willems - kenny.willems\@xpower.be

## Data settings

**Dealer Parameter**: Info tab

Application: HyperPortal

Brand: VOLVO

Site: \*

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/wq-RsMh2hMzglymTRMq11_image.png)

**Dealer Paramter:** Paramters tab

INurl: [https://tenantId.hyperportal.org/v2-integrations](https://tenantId.hyperportal.org/v2-integrations)

x-api-key: API key

x-tenant-id: tenantId

timestamps: leave empty

integrationId: fill in Group entity Id for which the Api key is generated in Hyper Portal.

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/8VoU9vI08nSuWX5OTdFyC_image.png)

## XDMS mapping

Maintenance > HyperPortalMapping > Select needed filter > Press Funnel > map XDMS fields

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/9Tzy-7jH07uBavQwuNn9J_image.png)

Red properties - not enough permissions

XDMS Automatically pulls up all Entities / Properties to which you have permissions.

You have to set XDMS table / XDMS field / Unique id flag.

**Note : only predefined tables are selectable. If a table is missing, ask a developer to add the table (and maintain the relation between the tables)**

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/eBrJG7pCsDFCIiaPketly_image.png)

Date is automatically converted to timestamp.

PhoneNumber is pushed as string.

When pushing XDMS rel-contact link to Organization, map it from cust table.

table = cust

XDMS field = NRcust

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/WdGInlr1u3QGbprFXfO0O_image.png)

At this point, for each entity type property XDMS creates a conversion record with a mapping entityId or xdmsRef from XDMS to Hyper.

Here you can manually adjust mapping for some static values. 

For example, for language code = GB use UK (HyperPortal uses GB, while XDMS uses UK)

Current flow:

If entity property value is updated.

XDMS will search entity by **xdmsExternalRef **property value

If nothing is found then by **code **property value

If nothing is found then create new entity item.

then create conversion record for new entity item. (probably need to omit this step).

then update origina target entity with entity type property = new entity item id.

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/SA922TfVjC2qYo4uD6cPH_image.png "Automatic conversion record")

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/wRUUKH-963QQ55e0GqLPB_image.png "Manual conversion record")

## Update Scheduling

Update calls to Hyper are made by a scheduled procedure. Suggested frequency - every 5 minute.

Failed calls are retried again by a retry proceudre, every evening. So if a call fails, retry will happen every evening.

### Create/Update procedure

**Preset tab**

Preset naam - HyperPortal Dumps

Procedure - HyperPortalWS.cls

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/uR-GehrPogJbYl0Q2-DBT_image.png)

**Parameters tab**

1. No. - 10
2. Naam - p-CDcall
3. Type - character
4. Value - DumpRecords



1. No. - 20
2. Naam - p-INparams
3. Type - character
4. Value
5. I/O - Input

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/FIPFClh5h2cEOjM9tVyVE_image.png)

### Resend procedure

**Preset tab**

Preset naam - HyperPortal Failure Resend

Procedure - HyperPortalWS.cls

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/Trxp5aRR6jm_gzhjOV2Lp_image.png)

**Parameters tab**

1. No. - 10
2. Naam - p-CDcall
3. Type - character
4. Value - DumpRecords
5. I/O - Input



1. No. 20
2. Naam p-INparams
3. Type character
4. Value
5. I/O Input

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/VT2Y6kd-yl-XwEFCO5FlN_image.png)

### Create / Update schedule

default cron = \*/4 07-18 \* \* 1,2,3,4,5,6,7

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/Itr-FQnq-ztmfGiG0-4uC_image.png)

### Resend scheudle

default cron = 30 18 \* \* 1,2,3,4,5,6,7

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/l5QWQFMnnAHbrRLpjIu7g_image.png)