As described earlier in this chapter, item mappings are the top-level container objects used to configure editing and display for specific asset types. They also provide default mapping information for general classes of asset types (repository items, virtual files).

The itemMapping item descriptor is defined as follows in ViewMapping.xml:

<item-descriptor name="itemMapping" id-space-names="viewmapping"
    default="true" display-property="description" query-cache-size="80">
    <table name="vmap_im" type="primary" id-column-names="id">
      <property name="id" data-type="string"/>
      <property name="name"/>
      <property name="description"/>
      <property name="itemPath" column-name="item_path"/>
      <property name="itemName" column-name="item_name"/>
      <property name="isReadOnly" column-name="is_readonly"
        data-type="boolean"/>
      <property name="formHandler" column-name="form_handler"
        item-type="formHandler"/>
      <property name="mode" column-name="mode_id" required="true"
        item-type="mapMode"/>
    </table>

    <!-- attributes property -->
    <table name="vmap_attrval_rel" type="multi"
      id-column-name="mapper_id" multi-column-name="name">
      <property name="attributes" column-name="attribute_id"
        data-type="map" component-item-type="attributeValue"
        cascade="update,delete"/>
    </table>

    <!-- viewMappings property, maps to array of ItemViewMapping -->
    <table name="vmap_im2ivm_rel" type="multi" id-column-name="item_id"
      multi-column-name="sequence_num">
      <property name="viewMappings" data-type="list"
        column-name="view_id" component-item-type="itemViewMapping"
        cascade="update,delete"/>
    </table>
  </item-descriptor>

Item mappings have the following key properties:

Property

Use

attributes

Optional key/value pairs that define an attribute of this item mapping. For more information, see View Mapping Attributes.

description

Informational description of the item mapping.

formHandler

A reference to a View Mapping formHandler item.

itemName

The repository item descriptor name or the VFS file type of this asset. Example: the itemName value for the default text file asset type is wwwTextFileAsset.

itemPath

The path of the Nucleus component that represents the repository or VFS.

Example: the itemPath value for the default text file asset type is /atg/epub/file/WWWFileSystem.

mode

The map mode to use for this mapping. This property is required.

name

The name of the item mapping. For all item mappings, specify the default value, which is an asterisk symbol. (This property exists mostly for the development of future releases of ATG Content Administration.)

viewMappings

A collection of references to ItemViewMapping items. It can be helpful to think of each ItemViewMapping as a separate tab of information in the overall view of an asset.

See Creating View Mapping Repository Items for the basic procedure for creating an itemMapping. Note that viewing the source of the JSP page used to display this asset type in the ATG Business Control Center can provide some of the information you need to create an itemMapping item (for example, information about the relevant item descriptor).

 
loading table of contents...