Create a Generic Adapter Package

A Generic Adapter package is similar to an Enhanced Generic Push Adapter package. To create the initial skeleton ZIP archive, it is recommended to copy an existing Generic Adapter package and customize it as required. For more information about the adapter package, see Achieving Data Push using the Generic Adapter.

The differences between an existing Enhanced Generic Push Adapter package and a Generic Adapter package are:

  • Adapter XML differences

    • The adapter class is changed from PushAdapter to GenericAdapter:

    • The adapter capabilities include population

    • Along with the definition of the Population connector, performed by the adapter setting:

      the Generic Adapter (using the population feature) also requires the definition of the Push Connector class:

  • Mapping file folders

    As opposed to the Enhanced Generic Push Adapter (which requires its mapping files to be located in the <adapter_package_zip>/adapterCode/<adapter_name>/mappings folder, the Generic Adapter requires its mappings to be placed in three separate folders (one each for push, population, and federation). The required folders are:

    <adapter_package_zip>/adapterCode/<adapter_name>/mappings/push
    <adapter_package_zip>/adapterCode/<adapter_name>/mappings/population
    <adapter_package_zip>/adapterCode/<adapter_name>/mappings/federation

    where <adapter_package_zip> refers to the zip archive that you will create for the generic adapter package.

Note Although the Generic Adapter supports all three types of data synchronization (push, population, and federation), a specific Generic Adapter can choose to supply only a subset of those types.

Points to remember when creating a new adapter from an existing adapter

  • TestAdapter\discoveryPatterns\TestAdapter.xml
  • Modify the TestAdapter.xml file:

    • <pattern xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="TestAdapter" xsi:noNamespaceSchemaLocation="../../Patterns.xsd" description="…" schemaVersion="9.0" displayName="…">
    • <adapter-id>TestAdapter</adapter-id>
  • The ZIP file containing the new adapter should have the same name as the adapter itself - TestAdapter.