You are here

SkyVault 2.0 » Developer guide » Share extensions

Share Extension Points

Introduction to the supported extension points in the SkyVault Share web application.

An extension point is an interface that a developer can use to customize the SkyVault Share web application in a supported way. There are a number of extension points that can be used to do things like adding custom pages, hiding content on existing pages, display custom metadata, modify the menu etc. To fully understand the extension points it is a good idea to first read through the Share Architecture section.

The Share extension points can be grouped into three different categories:

  • Declarative - XML configuration that requires no coding
  • Programmatic - Code that adds new functionality
  • Override - Code that overrides default behaviour of SkyVault Share

The following table lists all the extension points that are available to you when customization the Share web application:

Extension Point Name Category Support Status
Share Configuration Declarative Full Support
Form Controls Programmatic Full Support
Form Field Validation Handlers Programmatic Full Support
Evaluators Declarative and Programmatic Full Support
Site Presets Declarative Full Support
Share Themes Declarative Full Support
Document Library Declarative and Programmatic Full Support
Surf Extension Modules Declarative and Programmatic Full Support
Surf Web Scripts Declarative and Programmatic Full Support
Surf Web Script JavaScript Root Objects Programmatic Full Support
Surf Pages Declarative and Programmatic Limited Support (Use Aikau Pages instead)
Surf Dashlets Declarative and Programmatic Limited Support (Use Aikau Dashlets instead)
Surf Widgets Programmatic Full Support
Aikau Menus Programmatic Full Support
Aikau Pages Declarative and Programmatic Full Support
Aikau Dashlets Declarative and Programmatic Full Support
Aikau Widgets Programmatic Full Support
Modifying OOTB Surf Pages Override Full Support via Surf Extension Modules
Modifying OOTB Surf Dashlets Override Full Support via Surf Extension Modules
Modifying OOTB Surf Widgets Override Full Support via Surf Extension Modules
Modifying OOTB Aikau Pages Override Full Support via Surf Extension Modules
Modifying OOTB Aikau Dashlets Override Full Support via Surf Extension Modules
Modifying OOTB Aikau Widgets Override Full Support
Modifying OOTB Surf Web Scripts Override Full Support

Note that the table has links to each Extension Point section.

  • Share Configuration A lot of the customizations that you might want to do to the Share user interface does not require coding. They can be handled by XML configuration and a simple restart of SkyVault.
  • Form Controls When defining a form the form controls for each field controls how the field is displayed and handled.
  • Form Field Validation Handlers A validation handler is a small JavaScript function that gets called by the forms runtime when a field value needs to be validated.
  • Evaluators Component visibility in the Share user interface can be controlled by Evaluators.
  • Site Presets A site preset contains the initial configuration for a Share Site, such as the site Dashboard layout.
  • Share Themes The Share web application comes with a number of themes that can be used to set the look and feel of the application. It is also possible to create your own custom UI themes.
  • Document Library The Document Library page has several extension points that can be used to customize its behaviour, such as actions.
  • Surf Extension Modules This section covers the Surf Extension Modules.
  • Surf Web Scripts When you look under the covers of the Share web application you will notice that most of the functionality is implemented as Surf Web Scripts. This is true for both Pages and Dashlets.
  • Surf Web Script JavaScript Root Objects A number of JavaScript root objects are available when you are implementing a controller for a Surf Web Script, such as page and remote. Sometimes you might have custom Java code that you want to call from JavaScript controllers, this is possible by adding custom JavaScript root objects.
  • Surf Pages The Share web application is built up of a main menu from which you can navigate to a number of pages. These pages are implemented with the Surf development framework. However, note that some pages have been converted and implemented with the new Aikau development framework, see architecture section.
  • Surf Dashlets The Share web application has a special page called Dashboard, which contains windows (think Portlets) of content called Dashlets. Currently most of these Dashlets are Spring Surf Dashlets, but they will eventually be converted to Aikau Dashlets.
  • Surf Widgets The Share web application is built up of a main menu, pages, and Dashlets. The pages and Dashlets are mainly processed on the server side as Web Scripts. When client side processing is needed in the form of browser JavaScript and CSS then this is contained in Widgets. The Surf Widgets uses the Yahoo UI library as JavaScript framework and widget library. These widgets will eventually be replaced by Aikau Widgets.
  • Aikau Menus The main menu of Share is implemented with the new Aikau UI development framework. It is possible to customize this menu, so you can navigate to new custom pages for example.
  • Aikau Pages The Share web application is built up of a main menu from which you can navigate to a number of pages. These pages are implemented mostly in the Surf development framework. However, a number of pages, such as Search, have been converted and implemented with the new Aikau development framework, see architecture section.
  • Aikau Dashlets The Share web application has a special page called Dashboard, which contains windows of content called Dashlets. Currently most of these Dashlets are Spring Surf Dashlets, but they will eventually be converted to Aikau Dashlets.
  • Aikau Widgets Aikau pages are built up of widgets. There are two types of widgets, presentation widgets and service widgets. These JavaScript widgets are Dojo classes. A widget can have its own CSS, HTML, and Properties.
  • Modifying Out-of-the-box Surf Pages Most of the pages in the Share web application are implemented with the Surf UI framework. In many cases it is necessary to modify these pages.
  • Modifying Out-of-the-box Surf Dashlets The Share web application has a special page called Dashboard, which contains windows of content called Dashlets. Currently most of these Dashlets are Spring Surf Dashlets, and it is possible to modify the contents on them.
  • Modifying Out-of-the-box Surf Widgets The Share web application pages and dashlets are built up of widgets. Sometimes it is necessary to modify these.
  • Modifying Out-of-the-box Aikau Pages The Share web application has a number of Aikau pages. These can be modified.
  • Modifying Out-of-the-box Aikau Dashlets The Share web application has a special page called Dashboard, which contains windows of content called Dashlets. Currently most of these Dashlets are Spring Surf Dashlets, but they will eventually be converted to Aikau Dashlets.
  • Modifying Out-of-the-box Aikau Widgets Every Aikau menu, page, and dashlet is built up of one or more widgets. Sometimes it is necessary to modify out of the box widgets.
  • Modifying Out-of-the-box Surf Web Scripts Most of the Share UI functionality can be traced back to a Web Script in one place or another. Sometimes it is useful to be able to override the controller or template of one of these Out-of-the-box (OOTB) Web Scripts.
Parent topic: Share extensions

© 2017 TBS-LLC. All Rights Reserved.