Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The client-side architecture introduced in XperienCentral makes it possible to add functionality to the Workspace using Dojo widgets. The advantave of this architecture is that you can add functionality which reacts to changes in the Workspace and Editor, such as when starting editing or viewing content. The figure below shows a depiction of the XperienCentral client-side architecture.

 

Section
Column
width575px

Image RemovedImage Added

Column

From top to bottom:

  • The user interface of XperienCentral consisting of Dojo widgets.
  • The business logic classes provide an API for managing things such as content (the client-side API).
  • The communication between the client (browser) and the server is streamlined using Dojo data stores.
  • The client-side implementation is backed by server-side REST endpoints which provide access to content in XperienCentral.

...

The Dojo toolkit is an open source modular JavaScript library, or, more specifically a JavaScript toolkit which is designed for the rapid development of cross-platform, JavaScript/AJAX-based applications and websites. The following are examples of Dojo widgets you can develop:

 

Section
Column
width622px

Image RemovedImage Added

Column

 

Documentation

...

There is a lot of documentation available on Dojo. Here are a few starting points. If you’re not familiar with the Dojo toolkit, have a look at the tutorials. Another approach is to dive right into it by creating a sidebar widget based on the archetype and analyze the code using using the information available in the Sidebar Widgets page topic.

References:

The XperienCentral

...

Client-side API

Next In addition to those present in the standard Dojo toolkit, XperienCentral has it’s its own set of Dojo classes that can be used in custom widgets. They consist of widgets, business login objects and data stores:

 

Client-side architectureImage RemovedClient-side architectureImage Added

This The XperienCentral client-side API is documented in the XperienCentral JSDoc. JSDoc basically works like is similar to Javadoc, but for JavaScript in place except that it describes JavaScript instead of Java code. A practical example of how to use this documentation can be found on the Sidebar Widgets page.

Image Removed

XperienCentral JSDoc: https://api.gxsoftware.com/jsdoc/

...

Image Added


Widget Plugins in XperienCentral

There are two types of widget plugins in XperienCentral: Sidebar Widgets and Panel Widgets.Sidebar widgets are widgets that are placed  Sidebar widgets and panel widgets. Sidebar widgets are widgets that can be docked in either the left or right sidebar:Image RemovedSidebar in the XperienCentral Workspace:

 

Image Added

Sidebar widgets are described in detail on the in the Sidebar Widgets page topic, including how to create one using an archetype.

Panel widgets are widgets are widgets that can be opened via a menu item in the configuration Configuration menu, such as the standard Layout panel:

 

There is at the moment of writing no archetype or specific documentation for creating custom panel widgets. Therefore it requires more knowledge to write one than to write a sidebar widget.

...