Try OpenEdge Now
skip to main content
Managed Adapters Guide
Understanding the Managed Adapter framework : Framework components : File formats used in the Managed Adapter framework : config.xml
This file contains the adapter configuration. The configuration required by the default MapConfigurator is stored in XML, but a custom implementation of a MapConfigurator may use any other custom format.


This file is stored in the file OEBPS_HOME\ebmsapps\<Application_Name>\maps\<WS_Name>\config.xml file, where WS_Name is the name of the workstep.


The XML file contents are:
<configform synchronous="true|false">
<block title="title" description="description" hidden="true|false">
<param name="name" access="I|O|IO|HIDDEN|PASSWORD"
description="description" type="java_type" value="default_value"/>


The schema is given below:
<?xml version="1.0" encoding="utf-16"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
    <xs:element name="configform">
        <xs:attribute name="synchronous" type="xs:string" use="optional"/>
            <xs:element maxOccurs="unbounded" name="block">
                <xs:element maxOccurs="unbounded" name="param">
                        <xs:attribute name="name" type="xs:string" use="required" />
                        <xs:attribute name="access" type="xs:string" use="required" />
                        <xs:attribute name="description" type="xs:string"                             use="optional" />
                        <xs:attribute name="type" type="xs:string" use="optional" />
                        <xs:attribute name="value" type="xs:string" use="optional" />
                <xs:attribute name="title" type="xs:string" use="optional" />
The interpretation of the schema elements is shown in the following table.
Table 3. Default ConfigForm format
<configform synchronous="true|false"> ... </configform>
[required] The root element of the adapter configuration. This parameter specifies the adapter execution mode—synchronous or asynchronous.
<block title="title" description="description" hidden="true|false">
[required] Defines a block of adapter parameters. One or more blocks can be defined in a ConfigForm.
Grouping of the parameters in a block is useful for several purposes:
*Visual grouping of the parameters later in the MapConfigurator GUI.
*Defining a group of parameters as "hidden", not visible from the MapConfigurator GUI.
The "title" [required] attribute is used solely for visual purposes, to group the contained properties in a labeled block.
The "description" [optional] attribute is not used in the default GUI, but may be used in extended GUI versions.
The "hidden" [optional] attribute defines the visibility of all the parameters in the block. When this parameter is not specified, the value is taken as "true".
<param name="name" access="I|O|IO|HIDDEN| PASSWORD" description="description" type="java_type" value="default_value"/>
[required] Each block contains one or more adapter parameters. The parameters represent adapter inputs, outputs and configuration values.
The "name" [required] attribute defines parameter's name.
The "access" [required] attribute defines how the parameter is to be used:
*I – adapter input
*O – adapter output
*IO – input/output
*HIDDEN – hidden parameter (for example a configuration constant)
*PASSWORD - the same as an IO field, except that it is displayed as a password field.
The "description" [optional] attribute can be used by the MapConfigurator GUI to display short description or help message about the parameter.
The "type" [optional] attribute is used by the mapper to specify the Java data type of the parameter. When this parameter is not specified, the type is assumed as "java.lang.String".
The "value" [optional] attribute gives the default value of the parameter.