cmEngage Hub

cmEngageHub - Post Installation Steps

Overview

This guide walks a Salesforce Administrator through all steps required to activate and configure EngageHub after the managed package has been installed in the org. EngageHub adds an Activity Panel component to record pages, giving users a unified timeline to log calls, create tasks and events, take notes, and trigger custom flows (e.g., Send Secure Email, Send SMS, Send eForm).


Prerequisites

Requirement

Details

Salesforce Edition

Enterprise or above (Lightning Experience required)

Installer Role

System Administrator profile

Package Status

EngageHub managed package installed successfully

API Version

64.0 or higher



Step 1 — Assign Permission Sets

EngageHub ships with permission sets that control access to the Activity Panel and its supporting objects.

  1. Go to SetupPermission Sets.

  2. Locate the EngageHub permission sets (e.g., EngageHub User, EngageHub Admin).

  3. Click EngageHub AdminManage AssignmentsAdd Assignments.

  4. Assign to yourself (the installing admin) and any other admin users first.

  5. Repeat with EngageHub User for all end-user profiles that need access to the Activity Panel.

Note: Users without the correct permission set will not see the Activity Panel component on record pages.


Step 2 — Configure EngageHub

This section will be completed with step-by-step instructions and screenshots for the EngageHub Configuration page once the documentation is finalized. The Configuration page allows admins to manage the four core Custom Metadata records:

  • Activity Buttons Configuration — controls which action buttons (Log a Call, New Task, New Event, New Note, Send Secure Email, Send SMS, Send eForm) appear in the panel and their display order.

  • Activity Record Configuration — defines which activity record types and related fields are displayed per object.

  • Default Activity Filters — sets the default filter state when the Activity Panel first loads.

  • Default Schema Model — configures the field layout and modal behavior for each activity action (Create Task, Edit Task, Log Call, New Event, Edit Event, New Note, Edit Note, Create Follow-Up Task/Event, Change Status, Change Priority, Change Date, Edit Comments, Delete).


https://cloudmaven.atlassian.net/wiki/x/JYANdg


Step 4 — Add the Activity Panel to a Source Record Page

The activityPanel Lightning Web Component must be placed on each record page where users need the activity timeline. Follow these steps for every object (e.g., Account, Contact, Opportunity, Lead, or any custom object).

Open the Lightning App Builder

  1. Navigate to a record page of the target object (e.g., open any Account record).

  2. Click the gear icon (Setup) in the top-right corner of the page.

  3. Select Edit Page to open the Lightning App Builder.

Alternatively, go to SetupLightning App Builder → locate the page by name and click Edit.

Drag and Drop the Activity Panel Component

  1. In the Lightning App Builder left panel, scroll down to the Custom components section.

  2. Locate the component named Activity Panel (API name: activityPanel).

  3. Drag the Activity Panel component from the left panel and drop it onto the desired region of the page canvas — typically the right-hand column or a dedicated tab.

Recommended placement: A dedicated Activities tab on the record page, or the right-side panel column at full width, so the timeline has sufficient vertical space.

  1. With the component selected on the canvas, review any available component properties in the right panel and configure them as needed.

Save and Activate

  1. Click Save in the top-right corner of the Lightning App Builder.

  2. If prompted with an activation dialog:

    • Select Activate as org default to apply to all users, or

    • Select Assign as app default / Assign as app, record type, and profile default for a more targeted rollout.

  3. Click Activate (or Save if it was already active).

  4. Click Back to return to the record page and verify the Activity Panel renders correctly.

Repeat for Each Target Object

Repeat the steps above for every object where the Activity Panel should appear (e.g., Contact, Opportunity, Lead, custom objects).


Step 5 — Verify the Activity Panel

After placing the component, perform a quick smoke test on each configured record page:

  1. Open a record of the target object.

  2. Confirm the Activity Panel is visible with the configured action buttons (Log a Call, New Task, New Event, New Note, and any flow-based buttons).

  3. Click Log a Call — verify the modal opens with the correct fields (Subject, Comments, Name, Related To).

  4. Click New Task — verify the modal opens with required fields (Subject, Due Date, Assigned To, Status).

  5. Click New Event — verify the modal opens with required fields (Subject, Start, End, Assigned To).

  6. Click New Note — verify the modal opens with Title and rich-text Compose text fields.

  7. Confirm existing activity records appear in the timeline after saving.


Step 6 — (Optional) Configure Flow-Based Buttons

If your org has the Send Secure Email, Send SMS, or Send eForm flows deployed, these buttons appear in the Activity Panel dropdown menu automatically based on the Activity Buttons Configuration custom metadata record.

Ensure the following Flows exist and are Active in the org:

Button

Flow API Name

Send Secure Email

Send_Secure_Email

Send SMS

Send_SMS

Send eForm

Send_eForm

If a Flow is not present or inactive, the corresponding dropdown button will not function. Either activate the Flow or remove it from the Activity Buttons Configuration metadata record to hide the button.


Troubleshooting

Symptom

Likely Cause

Resolution

Activity Panel not visible on page

Component not added to the page layout

Follow Step 4 to drag and drop the component

Activity Panel visible but blank

Permission set not assigned

Assign EngageHub User permission set (Step 2)

Action button missing from panel

Button not enabled in Buttons Configuration

Review the Activity Buttons Configuration custom metadata record (Step 3)

Flow button throws an error

Flow not active or missing input parameter

Check the Flow API name and ensure it is Active

Component shows on desktop but not mobile

Supported form factors issue

The component supports both Large and Small — verify the page assignment includes mobile


Support

For issues or questions, contact the EngageHub support team at [support@cloudmaven.com] or visit the CloudMaven documentation portal.