Component Mapping for (deprecated) Guides

The component mapping file maps logical components to physical components for the targeted device. Use the mapping file to configure Guides for display on various devices. Multiple Guides can reference the same mapping file.

Workbench includes a default mapping file named SystemConfig.xml that supports Spark components. It is located in the /Guides (system)/2.0/Runtime application. Workbench also includes a mapping file for MX components, /Guides (system)/2.0/Runtime/SystemConfig-MX.xml file.

Create a mapping file for Guides

Use the system mapping file as a reference when you create a custom mapping file. Avoid editing the system mapping file.

After you customize the mapping file, add it to a LiveCycle application in Workbench. In the Guide Properties view, specify the mapping file in the Guide-specific Mappings and the System Mappings properties. For information about these properties, see Guide properties.

Important: If you edit the mapping file after you add it to a LiveCycle application, remove the reference to the mapping file. The reference is located in the Guide Properties view. After you remove the reference, to make the changes available, add the reference again.

Mapping file reference for Guides

The default component mapping file supports a target named flex. The mapping file format supports multiple targets for future use.

Elements and attributes in the Guides mapping file

The mapping file for Guides includes several elements and attributes that you can configure.

guideConfig version=”1.0”
The root of the mapping file.

componentMap
The component map includes all the mapping targets.

components
Lists the logical components. It maps the logical component name to the display name that is used in Workbench.

component type="wrapper|layout|control" name="logical-name" displayName="display-name"
Maps a logical name to a display name. workbench uses the display name when listing wrappers, layouts, and controls.

target name="logical-name"
Defines the component mappings for a specific target.

componentType name="wrapper|layout|control"
Includes all component mappings for a component type within a specific target.

concreteComponent name="logical-name" class="physical-class" skinClass="skin-class"
Maps a logical component to a real class.

skinClass
(Optional) Maps a skin to a Flex control.

How component mappings are resolved

Guides use three layers of mapping files. To map a logical component to a physical component, the mapping files are searched in order:
  1. Customer defined mapping: A custom mapping file that you create and store in a LiveCycle application in Workbench.

  2. System mapping file: The default mapping file that is included with Workbench. It is named SystemConfig.xml, and it is located in the /Guides (system)/2.0/Runtime application.

  3. Fall-back mapping: An object that resides in memory in case no mapping file is found. It contains the same mappings as the system mapping file.

// Ethnio survey code removed