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

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

  1. 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.

    Configuration Utility Run As Administrator Screen
  2. On the AgilePoint Server Manager screen, in the left pane, select your AgilePoint Server instance.

    Select AgilePoint Server Intance
  3. Click Open Server Configuration Open Server Configuration icon.

    Click Open Server Configuration
  4. On the AgilePoint Server Configuration screen, click the Integrations tab.

    Click Integrations Tab

Enable the DBSyncModule Extension

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

How to Start

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

    Click Add

Procedure

  1. Click Browse, and add the assembly (AgilePoint Server installation folder) C:\Program Files\AgilePoint\AgilePoint Server\bin\DBSyncModule.dll

    Click Browse
  2. Leave the Impersonator field blank.

    Leave Blank
  3. Click OK.

Configure Database Sync AgileConnector > DB Sync Config tab

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

Figure: Configure Database Sync AgileConnector > DB Sync Config tab

Configure Database Sync AgileConnector DB Sync Config tab

Prerequisites

How to Start

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

    Select DBSync Module
  2. Click Configure.

    Click Configure

Fields

Field NameDefinition

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
Function:
Specifies the database technology to store your data.
Accepted Values:
  • MSSQLDatabase
  • MySQLDatabase
  • OracleDatabase
Default Value:
MSSQLDatabase

Connection String
Function:
Specifies the connection string to be used to connect to the database.
Accepted Values:
A valid connection string.
Default Value:
server=localhost;database=pubs;trusted_Connection=yes
Accepts Process Data Variables:
Yes
Example:
server=DataServer;database=StoreDb;trusted_Connection=yes

Query
Function:

The SQL query used to fetch the records from the database.

Accepted 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.

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

Database Configuration screen

Prerequisites

Fields

Field NameDefinition

Tenant
Function:
Specifies the tenant name.
Accepted Values:
List of your enabled tenant names.
Default Value:
None

Database Type
Function:
Specifies the database technology to store your data.
Accepted Values:
  • MSSQLDatabase
  • MySQLDatabase
  • OracleDatabase
Default Value:
MSSQLDatabase

Connection String
Function:
Specifies the connection string to be used to connect to the database.
Accepted Values:
A valid connection string.
Default Value:
server=localhost;database=pubs;trusted_Connection=yes
Accepts Process Data Variables:
Yes
Example:
server=DataServer;database=StoreDb;trusted_Connection=yes

Query
Function:

The SQL query used to fetch the records from the database.

Accepted 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.

Figure: Configure Database Sync AgileConnector > Sync Options tab

Configure Database Sync AgileConnector Sync Options tab

Fields

Field NameDefinition

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
Function:
Specifies what actions to take if a member of your database group is not a registered AgilePoint user.
Accepted 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
Function:
Specifies if users are not in a database group, whether to delete them from an AgilePoint group.
Accepted 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
Function:
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.

Accepted 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
Function:
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.

Accepted 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 Yammer IDs with Email IDs
Function:
Synchronizes Yammer 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.
Accepted Values:
  • Selected - Synchronizes Yammer IDs with users' email IDs.
  • Deselected - Does not synchronize Yammer IDs with users' email IDs.
Default Value:
Deselected

Sync all Social Account Salesforce (Chatter) IDs with Email IDs
Function:
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.
Accepted 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