Documentation Center for Nuxeo Platform IDE

Wizard Index

Updated: September 18, 2017 Page Information Edit on GitHub

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

Here is the list of all wizards available on the IDE:

Projects

Name Description Generated files
Nuxeo Plugin Creates an empty Nuxeo plugin project.
  • src/test/java/packagePath
  • src/main/resources/META-INF/MANIFEST.MF
  • src/main/java/packagePath
  • src/main/resources/META-INF/MANIFEST.MF
  • pom.xml
Nuxeo WebEngine Creates an empty WebEngine project.
  • src/test/java/packagePath
  • src/main/resources/META-INF/MANIFEST.MF
  • src/main/java/packagePath/MyModule.java
  • src/main/resources/META-INF/MANIFEST.MF
  • src/main/resources/skin/base.ftl
  • src/main/resources/skin/resources/README.txt
  • src/main/resources/skin/resources/css/site.css
  • src/main/resources/skin/resources/img/logo.png
  • src/main/resources/skin/views/MyRoot/index.ftl
  • pom.xml

Automation

Name Description Generated files
operation Creates the operation and its XML contribution. You can choose the input/output of the operation, its ID, category etc.
  • src/main/java/packagePath/MyOperation.java
  • src/main/resources/OSGI-INF/extensions/extensions.xml

Component

Name Description Generated files
Nuxeo Component Creates a Java class extending DefaultComponent that can be exposed as a service.
  • src/main/java/packagePath/MyComponent.java
  • src/main/resources/OSGI-INF/extensions/extensions.xml

DocumentModel

Name Description Generated files
Adapter Generates an adapter and the appropriate XML contribution. The adapter will have a getter and a setter for the different properties of the selected schema. To select a schema, you need to bind the project to a Studio account.
  • src/main/java/packagePath/MyDocumentAdapter.java
  • src/main/java/packagePath/MyDocumentAdapterFactory.java
  • src/main/resources/OSGI-INF/extensions/extensions.xml
Listener Generates a listener and the appropriate XML contribution.
  • src/main/java/packagePath/MyListener.java
  • src/main/resources/OSGI-INF/extensions/extensions.xml

OpenSocial

Name Description Generated files
Automation Gadget Creates a gadget based on an automation chain.
  • resources/gadget/gadgetName/
  • resources/gadget/gadgetName/dynamic_messages.properties
  • resources/gadget/gadgetName/gadgetName.css
  • resources/gadget/gadgetName/gadgetName.js
  • resources/gadget/gadgetName/gadgetName.png
  • resources/gadget/gadgetName/gadgetName.xml
  • resources/gadget/gadgetName/gadgets-contrib.xml
Gadget Creates a gadget structure. Only difference with the Automation Gadget is in the JS file.
  • resources/gadget/gadgetName/dynamic_messages.properties
  • resources/gadget/gadgetName/gadgetName.css
  • resources/gadget/gadgetName/gadgetName.js
  • resources/gadget/gadgetName/gadgetName.png
  • resources/gadget/gadgetName/gadgetName.xml
  • resources/gadget/gadgetName/gadgets-contrib.xml

Seam

Name Description Generated files
Action Bean Code skeleton for a Seam bean that will manage a simple action. This can be used to:
  • do a navigation
  • do some modification on the currentDocument (or other docs)
  • create new documents
  • send/retrieve info from an external service
  • src/main/resources/extensions/MyAction-extensions.xml
  • src/main/resources/OSGI-INF/l10n/MyAction-messages.properties
  • src/main/resources/OSGI-INF/deployment-fragment.xml
  • src/main/resources/web/nuxeo.war/icons/MyAction-action.png
  • src/main/resources/seam.properties
  • src/main/seam/packagePath/MyActionBean.java
Controller Bean Code skeleton for a Bean that is controlling a new Tab like action (a XHTML fragment). This can be used:
  • to display additional information about a document
  • to provide a screen that allow to update the document
The bean is by default Conversation scoped so that:
  • if you have expensive computation it will be run only when needed
  • you can manage view/update/view cycle.
All states should be managed as member variables of the beans. The default invalidation policy is to reset the state when the currentDocument changes.
  • /src/main/resources/OSGI-INF/l10n/MyController-messages.properties
  • src/main/resources/OSGI-INF/deployment-fragment.xml
  • src/main/resources/web/nuxeo.war/icons/MyController-tab.png
  • src/main/resources/web/nuxeo.war/incl/tabs/MyController-tab.xhtml
  • src/main/resources/seam.properties
  • src/main/seam/packagePath/MyControllerBean.java
Service Bean This is a simple service wrapper that allow to inject a Nuxeo Runtime service as a Seam component. src/main/seam/packagePath/MyServiceWrapperBean.java

Security

Name Description Generated files
Permission Creates an XML contribution containing the new permission. src/main/resources/OSGI-INF/extensions/permissions.xml
Permission Visibility Creates an XML file that associates different permission to a document type. src/main/resources/OSGI-INF/extensions/permissions-visibility.xml
Security Policy Creates a Java file extending AbstractSecurityPolicy and the appropriate XML contribution.
  • src/main/java/packagePath/MySecurityPolicy.java
  • src/main/resources/OSGI-INF/extensions/extensions.xml
a month ago GitHub Fix formatting
3 years ago Solen Guitter 5
4 years ago Solen Guitter 4
6 years ago Solen Guitter 2
6 years ago Solen Guitter 3 | Migrated to Confluence 4.0
6 years ago Laurent Doguin 1
History: Created by Laurent Doguin