Documentation Center for Nuxeo Platform IDE

The Nuxeo IDE perspective

Updated: January 2, 2020

Nuxeo IDE is being replaced by the Nuxeo Generator and won’t be maintained any longer. You can take a look at the page Configure Nuxeo Platform to discover how to use the Nuxeo Generator.

The Nuxeo perspective is the proposed layout to work on Nuxeo projects. It extends the default Java perspective by adding some specific Nuxeo IDE views like:

Nuxeo Server

Let's start by looking at the Nuxeo Server tab . It gives you the ability to start , stop , start in debug mode . As you can see when starting Nuxeo, the tab starts displaying the server log. There are two associated buttons to Lock the scrolling and to Clear the console. Once you see the "Server started" line in the logs, you can click on the Open Nuxeo In Web Browser button. We'll talk about the other two (hot reload and deployment profile ) later.

Nuxeo components

The Components tab gives you an overview of the different Components available in the SDK. What's a component you might ask? It's an XML file declaring a Service, an Extension Point (XP) or a contribution to an XP. This is what makes Nuxeo easily extensible. Basically a Service will provide some business logic that can be modified or extend using XPs. The service knows how to handle and register contribution to XP. Here's an example. In Nuxeo there is a service that handles Document Type. It knows how to handle several XPs. One of them is used to register new Document Type for Nuxeo. You can find out more on our component model in our documentation.

Nuxeo Studio

The Studio tab lists the different Studio project you have access to. You can browse their content to see what configuration has been added to the project. Click on a feature and you'll be sent directly to the corresponding Studio tab. Notice the two icons on the upper right corner. One is used to refresh the list and the other is used to export the operations you develop in the IDE into your Studio project.

Nuxeo Shell

Nuxeo Shell is, as its name suggest, a shell. You can use it to log in to Nuxeo and realize different actions. You can use it to connect and do maintenance work on any remote Nuxeo server.

To switch to the Nuxeo perspective, click on Window > Open Perspective and choose Nuxeo. Of course, you can always use the default Java perspective and add the Nuxeo IDE views you want.

We'd love to hear your thoughts!

All fields required