Page Comparison

...

Now that XperienCentral is installed, it’s time to build your first plugin. The first plugin will contain one component: the helloWorld element component. After building and deploying this plugin, there will be a new element in XperienCentral. If that element is placed on a page, the text “Hello World!” will be displayed on the web page.

Maven

XperienCentral requires Maven 3.36.x. It’s very easy to check which version you are currently using: open a command prompt and type:  

...

To download the latest version of Maven 3.36.x, go to the website: http://maven.apache.org/download.html.

...

1. Create a folder on your computer in which you will start working on your helloWorld element (C:\GX\helloWorldWCBshelloWorld, for example).
2. Open a command prompt.
3. Navigate to the folder in which the element should will be created (C:\GX\helloWorldWCBshelloWorld).

4. Execute the command (replace the <XperienCentral Version> with the version number of XperienCentral that you’re building against (10.1037.0, for example)):
   
   mvn archetype:generate -DinteractiveMode=false -DarchetypeGroupId=nl.gx.webmanager.archetypes -DarchetypeArtifactId=webmanager-element-archetype -DarchetypeVersion=<XperienCentral Version> -DgroupId=com.gxwebmanager.helloworld -DartifactId=helloworldelement -Dclassprefix=HelloWorld -s <xperiencentral-root>\settings.xml



A new subfolder called "helloworldelement" is now present.

Building and Deploying the Plugin

...

1. Open a command prompt window.
2. Go to the folder C:\GX\helloWorldWCBshelloWorld\helloworldelement.
3. Execute the command:
   
   mvn -s <xperiencentral-root>\settings.xml clean package
   
   
4. Copy the file helloworldelement-1.0.0.jar from the target folder to <xperiencentral-root>\work\deploy.
5. The element is now available in XperienCentral. To prevent everybody from being able to use it right away, the element has to be activated first (this can be done through the
   Configuration > Channel configuration > Functionalities menu). After activation, the element is available in the menu.

...

Back to Top

...

Creating a Plugin with a Panel Component

...

1. Open a command prompt.
2. Navigate to the folder in which you already created your helloworldelement (C:\GX\helloWorldWCBshelloWorld, for example).
3. 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-panel-archetype -DarchetypeVersion=<XperienCentral Version> -DgroupId=com.gxwebmanager.helloworld -DartifactId=helloworldpanel -Dclassprefix=HelloWorld -s <xperiencentral-root>\settings.xml
   
   A new subfolder called "helloworldpanel" is now present.

Building and Deploying the Panel

...

1. Open a command prompt.
2. Navigate to the folder where the helloworldpanel was created (<xperiencentral-root>\helloWorldWCBshelloWorld\helloworldpanel, for example).
3. Execute the command:
   
   mvn -s <xperiencentral-root>\settings.xml clean package
   
   
4. Copy the file helloworldpanel-1.0.0.jar from the target folder to <xperiencentral-root>\work\deploy.

Press F5 to refresh XperienCentral - The panel is now available in XperienCentral in the Configuration menu.

...

Back to Top 

...

Creating a Plugin with a Media Item Component

In XperienCentral, the Content Repository can be filled with articles and multimedia items. These objects have a predefined set of metadata. If you need additional metadata for specific types of objects in the Content Repository, a new media item can be created. For example, vacancies have an additional selection list of predefined locations in the metadata. 

Creating the helloWorld Media Item

...

1. Open a command prompt.
2. Navigate to the folder in which you already created your helloworldelement and helloworldpanel (C:\GX\helloWorldWCBshelloWorld).
3. 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-mediaitem-archetype -DarchetypeVersion=<XperienCentral Version> -DgroupId=com.gxwebmanager.helloworld -DartifactId=helloworldmediaitem -Dclassprefix=HelloWorld -s <xperiencentral-root>\settings.xml

...

1. Open a command prompt.
2. Navigate to the folder C:\GX\helloWorldWCBshelloWorld\helloworldmediaitem.
3. Execute the command:
   
   mvn -s <xperiencentral-root>\settings.xml clean package
   
   
4. Copy the file helloworldmediaitem-1.0.0.jar from the target folder to <xperiencentral-root>\work\deploy.
5. Press F5 to refresh XperienCentral - The mediaItem component is now available in XperienCentral.

...

...

Back to Top

...

Creating a Plugin with a Page Metadata Component

...

1. Open a command prompt.
2. Navigate to the folder in which you already created your helloworldelement (C:\GX\helloWorldWCBshelloWorld).
3. Execute the command (replace <XperienCentral Version> with the version number of XperienCentral that you’re building against (10.6.0, for example):
   
   mvn archetype:generate -DinteractiveMode=false -DarchetypeGroupId=nl.gx.webmanager.archetypes -DarchetypeArtifactId=webmanager-pagemetadata-archetype -DarchetypeVersion=<XperienCentral Version> -DgroupId=com.gxwebmanager.helloworld -DartifactId=helloworldpagemetadata -Dclassprefix=HelloWorld -s <xperiencentral-root>\settings.xml

...

1. Open a command prompt.
2. Navigate to the folder C:\GX\helloWorldWCBshelloWorld\helloworldpagemetadata.
3. Execute the command:
   
   mvn -s <xperiencentral-root>\settings.xml clean package
   
   
4. Copy the file helloworldpagemetadata-1.0.0.jar from the "target" folder to <xperiencentral-root>\work\deploy.

Press F5 to refresh XperienCentral - The Page Metadata component is now available in XperienCentral. For each page it is now possible to enter a value for the new properties as defined in the page metadata component.

...

Back to Top 

...

Creating a Plugin with a Presentation Component

...

1. Open a Command prompt.
2. Navigate to the folder in which you already created your helloworldelement (C:\GX\helloWorldWCBshelloWorld).
3. 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

...

1. Open a command prompt.
2. Navigate to the folder C:\GX\helloWorldWCBshelloWorld\helloworldpresentation.
3. Execute the command:
   
   mvn -s <xperiencentral-root>\settings.xml clean package
   
   
4. Copy the file helloworldpresentation-1.0.0.jar from the ‘target’ folder to <xperiencentral-root>\work\deploy.

The style is now available in XperienCentral. 

Back to Top

...

Creating a Plugin with a Service Component

...

1. Open a Command prompt.
2. Navigate to the folder in which you already created your helloworldelement (C:\GX\helloWorldWCBshelloWorld).
3. Execute the command (replace <XperienCentral Version> with the version number of XperienCentral that you’re building against (10.6.0, for example):
   
   mvn archetype:generate -DinteractiveMode=false -DarchetypeGroupId=nl.gx.webmanager.archetypes -DarchetypeArtifactId=webmanager-service-archetype -DarchetypeVersion=<XperienCentral Version> -DgroupId=com.gxwebmanager.helloworld -DartifactId=helloworldservice -Dclassprefix=HelloWorld -s <xperiencentral-root>\settings.xml
   
   A new subfolder called "helloworldservice" is now present.

...

1. Open a Command prompt.
2. Navigate to the folder C:\GX\helloWorldWCBshelloWorld\helloworldservice.
3. Execute the command:
   
   mvn -s <xperiencentral-root>\settings.xml clean package
   
   
4. Copy the file helloworldservice-1.0.0.jar from the ‘target’ folder to <xperiencentral-root>\work\deploy folder.

The service is now available to other plugins in XperienCentral.

Back to Top 

...

Creating a Plugin with a Servlet Component

...

1. Open a command prompt.
2. Navigate to the folder in which you already created your helloworldelement (C:\GX\helloWorldWCBshelloWorld).
3. Execute the command (replace <XperienCentral Version> with the version number of XperienCentral that you’re building against (10.6.0, for example):
   
   mvn archetype:generate -DinteractiveMode=false -DarchetypeGroupId=nl.gx.webmanager.archetypes -DarchetypeArtifactId=webmanager-servlet-archetype -DarchetypeVersion=<XperienCentral Version> -DgroupId=com.gxwebmanager.helloworld -DartifactId=helloworldservlet -Dclassprefix=HelloWorld -s <xperiencentral-root>\settings.xml
   
   A new subfolder called "helloworldservlet" is now present.

...

1. Open a command prompt.
2. Navigate to the folder C:\GX\helloWorldWCBshelloWorld\helloworldservlet.
3. Execute the command:
   
   mvn -s <xperiencentral-root>\settings.xml clean package
   
   
4. Copy the file helloworldservlet-1.0.0.jar from the ‘target’ folder to <xperiencentral-root>\work\deploy.

...

http://<hostname>:<portnumber>/<context>/helloworldservlet.servlet

it should display:

helloworldservlet - Hello World!
Init parameter: ‘key’ = ‘value’ 

Back to Top

...

Creating a Plugin with a Sidebar Widget

You can add new sidebar (DOJO) widgets to XperienCentral. This archetype will give you a small working sidebar widget example which will respond to the current context and show the title of the content item (Page, Page Section, Media Item) that is being editted and enable the editor to change the url title. 

Creating the helloWorld Sidebar Widget 

...

1. Open a Command prompt.
2. Navigate to the folder in which you already created your helloworldelement (C:\GX\helloWorldWCBshelloWorld).
3. 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-sidebarwidget-archetype -DarchetypeVersion=<XperienCentral Version> -DgroupId=com.gxwebmanager.helloworld -DartifactId=helloworldsidebarwidget -Dclassprefix=HelloWorld -s <xperiencentral-root>\settings.xml

A new subfolder called "helloworldsidebarwidget" is now present.

Building and Deploying the

...

Sidebar Widget Component

In order to build and deploy the plugin, perform the following steps:

1. Open a command prompt.
2. Navigate to the folder C:\GX\helloWorldWCBshelloWorld\helloworldsidebarwidget.
3. Execute the command:
   
   mvn -s <xperiencentral-root>\settings.xml clean package
   
   
4. Copy the file helloworldpresentation-1.0.0.jar from the ‘target’ target folder to <xperiencentral-root>\work\deploy.

The widget is now available in XperienCentral (refresh the browser to load the new component in the javascript JavaScript client framework). 

Back to Top

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:

1. Open the menu Window > Preferences > Java > Installed JREs.
2. Ensure that a JDK version of Java is used in your JRE definition
3. 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.

Back to Top

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:

1. Open a Command prompt.
2. Navigate to the folder in which you already created your helloworldelement (C:\GX\helloWorld).
3. 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:

1. Open a Command command prompt.
2. Navigate to the folder in which you already created your helloworldelement (folder C:\GX\helloWorldWCBs)helloWorld\helloworldpresentation.
3. 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:

...

The style is now available in XperienCentral.

...

1. the command:
   
   mvn -s <xperiencentral-root>\settings.xml clean package
   
   
2. Copy the file helloworldpresentation-1.0.0.jar from the ‘target’ folder to <xperiencentral-root>\work\deploy.

The style is now available in XperienCentral.

Back to Top

...

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:

1. Open the menu Window > Preferences > Java > Installed JREs.
2. Ensure that a JDK version of Java is used in your JRE definition
3. 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.

Back to Top