The Server Addon tab in the customization manager facilitates the installation and management of custom Server Addon scripts that you can create to perform certain processes automatically without staff intervention, such as routing items and adding or removing flags. Unlike system and form addons, which run on the client, server addons run in the system manager. They are stored in the ServerAddons database table instead of the file system and configured from within the customization manager.
Addons require a Lua code file scripting and a configuration file of XML scripting. (For full details on writing Server Addons, see Creating Addons). These files are loaded into ILLiad together in a .zip file via the Customization Manager.
This server addon functionality is available in versions 8.7 and higher. |
Server Addons are administered within the Customization Manager from the Server Addons Tab. The following functions are available from the Server Addons ribbon:
Server Addons are installed and affect ALL sites and will display to ALL sites, no matter the site selected at installation.
DSP Addons are installed the same way but affect ONLY the site selected.
The name of the Addon can be modified in the editing window on the lower left. This will not save to the underlying config.xml but can be modified to create an alias for a particular addon when viewing it in the Customization Manager.
To edit the values in a server Addon:
The Reset Settings will restore only the changes in the Values column to the default settings when Addon was initially installed.
The updating process does include validations checks which will warn you if there are problems with the Addon update such as if you attempt to update to an older version, if required files are missing, or if a new version removes an existing value.
In previous versions of ILLiad, the System Manager had to be restarted when an Addon was updated or edited. Beginning in version 8.7, the System Manager will not need to be restarted unless the Addon uses an external assembly. Is that is the case, you will be prompted to restart the System Manager.
If the Addon does not convert successfully, or a non-Atlas Server Addon needs to be added after 8.7 has been installed:
Ensure all lua files are referenced in the Files element of the config.xml as shown here: <Files> <File>TwilioSMSNotifications.lua</File> </Files>
Zip both the the config.xml and the code file(s).
Users may choose to export an Addon with the default settings. The default file name will be the Addon name with a zip extension. The initial directory is set as the last directory used when uploading or exporting an Addon. If the user has never uploaded/exported an Addon, it is set to the base path of the Customization Manager. The last used directory is saved as in user settings for the Customization Manager so it will be specific to each windows profile user.
If you no longer want to use a previously installed Server Addon, you can either temporarily mark the Addon inactive and save it for later use, or permanently remove it from your machine:
Temporarily Disabling the Addon
If you would like to temporarily disable an Addon and leave the configuration settings intact for use at a later time, follow the steps below:
Select the Addon to be disabled from the grid list located in the Server Addons tab of the Customization Manager.
Choose the No radio button under Active.
Click Save to save those changes.
The Addon is now inactive. Check your routing rules in the Customization Manager and remove or disable any that require the use of the inactive Addon.
Permanently Deleting the Addon
If you would like to permanently delete the Addon and its configuration settings, follow the steps below:
Select the Addon to be disabled from the grid list located in the Server Addons tab of the Customization Manager.
Click Delete, then click Yes when prompted to confirm your decision.
Check your routing rules in the Customization Manager and delete any rules that require the use of the deleted Addon.
Check the entry for the addon in the Addon Directory and contact the creator of the Addon for any additional necessary steps or information.
This will delete all of the settings configured for the Addon from the database. The Addon files contained in the zip folder initially uploaded when installing the Addon will remain on your server. These are generally fine to keep as any passwords or other sensitive information will be stored in the Addon settings and deleted when the Addon is deleted in the Customization Manager. However, if you would like to remove the additional files, please contact Atlas Support if you are hosted or your local server administrator if you are self-hosted. |