Show TOC

Creating a Cnxml File for a Custom AdapterLocate this document in the navigation structure

Create a cnxml configuration file for your custom external adapter so that you can configure the adapter in Studio, and start and stop it with a project for ESP.

Procedure

  1. Specify attributes for the Adapter section:
    Attribute Description
    type (Required) Specify whether this is an input or output adapter.
    external (Required) Set the value to true as this is an external adapter.
    id (Required) Specify a unique identifier for your adapter. This value is listed in the type parameter within the ATTACH ADAPTER statement.
    label (Required) The name of your adapter. This name appears in Studio if you hover over the adapter icon in the Visual Editor.
    description (Required) Specify the purpose of the adapter. This is also visible in Studio.
  2. Specify attributes for the Library section:
    Attribute Description
    file (Required) Specify "simple_ext" as the value. Always specify this for external adapters.
    type (Required) Specify "binary" as the value.
  3. Specify internal parameters for the Special section. See the $STREAMING_HOME/lib/adapters/simple_ext.cnxml.template sample cnxml file for a complete list of internal parameters and usage details.
  4. Specify adapter parameters for the Section section. These parameters are visible and configuration in Studio.
    For each parameter, specify:
    Parameter Description
    id (Required) The property ID that you can reference in <Internal> command calls with $(id's name). This is what you reference when specifying adapter properties for an adapter in CCL.
    label (Required) The property name that appears in Studio.
    descr (Required) A description of the adapter property.
    type (Required) The property datatype.
    use (Required) Whether the property is required, optional, or advanced. In Studio, required properties appear in red and advanced ones appear on a separate tab.
    default (Optional) The default value to use, if you do not set a value for the property.