Idera AI Documentation Assistant

AI features in Aqua Data Studio are enabled by default. However, organizations can disable or customize these features based on their specific requirements. 

As an Administrator, you have the ability to configure AI options globally for all users by using a master ai-config.properties file. This configuration will override any user-specific settings, ensuring consistency across the application. Users will not be able to modify these settings through the File > Options > AI Configuration menu.

Configure AI Options:

  1. Prepare the ai-config.properties File:
    • Create or obtain the ai-config.properties file with the desired AI configuration settings.
  2. Locate the ADS Installation Directory:
    The location where you need to place the ai-config.properties file depends on the operating system:
    • Linux/Windows: Place the file in the <ADS_INSTALL_DIR> (the directory where ADS is installed).
    • macOS: Place the file in the $APP_ROOT/Contents/ (the directory where ADS is installed).
  3. Copy the ai-config.properties file to the appropriate directory as specified above.
  4. Enable or Disable AI Configuration:
    • The AI configuration will be automatically enabled or disabled based on the settings in the ai-config.properties file.
    • Once the master configuration is detected, ADS will disable users from modifying AI settings through the File > Options > AI Configuration menu.
  5. Verify the COnfiguration:
    • Launch ADS and ensure that the AI options are applied as expected.
    • Confirm that users cannot override these settings by attempting to access File > Options > AI Configuration.

Here is an example for Admin configuration of AI on MacOS application (.app)

Steps to Modify Info.plist for configuring ADS v25 > AI master configuration:

  1. Locate Aqua Data Studio.App/Contents folder: 
    • Navigate to the location of your .app file.
    • Right-click the .app file and select Show Package Contents.
    • Inside the package, find the Contents folder and open it.
  2. Copy ai.config.properties into the Contents folder. 
  3. Locate Info.plist in the Contents folder. The Info.plist file is a core configuration file for macOS applications. It contains essential metadata about your app, such as the bundle identifier, version, and JVM-related configurations.
  4. Open Info.plist for Editing: Open the Info.plist file with a text editor such as TextEdit, or any other preferred editor.
    Modify JVM Options: You need to modify JVM options in the Info.plist file. Insert the following section inside the Info.plist, under the <key>JVMOptions</key> section after defining JVM parameters.

    <key>JVMOptions</key>
    <array>
    <!-- Other JVM arguments go here →
    <string>-Dai.config.properties=$APP_ROOT/Contents/ai-config.properties</string>
    </array>

    This configuration ensures that the master configuration     ai-config.properties is loaded and the user will be disallowed with any AI configuration from File > Options.
  5. Save Changes: Once you’ve added the JVM options, save the Info.plist file and close the editor.
  6. Run the Application: After modifying the Info.plist, relaunch Aqua Data Studio.App to apply the changes.
  • No labels