This article provides information on installing and implementing the Higher Logic bridge for iMIS EMS/20.3.
The bridge is used to synchronize data from your iMIS database to Higher Logic for use with your Higher Logic Thrive Marketing Professional (Thrive Marketing Professional) account, and it allows Thrive Marketing Professional to write data to your iMIS database.
Integration support
IMPORTANT: Some of the steps in this article present optional customizations within your iMIS database that Higher Logic does not perform; these are noted accordingly.
Your iMIS solution provider or consultant, if you have one, should be able to assist with these customizations, possibly for a fee.
If you don't have an iMIS solution provider or consultant, consider Association Technology Solutions (ATS) or consult the iMIS Partner Directory.
Important notes
- The Contact and Groups IQAs should never be edited because Higher Logic checks them for specific values that are important to your integration.
- The Mailing List folder has some default marketing lists. You can add IQAs to this folder for segmentation of new lists.
- All IQAs for lists must return only the Contact ID (aliased as ID) and email address.
- There are two folders for managing the integration of Panel fields as custom Personalizations/Demographics for Higher Logic.
- These are optional but must be configured by following the instructions below in order to sync any custom fields.
Installation
Import Standard IQA and Business object files.
Before importing any files, verify that there is a HigherLogic folder in the IQA folder system.
- If there is not a HigherLogic folder, create it. (Note the absence of a space in the name.)
- If there is a folder, make a copy of it and rename it in order to preserve any custom IQAs already written.
There are three files that must be imported:
- Import1_ValueLists.xml - creates a lookup query for the ATS_Events business object.
- Import2_Bos.xml - creates the business objects needed for the default Higher Logic IQAs.
- Import3_IQAs.xml - creates the default queries based on the custom ATS business objects.
IMPORTANT: These file names are so numbered because they must be imported in the order specified below.
1 - Import 1_ValueLists.xml
This creates a lookup query for the HL_Events business object.
- Navigate to RiSE > IQA.
- Click Import.
- Select the file, Import1_ValueLists.xml; click Upload.
- Uncheck the Overwrite existing objects box.
- Click Import. (When the file is imported, a message appears in the messages box.)
- Click Close.
2 - Import 2_Bos.xml
This creates the business objects that are needed for the default Higher Logic IQAs.
- Navigate to RiSE > Business Object Designer.
- Click Import.
- Select the file, Import2_Bos.xml; click Upload. (This can take a few minutes.)
- Uncheck the Overwrite existing objects box.
- Click Import. (When file is imported, a message appears in the messages box.)
- Use the quick find feature to search for ATS.
- Select all HL_ objects (except HL_LastUpdate) and click Publish.
- Select HL_LastUpdate and click Publish.
3 - Import 3_IQAs.xml
This creates the default queries based on the custom ATS business objects.
- Navigate to RiSE > IQA.
- Click Import.
- Select the file, Import3_IQAs.xml; click Upload.
- Uncheck the Overwrite existing objects box.
- Click Import. (When the file is imported, a message appears in the messages box.)
- Click Close.
4 - Test default queries
- Navigate to RiSE > IQA > HigherLogic > Contacts > Contacts.
- Click Run.
- Optionally, specify any preferred parameters.
- Click Find.
5 - Update Custom Demographics IQAs (optional)
The IQAs in the CustomDemographics folder are set to ASI default demographic panels. In most cases, this will not be useful to you. You must identify which panels/Business Objects and fields you want to report on and add them to the correct IQA. (Your iMIS solution provider or consultant should be able to assist with this.)
- The Pick IQA is used for custom fields with a dropdown selection.
- The FreeForm IQA is used for custom fields with open text.
- The Multi-Pick IQA is used for multi-select fields (this is uncommon). The field will be comma delimited.
Create Higher Logic activity for writebacks
The writeback feature from Higher Logic to iMIS EMS uses the standard Activity table. If implemented, the Activity Type must be added; then a panel can be created and placed on a RiSE page as part of the Staff_Account_Page used in the iMIS EMS Staff site. All Higher Logic writeback activities will arrive as "HLOGIC" Activity Objects in iMIS and the Product_Code value will be the distinction on what type of writeback the activity is.
NOTE: Panels must be created on your site (they cannot be imported).
Configure a Thrive Marketing Professional activity writeback
- In your Thrive Marketing Professional account, navigate to Settings > Setup > Bridge Configuration (UPI Only).
- Click Writeback Settings, then select Enable Mail Activity Writeback.
- Choose whether to write sends and opens to iMIS.
- Choose the writeback frequency.
- Recommend Automatic, and Daily
- Click Save.
Configure a Community activity writeback
- Set up the activity writeback as part of configuring the OC Middle Provider.
- These activities will be written to iMIS along with the Thrive Marketing Professional activities.
Higher Logic IQAs - Data Contract
Contact
This is the standard installed IQA that is used by Higher Logic's EMS integration to populate the contact and related fields.
IMPORTANT: This IQA should not be edited under any circumstances. If it is edited, it will have to be removed and reinstalled.
$/HigherLogic/Contacts/Contacts
Higher Logic Contact Field | IQA Field Name |
---|---|
AlternativeContactId | AlternativeContactId |
Birthday | Birthday |
ContactType | ContactType |
Designation | Designation |
DoNotEmail | DoNotEmail |
ExcludeFromDirectory | ExcludeFromDirectory |
FirstName | FirstName |
Gender | Gender |
InformalName | InformalName |
IsMember | IsMember |
IsOrganization | IsOrganization |
LastName | LastName |
MemberExpiresOn | MemberExpiresOn |
MemberSince | MemberSince |
MiddleName | MiddleName |
OrganizationName | OrganizationName |
ParentContactId | ParentContactId |
PrefixCode | Prefix |
PrimaryEmailAddress | PrimaryEmailAddress |
SuffixCode | Suffix |
Title | Title |
WebsiteURL | WebsiteURL |
ContactAddress
Address info should be returned in the Contacts IQA ($/HigherLogic/Contacts/Contacts).
Higher Logic ContactAddress Field | IQA Field Name |
---|---|
AddressName | NULL |
AddressLine1 | Address1 |
AddressLine2 | Address2 |
AddressLine3 | Address3 |
City | City |
StateProvince | StateProvince |
PostalCode | Zip |
CountryCode | Country |
AddressType | "Primary Address" |
Latitude | NULL |
Longitude | NULL |
DoNotPublish | NULL |
IsBill | NULL |
IsShip | NULL |
IsMail | NULL |
IsPrimary | TRUE |
ContactPhone
Phone info should be returned in the Contacts IQA ($/HigherLogic/Contacts/Contacts). In each case, the phone data is populated if the IQA field containing the phone number (e.g., MobilePhone, WorkPhone) is not null or empty.
Mobile phone fields
Higher Logic ContactPhone Field | IQA Field Name |
---|---|
FormattedNumber | MobilePhone |
PhoneType | "Mobile" |
IsPreferred | NULL |
IsSmsPreferred | NULL |
DoNotPublish | NULL |
Work phone fields
Higher Logic ContactPhone Field | IQA Field Name |
---|---|
FormattedNumber | WorkPhone |
PhoneType | "Work" |
IsPreferred | NULL |
IsSmsPreferred | NULL |
DoNotPublish | NULL |
Home phone fields
Higher Logic ContactPhone Field | IQA Field Name |
---|---|
FormattedNumber | HomePhone |
PhoneType | "Home" |
IsPreferred | NULL |
IsSmsPreferred | NULL |
DoNotPublish | NULL |
ContactDemographic
For each demographic IQA, contact demographics are created according to the columns returned in the IQA. The name of the IQA column maps to the demographic type, and the value contained in a contact's IQA row under that column maps to the value that contact has for that demographic.
Higher Logic ContactDemographic Field | IQA Field Name |
---|---|
Pick Demographics: $/HigherLogic/CustomDemographics/Pick | |
DemographicTypeId | [IQA column name] |
DemographicTypeValue | [IQA column name] |
DemographicId | [IQA column name] |
DemographicTextValue | [IQA column name] |
Multipick Demographics: $/HigherLogic/CustomDemographics/Multipick | |
DemographicTypeId | [IQA column name] |
DemographicTypeValue | [IQA column name] |
DemographicId | [IQA column name] |
DemographicTextValue | [IQA column name] |
Freeform (text) Demographics: $/HigherLogic/CustomDemographics/Freeform | |
DemographicTypeId | [IQA column name] |
DemographicTypeValue | [IQA column name] |
DemographicId | [IQA column name] |
DemographicTextValue | [IQA column name] |
ContactGroup
Only active group memberships are synced.
Group memberships with a BeginDate in the future or an EndDate in the past are removed from result sets and not synced to Higher Logic.
Higher Logic ContactGroup Field | IQA Field Name |
---|---|
Chapter: $/HigherLogic/GroupLists/Group_Chapter | |
GroupName | GroupDescription |
GroupType | GROUPTYPE |
GroupId | GROUPID |
BeginDate | STARTDATE |
EndDate | ENDDATE |
Committee: $/HigherLogic/GroupLists/Group_Committee | |
GroupName | GroupDescription |
GroupType | GROUPTYPE |
GroupId | GROUPID |
BeginDate | STARTDATE |
EndDate | ENDDATE |
Dynamic: $/HigherLogic/GroupLists/Group_Dynamic | |
GroupName | GroupDescription |
GroupType | GROUPTYPE |
GroupId | GROUPID |
BeginDate | STARTDATE |
EndDate | ENDDATE |
Event: $/HigherLogic/GroupLists/Group_Event | |
GroupName | GroupDescription |
GroupType | GROUPTYPE |
GroupId | GROUPID |
BeginDate | STARTDATE |
EndDate | ENDDATE |
MemberType: $/HigherLogic/GroupLists/Group_MemberType | |
GroupName | GroupDescription |
GroupType | GROUPTYPE |
GroupId | GROUPID |
BeginDate | STARTDATE |
EndDate | ENDDATE |