Prerequisites:

The install procedure below was tested on:

 

Other DEB or RPM based distributions should function as well.

 

Installing

To install XF Ultrascale 2013 Server for Linux on RPM based distributions (Redhat, Fedora, Suse) the following command must be run:

 

 

       rpm -i XFUltrascale-vX.X.X-xxxx.i386.rpm

 

 

On Debian based distributions (including Ubuntu) the following command must be run:

 

 

       dpkg -i xfultrascale_vX.X.X-xxxx_i386.deb

 

 

where vX.X.X-xxxx stands for the current version and build number.

 

XF Ultrascale 2013 Server is automatically started and added to run levels 3 and 5.

The server will listen for rendering requests on port 1099. Incoming connections on this port must be allowed.

 

A suitable iptables rule for this is:

 

 

       iptables -A INPUT -p tcp --dport 1099 -j ACCEPT

 

 

Testing the Installation State

To test the installation state of the Ultrascale server the following command must be run:

 

 

       rpm -q XFUltrascale

 

 

On Debian based distributions, Ubuntu for example, the following command must be run:

 

 

       dpkg -l xfultrascale

 

 

 

What Is Included

The default installation folder is /opt/Ecrion/XFUltrascale.

The following tools and programs are installed under the Bin/ subfolder. Click on the hyperlinks for more information:

 

Server Commands:

To manually start the XF Ultrascale 2013 Server, the following command must be run:

 

 

       /etc/init.d/ultrascaled start

 

 

To stop XF Ultrascale 2013 Server, the following command must be run:

 

 

       /etc/init.d/ultrascaled stop

 

 

On Redhat/Fedora the "service ultrascaled start" and "service ultrascaled stop" can be used to start and stop the daemon.

 

 

Uninstalling

 

To uninstall XF Ultrascale 2013 Server for Linux on RPM based distributions (Redhat, Fedora, Suse) the following command must be run:

 

 

       rpm -e XFUltrascale_vX.X.X-xxxx_i386.rpm

 

 

On Debian based distributions (including Ubuntu) the following command must be run:

 

 

       dpkg -r xfultrascale_vX.X.X-xxxx_i386.deb

 

 

which will remove everything except the configuration files.

 

To remove everything, including all the configuration files that were created by the user, the following command must be run:

 

 

       dpkg --purge xfultrascale

 

 

 

Testing the installation:

 

Rendering a document using JURender:

 

 

       JURender -fo /opt/Ecrion/XFUltrascale/XML\ Samples/XSL-FO\ Test\ Suite/Barcodes.fo -pdf /root/Barcodes.pdf

 

 

All command line utilities will accept –help to display examples of usage:

 

 

       JURender -help

 

 

To place the rendered output in the standard output the following command must be used:

 

 

       JURender -fo /opt/Ecrion/XFUltrascale/XML\ Samples/XSL-FO\ Test\ Suite/Barcodes.fo -pdf stdout -parameters:loglevel=none

 

 

 

Licenses:

 

To list all the currently activated licenses the following command must be run:

 

 

       ULicUtil list

 

 

The easiest way to install and activate a license on Linux is to do it online. The following command must be run after receiving a license key:

 

 

       ULicUtil install -key KKKKKKKKKKKKKKKKKKKKKKKKKKKK -user <USERNAME> -pass <PASSWORD>

 

 

If no internet connection is available, the license can be installed and activated offline by following the next steps:

 

Firstly, the license must be installed using the following command:

 

 

       ULicUtil install -key KKKKKKKKKKKKKKKKKKKKKKKKKKKK

 

 

The program will generate an activation request. The activation request can be used to get an activation response in the client section at www.ecrion.com.

 

To activate a license, the activation response generated in the client section must be used:

 

 

       ULicUtil activate -response XXXXXXXXXXXXXXXXXXXXXXXXX

 

 

To uninstall a license:

 

 

       ULicUtil uninstall -key KKKKKKKKKKKKKKKKKKKKKKKKKKKK

 

 

An uninstall request will be printed. This uninstall request can be used in the Customer Section at www.ecrion.com to release the license and use it on another computer.

 

 

Certificate management:

 

UCertManager is the certificate management tool used to install/uninstall public certificate/private key pairs (digital identities).

 

Here is a brief list of commands:

 

 

 

       UCertManager list

 

 

The command will list all the identities from the container (index in the container, issuer and subject).

 

 

 

       UCertManager import pkcs12_file

 

 

The digital identity information is added to the container.

 

 

 

       UCertManager mport -incert cert_file -inkey privkey_file

 

 

The digital identity information (the private key and its ownership certificate) is added to the container.

 

 

 

       UCertManager delete -entry index.

 

 

 

 

       UCertManager export -entry index -out out_file.

 

 

Enabling Logging

 

To configure logging under Linux, the UDaemon configuration file located at /opt/Ecrion/Common/UDaemon.config must be edited (if the file does not exist, it must be first created).

To enable full logging, the following lines must be added at the end of the file:

 

 

       LogLevel=Debug
       LogFolder=/opt/Ecrion/Common

 

 
After saving the file, the Ultrascale service must be restarted using the following command:

 

 

       /etc/init.d/ultrascaled restart

 

 

The server will start generating logs in the specified "Log" folder (in this case /opt/Ecrion/Common).

There are several logging levels to choose from, Debug being the most verbose.  The other options are: None(default), Normal, and All.

 

Engine Settings

 

To configure various engine parameters, the UDaemon configuration file located at /opt/Ecrion/Common/UDaemon.config must be edited (if the file does not exist, it must be first created).

The available settings can be found here.

 

 

Note:

 

 

       "rpm -qlp XFUltrascale-vX.X.X-xxxx.i386.rpm"

 

 

vX.X.X-xxxx stands for current version and number of XF Ultrascale

 

The following paths will be displayed:

...

/opt/Ecrion/XFUltrascale/Bin/Render

/opt/Ecrion/XFUltrascale/Bin/UCertManager

/opt/Ecrion/XFUltrascale/Bin/UDaemon

/opt/Ecrion/XFUltrascale/Bin/ULicUtil

 

Server Templates

 

Server Templates are also available on Linux and can be found in the /opt/Ecrion/Common/Ecrion/ServerTemplates folder.

The next steps must be followed in order to add a local template as server template:

1. Access the /opt/Ecrion/Common/Ecrion/ServerTemplates folder.

2. Create a new folder (for example, "ServerApplicationSample"), then copy the template (for example, "SampleTemplate.xfd") and any additional resources in it (images, Building Blocks etc.).

3. Create a file named "Application.config" and insert the following line:

 

 

       AllowTo=Guest;

 

 

4. Restart the server

5. To test the created server application, use the following command:

 

 

       Render -xml xmlfile.xml -parameters:servertemplateid=ServerApplicationSample:SampleTemplate.xfd

 

 

Note: