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 Configuration screen, click the Extensions tab.
Enable the DBSyncModule Extension
To enable the DBSyncModule AgileConnector, do the procedure in this topic.
How to Start
- On the AgilePoint Configuration screen, in the Extensions tab, click Add.
Procedure
- Click the Ellipses button next to the Assembly field and add the assembly (AgilePoint Server installation folder) C:\Program Files\AgilePoint\AgilePoint Server \bin\DBSyncModule.dll
- Leave the Impersonator field blank.
- Click OK. Now you will need to configure the module to schedule the synchronization.
- Click the Configure button, and specify the desired configuration
settings.
In the configuration interface, specify the following information:
- Connection - Provide a valid database connection string.
- Query - Provide the SQL query to fetch records from a
table. The query must fetch the following fields, which are
mandatory:
- TITLE
- USER_NAME
- FULL_NAME
- DEPARTMENT
- EMAIL_ADDRESS
- MANAGER
- GROUP_NAME
To check that the query was set up correctly, click Verify Query.
- Schedule - Specify the synchronization with the frequency of every day, week, or month and at a particular time of day starting with the day you set the schedule.
- Option - This section provides an option to select what action needs to be taken when a database member is not an AgilePoint user. Either one can select to register user to AgilePoint automatically or send a notification to AgilePoint System user.
Configuration for Database Groups/Users Synchronization screen
Synchronizes AgilePoint Users and Groups with the user information resulting from a database query.
Prerequisites
How to Start
- On the AgilePoint Configuration screen, in the Extensions tab, select DBSyncModule.
- Click Configure.
Fields
Field Name | Definition |
---|---|
Configure |
|
Connection String |
|
Query |
|
Verify |
|
Schedule |
|
If Active Directory group member is not AgilePoint user |
|
Do not remove users from AgilePoint group, if users are not in Database Group |
|
Sync all Social Email IDs with Email IDs |
|
Sync all Social Account Lync IDs with Email IDs |
|
Sync all Social Account Yammer IDs with Email IDs |
|
Sync all Social Account Salesforce (Chatter) IDs with Email IDs |
|
Database Configuration screen
Synchronizes users and groups for a tenant with the user information resulting from a database query.
Prerequisites
- To access this screen, you must have a multi-tenant environment.
How to Start
- On the Configuration for Database Groups/Users Synchronization screen, in the Multi-Tenant Database Information section, click Configure.
Fields
Field Name | Definition |
---|---|
Tenant |
|
Connection String |
|
Query |
|
Add |
|
Verify |
|
Update |
|
Remove (-) |
|
Edit () |
|
Delete () |
|