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” |
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"
}
]
}