Universal Connector Integration Details

/wiki/spaces/E2D/pages/29982926 / Workflow Studio / Workflow Studio / Current: Universal Connector Integration Details

EmpowerID provides a Universal Connector that can be used for inventorying and managing resources originating in account stores for which EmpowerID does not provide a specific out of the box connector, like HR systems and custom applications via an Universal Connector database. (EmpowerID currently has out-of-the-box connectors for Active directory, LDAP, Google Apps, Office 365, and others). Using the Universal Connector requires the data in your external system be imported into the Universal Connector database via the technology of your choice—including scripting, an ETL tool like Microsoft SSIS, or code in the language of their choice—according to the schema defined for it by EmpowerID.

To find this topic helpful, you should have a good understanding of SQL and database principles.

Inbound Data

EmpowerID provides the following tables for importing data from an external system to the Universal Connector database. These tables are as follows:

User Table

Field	Data Type	Max Length (Bytes)	Optional	Default	Description

Field	Data Type	Max Length (Bytes)	Optional	Default	Description
UserGUID	uniqueidentifier	16	No	(newid())	Uniquely identifies a user account in EmpowerID. If this field is blank, EmpowerID will generate the guid. This field should never be updated for the life of the record.
UserID	nvarchar(200)	400	No		Specifies the UserID for a user in the external system. This value is derived from the external system and must be unique for each user. This field should never be deleted or updated for the life of the record.
LogonName	nvarchar(200)	400	No		Specifies the logon name for the user account. This value must be unique for each user and can be set to any desired value, such as a user's EmployeeID contained within an external system or a combination of data that can be found, derived or calculated from an external system. If this field is blank, EmpowerID will generate a unique logon name for each user record.
Active	bit	1	No	((1))	Specifies whether a user is active. This field can be used in place of the Status field.
FriendlyName	nvarchar(255)	510	Yes		Specifies the name shown to users in EmpowerID user interfaces. The field maps to the DisplayName attribute in Active Directory.
Name	nvarchar(255)	510	Yes		Specifies the account name. This value should be unique and maps to the CNor DistinguishedName in Active Directory.
FirstName	nvarchar(50)	100	Yes		Specifies the first name of the user and maps to the givenName attribute in Active Directory.
MiddleName	nvarchar(50)	100	Yes		Specifies the middle name of the user and maps to the middleName attribute in Active Directory.
LastName	nvarchar(50)	100	Yes		Specifies the last name of the user. Maps to the LastName field in Active Directory.
Email	nvarchar(255)	510	Yes		Specifies the email address of the user. The value of this field can be used to set the email address of the user in Exchange when an Exchange Resource Entitlement exists. Additionally, this field is used by EmpowerID to determine whether the specific user account needs to be joined to an EmpowerID Person. For more information, see Overview of the Account Inbox.
EmployeeID	nvarchar(50)	100	Yes		Specifies the Employee ID of the user in the external system and will set the EmployeeID attribute of the user in Active Directory. When used, this value must be unique for each user. Additionally, this field is used by EmpowerID to determine whether the specific user account needs to be joined to an EmpowerID Person. For more information, see Overview of the Account Inbox.
BusinessRoleID	nvarchar(200)	400	Yes		Specifies the Business Role ID of the Business Role associated with the user in EmpowerID. When populating Business Role data, you can elect to set this field or the BusinessRoleName field. If BusinessRoleID is selected, this field will be set to the ID of the corresponding Business Role in the Business Role table of the EmpowerID Identity Warehouse. If the user does not have a Business Role, both fields can be left blank. If the user has more than one Business Role and Location, the UserBusinessRoleLocation table can used instead of, or in conjunction with, this field as EmpowerID performs a union of the Business Role and Location data in the User table and the Business Role and Location data in the UserBusinessRoleLocation table. If this field is left blank and multiple entries exist in the UserBusinessRoleLocation table for a specific user, the record with the lowest priority will be set as the primary Business Role. EmpowerID uses this information for the following processes: RBAC: People belong to mapped Business Roles and Locations. Role and Location Compiler and Role and Location Processor Jobs: These jobs will change a Person's primary Business Role and Location, as well as remove secondary Locations based on Business Role and Location mappings.
BusinessRoleName	nvarchar(200)	400	Yes		Specifies the Business Role Name of the Business Role associated with the user in EmpowerID. When populating Business Role data, you can elect to set this field or the BusinessRoleID field. If BusinessRoleName is selected, this field will be set to the name of the corresponding Business Role in the Business Role table of the EmpowerID Identity Warehouse. If the user does not have a Business Role, both fields can be left blank. If the user has more than one Business Role and Location, the UserBusinessRoleLocation table can used instead of, or in conjunction with, this field as EmpowerID performs a union of the Business Role and Location data in the User table and the Business Role and Location data in the UserBusinessRoleLocation table. If this field is left blank and multiple entries exist in the UserBusinessRoleLocation table for a specific user, the record with the lowest priority will be set as the primary Business Role. EmpowerID uses this information for the following processes: RBAC: People belong to mapped Business Roles and Locations. Role and Location Compiler and Role and Location Processor Jobs: These jobs will change a Person's primary Business Role and Location, as well as remove secondary Locations based on Business Role and Location mappings.
LocationID	nvarchar(200)	400	Yes		Specifies the ID of the Location associated with the user in EmpowerID. When populating Location data, you can elect to set this field or the LocationNamefield. If LocationID is selected, this field will be set to the ID of the corresponding Location in the Location table of the EmpowerID Identity Warehouse. If the user does not have a Location, both fields can be left blank. If the user has more than one Location, the UserBusinessRoleLocation table can used instead of, or in conjunction with, this field as EmpowerID performs a union of the Business Role and Location data in the User table and the Business Role and Location data in the UserBusinessRoleLocation table. If this field is left blank and multiple entries exist in the UserBusinessRoleLocation table for a specific user, the record with the lowest priority will be set as the primary Location. EmpowerID uses this information for the following processes: RBAC: People belong to mapped Business Roles and Locations. Role and Location Compiler and Role and Location Processor Jobs: These jobs will change a Person's primary Business Role and Location, as well as remove secondary Locations based on Business Role and Location mappings.
LocationName	nvarchar(200)	400	Yes		Specifies the name of the Location associated with the user in EmpowerID. When populating Location data, you can elect to set this field or the LocationID field. If LocationName is selected, this field will be set to the name of the corresponding Location in the Location table of the EmpowerID Identity Warehouse. If the user does not have a Location, both fields can be left blank. If the user has more than one Location, the UserBusinessRoleLocation table can used instead of, or in conjunction with, this field as EmpowerID performs a union of the Business Role and Location data in the User table and the Business Role and Location data in the UserBusinessRoleLocation table. If this field is left blank and multiple entries exist in the UserBusinessRoleLocation table for a specific user, the record with the lowest priority will be set as the primary Location. EmpowerID uses this information for the following processes: RBAC: People belong to mapped Business Roles and Locations. Role and Location Compiler and Role and Location Processor Jobs: These jobs will change a Person's primary Business Role and Location, as well as remove secondary Locations based on Business Role and Location mappings.
ManagerLogonName	nvarchar(200)	400	Yes		Specifies the LogonName of the user's manager, if any. If populated, the field will be used to set the user's direct manager in EmpowerID. When populating user manager data, you can elect to set this field or the ManagerAccountIDfield. If the user does not have a manager, both fields can be left blank.
ManagerAccountID	nvarchar(200)	400	Yes		Specifies the User ID of the user's manager, if any. If populated, the field will be used to set the user's direct manager in EmpowerID. When populating user manager data, you can elect to set this field or the ManagerLogonNamefield. If the user does not have a manager, both fields can be left blank.
Telephone	nvarchar(50)	100	Yes		Specifies the primary telephone number of the user's place of business and and maps to the telephoneNumber attribute in Active Directory.
MobileNumber	nvarchar(50)	100	Yes		Specifies the mobile number of the user and maps to the mobile attribute in Active Directory.
BusinessPhone	nvarchar(50)	100	Yes		Specifies the business telephone number of the user.
HomePhone	nvarchar(50)	100	Yes		Specifies the home telephone number of the user and maps to the homePhone attribute in Active Directory.
StreetAddress	nvarchar(255)	510	Yes		Specifies the street address of the user and maps to the streetAddress attribute in Active Directory.
StreetAddress2	nvarchar(255)	510	Yes		Specifies a secondary street address of the user.
City	nvarchar(100)	200	Yes		Specifies the city where the user is located and maps to the l attribute in Active Directory.
State	nvarchar(100)	200	Yes		Specifies the state where the user is located and maps to the st attribute in Active Directory.
Country	nvarchar(50)	200	Yes		Specifies the country where the user is located and maps to the co attribute in Active Directory.
Province	nvarchar(100)	200	Yes		Specifies the province where the user is located.
Company	nvarchar(256)	512	Yes		Specifies the user's company name and maps to the company attribute in Active Directory.
Department	nvarchar(256)	512	Yes		Specifies the user's department name and maps to the department attribute in Active Directory.
DepartmentNumber	nvarchar(50)	100	Yes		Specifies the user's department number and maps to the departmentNumber attribute in Active Directory.
OfficeLocation	nvarchar(450)	900	Yes		Specifies the location or address of the user's office and maps to the physicalDeliveryOfficeName attribute in Active Directory.
Location	nvarchar(450)	900	Yes		Specifies the user's location within an organization, such as their office number and maps to the location attribute in Active Directory.
Division	nvarchar(450)	900	Yes		Specifies the user's division and maps to the division attribute in Active Directory.
PersonalTitle	nvarchar(255)	510	Yes		Specifies the user's personal title, such as "Mr", "Mrs" or "Ms." This field maps to the personalTitle attribute in Active Directory
Description	nvarchar(255)	510	Yes		Specifies a description for the user and maps to the description attribute in Active Directory.
SecondLastName	nvarchar(50)	100	Yes		Specifies a second last name for the user, where such is used.
GenerationalSuffix	nvarchar(10)	20	Yes		Specifies a generational suffix for the user, such as "JR" or "SR." This field maps to the generationQualifier attribute in Active Directory.
Initials	nvarchar(6)