Install Guide - MTS SuiteVoice Transcriber

System Requirements

• SuiteCRM 8.x (Cloud or On-premise)
• PHP 8.1+
• MySQL 5.7+ or MariaDB 10.3+
• Internet — To call AI APIs (Google Gemini or OpenAI)
• AI API key — From Google AI Studio or OpenAI platform

Installation

Step 1: Upload Module

1. Login to SuiteCRM with Admin rights
2. Go to Admin > Module Loader
3. Click Choose File and select MTS_SuiteVoice_Transcriber_Yearly_1.0.0.zip
4. Click Upload
5. Click Install

Step 2: Run Repair

After installation completes:

1. Go to Admin > Repair
2. Run Quick Repair and Rebuild
3. Wait for completion

Step 3: Verify Installation

Check:

1. Go to Admin
2. See MTS SuiteVoice Transcriber section in the admin panel
3. New modules are available:
   • SVT Providers
   • SVT History
   • SVT Config

Initial Configuration

Step 1: Add an AI Provider

1. Go to Admin > MTS SuiteVoice Transcriber > Settings
2. Click the AI Providers tab
3. Click Add Provider
4. Fill in the form:

5. Click Save Provider

Tip: Use Load Models to fetch available models automatically after entering the API key.

Tip: Use Test Connection to verify the key and model are working before saving.

Step 2: Configure Settings

1. Click the Settings tab
2. Configure the options:

3. Click Save Settings

Verify Operation

Test Transcription on a Note

1. Go to any Note record that has an audio or video attachment (e.g. an MP3, MP4, or WAV file)
2. On the Note detail view, look for the transcription action buttons in the Actions menu (legacy view) or the transcription panel (SuiteCRM 8 Angular view)
3. Click Transcribe: Full Text
4. Confirm the dialog
5. Wait for processing — the spinner will show progress
6. The Note description is updated with the transcript and a timestamp separator

Check History

1. Open the Note
2. View the History panel in the Angular component — it shows the most recent transcription with model name, token count, and processing time

Uninstall

If you need to remove the module:

1. Go to Admin > Module Loader
2. Find MTS SuiteVoice Transcriber in the installed modules list
3. Click Uninstall
4. Choose whether to remove database tables when prompted

Troubleshooting

Transcription Buttons Not Visible

1. Run Admin > Repair > Quick Repair and Rebuild
2. Clear browser cache and reload

Connection Test Fails

1. Verify the API key is correct and active in the provider's dashboard
2. Confirm the model name is valid (use Load Models to see available models)
3. Check that the SuiteCRM server has outbound internet access to the AI provider

File Not Supported Error

Only audio and video MIME types are accepted: - Audio: audio/mpeg, audio/mp4, audio/wav, audio/ogg, audio/webm, audio/flac, audio/x-m4a, audio/aac, audio/3gpp - Video: video/mp4, video/webm, video/ogg, video/quicktime, video/x-msvideo

Ensure the file attached to the Note is one of these formats.

File Too Large Error

Increase Max File Size (MB) in Settings, or compress the audio file before attaching.

Request Timeout Error

Increase Request Timeout in Settings. Large files or slow networks may require 60–120 seconds.

Contact

• Website: mientrungsoft.com
• Email: anhnhatuit@gmail.com
• WhatsApp: +84973131884