UC Database

Documentation for the usage of the Database contact source

Applicable to version 1.5.0 and above Unified Contacts Pro & Community Edition only

With Unified Contacts 1.5.0 and later you can fill the internal database (UC Database) with contacts from anywhere which can be searched by each of your users.

To fill the database you need to insert your contacts in a specific schema as described below. We also provide a RESTful API for CRUD operations on Database contacts.

We provide two detailed examples in our documentation on how to add contacts to the UC Database leveraging

1. Azure Data Factory as data integration service

2. Our API for CRUD operations

UC Database Documentation

The following documentation explains where to find the UC Database and how the Contacts table is structured.

Database Location

The UC Database (DB) can be found in the resource group in which Unified Contacts Pro was deployed.

If you did not choose a custom name when installing Unified Contacts Pro, the DB-Server is called db-uc- followed by 13 digits and numbers, the DB itself is calledsql-db by default.

To access the DB you will need the user and password you have set when installing Unified Contacts.

Database Contacts Structure

Only alter tables that have the prefix UnifiedContactsCustom. Only alter the content, NEVER change the table schema. Changing data in an unsupported way may degrade or even break Unified Contacts functionality.

Database Contacts are stored in the UnifiedContactsCustom.Contacts Table. You can change the content of this table as you like but DO NOT change the table's schema definition.

Schema Definition

column name	data type	optional?	description	example
id	NVARCHAR(256)		Unique identifier of the contact	sap_28648f3b-8a60-4ded-a2df-5f303a74a17a
displayName	NVARCHAR(256)		DisplayName of the contact	John Doe
jobTitle	NVARCHAR(256)		JobTitle of the contact	Software Developer
department	NVARCHAR(256)		Department of the contact	R&D
companyName	NVARCHAR(256)		Name of company associated with the contact	Fantastic Company Inc.
mailAddresses	NVARCHAR(4000)		Email addresses of the contact. Multiple entries have to be separated with a semicolon (;)	[e-mail];[e-mail]
imAddresses	NVARCHAR(4000)		Instant messaging addresses of the contact. Used for initiating a chat in Teams. If multiple imAddresses are provided, the first one is used to initiate a chat. If not provided the first email address of the contact is used. Multiple entries have to be separated with a semicolon (;)	[e-mail];[e-mail]
mobilePhoneNumbers	NVARCHAR(4000)		Mobile phone numbers of the contact. Multiple entries have to be separated with a semicolon (;)	[phone];[phone]
businessPhoneNumbers	NVARCHAR(4000)		Business phone numbers of the contact. Multiple entries have to be separated with a semicolon (;)	[phone];[phone]
homePhoneNumbers	NVARCHAR(4000)		Home phone numbers of the contact. Multiple entries have to be separated with a semicolon (;)	[phone];[phone]
addressFullString	NVARCHAR(512)		Full address of the contact. If this is set it is used for displaying the address in the contact card. If not set the address is built from the other address properties.	Any Street 1, 12345 Any City, Any Country
addressStreetAddress	NVARCHAR(512)		Street address of the contact	Any Street 1
addressPostalCode	NVARCHAR(512)		Postal code of the contact	12345
addressCity	NVARCHAR(512)		City of the contact	Any City
addressCountry	NVARCHAR(512)		Country of the contact	Any Country
source	NVARCHAR(64)		Sub source of the contact. This is used to identify the source of the contact if you are syncing multiple data sources.	SAP