Extension Reference Design

Documentatie •
In dit artikel

Banana Accounting offers JavaScript extensions as a way to extend the functionality of the software. These extensions are essentially scripts written in JavaScript, a popular programming language. They allow users to add custom features or automate specific tasks in the accounting software, catering to unique business needs or personal preferences.

The JavaScript extensions in Banana Accounting can vary widely in their functions. Some common examples might include:

  1. Custom Reporting: Tailoring financial reports to meet specific requirements that are not covered by the standard features of the software.
  2. Data Import/Export: Automating the process of importing or exporting data to and from different formats or systems.
  3. Automated Calculations: Performing complex calculations automatically, such as currency conversions, tax computations, or custom financial analyses.
  4. Integration with Other Tools: Connecting Banana Accounting with other tools or platforms, such as CRMs, eCommerce platforms, or external databases.

 

Extensions format and distribution

Banana Accounting Extensions have different format and availability.

  • Single file (javascript file)
    • It is the base format for all the extensions.
    • It is composed by a single .js file
    • Easier to edit (external text editors), move and update.
    • Can be included in the menu Extensions.
    • Can be used by different accounting file.
  • Embedded extensions
    • Extension file saved in the Document table.
    • Not available in the menu Extensions.
    • Only relative to the file where it is included.
    • Editing only with the limited internal editor.
    • On the Embedded Extensions  JavaScript Tutorial you will find the documentation and different basic examples embedded in a document that you can run and edit.
  • Packaged Extensions
    • Is a compressed file that can include different resource. 
      The suffix of the file is .sbaa
    • Can include one or many single file extension.
    • Can include any digital resource .
    • Can be included in the menu Extensions.
    • Can be used by different accounting file.
    • The current format used to create extensions.
    • Protected from user modification.

Extensions Store and Installation

In Menu Extension > Manage Extensions you can see the list of all available extensions. 

  • Clicking on install the extension is downloaded and is available to be used in the Extension menu.
  • Extensions are also installed automatically if you open an accounting file that in the File Properties specify a needed extensions.

From Manage extensions you can also install:

  • Local extensions.
  • Extensions with a url. 

Extensions Menu

The Extension Menu list all extensions that can be executed for this application. 
Within the Attribute section of the extension, the developer can specify that an extension apply only to certain file. In this case the command will be listed only if the file has the specified characteristics.
The extension will apply only to:

  • A specific type of file (for example double entry accounting). 
  • A file that include a specific term in the File properties.
  • A file that require the specific extension. 

Test framework for extensions

When we develop extension we require that a series of test are created to assure that when they are changed there are not regressions. 

We offer a test framework to automate the testing, see:

 

 

Help ons de documentatie te verbeteren

We horen graag uw feedback over hoe we deze pagina kunnen verbeteren.

Vertel ons welk thema een betere uitleg nodig heeft of hoe we een onderwerp kunnen verduidelijken.

Share this article: Twitter | Facebook | LinkedIn | Email