Using Addons on Client Forms
Form addons will appear as a tab on the host form. ILLiad supports addons on the request form, user form, and the main form. Information regarding data that is exposed on each of those forms and which commands those forms allow can all be found below. The following forms are supported:
- Main Form (FormMain)
- Request Form (FormRequest)
- User Form (FormUser)
- Modules (e.g., Borrowing Processing)
To configure an addon to be used on a form, the addon's configuration file must specify which form(s) the addon should load on. Multiple form elements can be added to duplicate addon functionality on additional forms.
Main Form (FormMain)
Supported Commands
Exposed Data
- None
Request Form (FormRequest)
Supported Commands
- Route Command
- SendTransactionNotification Command
- AddTransactionFlag Command
- RemoveTransactionFlag Command
- Save: Saves the data on the request detail form.
- SwitchTab: Activates the form tab whose name corresponds to the name provided.
Exposed Data
The following data sources are available on the request form. Access to the data is provided via the GetFieldValue and SetFieldValue functions. See Global Methods for more information.
- Transaction
- User (_read-only_)
- Lender (_read-only_)
User Form (FormUser)
Supported Commands
Exposed Data
The following data sources are available on the request form. Access to the data is provided via the GetFieldValue and SetFieldValue functions. See Global Methods for more information.
- User
Example
The following is an example of a configuration file for a sample addon that will load on the ILLiad request form.
<Configuration> <Name>Sample Request Form Addon</Name> <Author>Atlas Systems, Inc.</Author> <Version>1.0</Version> <Active>False</Active> <Description>...</Description> <Forms> <Form>FormRequest</Form> </Forms> <Settings></Settings> <Files> <File>SampleRequestAddon.lua</File> </Files> </Configuration>
Module Processes
function init() if not GetFieldValue("Transaction","ProcessType")=="Borrowing" then return end -- -- put your other init code here -- end