NOTE: This Higher Logic Technical Worksheet is intended for customers with Engagement Platform for Members.
The technical integration framework between your Association Management System (AMS) and Higher Logic is determined by the information received in this technical worksheet. This framework defines how Higher Logic interacts with the data in your AMS to create:
- member profiles,
- security groups,
- communities, and
- events.
After the integration is established, a periodic check (Periodic Refresh) for changed records in your AMS, coupled with a refresh of each updated record (Member Refresh) yields a robustly integrated ecosystem. The Periodic Refresh and Member Refresh ensure that Higher Logic has the most-up-to-date member data.
Complete the information below, providing as much detail as possible. Contact your project manager if you have any questions.
Section I: API access
Create an API account in YourMembership.
- Under Content & Settings, go to Admin Accounts > Administrators.
- Click on the API Accounts.
- Create a New API Account.
- Set the account name to HL Rest API and leave Date expires blank.
When the account has been created, record the following information below.
YM API URL: https://ws.yourmembership.com/Ams/
Username | |
Password | |
ClientID * | |
YM base domain ** |
* ClientID is found on the REST API Configuration Details page.
** YM base domain is found in YM Admin under Content & Settings > Website Settings > Website Configuration. Ex. <ymbasedomain>.site-ym.com.
Section II: Importing records and granting member status
Higher Logic syncs all active records or a subset of active records in your AMS based on the information provided in this worksheet.
During the sync, Higher Logic uses data that is retrieved from your AMS to create Security Groups in your Community site; these are usually based on Member Types.
- Security Groups make it possible for site administrators to restrict access to pages and/or communities to subsets of users.
- Security Groups also grant member status in your Community site. Those that do are grouped into a larger Security Group called IsMember, which administrators can use to easily restrict access to all members at large.
Do you want to sync all active records in YM? Yes | No
- If Yes, list only the Member Type Codes that should grant member status.
- If No, list the Member Type Codes that you want to sync and indicate which should grant member status.
MemberTypeCode | Grant member status? |
Example: Alum | Y |
Example: NMB | N |
Example: STF | Y |
Section III: Expiration date and grace period options
By default, Higher Logic uses a record's MembershipExpiry as the end date to their security group membership. In most cases, the user will no longer have access to your Community site when their end date is reached.
Should Higher Logic apply a grace period to extend users' access past MembershipExpiry? | Yes | No |
If Yes, how many days should be applied? |
Section IV: Groups
By default, Higher Logic syncs all groups in YM in a hidden state. Your site administrators will have the ability to unhide and launch communities within the Higher Logic admin portal.
Section V: Events
Events listed in your AMS can be synced as hidden communities that are populated with registrants who are allowed to access the community site and/or as calendar events.
Event information is synced from YourMembership to your Community site once per day.
- Create communities for events? Yes | No
- Create a calendar for events? Yes | No
Section VI: Profile
Member contact information (e.g., name, company address, etc.) is integrated from your AMS to create profiles. By default, the Emp address fields are synced.
- Sync profile pictures? Yes | No
Section VII: Custom demographics (optional)
In addition to contact details, custom demographics can be synced from YourMembership to Higher Logic. List the custom demographics that you want to sync. For each, indicate if the field prompts users to pick from a predefined list (PL) or enter their own values (FF).
FieldCode | Pick List (PL) or Free Form (FF) |
Example: CustomField1 | FF |
Example: CustomField2 | PL |
Section VIII: Single Sign-On
NOTE: Are you planning an SSO implementation with Higher Logic? If so, your implementation project may require a one-time fee for configuration and testing. Reach out to us to learn more.
Create an OAuth Client App by going to General Settings > API Configuration and clicking on the OAuth Management link at the top.
- Click on Add Client App.
- Change the name to Higher Logic.
- Record the Client App ID and Client App Secret in the fields below.
- Set the Redirect URIs to: {livesiteurl}/higherlogic/security/membersso/callback.
- Check the Full Profile.
- Toggle the Active button to yes.
- Fill out the information under the Information tab with your organization's contact information.
- Provide a test user's credentials below.
Client App ID | |
Client App Secret | |
Test User Username | |
Test User Password | |
Test User Member ID |