loading-img

Publish your Adapter on the Symphony
Testing Account aka Integration

Upon completion of your adapter code and test using the Device Adapter Library (DAL) simulator, the adapter can be submitted for AVI-SPL validation and production publication consideration. You can submit your adapter using Symphony Connect portal.

1. Using Symphony Connect portal (Register/Connect Account)

Perform a one-time registration to create your account.

You can register using one of these methods:

  • You can access the portal directly, when you have an AVI-SPL account email (e.g., @avispl.com).
  • OR you can use an existing GitHub login, if you have one.

2. Prepare your package and submit

2.1 Create an adapter JAR file

Adapter projects are built using Apache Maven: https://maven.apache.org/.If you are not familiar with this process, we recommend reading the following official Apache documents:

https://cwiki.apache.org/confluence/display/MAVEN/Tutorial%3A+Maven+in+60+seconds https://cwiki.apache.org/confluence/display/MAVEN/Tutorial%3A+Build+a+JAR+file+with+Maven+in+5+minutes

2.2 Submit an adapter using Symphony Connect Portal

Log on to Symphony Connect portal using the button on this tab.

Click Packages in the left navigation bar.

Click the plus sign in the upper right toolbar.

Add the required package fields.

Save the package and wait for the review.

Field Descriptions

Display Name contains the name displayed on the Packages view.

Name contains the name of the DAL Adapter primary class with the package included (e.g., com.company.domain.MyAdapter)

Version contains the adapter version number. Keep in mind when multiple versions for an adapter exist, the upload with the highest version overrides any lower versions.

BEST PRACTICE: Increment minor/patch version of your adapter.

Type contains an adapter type, (e.g., Device Adapter, DAL Aggregator, etc.).

Protocol contains the adapter communication protocol, (e.g. HTTP, etc.).

Status contains the current adapter development state, (Alpha, Beta, Release).

Adapter JAR file contains your jar file created using the adapter project Maven build procedure (described previously).

Models contains device models for which this particular adapter is built.