Configuration options for the mashups toolbox

To make additional widgets available to users, you add them to the mashups toolbox. For example, when you deploy new widgets, add them to the default mashups toolbox in the portal to make them available to users.

For an overview and conceptual details about the mashup toolbox refer to the topic about the Mashup toolbox.

Default toolbox content

The default toolbox entries are defined within an xml file that is stored as the value of the parameter mashups.catalog_template.xml in the portal WP Mashup Binary ConfigService Resource Environment Provider (REP) in the console. The content of this property is a simple catalog represented in XML. By default it contains a single catalog level include to another catalog.xml that is stored in the same REP under the property mashups.catalog_default.xml. As the only entry in the default toolbox is an include, the default behavior is that none of the widgets within mashups.catalog_default.xml can be removed from a user's toolbox.

Catalog name resolution

A catalog that is part of an include statement must be represented in the Binary ConfigService. The name of the property determines the catalog name referenced in <include> statements. The property naming conventions follow the template mashups.catalog_some_catalog.xml where some_catalog is the actual name of the catalog. For example, an include statement such as this: <include catalog="newcatalog" /> requires a WAS Resource Environment Provide (REP) property named mashups.catalog_newcatalog.xml to resolve correctly.

To modify the default catalog properties in the WAS REP, locate the XML source in the subdirectory $PORTAL_HOME/base/wp.mmi.deploy/config/bianaries/catalogs. Modify them as desired, for example to add a new catalog include statement, and use the import-config-file to modify the existing WAS property. Then use the task import-config-file to add the newly referenced catalog as a binary catalog. For more details refer to the procedure described in following section.

Update and modifying the toolbox

To enhance the toolbox, you need to update the catalog properties in the REP...

1. Locate the XML source file catalog_default.xml in the directory $PORTAL_HOME/base/wp.mmi.deploy/config/binaries/catalogs .

2. Use the file as a template. Save the file under a new name, for example c:/catalogs/mycatalog.xml and modify it as required. For example, add own toolbox drawers as new <category> tags, or add own widgets as new <entry> tags to existing categories.

3. Run the following configuration task:

   ConfigEngine.bat/.sh import-config-file 
      -DMMImportFile="fully_qualified_filename" 
      -DMMImportFilePropertyName="propertyname_in_WAS"

   Example:

   ConfigEngine.sh import-config-file 
      -DMMImportFile="c:/catalogs/mycatalog.xml" 
      -DMMImportFilePropertyName="mashups.catalog_custom.xml"

   This example creates a REP property with the name mashups.catalog_custom.xml in the WP Mashup Binary ConfigService. Include statements need to reflect the catalog name of custom for this catalog as follows: <include catalog="custom" /> . Again, be aware of the naming conventions for REP properties.

4. Add a catalog include to the default toolbox contents. Copy $PORTAL_HOME/base/wp.mmi.deploy/config/binaries/catalogs/catalog_default.xml to a writable location, such as c:/catalogs. Edit the file and add an <include> statement as a sibling to other categories. Add the include statement shown below in bold:

   <?xml version="1.0" encoding="UTF-8"?>
      <catalog id="default" unique-name="optional_name">
      <resource-type>Catalog</resource-type>
      <include catalog="custom" />
      <category name="Demo"><title>
             <!--@demo.title@-->
             <nls-string lang="en">Demo</nls-string>
             <nls-string lang="de">Demo</nls-string>

5. Modify the existing xml stored in WAS by using the import-config-file task, and overwrite the existing default toolbox contents with the new version:

   ConfigEngine.sh import-config-file 
      -DMMImportFile=
       "c:/catalogs/catalog_default.xml" 
      -DMMImportFilePropertyName="mashups.catalog_default.xml"

Parent

Configure options for mashups in portal (optional)
Mashup toolbox

 

+

Search Tips   |   Advanced Search