Sage CRM Labs Documentation

Here you can find the documentation for Sage CRM Labs, an area designed to accelerate innovation with experimental CRM features. These components are installed with Sage CRM and are plug-and-play features that require no core product changes, utilizing Sage CRM tested SDKs and metadata just like your own customizations. This allows customers to try out new features such as QuickCal, Webhooks, and Quote Templates early, empowering them with opt-in features that fit their needs and giving them a chance to help shape the future of Sage CRM through direct feedback.

Note:  Labs components are not enabled by default and must be explicitly installed by a Sage CRM System Administrator.

Where to find Sage CRM Labs components

All Sage CRM Labs components are managed through the Component Manager in Sage CRM.

To access the Component Manager:

1. Log on to Sage CRM as a System Administrator.

2. Go to Administration.

3. Select Customization.

4. Click Component Manager.

The Component Manager displays a list of available components and provides options to install, upgrade, or uninstall them.

Installing a Sage CRM Labs component

The general steps to install a Labs component are as follows:

1. Open the Component Manager
   Navigate to Administration → Customization → Component Manager.

2. Locate the Labs component
   Find the required Labs component in the list. Each component includes a short description explaining its purpose.

3. Review the component documentation
   Before installing:

   • Read the component documentation carefully.

   • Check any stated prerequisites or compatibility notes.

   • Ensure the component is suitable for your Sage CRM configuration and any integrations in use.

4. Run the component
   Select the component and choose Install (or Run, depending on the component design).

5. Confirm installation options
   Many Labs components require you to:

   • Accept a disclaimer.

   • Confirm installation choices or enable specific features.

6. Complete the installation
   The component will:

   • Apply any required metadata changes.

   • Add or update user interface elements such as buttons, tabs, or pages.

   • Deploy any associated ASP pages, scripts, or configuration settings.

7. Verify the installation
   After installation:

   • Test the feature in a test environment.

   • Confirm that the new functionality appears as described.

   • Validate that existing customisations and integrations continue to behave as expected.

Uninstalling a Sage CRM Labs component

Labs components are removed using the Component Manager, but the exact uninstall steps can vary by component.

Each Sage CRM Labs component includes component-specific uninstall instructions in its documentation. These instructions describe:

• How to safely remove user interface changes such as buttons, tabs, or menu entries.

• Whether any metadata or database structures are left in place intentionally.

• Any additional steps required to fully disable or clean up the feature.

To uninstall a Labs component:

1. Go to Administration → Customization → Component Manager.

2. Select the installed Labs component.

3. Choose Uninstall or Disable, as described in the component’s documentation.

4. Follow the component-specific instructions provided.

Best practice

• Always install and test Labs components in a test or staging environment first.

• Review the documentation for each component before installation and uninstallation.

• Only deploy Labs components to a live system once you are confident they meet your business and technical requirements.