...
Note |
---|
To generate a plugin containing a sidebar widget, see the topic Widget Archetype. |
Maven
XperienCentral requires Maven 3.3.x. It’s very easy to check which version you are currently using: open a command prompt and type:
...
The widget is now available in XperienCentral (refresh the browser to load the new component in the javascript client framework).
Troubleshooting
The Plugin Does not Compile
Sun Microsystems provides two versions of Java for download on http://java.sun.com/:
- The Java Runtime Environment (JRE)
- The Java Development Kit (JDK)
The JDK consists of the JRE plus added extras. For plugin development you will need the JDK. If you get a build failure, check the following:
- Open the menu Window > Preferences > Java > Installed JREs.
- Ensure that a JDK version of Java is used in your JRE definition
- If the used JRE definition points to a JRE version of Java, then remove the reference to the JRE and create a new reference to the JDK.
Creating a Plugin with a Presentation Component
Each XperienCentral page is connected to a presentation (appearance). A presentation is connected to its own JSP template, used by XperienCentral to generate the HTML of the page. With this component it is possible to create new presentation. Presentations can have small differences (like another lead color or logo) or can be completely different.
Creating the helloWorld Presentation
...
Creating a Plugin with a Presentation Component
Each XperienCentral page is connected to a presentation (appearance). A presentation is connected to its own JSP template, used by XperienCentral to generate the HTML of the page. With this component it is possible to create new presentation. Presentations can have small differences (like another lead color or logo) or can be completely different.
Creating the helloWorld Presentation
To create a plugin that will add a new presentation style to XperienCentral, perform the following steps:
- Open a Command prompt.
- Navigate to the folder in which you already created your helloworldelement (
C:\GX\helloWorldWCBs
). - Execute the command (replace
<XperienCentral Version>
with the version number of XperienCentral that you’re building against (10.10.0, for example):mvn archetype:generate -DinteractiveMode=false -DarchetypeGroupId=nl.gx.webmanager.archetypes -DarchetypeArtifactId=webmanager-presentation-archetype -DarchetypeVersion=<XperienCentral Version> -DgroupId=com.gxwebmanager.helloworld -DartifactId=helloworldpresentation -Dclassprefix=HelloWorld -s
<xperiencentral-root>
\settings.xml
A new subfolder called "helloworldpresentation" is now present.
Building and Deploying the Presentation Component
In order to build and deploy the plugin, perform the following steps:
- Open a Command command prompt.
- Navigate to the folder in which you already created your helloworldelement (folder
C:\GX\helloWorldWCBs
)\helloworldpresentation
. - Execute the command (replace
<XperienCentral Version>
with the version number of XperienCentral that you’re building against (10.10.0, for example):mvn archetype:generate -DinteractiveMode=false -DarchetypeGroupId=nl.gx.webmanager.archetypes -DarchetypeArtifactId=webmanager-presentation-archetype -DarchetypeVersion=<XperienCentral Version> -DgroupId=com.gxwebmanager.helloworld -DartifactId=helloworldpresentation -Dclassprefix=HelloWorld -s
<xperiencentral-root>
\settings.xml
A new subfolder called "helloworldpresentation" is now present.
Building and Deploying the Presentation Component
In order to build and deploy the plugin, perform the following steps:
...
-s
<xperiencentral-root>
\settings.xml clean package- Copy the file
helloworldpresentation-1.0.0.jar
from the ‘target’ folder to
.<xperiencentral-root>
\work\deploy
The style is now available in XperienCentral.
...
Troubleshooting
The Plugin Does not Compile
Sun Microsystems provides two versions of Java for download on http://java.sun.com/:
- The Java Runtime Environment (JRE)
- The Java Development Kit (JDK)
The JDK consists of the JRE plus added extras. For plugin development you will need the JDK. If you get a build failure, check the following:
- Open the menu Window > Preferences > Java > Installed JREs.
- Ensure that a JDK version of Java is used in your JRE definition
- If the used JRE definition points to a JRE version of Java, then remove the reference to the JRE and create a new reference to the JDK.