DBSyncModule Extension

The DBSyncModule AgileConnector extension allows you to synchronize custom user and group database tables with AgilePoint groups automatically.

Background and Setup

To configure an AgileConnector, do the procedure in this topic.

Prerequisites

AgilePoint NX OnPremises or AgilePoint NX PrivateCloud.
The AgilePoint System User (as defined in the AgilePoint Server Configuration Utility) should be a Database user.
AgilePoint Server's Application Pool's Identity user account (as configured in IIS) needs to have read permissions for the appropriate database.

Good to Know

Group Member Synchronization Rules:
- Only groups that have already been added into AgilePoint will be synchronized with the database. New groups will be added automatically to AgilePoint when the group name starts with a Group prefix value. The new groups will automatically be assigned to the default "Users" Role. If a group prefix value is empty, then new groups can be added manually through the Enterprise Manager interface.
- The changes of user members (adding or removing) in the database will be synchronized to AgilePoint but the changes in AgilePoint groups will NOT be synchronized back to the database.
- The synchronization only applies to member association (Add or Remove) within the groups.
- When a new member is added to the database, this member will also be added to the corresponding AgilePoint group. If the actual user entity is not registered in AgilePoint yet, the user entity will be registered to AgilePoint automatically.
- When a member is removed from the database, this member in the corresponding AgilePoint group will also be removed. The actual user entity will NOT be removed from AgilePoint as the same user entity can also be associated with other groups in the system.
User Synchronization Rules:
- Changes to the following database field properties will be synchronized to AgilePoint. Other properties will NOT be synchronized.
  - Full Name
  - Email Address
  - Department
  - Title
  - Manager

How to Start

On the AgilePoint Server machine, in Windows Explorer, right-click the file (AgilePoint Server installation folder) C:\Program Files\AgilePoint\AgilePoint Server\WCFConfigurationUtility.exe, and click Run as Administrator.
On the AgilePoint Server Manager screen, in the left pane, select your AgilePoint Server instance.
Click Open Server Configuration .
On the AgilePoint Server Configuration screen, click the Integrations tab.

Enable the DBSyncModule Extension

To enable the DBSyncModule AgileConnector, do the procedure in this topic.

How to Start

On the AgilePoint Server Configuration screen, in the Integrations tab, click Add.

Procedure

Click Browse, and add the assembly (AgilePoint Server installation folder) C:\Program Files\AgilePoint\AgilePoint Server\bin\DBSyncModule.dll
Leave the Impersonator field blank.
Click OK.

Configure Database Sync AgileConnector > DB Sync Config tab

Synchronizes AgilePoint Users and Groups with the information retrieved from a database query.

Prerequisites

Enable the DBSyncModule Extension AgileConnector.

How to Start

On the AgilePoint Server Configuration screen, in the Integrations tab, select DBSyncModule.
Click Configure.

Fields

Field Name	Definition
Configure	Opens this Screen: Database Configuration screen To Open this Field: You must be using a multi-tenant environment. Function of this Screen: Synchronizes users and groups for a tenant with the user information resulting from a database query.
Database Type	Description: Specifies the database technology to store your data. Allowed Values: MSSQLDatabase MySQLDatabase OracleDatabase Default Value: MSSQLDatabase
Connection String	Description: Specifies the connection string to be used to connect to the database. Allowed Values: A valid connection string. Default Value: server=localhost;database=pubs;trusted_Connection=yes Accepts Variables: Yes Example: server=DataServer;database=StoreDb;trusted_Connection=yes
Query	Description: The SQL query used to fetch the records from the database. Allowed Values: A valid SQL query. The query must fetch the following fields, which are mandatory: TITLE USER_NAME FULL_NAME DEPARTMENT EMAIL_ADDRESS MANAGER GROUP_NAME
Verify	Function: Verifies whether the specified query and connection string are valid.

Configure Database Sync AgileConnector > DB Sync Config tab (Multi-tenant Environment)

Synchronizes users and groups for a tenant with the user information resulting from a database query.

Database Configuration screen — Figure: Configure Database Sync AgileConnector > DB Sync Config tab (Multi-tenant Environment)

Prerequisites

Enable the DBSyncModule Extension AgileConnector.
To access this screen, you must have a multi-tenant environment.

Fields

Field Name	Definition
Tenant	Description: Specifies the tenant name. Allowed Values: List of your enabled tenant names. Default Value: None
Database Type	Description: Specifies the database technology to store your data. Allowed Values: MSSQLDatabase MySQLDatabase OracleDatabase Default Value: MSSQLDatabase
Connection String	Description: Specifies the connection string to be used to connect to the database. Allowed Values: A valid connection string. Default Value: server=localhost;database=pubs;trusted_Connection=yes Accepts Variables: Yes Example: server=DataServer;database=StoreDb;trusted_Connection=yes
Query	Description: The SQL query used to fetch the records from the database. Allowed Values: A valid SQL query. The query must fetch the following fields, which are mandatory: TITLE USER_NAME FULL_NAME DEPARTMENT EMAIL_ADDRESS MANAGER GROUP_NAME
Add	Function: Creates a row where you can specify your tenant name, connection string and query.
Verify	Function: Verifies whether the specified query and connection string are valid.
Update	Function: Updates the selected row from the database configuration list.
Delete	Function: Deletes the selected row from the database configuration list.
Delete All	Function: Deletes all rows from the database configuration list.

Configure Database Sync AgileConnector > Sync Options tab

Specifies how often the database users and groups are synchronized.

Fields

Field Name	Definition
Schedule	Function: The frequency for database synchronization. Synchronization can occur every day, week, or month, at a particular time or day.
If Database group member is not AgilePoint user	Description: Specifies what actions to take if a member of your database group is not a registered AgilePoint user. Allowed Values: Register user to AgilePoint automatically - Creates an AgilePoint account for the user using their information in the database. Send email to AgilePoint system user, and do not take any action - Does not create an AgilePoint account for the database user, but sends a notification email to the AgilePoint system user account. Default Value: Register user to AgilePoint automatically
Do not remove users from AgilePoint group, if users are not in Database Group	Description: Specifies if users are not in a database group, whether to delete them from an AgilePoint group. Allowed Values: Selected - Users are not deleted from the AgilePoint group. Deselected - Users are deleted from the AgilePoint group. Default Value: Deselected
Sync all Social Email IDs with Email IDs	Description: Specifies whether to synchronizes users' social account e-mail IDs with AgilePoint users' e-mail IDs. This synchronization occurs each time and Active Directory synchronization occurs. AgilePoint recommends using this option only if all of your users' messaging IDs and email IDs are the same. Allowed Values: Selected - Synchronizes users' social account e-mail IDs with users' e-mail IDs. Deselected - Does not synchronize users' social account e-mail IDs with users' e-mail IDs. Default Value: Deselected
Sync all Social Account Lync IDs with Email IDs	Description: Synchronizes all of your users' Skype for Business IDs with their email IDs. This synchronization occurs each time and Active Directory synchronization occurs. AgilePoint recommends using this option only if all of your users' messaging IDs and email IDs are the same. Allowed Values: Selected - Synchronizes Lync IDs with users' email IDs. Deselected - Does not synchronize Lync IDs with users' email IDs. Default Value: Deselected
Sync all Social Account Viva Engage IDs with Email IDs	Description: Synchronizes Viva Engage IDs with AgilePoint users' email IDs. This synchronization occurs each time and Active Directory synchronization occurs. AgilePoint recommends using this option only if all of your users' messaging IDs and email IDs are the same. Allowed Values: Selected - Synchronizes Viva Engage IDs with users' email IDs. Deselected - Does not synchronize Viva Engage IDs with users' email IDs. Default Value: Deselected
Sync all Social Account Salesforce (Chatter) IDs with Email IDs	Description: Synchronizes Salesforce Chatter IDs with AgilePoint users' email IDs. This synchronization occurs each time and Active Directory synchronization occurs. AgilePoint recommends using this option only if all of your users' messaging IDs and email IDs are the same. Allowed Values: Selected - Synchronizes Salesforce Chatter IDs with users' e-mail IDs. Deselected - Does not synchronize Salesforce Chatter IDs with users' e-mail IDs. Default Value: Deselected