In This Topic

Building Your First Plugin

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.6.x. It’s very easy to check which version you are currently using: open a command prompt and type:

mvn -version

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

Creating the helloWorld Element Plugin

To create a plugin that will add an element to XperienCentral, perform the following steps:

Create a folder on your computer in which you will start working on your helloWorld element (C:\GX\helloWorld, for example).
Open a command prompt.
Navigate to the folder in which the element will be created (C:\GX\helloWorld).
Execute the command (replace <XperienCentral Version> with the version number of XperienCentral that you’re building against (10.37.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

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

Open a command prompt window.
Go to the folder C:\GX\helloWorld\helloworldelement.
Execute the command:

mvn -s <xperiencentral-root>\settings.xml clean package
Copy the file helloworldelement-1.0.0.jar from the target folder to <xperiencentral-root>\work\deploy.
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

After creating your first plugin with an element component, it’s time to create a new type of component: a panel. A panel is a pop-up in XperienCentral that usually contains functionality that performs maintenance on objects. An example of such a panel is the pop-up in which you can maintain web users in XperienCentral.

Creating the helloWorld Panel

To create a plugin that will add a panel to XperienCentral, perform the following steps:

Open a command prompt.
Navigate to the folder in which you already created your helloworldelement (C:\GX\helloWorld, for example).
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

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

Open a command prompt.
Navigate to the folder where the helloworldpanel was created (<xperiencentral-root>\helloWorld\helloworldpanel, for example).
Execute the command:

mvn -s <xperiencentral-root>\settings.xml clean package
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.

In XperienCentral, the terms "media item" and "content item" are synonymous. For reasons of backward compatability with earlier versions of GX WebManager 9.x, these terms are used interchangeably throughout our documentation.

Creating the helloWorld Media Item

To create a plugin that will add a media Item to XperienCentral, perform the following steps:

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

A new subfolder called "helloworldmediaitem" is now present.

Building and Deploying the Media Item

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

Open a command prompt.
Navigate to the folder C:\GX\helloWorld\helloworldmediaitem.
Execute the command:

mvn -s <xperiencentral-root>\settings.xml clean package
Copy the file helloworldmediaitem-1.0.0.jar from the target folder to <xperiencentral-root>\work\deploy.
Press F5 to refresh XperienCentral - The mediaItem component is now available in XperienCentral.

If you create a custom download media item that you want to be downloadable directly from a Content Overview and/or Dynamic Content Overview element, the custom mediaItemVersionImpl should implement: nl.gx.webmanager.cms.mediarepository.MediaItemDownloadVersion.

Back to Top

Creating a Plugin with a Page Metadata Component

In XperienCentral, pages are the building blocks of your website. Pages have some default metadata properties like title, navigation title, publication date and so forth. The page metadata component allows the plugin programmer to add additional metadata fields to each page in XperienCentral. This part describes how to create a plugin based on the pagemetadata archetype.

Creating the helloWorld pagemetadata

To create a plugin that will add page metadata to XperienCentral, perform the following steps:

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

A new subfolder called "helloworldpagemetadata" is now present.

Building and Deploying the pagemetadata

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

Open a command prompt.
Navigate to the folder C:\GX\helloWorld\helloworldpagemetadata.
Execute the command:

mvn -s <xperiencentral-root>\settings.xml clean package
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

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\helloWorld).
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 prompt.
Navigate to the folder C:\GX\helloWorld\helloworldpresentation.
Execute the command:

mvn -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.

Back to Top

Creating a Plugin with a Service Component

A service component is a so-called headless service - It has no user interface. Examples of services are mailing services, newsfeed imports, storage services and scheduling services. Often a service is used as support for components that work together, like a bookstore panel and a bookstore element: they depend on a service that regulates the storage of the content of the business objects.

Creating the helloWorld Service

To create a plugin that will add a new service component to XperienCentral, perform the following steps:

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

Building and Deploying the Service Component

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

Open a Command prompt.
Navigate to the folder C:\GX\helloWorld\helloworldservice.
Execute the command:

mvn -s <xperiencentral-root>\settings.xml clean package
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

A servlet is a Java program that runs in a web container. A servlet is an object that receives a request and generates a response based on that request. Examples of servlets are the controller and show servlet of XperienCentral. An example use case of a servlet: a servlet that handles AJAX calls.

Creating the helloWorld Servlet

To create a plugin that will add a new servlet component to XperienCentral, perform the following steps:

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

Building and Deploying the Servlet Component

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

Open a command prompt.
Navigate to the folder C:\GX\helloWorld\helloworldservlet.
Execute the command:

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

The servlet is now available to other plugins in XperienCentral. To test the proper working of the servlet, open a browser window and navigate to either:

http://<hostname>:<portnumber>/<context>/wcbservlet/com.gxwebmanager.helloworld.helloworldservlet.servlet

or

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

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\helloWorld).
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:

Open a command prompt.
Navigate to the folder C:\GX\helloWorld\helloworldsidebarwidget.
Execute the command:

mvn -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 widget is now available in XperienCentral (refresh the browser to load the new component in the JavaScript client framework).

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

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\helloWorld).
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 prompt.
Navigate to the folder C:\GX\helloWorld\helloworldpresentation.
Execute the command:

mvn -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.

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:

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.

Back to Top