Organize Your Integration Guide

Creating an integration guide for your plugin is an important step towards launching your project.

In this guide, we will cover some things to consider documenting and also cover some resources which may be helpful in creating an integration guide.


Prerequisites

You’ll want to have completed the development of your plugin.

Make sure that your plugin works in:

  • Banno Online
  • Banno Mobile (Android)
  • Banno Mobile (iOS)


Settings Resources

These resources may be helpful in creating your integration guide.

The images show the back office settings in Banno which are used to create an External Application and a Dashboard Configuration for a plugin.

External Application

Use your image editor to document the settings which are necessary for the External Application which powers your plugin.

If necessary, review the External Applications topic for information about the various options.

A plugin will have at least one External Application configured and may have two (one for the Card Face and one for the Expanded View).

  • If you have more than one, make sure to capture the settings for each External Application and make it clear which one is for the Card Face and which one is for the Expanded View.

We have provided images which show both the empty and selected options for the External Application.

Open the images in a new browser tab to see the full-size image.

External applications - Create new external application (empty)

External applications - Create new external application (selected)

Dashboard Configuration

Use your image editor to document the settings which are necessary for your plugin’s Dashboard configuration.

If necessary, review the Configuration topic for information about the various options.

Open the image in a new browser tab to see the full-size image.

Dashboard configuration - Create a plugin


Next Steps

Prepare your press release to let the world know about your plugin.