With the GivePulse-Anthology Engage Integration, existing groups in Anthology Engage can be mapped and synced to groups in GivePulse. This streamlined process enables group admins to more easily manage membership rosters between platforms.
This article will cover the following:
- Important Information to Review Before Setting up Group Membership Syncing
- How to Set up Group Membership Syncing
- How to Map an Anthology Engage Group to a GivePulse Group
- How to Push a Manual Sync
- How to Remove Members from your Organization in Anthology Engage
Important Information to Review Before Setting up Group Membership Syncing
Please review the notes below before setting up membership syncing between Anthology Engage and GivePulse.
- Before syncing groups from the Engage platform ensure the group rosters are up to date with current student members. You want to avoid syncing student users that are no longer enrolled or active. We recommend you focus on syncing groups actively engaged in the community.
- Syncing these groups updates information in GivePulse to match Anthology Engage, including users, user memberships roles, group details (title, description, address, etc.). During membership sync, the system uses email and SSO username to locate existing users.
-
-
- If a user isn't found, a new user is created and added to the GivePulse group.
- If a member is removed from an Engage group, they're also removed from the GivePulse group.
- When an Engage group is marked inactive, it's marked as administrative in GivePulse.
-
-
How to Set up Group Membership Syncing
Please follow the steps below to enable group membership syncing within your GivePulse instance:
Generate a New Admin for API Calls
- Generate a new admin user solely for API calls, such as
example-api@xxxx.edu
and be sure to assign a strong password. - Generate a consumer key/secret on the GivePulse API page. Combine this information with the previously created email and password. Then, attempt to obtain a Bearer Token by sending a POST request to
https://api2.givepulse.com/auth
- If successful, you're all set. If not, review either step 1 or step 2, as there may have been an error.
Retrieve API Key from Anthology
Community Administrators in Anthology Engage have access to create an API Key to help set up the subgroup and organization integration.
To create your API key:
- Navigate to your Switchboard,
- Click on Admin,
- Select Configure tab to navigate to the API Keys section.
You will need to Create a New Key, title the API to help you better understand and manage your API keys, use the Live Key, and disable the Restrict to IP setting under access.
Once these settings have been selected you can give the endpoint access to GET Organizations, including Organization Members, Organization Position Holders, and Organizations.
If you have any questions about creating your key, we recommend contacting the Anthology Engage Support Team.
Setting Up the Integration in GivePulse
- From your group dashboard, navigate to More Tools > Engage Integration
- Enter the API Key you obtained from Anthology in the box provided, click Save.
If the key is entered correctly, you'll see 3 dropdown menus as shown below.
- The first dropdown populates with Engage Organizations.
- The second will populate with options to create groups and GivePulse groups.
- The third dropdown populates with only GivePulse groups. The third dropdown is for the placement of the new group.
How to Map an Anthology Engage Group to a GivePulse Group
After the set-up has been completed, admins can begin mapping Engage groups to GivePulse groups.
Note: In GivePulse, memberships roll-up. This means that if you are a member of a subgroup, you will automatically become a member of the parent group. For this reason, we only allow the syncing of "leaf" type groups (groups with no subgroups). If your GivePulse group has multiple subgroups, you will not be able to map Engage organizations under it.
If the Engage group already exists in GivePulse, please follow the instructions below:
- Using the first dropdown menu, first select the Engage organization, with which you'd like to create a sync.
- In the second menu, select the matching GivePulse group and click Save
- If done correctly, you'll see the following in the grid below
If the Engage group does not already exist in GivePulse, please follow the instructions below:
- Using the first dropdown menu, first select the Engage organization, with which you'd like to create a sync.
- In the second menu, select Create new group. (Note: If you want to create all of your Engage organizations as GivePulse groups, you can select Create all groups.)
- In the third column, select the group you'd like this new group to live under in GivePulse.
- Click Save.
How to Push a Manual Sync
All Anthology Engage organizations are synced nightly with GivePulse groups. To manually sync all of the currently mapped groups, you can click Sync All Groups in the top-right corner.
Alternatively, you can sync an individual group via the Actions dropdown in the grid.
When you sync these groups, the following information in GivePulse will be updated to appear as it does in Anthology Engage: users, user memberships roles, group title, group description, group address, etc.
When syncing memberships, the system will use email and SSO username to find an existing user.
- If a user isn't found, a new user is created and added to the GivePulse group.
- If a member is removed from an Engage group, they're also removed from the GivePulse group.
- When an Engage group is marked inactive, it's marked as administrative in GivePulse.
If you opt to remove a connection, the Engage organization and the GivePulse group will no longer be synced.
How to Remove Members from your Organization in Anthology Engage
If an admin or student organization leader needs to make updates to their group roster on Anthology Engage, please click HERE to learn how to complete this process.
Comments
0 comments
Article is closed for comments.