AI Dashlet Generator - User Guide

This guide will help you use the AI Dashlet Generator to create insightful charts and dashlets within SuiteCRM.

Starting a Session

1. Locate the AI Assistant Icon:
   • SuiteCRM 8: Click the robot icon located in the top right corner of the screen.
   • SuiteCRM 7: Click the robot icon located in the bottom right corner of the screen.
2. Start Session: Click the Start Session button. This will activate the AI assistant.

Generating Insights and Charts

1. Interact with the AI:
   • Type your request into the chat box. Be specific about the type of insights you want to see.
   • Examples:
     • "Show me the total revenue by sales stage."
     • "What are the top 5 lead sources by count?"
     • "Create a bar chart of opportunities closed this month by assigned user."
     • "Show me the number of activities by type for this quarter."
     • "List all my overdue tasks"
     • "Show me all my calls scheduled for today"
2. The AI will generate a chart based on your request.

Improving the Chart

1. Provide Feedback:
   • You can refine the chart by providing further instructions to the AI.
   • Examples:
     • "Change the chart type to a pie chart."
     • "Filter the data to only show opportunities from the last quarter."
     • "Group the results by month instead of by week."
     • "Show values as percentages."
     • "Change the axis labels to be more descriptive."
2. The AI will update the chart based on your feedback.

Viewing the SQL Query

• Click the SQL button associated with the chart to see the SQL query that the AI used to generate the data. This is helpful for advanced users who want to understand how the data is being retrieved.

Generating a Dashlet

1. Click the Generate Dashlet button. This will open a form to save your chart as a dashlet.
2. Fill in the Details:
   • Name: Enter a descriptive name for your dashlet.
   • Description (Optional): Provide a brief description of the dashlet's purpose.
3. Click Save.

Adding the Dashlet to Your Dashboard

1. Go to your desired Dashboard (e.g., Home, Sales, etc.).
2. Click Actions -> Add Dashlets.
3. Select the Charts tab.
4. Find Your Dashlet:
   • Type the name of your newly created dashlet into the search bar within the Charts tab.
5. Click on your dashlet's name to add it to the dashboard.
6. Click Save on the dashboard to save the changes.

Tips

• Be Specific: The more specific your requests to the AI, the better the results will be.
• Experiment: Try different types of requests and chart types to explore your data.
• Iterate: Don't be afraid to refine your charts by providing feedback to the AI.
• Save Often: Save your dashlets frequently so you don't lose your work.

Troubleshooting

• Chart not generating:
  • Make sure your API key is correctly configured in the AI Dashlet Generator settings (see the Administrator Guide).
  • Check your internet connection.
  • If the problem persists, consult the SuiteCRM logs or contact support abuzarfaris@gmail.com.