Space banner This version of the product is in limited support. However, the documentation is available for your convenience. You will not be able to leave comments.

Developing a vendor adapter

A vendor device adapter is the simplest type of adapter. It does no more than defining a vendor name, which you can use later as a parent to device type adapters. That is, a vendor is used as a container for organizing device types. It is used in the GUI when selecting a device type; where you first select a vendor, and then you can choose device types within the vendor. This topic describes the XML template for a vendor adapter. Create a new vendor when you need to add a new device type for an equipment manufacturer that is not already present in the system.

This topic discusses the XML template for developing a vendor adapter. See the Device adapter development process for the tasks that you are required to perform for developing an adapter. 

Use this template for the XML for a vendor adapter:

<?xml version="1.0" encoding="UTF-8"?>
<deviceTypeMap>
   <vendors>
       <vendor>
           <guid>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</guid>
           <name>display name</name>
       </vendor>
   </vendors>
</deviceTypeMap>

The legal XML elements in a vendor adapter are:

Tag

Description

<guid>

(Required) A globally unique ID (GUID)

Run the create_guid.sh or create_guid.bat script in the BCAN_HOME\tools directory to generate a new GUID for use here.

<name>

(Required) Name of the vendor, up to 255 characters in length

This name appears on the GUI and must be unique across all vendors.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*