History | Edit

It is possible to use your own Oxygen Content Fusion Enterprise server to store uploaded content rather than the server hosted by the Oxygen Content Fusion Service. The information in this topic is meant to help system administrators install and configure your own Enterprise server.

The Two Types of Server Hosting Solutions

There are two types of server hosting solutions that you can choose from and each one has certain advantages:
Oxygen Content Fusion Enterprise
This solution allows you to host your own server to store content that is uploaded through the Oxygen Content Fusion connector add-on. With this model, you will be able to setup and configure your own server. This solution also allows you to upload custom frameworks so that all contributors will have access to them when reviewing content in Oxygen Content Fusion.
Oxygen Content Fusion Service
This solution is a service where content that is uploaded through the Oxygen Content Fusion connector add-on is stored on a server hosted by Oxygen. The biggest advantage of using this model is that there is no server setup or configuration required.

Prerequisites

An Enterprise server solution requires the following prerequisites:

Downloading the Oxygen Content Fusion Enterprise Virtual Machine Software

To use your own server, you need to download the Oxygen Content Fusion Enterprise virtual machine software. The download package includes the following:
  • An OVF file that defines the virtual machine.
  • Several VMDK (virtual machine disk) files.
  • A manifest (.MF file) that contains the signatures of the files.

Importing the Oxygen Content Fusion Virtual Machine Software in VirtualBox

To import the Oxygen Content Fusion Enterprise virtual machine software in VirtualBox:
  1. Start Oracle VM VirtualBox Manager.
  2. Select File / Import Appliance and choose the OVF file.
  3. Click Import.
  4. Do not start the VM yet. You need to configure the network settings first.

Changing Network Settings from NAT to Bridged

You need to change the network adapter settings from NAT to bridged so that the VM will be visible in your local network:
  1. Make sure the VM is not running.
  2. In Oracle VM VirtualBox Manager, select the VM and click Settings.
  3. Select Network / Adapter1.
  4. Change it from NAT to Bridged Adapter.

Initial Oxygen Content Fusion Configuration

To configure Oxygen Content Fusion, use the following procedure:
  1. In the Oracle VM VirtualBox Manager, press Start (normal ) to start the imported virtual machine. If the bootloader menu is displayed, press Enter to choose the first option. On this first start, the VM console will display the IP address (you will need this), and the SSH access administrator user name and password (these will be changed). The fingerprint of the HTTPS self-signed certificate is also displayed.
  2. Login to the machine using the credentials displayed in step 1. You can do this either directly in the VirtualBox console or by using SSH.
  3. After you login, you will be prompted to change the default password for the administration account. This password can be used to login to the following:
    • The VM using SSH or the VM console
    • The Oxygen Content Fusion configuration page
    • The Web Author Administration page
    • The license server management page
  4. Exit the console by typing exit.
  5. Use the IP address shown in the VM console to access the web interface of Oxygen Content Fusion. The address should be http://<server-address>.
    Note: By default, Oxygen Content Fusion uses a self-signed certificate, so the browser will display a security warning. Continue (for example, if you are using Edge or Internet Explorer, click Details and then Go on to the webpage).
  6. Configure the Domain Name of the server. To properly configure the server, you should associate a domain name for this server in your DNS. You can also use the server IP address instead of the domain name. In this case, the server will run with several limitations:
    • The e-mail messages generated by the server are more likely to be considered as SPAM.
    • HTTPS support cannot be enabled.
  7. On the next page, use the trial license.
  8. Restart the VM using the Restart Machine button from the General tab.

Configuring Oxygen Content Fusion using the Web Interface

  1. Use the IP address shown in the VM console to access the web interface of Oxygen Content Fusion. The address should be https://<server-address>:9080.
    Note: By default, Oxygen Content Fusion uses a self-signed certificate. If you did not change it, the browser will display a security warning. Continue (for example, if you are using Edge or Internet Explorer, click Details and then Go on to the webpage).
  2. Login with the previously configured password, the username is fusion.
  3. Use the Web Interface to change any configuration options.
    Note: When generating a DKIM private key for the mail, the selector must be set to mail
  4. Restart the VM using the Restart Machine button from the General tab.

Configuring Oxygen XML Editor/Author to Connect to Your Enterprise Server

All Content Authors in your organization that will be uploading tasks will need to configure Oxygen XML Editor/Author to connect to your Enterprise server. You need to provide them with your Enterprise server URL and then each of them will need to follow the procedure found in: Connecting to Your Own Enterprise Server. Alternatively, if you want to impose the server URL for all Content Authors so that they do not need to do any manual configuration, continue reading to learn how to use a properties file to impose the Enterprise server address.

Configuring a Properties File to Instruct Oxygen XML Editor/Author to Connect to Your Enterprise Server

You can create a properties file to specify the address of your Enterprise server. This server address will then be imposed when Oxygen XML Editor/Author connects to the server and the Content Authors that will be uploading tasks will not need to do any manual configuration. When they click Connect, your server address will be imposed and they will not have the ability to change it. To create the properties file, use this procedure:
  1. Create a properties file named oxygenContentFusion.properties with the following content:
    server=[on-premise_server_address]

    where [on-premise_server_address] is the URL of your on-premise server (for example, http://myserver.com:8080).

  2. Save this file in Oxygen's default preferences directory. Depending on the platform and product you are using, this file is located in the following directories:
    For Oxygen XML Editor:
    • Windows - [user-home-folder]\AppData\Roaming\com.oxygenxml
    • OS X - [user-home-folder]\Library\Preferences\com.oxygenxml
    • Linux - [user-home-folder]\.com.oxygenxml
    For Oxygen XML Author:
    • Windows - [user-home-folder]\AppData\Roaming\com.oxygenxml.author
    • OS X - [user-home-folder]\Library\Preferences\com.oxygenxml.author
    • Linux - [user-home-folder]\.com.oxygenxml.author
  3. Each Content Author needs to install the Oxygen Content Fusion Connector add-on in Oxygen XML Editor/Author, then open the task management view and click Connect.

Using Custom Frameworks with Oxygen Content Fusion

One of the advantages of using the Oxygen Content Fusion Enterprise server solution is that it can be configured to support any DITA specialization or XML language. This must be done by someone who has access to customize Oxygen XML Web Author (for example, a server administrator).

For information about how to create, configure, reuse, test, and upload custom frameworks, see Integrating Web Author with Your Content by Creating Custom Frameworks.

To upload a custom framework to your Oxygen XML Web Author deployment, follow this procedure:
  1. Go to your Content Fusion configuration page.
  2. In the Web Author tab, click Manage Web Author. This will open the Oxygen XML Web Author Administration page.
  3. Select Frameworks.
  4. Click Upload Framework and choose a framework archive to upload.
    Important: Oxygen XML Web Author does a validation check to make sure the uploaded framework archive contains the proper extension descriptor file (*.framework). The archive should contain exactly one folder. Otherwise you will receive an error that the upload was rejected.
  5. Click OK to upload the file.

    Result: The framework should appear in the list on this Frameworks page. Uploaded frameworks appear with a light green highlight so that you can identify them easily.

  6. Once you are finished with all of your changes, restart the server.

Once a custom framework has been uploaded to your Oxygen XML Web Author deployment, whenever a file from that custom framework is opened in Oxygen Content Fusion, the reviewers will have access to the customizations made in that framework.