CCB Overview
Overview
The CCB backend integration allows you to sync public events, small groups and members over to these modules in the cms. We are not able to use specific calendars from within CCB, but all public events will pull over. Also, only specific fields will sync over to the website backend, so please check out the info below for more details.
With this integration, your CCB data will re-sync to the website every 60 minutes.
NOTE: The CCB integration option is only available at the Pro plan level. Please contact your project manager or the E360 support team for more info.
NOTE: a small group layout would need to be purchased in order to use the small groups integration option. Please contact your website specialist or project manager for more info.
Setup
Generate API login credentials in CCB
The credentials you set up will need to have full admin privileges, and we recommend setting up a generic login (like Username MonkDev or Integration).
For the integration, we will need the following info:
- Create an API login account - this is different from a standard login for your CCB platform
- Give us access to all commands (you can do this in the process of creating the login)
To set this up, please follow the steps below:
1. Go to system settings
2. Go to API (see the first image below)
3. Add a user
4. Click the user name
5. Click Services
6. Hit the Check Box that says "Select All" (see the second image below)
Link your CCB account to the website
Once your CCB API login is setup, you can either follow the steps below to link your account to the website or contact your project manager for assistance.
Go to Admin > Site > "More Menu" link at the top right > "Integrations" tab in the sidebar
Under the section labeled "Church Community Builder", fill in the" username" and "password" fields with the API login credentials. The "subdomain" should only be your church name in the CCB url.
ex: https://yourchurchname.ccbchurch.com/login.php - in this example, the "subdomain" field would only need this info: yourchurchname (not the full url).
Additional fields:
- Sync events, groups and members - this will enable your CCB data to pull over for the respective module, so only check the data you want synced to the cms.
- Include categories in sync - when selecting this option, you can choose to sync a standard or custom CCB field from the dropdown. This will pull into the module as your category list.
Sync "Area of Town" Field - this is an optional setting for the small groups integration only. Selecting this option will sync this info over from CCB and create a new field in the small groups module labeled "Area of Town". Please note, your groupfinder layout will need to be updated to support this new field, as this is not standard field available with our groups module. Please contact your project manager or support if you'd like to use this option.
Events Integration
Your public CCB events will pull into the website under Events > Events. When an event is synced, you will see this info stated at the top of the settings screen for the specific event.
Additional notes:
- All events are synced as one-time events. Recurring events are not supported, so each recurrence will sync as an individual event
- Events are only synced one year into the future, in order to keep syncing quick and stable
- The "published as featured" status needs to be manually added to events in the cms.
Fields Synced
Below is a list of fields synced from CCB and the corresponding fields where the data will pull in the Events module in the CMS. The fields that are synced will show greyed out in the events module and cannot be edited in the cms, since the data is pulling from CCB (see image below). Fields that are not synced can be manually updated in the events module, if needed.
CCB Field |
CMS Events Field |
Notes |
---|---|---|
Name | Name | |
Description |
Description |
|
Group Type | CMS Category | Field labeled "type" in CCB This field will be used as the default for your event categories. You can choose a different standard or custom field in the integration settings. |
Grouping Name | CMS Category | Field labeled "department" in CCB |
Group Name | CMS Category |
|
Date | Start/End Date |
|
Start Time | Start Time |
|
End Time | End Time | |
Image | Event Image | |
Rooms | Rooms | |
Location | Location | |
Leader | Coordinator | **The member sync option must be enabled |
Registration | External Registration Link | |
Campus ID | Site Groups | The campus assigned in CCB will pull into the cms as the campus group assigned to your event. The campus group on the website and the campus name in CCB need to match. |
Fields with the red asterisk will be synced from CCB. You can also manually add additional categories once an event is synced to the website, if needed.
Small Groups Integration
Your public CCB small groups will pull into the website under Events > Small Groups. When a group is synced, you will see this info stated at the top of the settings screen for the specific small group.
This small group is synced with Community Church Builder!
The fields that are synced will show greyed out/read only in the small groups module and cannot be edited in the cms, since the data is pulling from CCB (see image below). Fields that are not synced can be manually updated in the events module, if needed.
Fields Synced
Here is a list of synced fields for the small groups module, and the synced fields will be locked in the cms, since the data is pulling over from CCB.
AREA OF TOWN
If the "sync area of town field" option is selected in the integration settings, then a new field will be added to your small groups module for this data to be synced over.
Please note, your groupfinder layout will need to be updated to support this new field, as this is not standard field available with our groups module. Please contact your project manager or support if you'd like to use this option.
CCB Field |
CMS Small Groups Field | Notes |
---|---|---|
Name |
Name |
|
Group Type | CMS Category |
This field will be used as the default for your small group categories. You can choose a different standard or custom field in the integration settings. |
Department | CMS Category |
|
Description |
Description |
|
Childcare Provided | Childcare Provided |
|
Image | Image | |
Leader ID | Primary Leader |
**The member sync option must be enabled |
Location | Location | |
Meeting Day ID | Day of the week | |
Meeting Time | Start time | Meeting Time will only sync if its value has a valid time format. End time will not be synced. |
Campus ID | Site Groups | The campus assigned in CCB will pull into the cms as the campus group assigned to your group. The campus group on the website and the campus name in CCB need to match. |
Fields with the red asterisk will be synced from CCB. You can also manually add additional categories once an small group is synced to the website, if needed.
Member Sync
If the member sync option is enabled, members will sync over to the cms under People > Members. It's not a full sync of all members within CCB but only members assigned a contact/leader for synced events and small groups.
Fields Synced
Here is a list of synced fields for the members module, and the synced fields will be locked in the cms, since the data is pulling over from CCB.
CCB Field |
CMS Member Field |
Notes |
---|---|---|
First Name | First Name | |
Last Name | Last Name | |
Email Address | ||
Home Phone | Home Phone | Under the member profile |
Work Phone | Work Phone | |
Cell Phone | Cell Phone | |
Address | Address/Country/Zip | This field in CCB is parsed into multiple fields in the cms |
Birthday | Birth Date | |
Image | Image |