SPSyncModule Extension

This AgilePoint Server extension (AgileConnector) allows you to synchronize SharePoint site collection groups with AgilePoint groups automatically.

This extension is optional.

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 SharePoint. New SharePoint groups will be added automatically to AgilePoint only if the group prefix value is not empty and the new SharePoint 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 SharePoint groups will be synchronized to AgilePoint but the changes in AgilePoint groups will NOT be synchronized back to the SharePoint groups.
    • The synchronization only applies to member association (Add or Remove) within the groups. Group properties such as names and descriptions are NOT synchronized.
    • When a new member is added to SharePoint group, 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 SharePoint group, 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 SharePoint User 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.
  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.

Configure the SPSyncModule Extension

To configure the SPSyncModule 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. Browse one of the following locations to open the file SPSyncModule.dll:
    • For IIS installations, this file is located in the bin folder under the AgilePoint Server installation folder.
    • For Windows Service installations, this file is located in the bin folder under the path provided in the Location field in Windows Server Manager for the Windows Service instance you want to configure.
  2. Leave the Impersonator field blank.
  3. Click OK.

    Now you will need to configure the module to schedule the synchronization.

  4. Click the Configure button, and specify the desired configuration settings.

    In the configuration interface, you can specify the SharePoint site for which you want to synchronize the groups; you can also optionally provide the site prefix and group prefix. You can also 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. The synchronization module also provides the option of registering the users automatically or sending an alert email to AgilePoint system user if there are members in the SharePoint groups that have yet to be registered in AgilePoint.

  5. Provide a valid SharePoint Site URL, for example http://[hostname]:[port]/sites/MySite.
  6. The Site Prefix field is optional.

    In a case where two site collections are configured, then groups with a common name can be distinguished using this property. For example Site "A" has a group called "Employees" and Site "B" also has a group called "Employees". In AgilePoint, you can create two groups "SiteA_Employees" corresponding to Employees group in site A and "SiteB_Employees" corresponding to siteB's Employees. So while configuring Site A mention "SiteA_" in site prefix so that it will sync with "SiteA_Employees" during the synchronization process and for site B mention "SiteB_" in site prefix so that it sync's with "SiteB_Employees".

  7. The "Group Prefix" field is optional.

    This property is used in case a new group is created in SharePoint and you want that group to be created in AgilePoint. If a group prefix is not empty, then all the groups created in SharePoint starting with a Group prefix value will be created in AgilePoint during the Synchronization process. For example, the group prefix value is set as "GR_" then all the new groups in SharePoint starting with GR_ will be created and synced during the synchronization process.

  8. The Schedule section is used to schedule the frequency of synchronization.

    You can configure Synchronization frequency to sync daily (Every Day) at a particular time, or Weekly (Every Week), or Monthly (Every Month).

  9. The Option section provides an option to select what action needs to be taken when a SharePoint group 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 SharePoint Groups Synchronization screen

Specifies how to synchronize SharePoint groups with AgilePoint groups.

Figure: Configuration for SharePoint Groups Synchronization screen

Configuration for SharePoint Groups Synchronization screen

Prerequisites

How to Start

  1. On the AgilePoint Server Configuration screen, in the Integrations tab, select SPSyncModule.
  2. Click Configure.

Fields

Field NameDefinition

Configure
Opens this Screen:
SharePoint Groups Synchronization screen
To Open this Field:
You must be using a multi-tenant environment.
Function of this Screen:
Specifies how to synchronize SharePoint groups with AgilePoint groups within a tenant.

Site URL
Description:
Specifies the URL for your SharePoint site.
Allowed Values:
A valid SharePoint site URL.
Default Value:
None
Accepts Variables:
Yes
Example:
http://mysharepoint:8000/sites/${mysite}

Site Prefix
Function:

Distinguishes a site with the specified name prefix in two site collections during the synchronization process.

Allowed Values:
One line of text (a string).

Not Accepted:

  • Spaces
Default Value:
None
Example:
Two sites, Site A and Site B, each have a group called "Employees." In AgilePoint, you can create two groups: "SiteA_Employees" and "SiteB_Employees." While configuring site A, enter "SiteA_" in the Site Prefix so this site syncs with "SiteA_Employees." While configuring Site B, enter "SiteB_" in Site Prefix so this site syncs with "SiteB_Employees".

Group Prefix
Function:

Indicates that all the groups in SharePoint starting with a specified prefix in the group name are created in AgilePoint during the synchronization process.

Allowed Values:
One line of text (a string).

Not Accepted:

  • Spaces
Default Value:
None
Example:

If the group prefix value is set as GR_ then all the new groups in SharePoint starting with GR_ will be created and synced during the synchronization process.

Schedule
Function:

The frequency for SharePoint synchronization. Synchronization can occur every day, week, or month, at a particular time or day.

If Active Directory group member is not AgilePoint user
Description:
Specifies what actions to take if a member of your Active Directory is not a registered AgilePoint user.
Allowed Values:
  • Register user to AgilePoint automatically - Creates an AgilePoint account for the user using their Active Directory information.
  • Send email to AgilePoint system user, and do not take any action - Does not create an AgilePoint account for the Active Directory 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 SharePoint Group
Description:
Specifies if users are not in a SharePoint 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

SharePoint Groups Synchronization screen

Specifies how to synchronize SharePoint groups with AgilePoint groups within a tenant.

Figure: SharePoint Synchronizer Configuration screen

SharePoint Synchronizer Configuration screen

Prerequisites

  • To access this screen, you must have a multi-tenant environment.

How to Start

  1. On the SharePoint Groups Synchronization screen, click Configure.

Fields

Field NameDefinition

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

Site URL
Description:
Specifies the URL for your SharePoint site.
Allowed Values:
A valid SharePoint site URL.
Default Value:
None
Accepts Variables:
Yes
Example:
http://mysharepoint:8000/sites/${mysite}

Site Prefix
Function:

Distinguishes a site with the specified name prefix in two site collections during the synchronization process.

Allowed Values:
One line of text (a string).

Not Accepted:

  • Spaces
Default Value:
None
Example:
Two sites, Site A and Site B, each have a group called "Employees." In AgilePoint, you can create two groups: "SiteA_Employees" and "SiteB_Employees." While configuring site A, enter "SiteA_" in the Site Prefix so this site syncs with "SiteA_Employees." While configuring Site B, enter "SiteB_" in Site Prefix so this site syncs with "SiteB_Employees".

Group Prefix
Function:

Indicates that all the groups in SharePoint starting with a specified prefix in the group name are created in AgilePoint during the synchronization process.

Allowed Values:
One line of text (a string).

Not Accepted:

  • Spaces
Default Value:
None
Example:

If the group prefix value is set as GR_ then all the new groups in SharePoint starting with GR_ will be created and synced during the synchronization process.

Add
Function:
Creates a row where you can specify your tenant name, site url, site prefix and group prefix.

Update
Function:
Updates the selected row from the SharePoint groups synchronization configuration list.

Remove (-)
Function:
Deletes the selected row from the SharePoint groups synchronization configuration list.

Edit ()
Function:
Modifies the selected row from the SharePoint groups synchronization configuration list.

Delete ()
Function:
Deletes all rows from the SharePoint groups synchronization configuration list.