Configuring the SPSyncModule Extension

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

This extension is optional.

Prerequisites

  • The AgilePoint System User (as defined in the AgilePoint Server Configuration utility) should be a SharePoint user.
  • AgilePoint Server's Application Pool's Identity user account (as configured in IIS) needs to have read permissions to the SharePoint data.

How to Start

  1. On the AgilePoint Server machine, in Windows Explorer, right-click the file [AgilePoint Server installation folder]\WCFConfigurationUtility.exe, and click Run as Administrator.
  2. On the AgilePoint Server Manager screen, in the left pane, select your AgilePoint Server instance.
  3. Click Open Server Configuration Open Server Configuration icon.
  4. On the AgilePoint Configuration screen, click the Extensions tab.

Procedure

  1. On the Extension tab, click Add.
  2. 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.
  3. Leave the Impersonator field blank.
  4. Click OK.

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

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

  6. Provide a valid SharePoint Site URL, for example http://[hostname]:[port]/sites/MySite.
  7. 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".

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

  9. 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).

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