Show TOC

Accessing Attributes in the XML ScriptLocate this document in the navigation structure

Use

A handler can access the following information in the XML script:

  • Attributes: Attributes defined with <Attribute> tags that are nested within the <Context> or <Action> tag for the handler.

    These are passed to IHandler methods in an IGCAttributes object.

  • Meta-Attributes: Attributes defined in the <Context> or <Action> tag for the handler.

    These are passed to IHandler methods in a Map object.

Default Attributes

The following attributes are passed in the Map object, which contains the element's meta-attributes:

  • ignore: The value of the ignore attribute for the current <Context> or <Action> element. If not defined, the ignore attribute for the <GenericCreator> element is returned.

  • handler.id: The name of the attribute that contains the handler ID, id for <Action> elements and objectClass for <Context> elements.

  • defaultLocale: The value of the defaultLocale attribute for the <GenericCreator> element.

    If the defaultLocale attribute is not defined, than en is returned.

    Each <Context> element can define the originalLocale attribute for overriding the default setting. This value is available in the Map with the originalLocale key.

  • createMode: The value of the createMode attribute for the current <Context> element. If not defined, the createMode attribute for the <GenericCreator> element is returned.

XML Sample

The following sample XML file defines a folder called General , which contains an iView called myIview . The XML for the iView is marked.

The following information is provided to the iView handler, whose type is registered as com.sapportals.portal.iView :

  • Attributes: The attributes of the <Context> tag, including the template , objectClass and create_as attributes. These attributes are passed in a Map object.

  • Meta-Attributes: The url attribute, which is defined by the <Attribute> tag. This attribute is passed in an IGCAttributes object, which also provides access to meta-attributes of the url attribute - type and isOrdered .

More information: Registering and Unregistering Custom Script Handlers