Content Management Platform

For Business Applications

/
Nuxeo Case Management
Framework 1.x
Installation
Guide
Released on 02/11/13
1. Nuxeo CMF Installation Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1 Some requirements before you start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.2 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.3 Nuxeo DM and Nuxeo CMF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.3.1 Working with the same repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Nuxeo Case Management Framework 1.x Documentation Center
Copyright 2010-2013 Nuxeo.
This documentation is published under Creative Common BY-SA license. More details on the . Nuxeo Documentation License page
1.
2.
3.
Nuxeo CMF Installation Guide
Welcome to the Nuxeo CMF Installation Guide.
You have just downloaded Nuxeo Case Management Framework 1.x, now how do you try it on your computer?
Nuxeo CMF can be installed on any computer, provided that . Installing Nuxeo CMF requires 3 Java is installed
simple steps:
Install the downloaded package,
Start the server,
Connect to Nuxeo CMF in a web browser.
Once Nuxeo CMF is installed, you may want to used for some features. install some additional resources
In this page, we explain how to quickly install and start the different Nuxeo CMF packages available for download:
Install Nuxeo CMF on Windows
How to Install Nuxeo CMF with the Windows installer
How to Install Nuxeo CMF from the ZIP archive
How to start Nuxeo CMF on Windows
Install Nuxeo CMF on Linux
How to install Nuxeo CMF the ZIP package
How to Install Nuxeo CMF from the APT repository for Debian and Ubuntu
How to install Nuxeo CMF with the Debian package
How to start Nuxeo CMF on Linux
How to Install Nuxeo CMF on Mac OS
By default, you cannot run two Nuxeo applications at the same time. If you want to run two
Nuxeo applications at the same time (for instance a Nuxeo DM and a Nuxeo DAM), you need to
. change the default port used by the Nuxeo server
Install Nuxeo CMF on Windows
Depending on the version and distribution of Nuxeo CMF you downloaded, you can have:
a .exe file (Windows specific installer)
a .zip file (simple archive, multi-OS compliant)
How to Install Nuxeo CMF with the Windows installer
Here are the steps to install Nuxeo CMF using the Windows installer.
To install the application using the Windows installer (.exe), double-click on the .exe installer you
downloaded and follow the instructions displayed.
CMF 1.7
On Windows 7, because of rights issues, it is highly recommended to install your
Nuxeo application at the root of C: in order for your application to restart correctly at
the end of the . startup wizard steps
You can then . start Nuxeo CMF

Nuxeo Case Management Framework 1.x Documentation Center
Copyright 2010-2013 Nuxeo.
This documentation is published under Creative Common BY-SA license. More details on the . Nuxeo Documentation License page
1.
2.
3.
How to Install Nuxeo CMF from the ZIP archive
Here are the steps to install Nuxeo CMF using the ZIP archive.
Unzip the .zip archive using your favorite tool.
CMF 1.7
On Windows 7, because of rights issues, it is highly recommended to install your
Nuxeo application at the root of C: in order for your application to restart correctly at
the end of the . startup wizard steps
You can then . start Nuxeo CMF
How to start Nuxeo CMF on Windows
Open the Nuxeo Control Panel.
Depending on how you installed your application, you can open the Nuxeo
Control Panel in two different ways. See below for the appropriate command.
The Nuxeo Control Panel opens.
Click on the button. Start
Starting the Nuxeo server takes between 30 sec and several minutes, depending on your
hardware and the distribution you have chosen to install.
When the server is started, the button becomes a button. Start Stop
Open a browser and type the URL . http://localhost:8080/nuxeo/
On Nuxeo CMF 1.0 to 1.6, you can directly log in to your application the user name Administrator
and the password and start using your application. Administrator
On Nuxeo CMF 1.7, you need to set up your application's configuration using the displayed startup
. wizard
How to open the Nuxeo Control Panel
Nuxeo CMF package Command
zip package of Nuxeo CMF 1.0 to 1.6 In the folder , C:\Nuxeo application\bin
double-click on NuxeoCtl.exe.
zip package of Nuxeo CMF 1.7 In the folder , C:\Nuxeo application\bin
double-click on nuxeoctl.bat.
On Windows 7, you need to run the nuxeoctl.bat and Start Nuxeo.bat commands as an
administrator if you haven't installed your Nuxeo application at the root of (for instance in C: C:\
). To run them as an administrator, right-click on the command and click on Program Files
"Run as administrator".
On Windows, it is possible to start Nuxeo as a service. Please report the Install the application as a Windows
page for guidelines and examples. service

Nuxeo Case Management Framework 1.x Documentation Center
Copyright 2010-2013 Nuxeo.
This documentation is published under Creative Common BY-SA license. More details on the . Nuxeo Documentation License page
1.
Install Nuxeo CMF on Linux
You can install Nuxeo CMF on Linux in three different ways:
from the downloaded zip archive,
from APT sources for Debian,
from the downloaded Debian package.
How to install Nuxeo CMF the ZIP package
Unzip the downloaded ZIP file using your favorite tool.
You can then . start Nuxeo CMF
How to Install Nuxeo CMF from the APT repository for Debian and Ubuntu
Installing Nuxeo CMF using the APT sources for Debian installs and configures Nuxeo CMF, but it also installs all
required dependencies for an optimal use of the application.

Nuxeo Case Management Framework 1.x Documentation Center
Copyright 2010-2013 Nuxeo.
This documentation is published under Creative Common BY-SA license. More details on the . Nuxeo Documentation License page
1.
a.
b.
2.
3.
4.
5.
Activate and sources for JDK Sun install and other third parties: multiverse partner
Click on . System/Administration/Software Sources
Check the and sources. multiverse partner
Add the Nuxeo key:
Download the Nuxeo key and import it in the "Authentication" tab.
Or, in a terminal, issue:
wget -q -O- http://apt.nuxeo.org/nuxeo.key | sudo apt-key add -
Add the Nuxeo source:
In the "Other Software" tab, add " " to deb lucid releases http://apt.nuxeo.org/
the software sources.
Or issue the following commands in a terminal:
sudo add-apt-repository "deb http://apt.nuxeo.org/ lucid
releases"
sudo apt-get update
Install Nuxeo CMF:
Click on apt://nuxeo-cmf
or, in a terminal, issue:
sudo apt-get install nuxeo-cmf
Follow the instructions displayed.
If it's your first install of Nuxeo CMF, you can configure:
the bind address,
the port,
the database (a preconfigured PostgreSQL database is suggested by default).
The application is installed as a service. It is automatically started and set to automatically start at boot.
Installation details
Here are some information of the installation's configuration:

Nuxeo Case Management Framework 1.x Documentation Center
Copyright 2010-2013 Nuxeo.
This documentation is published under Creative Common BY-SA license. More details on the . Nuxeo Documentation License page
application: opt/nuxeo-cmf
Configuration file (nuxeo.conf): etc/nuxeo-cmf/nuxeo.conf
logs: var/log/nuxeo-cmf
data: var/log/nuxeo-cmf
How to install Nuxeo CMF with the Debian package
A Debian installer (.deb) is available for download. This installer enables you to configure your application at the
time of installation and to install it as a Debian service directly.
To install Nuxeo DAM using the Debian package:
Double-click on the and follow the instructions displayed. If it's your first install of downloaded .deb file
Nuxeo DAM, you can configure:
the bind address,
the port,
the database (a preconfigured PostgreSQL database is suggested by default).
The application is automatically installed as a service and immediately started and set to automatically
start at boot.
The installation's configuration (where to find the configuration file, logs etc) are the same as for the APT sources
. installation
How to start Nuxeo CMF on Linux

Nuxeo Case Management Framework 1.x Documentation Center
Copyright 2010-2013 Nuxeo.
This documentation is published under Creative Common BY-SA license. More details on the . Nuxeo Documentation License page
1.
2.
3.
4.
1.
For a Nuxeo DAM installed from the zip archive:
Launch a terminal and go to your installation directory.
Start the server using the script (located in the directory): nuxeoctl bin
./bin/nuxeoctl gui
The command used to launch the Control Panel may not be executable by
default. If it is the case, in the terminal go to the directory of Nuxeo and bin
type the line below to be able to use it:
chmod +x *.sh *ctl
The Control Panel opens.
Click on the button. Start
Starting the Nuxeo server takes between 30 sec and several minutes, depending on your
hardware and the distribution you have chosen to install.
When the server is started, the button becomes a button. Start Stop
Open a browser and type the URL . http://localhost:8080/nuxeo/
On Nuxeo CMF 1.0 to 1.6, you can directly log in to your application the user name Administrator
and the password and start using your application. Administrator
On Nuxeo CMF 1.7, you need to set up your application's configuration using the displayed startup
. wizard
How to Install Nuxeo CMF on Mac OS
To install Nuxeo CMF on Mac OS, you need the .zip package.
Step 1: Install Nuxeo CMF
Unzip the downloaded ZIP file using your favorite tool.

Nuxeo Case Management Framework 1.x Documentation Center
Copyright 2010-2013 Nuxeo.
This documentation is published under Creative Common BY-SA license. More details on the . Nuxeo Documentation License page
1.
2.
3.
Step 2: Start Nuxeo CMF
From the Finder, click on "Start Nuxeo.command". You can also drag and drop the start script in
the terminal and press Enter.
The command may not be executable by default. If it is the case, in the
terminal go to the directory of Nuxeo and type the line below: bin
chmod +x *.command
The Control Panel opens.
Click on the button. Start
Starting the Nuxeo server takes between 30 sec and several minutes, depending on your
hardware and the distribution you have chosen to install.
When the server is started, the button becomes a button. Start Stop
Open a browser and type the URL . http://localhost:8080/nuxeo/
On Nuxeo CMF 1.0 to 1.6, you can directly log in to your application the user name Administrator
and the password and start using your application. Administrator
On Nuxeo CMF 1.7, you need to set up your application's configuration using the displayed startup
. wizard
See the to discover all Nuxeo CMF features. Nuxeo CMF User Guide
Download
. Download this documentation in PDF
Detailed install instructions
Some requirements before you start: Check java version and install it if needed
Set up additional resources: Install external software you may need for a comprehensive
experience of Nuxeo CMF.
Join the Nuxeo community
Use our to share your experiences, connect to other users and get help discussion forum
Subscribe to the to stay informed about the evolution of the platform ECM list
Follow us on , and . LinkedIn Facebook Twitter
Some requirements before you start
Nuxeo CMF can run on Windows, Mac OS X and Linux distributions.
Nuxeo CMF is available in a zip package (.zip extension) for all operating systems.
Nuxeo CMF is fully based on Java. This means that Nuxeo can easily be deployed on any platform with a Java
Runtime Environment (JRE).
Either Java 1.5 (also called Java 5) or Java 1.6 (also called Java 6) is required. Java 6 is the preferred version, if
you have the choice.
The Java Runtime Environment (JRE) is enough to run the product, the Java Software
Development Kit (SDK) is only necessary if you plan to do some development.

Nuxeo Case Management Framework 1.x Documentation Center
Copyright 2010-2013 Nuxeo.
This documentation is published under Creative Common BY-SA license. More details on the . Nuxeo Documentation License page
1.
2.
1.
2.
We recommend Sun's JRE and do not support other JREs.
Don't hesitate to contact us if you need us to support a JRE from another vendor, such as
JRockit from Oracle or the IBM JRE.
Check Java version
To check that you have the right version of Java
Open a terminal :
In Windows: press "windows" + r, type "cmd" in the run window and press "OK" or open the
Prompt command from "Start > Programs > Accessories" menu.
In Linux or Mac OS: open a terminal.
Type " " and press "Enter". java -version
If Java is installed on your computer, the name and version of your Java virtual machine is
displayed:
If Java is not installed on you computer, it fails to display the java version. If this is the case, you
need to install Java.
Install Java
For Windows users
If the required version of Java is not installed on your computer:
Download it from Sun website: choose
"Java SE Runtime Environment"
then, the appropriate configuration for your hardware and Windows version.
Run the downloaded .exe file.
For Linux users
On a modern Linux distribution, you can now install Java 6 with the packaging system of your distribution (using
rpm, apt, yum, etc.).
If a JRE or SDK from Sun (or the OpenSDK) is not available for your OS, you can still download it from Sun using
the same instructions as for Windows users.
For Mac OS users
An appropriate version of Java should already be installed on your computer if you are using either Mac OS X
Leopard (Java 5) or Snow Leopard (Java 6).
Run " " after having checked export JAVA_HOME=/System/Library/Frameworks/JavaVM.framework/Home

Nuxeo Case Management Framework 1.x Documentation Center
Copyright 2010-2013 Nuxeo.
This documentation is published under Creative Common BY-SA license. More details on the . Nuxeo Documentation License page
it's actually there.
Configuration
Mailbox synchronization
Synchronization is triggered when the event 'syncMailbox' occurs. Default configuration is available in
'org.nuxeo.cm.schedule' component. The event is programmed for 1 am every day. If you don't need
synchronization, you have to remove or modify cm-sync-scheduler-config.xml in templates/cmf/config :
<?xml version="1.0"?>
<component name="org.nuxeo.cm.schedule.custom.contrib">
<require>org.nuxeo.cm.schedule</require>
<extension
target="org.nuxeo.ecm.platform.scheduler.core.service.SchedulerRegistryService"
point="schedule">
<documentation>
Change the frequence of syncMailbox event so it is triggered
at 01:00am on the last day of every month.
Details about the cronExpression syntax can be found here:
[http://www.quartz-scheduler.org/docs/tutorials/crontrigger.html]
</documentation>
<schedule id="syncMailbox">
<username>Administrator</username>
<password>Administrator</password>
<eventId>syncMailbox</eventId>
<eventCategory>cmSync</eventCategory>
<cronExpression>0 0 1 L * ?</cronExpression>
</schedule>
</extension>
</component>
Synchronization Service
Default configuration will synchronize user and group directories.
If you need to deactivate one of them, or change the mailbox titles are generated, you need to override default
configuration. Simply add an xml file like cm-sync-mailbox-custom-config.xml in your template folder with the
following content:

Nuxeo Case Management Framework 1.x Documentation Center
Copyright 2010-2013 Nuxeo.
This documentation is published under Creative Common BY-SA license. More details on the . Nuxeo Documentation License page
<?xml version="1.0"?>
<component name="org.nuxeo.cm.service.synchronization.contrib.custom">
<require>org.nuxeo.cm.service.synchronization.contrib</require>
<extension
target="org.nuxeo.cm.core.service.synchronization.MailboxSynchronizationService"
point="directoryToMailbox">
<!-- deactivate user synchronization -->
<userToMailbox enabled="false" />
<!-- use a custom title generator for group synchronization -->
<groupToMailbox>

<titleGenerator>com.company.project.cmf.synchronization.CustomGroupMailboxTitleGener
ator</titleGenerator>
</groupToMailbox>
</extension>
</component>
If you need more details on synchronization implementation, please visit . the Mailbox synchronization page
Nuxeo DM and Nuxeo CMF
Working with the same repository
Deployment
Nuxeo CMF is a framework based on Nuxeo Enterprise Platform (EP). That means that all the features available on
a Nuxeo DM instance are available or can be easily integrated to CMF.
Despite that, an interesting use case might be to have 2 separate instances , one DM and one CMF running on the
same repository.
For this configuration, the clustering needs to be enabled on the 2 servers.
The documentation to enable the clustering can be found here: . Nuxeo clustering configuration
We also need to have the same document types available on both instances and a common structure of the root
documents.
For this you need to deploy the following CMF jars on DM:
nuxeo-case-management-api
nuxeo-case-management-core
nuxeo-case-management-lang
By default the , we have the following structure for the Default Domain :
Case Management
-CaseRoots
-MailboxRoots
-SectionRoots

Nuxeo Case Management Framework 1.x Documentation Center
Copyright 2010-2013 Nuxeo.
This documentation is published under Creative Common BY-SA license. More details on the . Nuxeo Documentation License page
If you need to modify it , in order to make available for example the Workspaces root (as in standard DM), you
should ovveride the contentTemplate defined in cm-content-template-contrib.xml and deploy your contribution on
both instances.