Help /

Install/Activate Extensions

Purpose

To be done

Procedure

Tips and Tricks

Quick Guide to activating extensions.

Versions of FA above 2.3 now have an automated, repository based extension system. To activate an extension, logon to FA as the system administrator (only) and do the following:

1. Go to Setup / Install/Activate Extensions

The system retrieves extensions from the FA remote server AND picks up any directories you have under /modules.

2a. Click the 'download' icon to download the extension and install you want. (Once the extension has been installed, the download icon will disappear and a delete (red 'X') icon will appear on the right) Screenshot

2b.Now at the top where it states 'Extensions: click the dropdown box and select Activate for 'Company name'. Select the company you want to make the extension active for and tick the box for the required extension and then the 'update' button at the bottom. You will need to do this for all companies that you require to use this extension. Screenshot

3. Go to Setup / Access Setup, Select the USER ROLE you want to activate the extension for in the drop down box at the top of the page.

Click the tick-box for the extension you want and then the 'Save Role' button at the bottom.

4. Logoff and log back on to start using your extension.

Remember to activate the extension in each company you want to use it in.

Files required for a new extension module

  1. Your custom extension code file (eg. import_transactions.php)
  2. hooks.php

The hooks file creates a new class that extends hooks. In this class, you implement some or all of

  • install_options
  • install_tabs
  • install_access

And, you must implement

  • install_extension
  • activate_extension

Both of these functions return true.

For submitting a new extension, you should also create an _init/config text file that describes the extension.

See a new extension module like asset_register to understand the code.

  • You are free to use any numbers in range 100<<8 to 155<<8 as section id, and any number from 101 to 255 as security area id. You should only keep them unique inside module where they are defined. The "<<" is the php shift bitwise operator.
  • Customise Icons, Shortcuts Menu entries for extensions