Installing and Running Extensions in Banana Accounting

Documentation •
In this article

Extensions for Banana Accounting need to be first installed. 

The Banana Accounting Extension Marketplace

The Banana Accounting Marketplace includes a great assortment of extension that make Banana Accounting more flexible and powerful. 

You can have a list and search the available extensions in menu Extensions → Manage Extensions  

Installation of an extension

In order to use the Extensions you need to install it in menu Extensions → Manage Extensions  

The installation process varies depending on where the extension resided.

Marketplace extensions

Once you install a marketplace extension:

  • The Title of the extension registered in the Marketplace is used as a title of the extension.
    The title in the package is used only if the extension is not available in the marketplace.
  • The extension's file is downloaded from the market place and saved in the local user data storage.
  • The  extension's is registered in the config file as locally available. 
  • If a new version is available it will be automatically updated.
    • The program only check once a day (on the first run) for update extensions .
    • Use the Update button to be sure to have the latest extension.
  • In order to execute or fully use an extension a specific Subscription Plan may be required.

Local extensions

Local extensions are extensions that reside on your computer. You use local installed extension when developing an extension.
You can install single file extension or packaged extensions.
Click on Add from file...
Once you install the extension:

  • The  extension's is simply registered in the config file as locally available. 
  • The title of the package or the description of the extension is used as a name of the extension.
  • When you execute the extension the program will read the extension, so it will use the last modified file. 
  • If you install a packaged extension Banana Accounting will automatically see all extensions included.
  • For developing purpose you can also install a single local javascript extension file.
    Make sure that you don't have the extension id is unique.

In order install local Extension you need to have a subscription to the Advanced plan.




Manage Extensions Dialog
 

URL extensions

Install from URL allow to use an extension available online.

  • You can install single file extension or packaged extensions.
  • The extension's file is downloaded from the specified Url and saved in the local user data storage.
  • The title of the package or the description of the extension is used as a name of the extension.
  • The  extension's is registered in the config file as locally available. 
  • If the extension on the origin change you have to install again.

In order install local Extension you need to have a subscription to the Advanced plan.

Release Stable, Beta and Internal 

The Marketplace allows to make available different version of the extension. This is very helpful when developing new functionalities of fixing bug. Selected users can try the new version without affecting other users. 

In Menu Extensions → Manage Extensions  next to each extension you can see if an Extension makes available different release. You can then choose the preferred release that you want to use between:

  • Stable channel.
    When developing a new extension we usually develop Beta release also in the Stable channel. 
  • Beta channel.
    Release that are not considered stable and are made available for test purpose.
  • Internal channel
    Available only internally to Banana.ch for special development purpose. 

Uninstalling extensions

You can uninstall extensions in Menu Extensions → Manage Extensions  

  • The  extension's will be un-registered from  the config file . 
  • If the extension has been installed from the marketplace or from an Url, the extension file will be deleted.
  • If the extension is local the file will remains and you can install later again.

Install an Extension from a local file

  • In Banana select from the menu Extensions the command Manage Extensions...
  • Click on Add from file...


    Manage Banana Apps dialog
     
  • Choose your JavaScript (.js) file
  • Click on Open to install the App
  • Click on Close to close the Manage Banana Extensions dialog

At this point, the BananaApp is installed and ready to be used.

Important information:

  • Once installed, the file .js needs to always remain in the same directory.
  • If the App is modified, the program will always use the last version.

 

Extensions Menu

General extensions will be automatically listed in the menu extension:

  • The description of the extension is used as the item text.
  • For package the title specified in the manifest is used as a title of the submenu.
    • The general extensions included in the package will be listed in the submenu in alphabetic order.
    • If you want a specific order start the description of the extension with a number.

 

Auto installing extensions 

In the Menu File > File Properties > Other you can specify that an extension available on the Banana.ch marketplace should be automatically installed when the file opened. Extensions are marked as automatically installed.

This is very useful when you preparing template that are associated with a specific extension. When the user open a file the program will automatically download and install the extension.

If you do not use the extension any more you need to uninstall the extension manually. 

Installing for development 

When you are developing an extension it must reside on your computer and you need to install manually. See:

Each extension should have a unique Id, therefore if you are working on an extension that is available on the marketplace and that has been already installed you have a conflict of id and the program will choose the first one.  To resolve the conflict you can use the property Enable of the extension.

  • In Menu Extensions → Manage Extensions  
    • Disable the extension from the marketplace.
    • Enable the local installed extension.
  • Once the development is finished and the extension has been published. 
    • Re-enable the extension from the marketplace.
    • Disable or uninstall the local installed extension.

 

Community extensions

Community extensions are extensions developed by third party and that are made available through the Banana.ch marketplace. 

Installation folder 

The market place Extensions are installed in the AppData of the user folder under Windows:

  • "\Users\username\AppData\Roaming\Banana.ch\BananaPlus\10.0\Apps\". 
  • The "bananaapps.cfg" contains the list of the installed extensions. 

Enterprise extensions

If you need to install a specific extension for each user in your organization.

  •  Marketplace extensions.
    • In the accounting File Properties specify the extension to be automatically installed.
    • Instruct the user how to install the extension.
  • Local extensions.
    Extension developed for you organization.
    • Make available the extension to the uses, preferably on a shared folder that the administrator can easily update.
    • Install for each user the extension manually. 

The first time you install a software you can eventually automatically overwrite a config file  with a standard one.

 

 

 

 

 

 

Help us improve the documentation

We welcome feedback on how to improve this page.

Tell us what theme needs a better explanation or how to clarify a topic.

Share this article: Twitter | Facebook | LinkedIn | Email