Widget manifest

widget.xml

The Widget Manifest file is required to create widgets in the Mashup Builder. For example, the Hello World Widget Manifest file is as follows:

<xml version="1.0" encoding='UTF-8'>
<Widget1 name="Hello World" group="Style Tools">

   <Description2> Widget description</Description>

  <Preview3>
   <![CDATA[
      <h2>Hello World</h2>
    ]]>
  </Preview>

  <Includes4>
    <Include type="css" path="css/style.css" />
    <Include type="css" path="/resources/static/css/style.css" />
  </Includes>

  <SupportWidgetsId5 arity="ZERO_OR_MANY" />
  <SupportFeedsId6 arity="MANY" />
  <SupportI18N7 supported="true" />

  <OptionsGroup8 name="Configuration">
    <Option9 id="person" name="Person" arity="ONE">
      <Description10>Person you want to say Hello to</Description>
      <Values11>
        <Value>World</Value>
        <Value>Tintin</Value>
      </Values>
      <Functions12>
        <ContextMenu13>Pages()</ContextMenu>
        <Display14>SetHeight(3)</Display>
        <Check15>isPageName</Check>
      </Functions>
    </Option>
  </OptionsGroup>

  <DefaultValues16>
    <DefaultValue name="person">World</DefaultValue>
  </DefaultValues>

</Widget>

This file contains the following information:


#	Element/tag	Description
1	Widget Declaration	`name`: The widget’s user friendly name. `group`: The widget’s group name (can be hierarchical using slashes); used to group similar widgets in the Mashup Builder.
2	Description	The widget’s description.
3	Preview	The preview can contain any text or HTML embedded using CDATA tags.
4	Includes	List of widget assets to inject in the page. `type`: The type of the asset (`css` or `js`). `path`: Path of the resource. The path can be relative to the widget (for example, `css/style.css`) or absolute (for example, `/resources/static/css.style.css`).
5	SupportWidgetsId	Defines how this widget supports sub widgets. `arity`: ZERO, ZERO_OR_MANY, ONE, MANY If you want to restrict the possibilities of sub widgets types, you can nest WidgetId tags to describe them: `<WidgetId>tabContent</WidgetId>`
6	SupportFeedsId	Defines how this widget supports feeds. `arity`: ZERO, ZERO_OR_MANY, ONE, MANY If you want to restrict the possibilities of feed types, you can nest `FeedId` tags to describe them: `<FeedId>myFeed</FeedId>`
7	SupportI18N	Widget internationalization support. `supported`: Boolean value to enable internationalization
8	OptionsGroup	Declares an Option Group (displayed as a tab in the widget configuration). `name`: Option group name
9	Option	Declares a widget Option. `id`: Internal ID of the option, to be used to retrieve the option value `name`: Displayable name of the option `arity`: ZERO, ZERO_OR_MANY, ONE, MANY
10	Description	User-friendly option description.
11	Values	Declares the option's value(s). Declaring several values will create a selection box.
12	Functions	A container to describe this Option's expected display, behavior, error checking, etc.
13	ContextMenu	Use this tag to specify the types of functions that will be available in the Value tab of the dynamic list displayed on the left of the widget properties panel: addContext(name, values): Appends a custom context to the dynamic list. The context is defined with names and values. For example, list `["a", "b"]` or `[{display:"A",value:"a_"},{display:"B",value:"b_"}]` Aggregations(facetOptionId): Gets all facet aggregations, for example, count, score etc. Optionally you can use `facetOptionId` to specify the ID of the option that contains the facet aggregation you want to retrieve. ApiCommand(): Gets all the search API commands of all Search API configurations (see > Search API). ApiConfig(): Gets the names of all the Search API configurations (see Adminstration Console > Search API). For example, `sapi0`, `sapi1`, `sapi2`, etc. appendOnChange(str): A click of the user on the dynamic list, will append the specified string to the active input. Cookies(): Displays how to access the attributes of the dynamic list > Cookies parameters node in Mashup Expression Language. For example, the name attribute is accessed via the `${cookies['__cookieName__'].name}`expression. DataModelClass(): Gets a list of all data model classes (see Administration Console > Classes). DateFacets(): Gets all Date facets from the feeds used by the widget. emptyOnChange(): A click of the user on the dynamic list, will remove the current value of the option before setting the clicked value. EntryVariables(): Displays how to access the variables of an entry in Mashup Expression Language. Eval(): Gets all possibilities evaluated by the widget. EvalCategory(): Gets all possibilities evaluated by the category. EvalFacet(): Gets all possibilities evaluated by the facet. EvalMeta(): Gets all possibilities evaluated by the meta. Facets(facetType, refinementPolicy): Gets all facets from the feeds used by the widget. `facetType` can be a string `'DATETIME'`or an array `['DATETIME', 'NUMERICAL']` Feeds(): Gets the feeds called by the widget. FeedVariables(): Displays how to access the variables of a feed in Mashup Expression Language. Fields(): Gets all the virtual fields, numerical fields and RAM-based fields from the feeds used by the widget. GeoFacets(refinementPolicy): Gets only Geographical facets from the feeds used by the widget. Hierarchical2DFacets(refinementPolicy): Gets only Hierarchical2D facets from the feeds used by the widget. I18N(): Displays how to access the attributes of the dynamic list > Internationalization and localization parameters node in Mashup Expression Language. For example, the code attribute is accessed via the `${i18n['__code__']}`expression. JsKeys(): Gets a list of all the I18N jskeys available. Metas(): Gets all metas from the feeds used by the widget. MultiDimension2DFacets(refinementPolicy): Gets Multi-dimension 2D facets from the feeds used by the widget. MultiDimensionFacets(refinementPolicy): Gets Multi-dimension facets from the feeds used by the widget. NormalFacets(refinementPolicy): Gets only Category facets from the feeds used by the widget. NumericalFacets(refinementPolicy): Gets Numerical facets from the feeds used by the widget. PageParameters(parameterId): Displays how to access the attributes of the dynamic list > Page parameters node in Mashup Expression Language. For example, the lang attribute is accessed via the `${page.params['lang']}`expression. Pages(): Gets the names of available pages. PageVariables(): Displays how to access the variables of a page in MEL. QueryPrefixes(): Gets all the query prefix handlers of the search logics (see Administration Console > Search logics > Query Language). Reporters(): Gets all the reporters defined in Administration Console > Reporting). Request(): Displays how to access the attributes of the dynamic list > Request parameters node in Mashup Expression Language. For example, the authPath attribute is accessed via the `${request.authType}`expression. SearchLogics(): Gets a list of all Search Logics (see Administration Console > Search logics). SearchTargets(): Gets a list of all Search Targets (see Administration Console > Build Groups > Search targets). Security(): When the user is logged in, it gets all user-related information (the token, the user name and the display name). SecuritySources(): Gets a list of all Security Sources (see Administration Console > Security Sources). SelfMetas(): Gets the metas of the current feed only. Session(): Displays how to access the attributes of the dynamic list > Session parameters node in Mashup Expression Language. For example, the creationTime attribute is accessed via the `${session.creationTime}` expression. Sorts(): Gets all the feed elements that can be sorted. SubMetas(): Gets the current subfeed metas. SuggestNames(): Gets the names of all the suggests and suggest dispatchers (see Administration Console > Suggest). SuggestServices(): Gets the complete URLs of all the suggests and suggest dispatchers (see Administration Console > Suggest). WUIDS(): Gets a list of this page Widget’s unique IDs.
14	Display	Use this tag to specify how the property will be displayed. For example, you can force the property to act as a select box, force it to act as an input (default is Text area), force it to act as a password input, etc. Code Editor: Transforms the property's input field into a code editor Number: Transforms the property's input field into a number input field. Password: Transforms the property's input field into a password input field (encrypted). Radio: Transforms the property's input field into a radio button. SetHeight: Sets the minimum height (in terms of lines) of the option's input field. TextEditor: Transforms the property’s input field into a rich text editor. TextArea: Transforms the property's input field into a text area field. ToggleDisplay: Shows/hides properties conditionally depending on the selected property value. For example, value1 of PropertyA will display PropertyB and PropertyD, value2 will display PropertyB and PropertyC. You need to set: * the value to match (using the `valueToMatch` and `ifEquals` attributes) * the options to hide (in `hideOptions)` * the options to show (in `showOptions`).
15	Check	Error checking functions to validate user input. isInteger: Checks that the value is an integer and displays an error message if not. isAlphanum: Checks that the value is a chain of alphanumerical characters and displays an error message if not. isPageName: Checks that the value is a page name and displays an error message if not. isEmpty: Checks that the value is NOT empty and displays an error message if it is the case.
16	Default Values	Specifies the default value of the option (one of the values specified for the "Value" element).

Widget manifest

widget.xml

widget.jsp