Sage CRM Side Configuration
To configure GUMU™ Co-Pilot on the Sage CRM side, follow the steps below.
8.1 Install Required Components
Log in to Sage CRM with an administrator account.
Navigate to Administration → Customization → Component Manager.
Install the CopilotConfig component.
Once the installation is complete, install the CustomersData component.
Note: Ensure that both components are installed successfully before proceeding with the remaining configuration.
8.2 Enable GUMU™ Co-Pilot Globally
To enable GUMU™ Co-Pilot globally in Sage CRM:
Navigate to Administration → Customization → Translations.
In the Caption Code field, enter:
UseGUMUChatBotSet the corresponding translation value to:
YSave the changes.
Refer to the screenshot below for reference.
8.3 Enable GUMU™ Co-Pilot for a Sage CRM User
GUMU™ Co-Pilot must be enabled individually for the users who need access.
Navigate to Administration → Users → Users.
Select and edit the required Sage CRM user.
Enter the following GUMU™ Co-Pilot details:
Field
Value
GraphQL UserName
Bportal username
GraphQL Password
Bportal password
API Key
Bportal API Key
Copilot Access
Select this checkbox to enable GUMU™ Co-Pilot for the user
Save the user record
Note: The Copilot Access checkbox determines whether GUMU™ Co-Pilot is available to the selected Sage CRM user.
8.4 Generate the GUMU™ Co-Pilot API Key
The API Key is generated from the Bportal application and must be entered against the corresponding Sage CRM user.
Log in to Bportal.
Navigate to GUMU™ Co-Pilot → Configuration → API Key.
Click Generate GUMU™ Co-Pilot API Key.
Copy the generated API Key.
Return to Sage CRM.
Open the required user under Administration → Users → Users.
Enter the copied API Key in the API Key field.
Save the user record.
8.5 Configure GUMU™ Co-Pilot
To configure GUMU™ Co-Pilot in Sage CRM:
Navigate to Administration → GUMU Co-Pilot.
Click New.
Enter the required configuration details as follows:
Field
Description / Value
Plugin Name
Enter the GUMU™ Co-Pilot plugin name.
User
Select the required Sage CRM user.
WebSocket URL
Select the type of WebSocket URL provided for GUMU™ Co-Pilot.
Workflow Name
Enter/the workflow name which is subscribed in Bportaly.(Agent Name)
Default Config
Select the checkbox to mark this configuration as the default configuration.
Domain
Enter the domain from Bportaly.
Verify all the entered details.
Save the configuration.
8.6 Provide Sage CRM Metadata
After completing the above configuration, generate the Sage CRM metadata.
Navigate to Administration → System → Metadata.
Generate/refresh the metadata as required.
Wait for the metadata generation process to complete successfully.
Important: Metadata should be generated after completing the GUMU™ Co-Pilot configuration and user-level settings.
8.7 Verify SData Access
After completing all the configuration steps, verify that the configured user can access Sage CRM entities through the SData URL.
Use the following URL format:
Example
Open the URL in a browser while logged in with the appropriate credentials.
Expected Result
If the URL successfully returns the Company data in XML format, the SData configuration is working correctly and the data should be accessible from Bportal/GUMU™ Co-Pilot.
8.8 Configuration Checklist
Before completing the Sage CRM configuration, verify the following:
· CopilotConfig component is installed.
· CustomersData component is installed.
· UseGUMUChatBot is set to Y under Translations.
· GraphQL username is configured for the required user.
· GraphQL password is configured for the required user.
· GUMU™ Co-Pilot API Key is generated and entered.
· Copilot Access is enabled for the required user.
· GUMU™ Co-Pilot configuration is created.
· WebSocket URL is configured correctly.
· Workflow Name is set to Sage CRM.
· Default configuration is selected where applicable.
· Sage CRM domain is configured.
· Sage CRM metadata has been generated.
· SData URL successfully returns XML data.
Once all the above steps are completed and the SData URL is returning the expected XML response, the Sage CRM-side configuration for GUMU™ Co-Pilot is complete.
Last updated