Installation and Licensing (Enterprise)

Installation

To install this add-on, follow this procedure:

Go to Help > Install new add-ons to open an add-on selection dialog box. Enter or paste https://www.oxygenxml.com/InstData/Addons/default/updateSite.xml in the Show add-ons from field or select it from the drop-down menu.
Note:
If you have issues connecting to the default update site, you can download the add-on package, unzip it, then use the Browse for local files action in the Install new add-ons dialog box to locate the downloaded addon.xml file.
Select the Oxygen AI Positron Assistant (Enterprise) add-on and click Next.
Important:
There are two different iterations of the add-on and you can only have one or the other installed at once:
- Oxygen AI Positron Assistant - The regular version of the add-on.
- Oxygen AI Positron Assistant (Enterprise) - This Enterprise version is for those who want to connect to their own AI service (OpenAI, MS Azure OpenAI, Anthropic Claude, Google Gemini, xAI Grok,or a custom service).
Read the end-user license agreement. Then select the I accept all terms of the end-user license agreement option and click Install.
Restart the application.

Result: The AI Positron Assistant side view is now available. If the view is not displayed, it can be opened by selecting it from Window > Show View.

Licensing and Configuration

You can configure the company-specific AI service details in the AI Service Configuration Preferences.

The AI Positron Enterprise add-on works free of charge with any Oxygen installation using an Enterprise license type for Oxygen.

If your license of Oxygen is not an Enterprise license, a special license key needs to be purchased for the add-on to enable this direct access. You can use the Register button in the AI Positron Assistant side view to configure the special license key.

Important:

If you want to use the default Oxygen AI Positron service instead of a company-specific AI service, the Oxygen AI Positron Assistant add-on needs to be installed and used instead of the one listed above.

Note:

If you are an integrator using the Web Author Component in your own solution and you want to license the AI Positron Enterprise for Web Author, you can set a dedicated license server for AI Positron.

Troubleshooting

To see the exact prompt that is sent for any custom AI action (in the Chat view), you can set the oxygen.ai.positron.development.mode system property with the value of true in the parent Oxygen XML application.

If the add-on fails to connect with the custom settings, it might be useful to enable debug logging in the application to see what requests and responses are made to/from the AI server.

You can enable debug logging in the application by adding a logback.xml file in the application's installation folder. A minimal logback.xml configuration XML file content to enable logging only for the AI Positron add-on's connections would look like this:

<configuration>
  <appender name="R2" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${user.home}/Desktop/oxygenLog/oxygen.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
      <fileNamePattern>${user.home}/Desktop/oxygenLog/oxygen%i.log.gz</fileNamePattern>
      <minIndex>1</minIndex>
      <maxIndex>20</maxIndex>
    </rollingPolicy>
    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
      <maxFileSize>12MB</maxFileSize>
    </triggeringPolicy>
    <encoder>
      <pattern>%r %marker %p [ %t ] %c - %m%n</pattern>
    </encoder>
  </appender>
  <logger name="com.oxygenxml.positron.connector" level="debug"/>
  <logger name="com.oxygenxml.positron.core" level="debug"/>
  <root level="error">
    <appender-ref ref="R2"/>
  </root>
</configuration>

Important:

The logging information will be copied in the Desktop/oxygenLog folder once the application is started. To avoid performance problems, the logback.xml file must be deleted once the logging has been obtained.