62 Customizing Global Properties, Toolbar, and Menu Bar in the Contributor Interface

You work with the global configuration element (UI/Config/GlobalHtml) to customize the global features (such as global properties, toolbar, and menu bar) of the Contributor interface.

Topics:

Customizing Global Configuration Properties

Global configuration properties are used to set display conditions for the Contributor interface across all content management sites.

This section includes the following topics:

About the Configuration Properties

The client-side framework retrieves its main configuration settings from the server-side controller element UI/Config/GlobalHtml. This presentation element serves JavaScript code, which is executed by the client-side application at startup. The JavaScript code defines a JavaScript function, whose name is given as a request parameter by the client-side application:

<%@ taglib prefix="cs" uri="futuretense_cs/ftcs1_0.tld"%> 
<cs:ftcs>
webcenter.sites['${param.namespace}'] = function (config) {
    config.maxTabCount = 50;
    config.defaultView =  …;
     … merge
}
</cs:ftcs>

The config object is then manipulated as needed in the function body, by setting the properties expected by the client-side application.

In addition, as explained below, the client-side application is capable of retrieving additional configuration properties from the server-side, which allows to merge settings from multiple sources, without having to duplicate the global properties in multiple locations.

Default Configuration Properties That Can Be Modified

The following describes the system-defined configuration properties and indicates which properties can be modified.

Table 62-1 Configuration Properties in UI/Config/GlobalHtml

Property Name Description Values and Examples

maxTabCount

Maximum number of tabs that can remain open simultaneously. A tab is the tab of an open asset.

Any integer greater than 0.

For example:

config.maxTabCount = 30;

enableContextMenu

Indicates whether the default browser context (right-click) menu should be enabled when users work in web mode.

true | false

For example:

config.enableContextMenu = true;

enableWebMode

Indicates whether web mode should be enabled. When this property is set to false, users can work only with assets in form mode and use the preview functionality.

By default, this property takes the value of the xcelerate.enableinsite property, found in wcs_properties.json.

true | false

For example:

config.enableWebMode = true;

enableDatePreview

Indicates whether date-based preview should be enabled.

By default, this property takes the value of the cs.sitepreview property, found in wcs_properties.json.

true | false

For example:

config.enableDatePreview = false;

enablePreview

Indicates whether preview is allowed.

By default, this property takes the value of the Preview method attribute in the Edit Site form (accessible from the Admin interface: Select Admin tab, expand Sites, double-click SampleSite, and select Edit).

true | false

For example:

config.enablePreview = true;

defaultView

Defines the preferred view for working with assets (that is, whether assets are viewed, by default, in form mode or web mode).

Note: An asset is opened in web mode only if the asset is associated with a default template.

The expected value is one of the following:

  • "default": "form" | "web"

  • "assetType" : "form" | "web"

  • "assetType/subtype": "form" | "web"

where assetType is a valid asset type name, and subtype is a valid subtype or definition name. For example:

config.defaultView = {
 "default": "form",
 "AVIArticle": "web",
 "Page/AVISection": "web"
}

toolbars

Defines the list of available toolbar actions for each type of view.

See Customizing the Toolbar.

toolbarButtons

Used to define the behavior of specific toolbar buttons.

See Customizing the Toolbar with Custom Actions.

menubar

Defines the list of available actions in the menu bar.

See Customizing the Menu Bar.

documents

Registers available implementations of documents.

Do not modify the value of this property.

The only supported value is asset.

views

Registers view implementations.

Do not modify the value of this property.

controllers

Registers controller implementations and the set of actions supported by each controller.

Do not modify the value of this property.

roles

Contains the list of roles for the currently logged in user.

Do not modify the value of this property.

supportedTypes

Contains the list of asset types that can be edited from the Contributor interface.

Do not modify the value of this property.

searchableTypes

Contains the list of asset types that can be searched from the Contributor interface.

Do not modify the value of this property.

token

Used for security when uploading binary file.

Do not modify the value of this property.

sessionid

Used for security when uploading binary file.

Do not modify the value of this property.

contextMenus

Defines the list of available actions in the context menu.

See Customizing Context Menus.

Adding Custom Configuration Properties

In addition to retrieving the global properties, stored in UI/Config/GlobalHtml, the Contributor application attempts to retrieve additional settings in UI/Config/SiteConfig and any element present in UI/Config. Depending on the requirement, this lets you set global properties, or site-specific properties, without having to replicate all the properties defined in UI/Config/GlobalHtml, but only the properties that actually change.

This section includes the following topics:

Adding Custom Global Properties

Custom global properties are meant to be shared across all sites on a given content management system. The recommended approach consists of creating a custom configuration element defined as follows:

For example, you may want to:

  • Override the value of maxTabCount for all sites.

  • Override the default view for Page assets.

  • And, define an additional custom property called foo.

To do this, create an element called CustomElements/UI/Config/SiteConfigHtml, containing the following code:

<%@ taglib prefix="cs" uri="futuretense_cs/ftcs1_0.tld" %> 
<cs:ftcs>
webcenter.sites['${param.namespace}'] = function (config) {
    // override existing properties
    config.maxTabCount = 60;
    config.defaultView.Page = "form";

    // add custom properties
    config.foo = "bar";

}
</cs:ftcs>
Adding Site-Specific Properties

In some cases, the Contributor interface must be configured differently for each content management site. It is recommended that you override the core controller element called UI/Config/SiteConfig.

To override the UI/Config/SiteConfig core element, create an element as follows:

CustomElements/siteName/UI/Config/SiteConfigHtml

where siteName is the name of the content management site (for instance, avisports).

For example, the avisports demo site enforces web mode as the default mode for assets of type Page and AVIArticle. This is done by defining the JSP element CustomElements/avisports/UI/Config/SiteConfigHtml, and providing the following settings:

<%@ taglib prefix="cs" uri="futuretense_cs/ftcs1_0.tld" %>
<%@ taglib prefix="ics" uri="futuretense_cs/ics.tld" %>
<cs:ftcs>
webcenter.sites['${param.namespace}'] = function (config) {
    // default view modes for avisports
    config.defaultView.Page = "web";
    config.defaultView.AVIArticle = "web";
}
</cs:ftcs>

Loading of Configuration Elements

The global configuration element is always loaded first. Additional configuration elements are loaded in alphabetic order. For instance, using the examples above, configuration properties would be loaded in the following order:

  1. UI/Config/GlobalHtml
  2. UI/Config/SiteConfigHtml

Property Values

The value of some properties is, in some cases, an object. That is:

config.someProperty = {
  foo: "bar",
  x: 123
};

When partially overriding this property, it is important to distinguish between the following types of code:

config.someProperty = {
  x: 3456
};

vs.

config.someProperty.x = 3456;

In the first case, the property foo is overridden as "undefined", whereas in the second case, the original value of foo is preserved.

Customizing the Toolbar

On the toolbar you can list actions for operating on assets in web mode or form mode. You can customize the toolbar further per asset type and subtype.

Topics:

About Toolbar Customization

The global configuration element (UI/Config/GlobalHtml) describes for each type of view (such as web mode inspect, web mode edit, form mode edit, and form mode inspect), the list of actions to display in the toolbar to the user. This is done through the toolbars property. Its value is an object with the following syntax:

config.toolbars = {
    "viewAlias": [action_1, action_2,  …],
    or:
    "viewAlias": {
        "view_mode_1": [action_1, action_2,  …],
        "view_mode_2": [action_1, action_2,  …]
    }
 …
}

where:

viewAlias indicates for which type of view this toolbar must be used. The alias must match one of the view aliases defined in the config.views section.

action_i is an action name. For standard actions, such as save and approve, the action name is automatically mapped to a given icon, title, alternate text, and so on. For more information about standard actions, custom actions, or customizing the appearance of a custom button, see Examples of Toolbar Customization.

view_mode_i is one of the modes supported by the view (typically, edit or view).

Examples of Toolbar Customization

This section includes the following topics:

Customizing the Toolbar with Standard Actions for Web Mode
  • Use the following configuration which determines the toolbar actions that are available in web mode for all asset types:

    config.toolbars = {
        ( …)
     
        "web": {
          "edit": ["form-mode", "inspect", "separator", "save", "preview",
                   "approve", "delete", "separator", "changelayout",
                   "separator", "checkincheckout", "refresh"],
          "view": ["form-mode", "edit", "separator", "preview", "approve",
                   "delete", "separator", "checkincheckout", "refresh"]
    
        ( …)
    
    }
    

The above configuration defines two lists of actions (edit and view), corresponding to the asset's views: Edit and Inspect.

Note:

To find the set of standard actions, refer to the list of actions specified in the following properties under the controllers property:

  • fw.ui.document.AssetDocument (all actions supported by assets)

  • fw.ui.controller.InsiteController (all actions supported by the view controller)

Customizing the Toolbar with Standard Actions for Asset Type and Subtype

Each toolbar configuration can be customized by asset type and subtype by adding a property named:

  • viewAlias/assetType

  • viewAlias/assetType/assetSubtype

For example, add the Bookmark/Unbookmark buttons for page assets in web mode.

  • In a custom configuration element (such as CustomElements/avisports/UI/Config/SiteConfigHtml), add the following property:

    config.toolbars["web/Page/AVISection"] = {
        "edit": config.toolbars.web.edit, // reuse default for edit mode
        "view": ["form-mode", "edit", "separator", "preview", "approve", "delete",
                        "bookmark", "unbookmark", "separator",
                        "checkincheckout",  "refresh"]
    }
    

    Inspecting the Surfing Page asset now shows the toolbar.

    Figure 62-1 Surfing Page Asset Toolbar

    Description of Figure 62-1 follows
    Description of "Figure 62-1 Surfing Page Asset Toolbar"

Note:

Keep in mind the following:

  • We are customizing only the view mode. When a Page/AVISection asset is being edited in web mode, the standard toolbar is shown.

  • The Bookmark and Unbookmark buttons are not shown simultaneously, because they both depend on the asset's current state (whether it is bookmarked or not).

Customizing the Toolbar with Custom Actions
  • To define custom actions add new entries to the config.toolbarButtons property, as follows:

    config.toolbarButtons.<customActionName> = {
      src: <path_to_icon>,
      onClick: <click_handler>
    }
    
  • For example, let's define the following helloWorld custom action:

    config.toolbarButtons.helloWorld = {
          src: 'js/fw/images/ui/ui/toolbarButton/smartlist.png',
          onClick: function () {
              alert('Hello World!!');
          },
          buttonType: 'button'
    }

    The helloWorld action can now be referenced from a toolbar configuration as follows (we reuse our example from the previous section):

    config.toolbars["web/Page/AVISection"] = {
        "view":
              ["form-mode", "edit", "separator", "preview", "approve",
               "bookmark", "unbookmark", "separator",
               "checkincheckout", "separator", "helloWorld", "refresh"],
    
        "edit": config.toolbars.web.edit // reuse default web mode toolbar
    }

    Note:

    In this example, we have added a separator (a vertical line) and the custom button to the toolbar.

    Figure 62-2 Separator and Toolbar Button

    Description of Figure 62-2 follows
    Description of "Figure 62-2 Separator and Toolbar Button"

A more elaborate example would involve, for instance, creating a CSElement which outputs an asset's id and type, and then creating a toolbar option that calls the element when clicked. For example:

  1. Create a CSElement (HelloAsset, in this example) which outputs assets' id and type.
  2. Now, define the helloAsset custom action by adding new entries to the config.toolbarButtons property (in the SitesConfigHTML.jsp), as follows:
    config.toolbarButtons.helloAsset = {
          src: 'js/fw/images/ui/ui/toolbarButton/smartlist.png',
          onClick: function () {
           /* current active document which holds the asset*/      
            var doc = SitesApp.getActiveDocument(); 
            var asset = doc.get('asset');
            var id = asset.get("id"); 
            var type = asset.get("type"); 
            /* make an ajax call to call an element */
            dojo.xhrGet({ 
                 url: "url of element to call", /*url of the element*/
                 /*pass any parameters that need to be passed to the element */
                 content:{"id":id,"type":type}
                 /*handleAs:"json" */ /* this is needed only if the element returns json response */                                                  
                 }).then(function(response) { 
                     console.log("Response:", response);
                     /*handle response from the element here */  
                     alert(response);                                               
                }, 
                    function(err){
                         /*handle error*/ 
                         console.log("error on ajax call");
               });           
         }
    };
  3. Add the custom button (defined in step 2) to the toolbar under config.toolbars ={ }. For example:
    /*add the custom button in web mode for AVIArticle*/  
          config.toolbars["web/AVIArticle"] = {
                "view" : ["form-mode", "edit", "separator", "preview", "approve", "delete",
                "bookmark", "unbookmark", "separator", "checkincheckout", "helloAsset",
                "separator", "refresh",]
          };
    

    This figure shows the custom option in the toolbar:

    Figure 62-3 Custom helloAsset Toolbar Button

    Description of Figure 62-3 follows
    Description of "Figure 62-3 Custom helloAsset Toolbar Button "

When the custom helloAsset button is clicked, the CSElement (created in step 1) is called and a dialog box opens providing the asset's name, id, and type:

Figure 62-4 Dialog Box Showing Asset's Name, ID, and Type

Description of Figure 62-4 follows
Description of "Figure 62-4 Dialog Box Showing Asset's Name, ID, and Type"

Customizing the Menu Bar

On the menu bar, you can add submenus that let contributors operate on assets of a certain type and subtype. You can make these submenus actionable items, additional menus, or menu separators.

Topics:

About Menu Bar Customization

The menu bar configuration is defined by the config.menubar property:

config.menubar = {		
		    "key_i": [
			          //menu_i
			          {
				              "id": "menu_id",
				              "label": "menu_label",			
				              "children": [				
				                  //submenus
				                  //- actionable menu item
					                  {
						                     label: 'menu_item_label', 
						                     action: 'action_name' | click_handler
					                  },
					                  //- deferred pop-up menu
					                  {
						                     label: 'menu_item_label', 
						                     deferred: 'controller_element', 
						                     cache: true|false
					                  },					
					                  //- pop-up menu
					                  {
						                     label: 'menu_item_label', 
						                     children: [
							                         // submenu_1
							                         {
								                            label: 'menu_item_label', 
								                            action: 'action_name' | click_handler
							                         }'
							                         // submenu_2
							                         {
								                            label: 'menu_item_label', 
								                            action: 'action_name' | click_handler
							                         },							
							                          …
							                          …
							                          …
						                     ]
					                  },					
					                  //- menu item separator
					                  {separator: true}

				              //additional menu_i 
               …
               …
               …
              ]
			          }

where:

key_i is one of the following:

  • default: Defines the default menu bar.

  • assetType: Defines the customized menu bar for all assets of type assetType.

  • assetType/subtype: Defines the customized menu bar for all assets of type assetType and subtype subtype.

//menu_i starts a section that describes each top menu, where:

  • menu_id is the identifier of the menu.

  • menu_label is the display name of the menu.

  • submenus can be any of the following:

    • An actionable menu item (clicking the menu item produces an action), where:

      • label specifies the display name of the menu item.

      • action can be any action supported by a controller, such as edit and inspect, or a custom click handler (see the customization example in Adding a Custom Action to the Menu Bar).

        Note:

        When a given action is not supported by the current document/view, it is disabled (greyed out) in the menu.

      For example, a menu item triggering a save action is defined as follows:

      {
          label: "Save",
          action: "save"
      }
      
    • A deferred pop-up menu (the pop-up menu is determined dynamically by running a controller element on the server-side), where:

      • label specifies the display name of the menu item.

      • deferred specifies a controller element name, such as UI/Data/StartMenu/New.

      • cache is a Boolean value indicating whether the output of the controller element should be cached or not.

      For instance, the New pop-up menu, which reads all available start menu items for the current site/user, is defined as follows:

      {
          label: New,
          deferred: "UI/Data/StartMenu/New",
          cache: true
      }
      
    • A pop-up menu (the child menu items are hard wired in the configuration itself).

    • A menu item separator (a horizontal line), which is used to group menu entries together.

Adding a Custom Action to the Menu Bar

In this example, we want to add the helloWorld custom action defined in Customizing the Toolbar with Custom Actions to the menu bar (to run the custom onClick handler). Add this action by adding a new entry to the menu bar called Custom Menu, with a single menu item called Hello World, which triggers the custom action. Our steps are the following:

  1. First, reuse the default menu bar, and add to it. The simplest way to do this is to make a copy of the original array:
    config.menubar["Page/AVISection"] = config.menubar["default"].slice(0);
    
  2. Add the menu, as follows:
    config.menubar["Page/AVISection"].push(
        "id": "myCustomMenu",
        "label": "Custom Menu",
        "children": [ 
            // Children go here
        ]
    );
    
  3. Define the child menu items:
    config.menubar["Page/AVISection"].push({
        "id": "myCustomMenu",
        "label": "Custom Menu",
        "children": [{ 
          "label": "Hello World",
          "action": function () {
             alert("Hello from the top menubar!");
          }
        }]
    });
    

    The Custom Menu can now be seen whenever an AVISection Page section is viewed.

    Selecting the Hello World menu item should run the custom onClick handler.

    Figure 62-6 Custom onClick Handler

    Description of Figure 62-6 follows
    Description of "Figure 62-6 Custom onClick Handler"
  4. To run the exact same code, whether clicked from the menu bar or toolbar, write the following:
    // define the helloWorld code once
    config.myActions = {
        hello: function (args) {
          var doc = SitesApp.getActiveDocument(),
            asset = doc.get('asset'),
            view = SitesApp.getActiveView();
    
          view.info('Hello World!! The asset is a ' + asset.type + 	' with id: 
                + asset.id);
        }
    };
    
    // attach it to the helloWorld button
    config.toolbarButtons['helloworld'] = {
        src: 'js/fw/images/ui/ui/toolbarButton/smartlist.png',
        onClick: config.myActions.hello
    };
    
    config.toolbars["web/Page/AVISection"] = {
        "edit": config.toolbars.web.edit, // reuse default for edit mode
        "view": [  "form-mode", "edit", "separator", "preview", "approve",
        "delete", "bookmark", "unbookmark", "separator",
        "checkincheckout","separator","helloworld", "refresh"]
    }
    
    // attach it to the menubar, under "Custom Menu">"Hello World"
    config.menubar['Page/AVISection'] = config.menubar['default'].slice(0);
    
    config.menubar["Page/AVISection"].push({
        "id": "myCustomMenu",
        "label": "Custom Menu",
        "children": [{
            "label": "Hello World",	
            "action": config.myActions.hello
        }]
    });

Customizing Context Menus

On a right-click, a context menu shows options from which contributors choose what they need to work with the objects they right clicked. You can customize the specific items available in a context menu and the order in which the objects are displayed.

To define context menus use the config.contextMenus property:

config.contextMenus = {
   	"default": ["action_1", "action_2", … "action_n"]		
   "asset": ["action_1", "action_2", … "action_n"],
   "asset/assetType": ["action_1", "action_2", … "action_n"],
}

where the values are defined as:

  • default: Defines the default list of context menus. Each menu item displayed in the list is an action.

  • asset: Defines the customized list of context menus for all assets. Each menu item displayed in the list is an action.

  • asset/assetType: Defines the customized list of context menu items for the assets of type assetType. Each menu item displayed in the list is an action.

An example context menu configuration for the asset type Page:

"asset/Page":["edit", "copy", "preview", "delete", "bookmark", "tagasset"]