Setup, access and model configuration

Install and activate OpenAI Integration v1.0.0

Activate the bundled provider module and verify that its settings child appears under the CRM AI settings group.

Audience: CRM administrators and authorised staffPermission: AdministratorModule v1.0.0

Exact navigationAdmin Area → Setup → Modules → OpenAI Integration → Activate

Before you begin

Use an account with Administrator and confirm the intended record or setting before making a change.
Follow the exact route above. If the screen or action is absent, check module activation, ownership and permissions rather than using another person’s account.
Use controlled test data for configuration, integration, email, AI, payment, portal or automation changes before production-wide use.

What this guide covers

Activate the bundled provider module and verify that its settings child appears under the CRM AI settings group. The instructions reflect the supplied module’s registered menus, controller actions, views, settings and code-backed validation flow.

Exact step-by-step process

Open Admin Area → Setup → Modules → OpenAI Integration → Activate.
Locate OpenAI Integration in the module list and review the displayed version and CRM requirement.
Choose Activate and allow the module lifecycle hook to complete.
Reload the admin area and open the module workspace shown in this guide.
Confirm that the expected settings, menus and records are available before production use.

Fields, choices and supported possibilities

ActionInstall and activate OpenAI Integration v1.0.0

Exact navigationAdmin Area → Setup → Modules → OpenAI Integration → Activate

Module version1.0.0

VerificationConfirm the saved record, status, output or setting in the same workspace and review any linked activity, file or notification.

Code-backed validations and workflow rules

Activation creates the openai_api_key and openai_model options if they do not already exist.
The module does not register a standalone main-menu item.

Expected result and verification

The supported install and activate openai integration v1.0.0 flow completes without bypassing permission or validation checks.
The resulting record, setting, status, file, delivery event or external response is visible from the relevant workspace.
Unexpected validation, provider or linked-record errors are investigated before retrying.

Security, privacy and operational checks

Restrict the API key and AI settings to authorised administrators.
Do not submit confidential, special-category or unnecessary personal data to the external AI provider.
Review generated text before using it in customer, staff, legal, financial or compliance communication.
Monitor provider billing and retention independently because this module has no built-in cost dashboard.