Developer Guide

2.3.2
- 2.5.0
- 2.4.0
- 2.3.1
- 2.3.0

Back Next

Creating the Vibe Data Stream Plug-in XML Document

Create an XML document called

vdsplugin.xml

. In the XML document, describe the configuration of the custom entity type.

You can create the XML document in the following ways:

Create the VDS Plug-in XML Document Manually: Manually edit an XML file to include all the required XML elements.
Generate a Sample XML Document from the VDS Plug-in Schema and Modify the XML Document: Use a tool of your choice to generate an XML document from the schema definition.

Perform the following tasks:

Create a copy of the

field

element for each field that you want the entity to contain, and then provide values for the XML elements for each field. For example, in the version element, specify a version number.

Specify a unique plug-in ID in the XML document. The plug-in ID must not contain spaces. If two or more VDS plug-in JAR files have the same plug-in ID, VDS loads only one of those plug-in JAR files, and only that plug-in JAR file is visible as a custom entity type in the Administrator tool. For the plug-in JAR files that VDS does not load, VDS logs an error.

Edit the values of the XML elements that the

vdsPlugin

XML element encloses.

After you create the VDS plug-in XML document, validate the document against the schema definition.

Creating a Custom Entity Type

Format of the Vibe Data Stream Plug-in XML Document

Sample Implementations of Vibe Data Stream Interfaces

Implementing the VDSSource Interface

Implementing the VDSConsumptionSource Interface

Implementing the VDSTarget Interface

Implementing the VDSTransform Interface

Implementing the VDSPluginStatistics Interface