Register iWidgets for use with the Page Builder theme

To make the portal aware of available iWidgets, you register the iWidget definitions in the portal by telling the portal the location from where it can load the iWidget definition XML.

The portal can load the iWidget definitions from the following locations:

• A location that the portal can access via HTTP routed through the portal Ajax Proxy

• A server relative URL that is relative to the portal server

• A location within the portal WebDAV file store that is identified by a corresponding portal WebDAV URI.

Registered iWidgets become available to the portal administration via corresponding IWidget Wrapper portlet clones. These are created during the iWidget registration process.

You can register iWidgets for use with the Page Builder theme by one of the following methods:
iWidget registration via the configuration task register-iwidget-definition

This is the typical way of registering iWidgets in the portal. For details about using this task refer to the corresponding IC section.

iWidget registration via static page deployment

This means that you create a new page by uploading an archive or compressed file that contains static page markup files. This static page deployment process checks whether any of the referenced iWidget definitions contained in the given static page index HTML file exist in the portal already and then registers the ones that do not exist yet. Example: Your static page content contains the following HTML element:

<div class="iw-iWidget" id="sampleID" style="skin:csa2.standard">
     <a class="iw-definition" 
        href="dav:fs-type1/iwidgets/sampleWidget/SampleWidget.xml"></a>
</div>

In this case the static page deployment process makes sure that the iWidget defined by the SampleWidget.xml file contained in the location /iwidgets/sampleWidget of the WebDAV file store is registered in the portal after the page is created.

iWidget availability

After you register an iWidget in the portal, you can place it on a page by using the Customization shelf. After registering the iWidget, clear browser cache and navigate to the Add Content panel in the Customization shelf. For details about how to do this see the topic about Adding content. The registered iWidget should be available in the All category and for search. For more details see the topic about How to add widgets to pages.
Access rights required for iWidget registration

The process of registering a new iWidget definition in the portal includes duplicating the IWidget Wrapper portlet. Therefore it requires the same access right privileges as duplicating the IWidget Wrapper portlet.

Parent

Use widgets
How iWidgets are represented in the portal model

Related tasks

Reusing registered iWidgets
Customize iWidget attributes
Add content
How to add widgets to pages
Update iWidget attributes when refreshing iWidget definitions
Task refresh-page-layout

 

+

Search Tips   |   Advanced Search