> For the complete documentation index, see [llms.txt](https://docs.greytrix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.greytrix.com/sage-crm-add-ons/gumu-co-pilot-for-sage-crm/installation-+-setup/sage-crm-side-configuration.md).

# Sage CRM Side Configuration

To configure **GUMU™ Co-Pilot on the Sage CRM side**, follow the steps below.

### 8.1 Install Required Components

1. Log in to **Sage CRM** with an administrator account.
2. Navigate to **Administration → Customization → Component Manager**.
3. Install the **CopilotConfig** component.
4. 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:

1. Navigate to **Administration → Customization → Translations**.
2. In the **Caption Code** field, enter:\
   `UseGUMUChatBot`
3. Set the corresponding translation value to:\
   `Y`
4. Save the changes.

Refer to the screenshot below for reference.

<figure><img src="https://794987320-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MCRVg-TYx3gVa2Tqtf_%2Fuploads%2FLhVG16wQHdTCRc7SVzJm%2Fimage.png?alt=media&amp;token=ef9f0efe-6fc4-4cea-a3f1-31e942e9ce3d" alt=""><figcaption></figcaption></figure>

### 8.3 Enable GUMU™ Co-Pilot for a Sage CRM User

GUMU™ Co-Pilot must be enabled individually for the users who need access.

1. Navigate to **Administration → Users → Users**.
2. Select and edit the required Sage CRM user.
3. 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

<figure><img src="https://794987320-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MCRVg-TYx3gVa2Tqtf_%2Fuploads%2FybTtOqMVQ8FosqGoNMcH%2Fimage.png?alt=media&amp;token=9ded05f1-9a6e-48dc-8129-e64d095f11aa" alt=""><figcaption></figcaption></figure>

**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.

1. Log in to **Bportal**.
2. Navigate to **GUMU™ Co-Pilot → Configuration → API Key**.
3. Click **Generate GUMU™ Co-Pilot API Key**.
4. Copy the generated API Key.
5. Return to Sage CRM.
6. Open the required user under **Administration → Users → Users**.
7. Enter the copied API Key in the **API Key** field.
8. Save the user record.

<figure><img src="https://794987320-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MCRVg-TYx3gVa2Tqtf_%2Fuploads%2FmWvvdGnIGdUK6FBbTpJA%2Fimage.png?alt=media&amp;token=28392d3b-a304-44a4-a2ef-70af8c984dda" alt=""><figcaption></figcaption></figure>

### 8.5 Configure GUMU™ Co-Pilot

To configure GUMU™ Co-Pilot in Sage CRM:

1. Navigate to **Administration → GUMU Co-Pilot**.
2. Click **New**.
3. 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.                                              |

4. Verify all the entered details.
5. Save the configuration.

<figure><img src="https://794987320-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MCRVg-TYx3gVa2Tqtf_%2Fuploads%2FYuCD8rXsuA90YH1vrmMt%2Fimage.png?alt=media&amp;token=969a7ed1-46e5-45db-96a7-2f5a41f38be9" alt=""><figcaption></figcaption></figure>

### 8.6 Provide Sage CRM Metadata

After completing the above configuration, generate the Sage CRM metadata.

1. Navigate to **Administration → System → Metadata**.
2. Generate/refresh the metadata as required.
3. 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:

```
http://<IP of CRM>/sdata/<CRM Instance>/sagecrm/-/Company
```

#### Example

```
http://49.248.14.237/sdata/crm2024r1j/sagecrm/-/Company
```

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**.