Configure the Plug-In Files for CIV

Configuring the CIVEnrollment.properties Plug-In

This plug-in enables you to customize CIV Commercial Identity Verification Enrollment configuration.

Open the CIVEnrollment.properties file in the %PROGRAMDATA%\HID Global\Credential Management System\Shared Files\ directory.

Update the attributes as per your requirement (see Configuring the PIVEnrollment.properties Plug-In).

The following code displays the CMS Link Parameters section from the default configuration.

Copy

# Input CMS Link Parameters
#---------------------------------------------------------
linkParameters = UserID,CUID,FullName,OrganizationalAffiliation1,OrganizationalAffiliation1,GUID,IssuerIdentification,IssuerIdentification,policyoncardkeys
# Metadata Database Config
#---------------------------------------------------------
metadataStore = CUID,Photo
metadata.key = UserID

Configuring the CIVNotification.properties Plug-In

This plug-in enables you to customize CIV Notification configuration.

Open the CIVNotification.properties file in your %PROGRAMDATA%\HID Global\Credential Management System\Shared Files\ directory.

Update the directory-related attributes as per your requirement (see Configuring the PIVNotification.properties Plug-In).

The following code displays a section from the default configuration.

Copy

metadata.key = UserID
 
# Event Notification
#---------------------------------------------------------
delete.events = 10001.SUCCESS
 
notify.class = com.actividentity.civ.notify.SimpleNotifier 
notify.destinations = testdestination1,testdestination2
notify.events = 10001

Configuring the generic_plugin.properties Plug-In

Open the generic_plugin.properties file in your %PROGRAMDATA%\HID Global\Credential Management System\Shared Files\ directory.

Update the civ.link attribute according to your directory type as indicated in the following tables.

Important: If you have configured ActivID CMS to work with more than one type of directory, you may need to specify the directory type by adding a suffix with the directory short name to the civ.link attribute (for example, civ.link.msft-ad). For details about the directory short names, see Configuring the Generic Plugin.

Some attributes depend on the directory that is used. The first attribute (uid/sAMAccountName/cn) must be the same directory attribute name that is configured in ActivID CMS for “userID”. The third attribute must match the user’s full name (for example, displayName for Microsoft). The sixth attribute must correspond to a universally unique identifier, for example ObjectGUID for Microsoft directories or entryUUID for OpenLDAP directories. The full correspondence is displayed in the table below:

Directory Type	Entry UUID
Microsoft Active Directory	ObjectGUID
IBM Tivoli Directory Server / Novell eDirectory (UID) / Oracle Directory Server	ibm-entryuuid
Critical Path / Siemens DirX	entryUUID
Microsoft LDS	ObjectGUID
Novell eDirectory (UniqueID)	entryUUID
OpenLDAP	entryUUID

‘civ.link’ Attribute Examples
Directory Type	Attributes
Microsoft^® Active Directory	sAMAccountName:str,card#cuid:str,displayName:str,o:str,company:str,objectGUID:str,o:str,company:str,policy#oncardkeys:str,jpegPhoto:bin,policy#discoveryobject:str,content#DiscoveryObjectValue:str
IBM^® Tivoli Directory Server / Novell^® eDirectory (UID) / Oracle^® Directory Server	uid:str,card#cuid:str,cn:str,o:str,company:str,ibm-entryuuid:str,o:str,company:str,policy#oncardkeys:str,jpegPhoto:bin,policy#discoveryobject:str,content#DiscoveryObjectValue:str
Critical Path^® / Siemens^® DirX	cn:str,card#cuid:str,cn:str,o:str,company:str,entryUUID:str,o:str,company:str,policy#oncardkeys:str,jpegPhoto:bin,policy#discoveryobject:str,content#DiscoveryObjectValue:str
Microsoft^® Lightweight Directory Services	uid:str,card#cuid:str,cn:str,o:str,company:str,objectGUID:str,o:str,company:str,policy#oncardkeys:str,jpegPhoto:bin,policy#discoveryobject:str,content#DiscoveryObjectValue:str
Novell^® eDirectory (UniqueID)	uniqueID:str,card#cuid:str,cn:str,o:str,company:str,entryUUID:str,o:str,company:str,policy#oncardkeys:str,jpegPhoto:bin,policy#discoveryobject:str,content#DiscoveryObjectValue:str
OpenLDAP	uid:str,card#cuid:str,cn:str,o:str,company:str,entryUUID:str,o:str,company:str,policy#oncardkeys:str,jpegPhoto:bin,policy#discoveryobject:str,content#DiscoveryObjectValue:str

The following code displays the default configuration for the CIV section in the generic_plugin.properties file.

Copy

# CIV Enrollment Plug-in
civ.link=sAMAccountName:str,card#cuid:str,displayName:str,o:str,company:str,objectGUID:str,o:str,company:str,policy#oncardkeys:str,jpegPhoto:bin,policy#discoveryobject:str,content#DiscoveryObjectValue:str