Introduction
Major entities in TS system (customer and inquiry) can be referenced with openVIVA. In order to use the referencing system the crmIdent parameter needs to be set to “openVIVAv1”. The following openVIVA references are transferered and updated within the broker forward. When inquiryId (param iId) is provided in broker Forward, references will be updated.
Customer references
The customer object in TS is linked with the openVIVA system. The references are also returned in all notifications so that any data from TS system can be linked back to customer in openVIVA system
openVIVA reference | TS reference in broker forward | Comment |
|---|---|---|
PER_KND Primary ID | “cExternalId” | this is the primary key used to uniquey identify the customer in openVIVA |
Kunden-Nr | “cExternalReferences” | param_key: “oV-Kunden-Nr” and origin: “crm” |
Partner-Nr | “cExternalReferences” | param_key: “oV-Partner-Nr” and origin: “crm” |
Inquiry references
The inquiry object in TS is linked with the openVIVA system. The references are also returned in all notifications so that any data from TS system can be linked back to contract in the openVIVA system
openVIVA reference | TS reference in broker forward | Comment |
|---|---|---|
VTR Primary ID | “iExternalReferences” | param_key: “oV-Vertrag-ID” and origin: “crm” |
Vertragsnr | “iExternalReferences” | param_key: “oV-Vertrag-Nr” and origin: “crm” |
Angebotsnr | “iExternalReferences” | param_key: “oV-Angebots-Nr” and origin: “crm” |
Antragsnr | “iExternalReferences” | param_key: “oV-Antrags-Nr” and origin: “crm” |
Vertragsart ID | “iExternalReferences” | param_key: “oV-Vertragsart-ID” and origin: “crm” |
Deckungskonzept ID | “iExternalReferences” | param_key: “oV-Deckungskonzept-ID” and origin: “crm” |
Additional questionnaire mappings
Basic company data
Basic company data (revenue, salary, and #FTE) can be transferred and attached to the customer within the broker forward in the section qasCustProfile
openVIVA reference | TS reference in broker forward | Comment |
|---|---|---|
PER_UMS_GEHALT | “lgs” | Lohn- und Gehaltssumme in cent. So 12.345 EUR needs to be entered as “1234500” |
PER_UMS_UMSATZ | “umsatz” | revenue of the company in cent. So 123.456 EUR needs to entered as “12345600” |
PER_UMS_ANZAHL_MITARBEITER | “anzahl vollzeitmitarbeiter” “anzahl teilzeitmitarbeiter” | No. of full time employees. This can only be an integer. If answer is 1,5 then the number of half-time-employees should be used. 1.5 employees => “anzahl_vollzeitmitarbeiter” : “1” and “anzahl_teilzeitmitarbeiter”: 1 |
PER_UMS_BILANZSUMME | “bilanzsumme” | balance sheet total of the company in cent. So 12.345.678 EUR needs to entered as “1234567800” |
Example see below
Example for broker forward:
{
"type": 1,
"crmIdent": "openVIVAv1",
"bToken": "{{bToken}}",
"bLastName": "{{bLastName}}",
"bFirstName": "{{bFirstName}}",
"bEmail": "{{bEmail}}",
"bExternalId" : "{{bExternalId}}",
"bCompany" : "{{bCompany}}",
"callbackUrl" : "{{callbackUrl}}",
"fullCallback" : 1,
"cFirstName": "Testuser",
"cExternalId": "{{oVVTRPrimaryID}}",
"cLastName": "cu",
"cEmail": "cust@mer3.com",
"cExternalReferences": [
{
"origin": "crm",
"paramKey": "oV-Kunden-Nr",
"paramValue": "12345"
},{
"origin": "crm",
"paramKey": "oV-Partner-Nr",
"paramValue": "12345"
}
],
"iExternalReferences": [
{
"origin": "crm",
"paramKey": "oV-Vertragsart-ID",
"paramValue": "1021640"
},
{
"origin": "crm",
"paramKey": "oV-Deckungskonzept-ID",
"paramValue": "11052060"
},
{
"origin": "crm",
"paramKey": "oV-Vertrag-ID",
"paramValue": "4342343"
},
{
"origin": "crm",
"paramKey": "oV-Vertrags-Nr",
"paramValue": "4342345"
},
{
"origin": "crm",
"paramKey": "oV-Angebots-Nr",
"paramValue": "4342344"
},
{
"origin": "crm",
"paramKey": "oV-Antrags-Nr",
"paramValue": "4342344"
}
],
"qasCustProfile": {
"categories": [
{
"id": "default",
"questions": [
{
"id": "umsatz",
"answers": [
"12345600"
]
},
{
"id": "lgs",
"answers": [
"1234500"
]
},
{
"id": "anzahl vollzeitmitarbeiter",
"answers": [
"1"
]
},
{
"id": "anzahl teilzeitmitarbeiter",
"answers": [
"2"
]
},
{
"id": "bilanzsumme",
"answers": [
"1234567800"
]
}
]
}
],
"source": "crm"
}
}