Admin Guide
Installation
Requirements
Sugar 12.x, 13.x
Note: Sugar 13.1 and up requires at least Addon Verion 1.1
Step 1 - Back Up
Back up your entire CRM system (files and database).
Step 2 - Installation
To install the ChatGPT for Sugar, follow these steps:
- Navigate to the Administration page and locate the "Module Loader" section.
- Select the zipped module file and proceed by initiating the upload process.
- Once the upload is finalized, proceed by selecting the designated "install" button to initiate the installation.
Step 3 - Repair & Rebuild
Once the installation of the ChatGPT Integration for SugarCRM is completed successfully, return to the Administration page and locate the "Repair" option. Proceed by performing a rebuild and repair process through the selection of "Quick Repair and Rebuild".
Step 4 - License Validation
To return to the Administration page, go to the ChatGPT Integration for SugarCRMsection and select "Validate License." Enter your SugarOutfitters License Key and click on "Validate."
In the "Manage Users" section, select the users who should be licensed to use the ChatGPT Integration for SugarCRM and click on "Save."
Once the license validation is successful, a "Continue" button will appear, which will take you to the ChatGPT Integration for SugarCRM settings.
Step 5 - ChatGPT for Sugar Integration Settings
The settings play a crucial role in enhancing the product experience. It is imperative to comprehend the settings and their impact on the requests made by the ChatGPT Integration for SugarCRM. Comprising four sections, each section holds its own significance and role.
Section 1 - API Settings
Enterprise: This version necessitates the utilization of your own API Key and custom endpoint. Please log in to your OpenAI account, click on your avatar located in the top right corner, and proceed to the "View API keys" section. If you do not possess a pre-existing API Key, generate a new one to facilitate usage. The "Base URL" will be automatically populated with https://api.openai.com/v1/. This serves as the default API endpoint for OpenAI's services. It is imperative to exercise caution and prudence when configuring your maximum monthly token consumption.
Professional & Professional+: This version does not require any modifications within this section, as those fields are automatically filled out and disabled.
Section 2 & 3 - Chat Configuration & Completion Configuration
At these sections, you have the opportunity to configure several adjustments that have an impact on the requests. It is of utmost importance to thoroughly review the provided information. Additionally, comprehensive explanations of all settings can be found in OpenAI's API Reference.
Section 4 - E-Mail Configuration
Here, it is possible to modify the maximum token count allocated for each request, particularly in relation to framed input fields commonly encountered in the Email and Knowledge Base modules. For longer text inputs, it is advisable to utilize a higher token count to achieve optimal results.
Troubleshooting
This troubleshooting guide is a comprehensive resource aimed at assisting administrators in effectively managing and maintaining our tech product. It provides the necessary knowledge and techniques to overcome any obstacles that may arise, ensuring smooth operation and optimal performance.
Approaches to Utilize within Sugar Itself
A straightforward approach to addressing typical errors in Sugar involves performing a repair and rebuild procedure, as outlined in Step 3 – Repair & Rebuild. In our case, rebuilding the JS Grouping Files can effectively resolve potential errors. Navigate to the Administration page and locate the "Repair" option. Proceed by rebuilding the JS Grouping Files through the selection of " Rebuild JS Grouping Files".
Approaches to Utilize outside Sugar
One possible issue arises when the browser caches JS files and subsequently loads them automatically. Deleting the browser cache can serve as a viable solution for potential errors.