ILLiad Flag Popups System Addon
- Andrew Morgan
Please note that only one system addon can register for each system event handler, and as such this addon will conflict with other system addons that use the same event handlers such as Alma NCIP System Integration.
Name | ILLiad Flag Popups System Addon |
|---|---|
Version | 1.0.0 |
Author | Atlas Systems, Inc. |
Description | System addon that displays flags in dialog boxes during various system events. This addon works best with Auto Process toggled on for the processes where it is available, since a dialog box displays for each transaction. If batch processing is used, the pop-ups will display all at once after Process Queue is clicked. The transaction number for each request is still displayed in each dialog box. Please note that only one system addon can register for each system event handler, and as such this addon will conflict with other system addons that use the same event handlers such as Alma NCIP System Integration.
The ILLiad client must be restarted for any changes to this addon's settings to take effect. |
Download
Configuration
Addon settings are configured in the Manage Addons form.
The ILLiad client must be restarted for any changes to this addon's settings to take effect.
Setting | Default | Type | Description |
|---|---|---|---|
BorrowingCheckInFromLenderEnabled | false | Boolean | Determines whether this addon runs when items are checked in from the lender in borrowing. |
BorrowingCheckInFromCustomerEnabled | false | Boolean | Determines whether this addon runs when items are checked in from the patron in borrowing. |
DocumentDeliveryMarkFoundEnabled | false | Boolean | Determines whether this addon runs when items are marked found in document delivery. |
LendingMarkFoundEnabled | false | Boolean | Determines whether this addon runs when items are marked found in lending. |
LendingReturnsEnabled | false | Boolean | Determines whether this addon runs when items are returned in lending. |
FlagsToDisplay |
| String | A comma-separated list of flags to display pop-up messages for when performing an action. Can include system flags. |
FlagsToRemove |
| String | A comma-separated list of custom flags that should be automatically removed after performing an action. These flags will be removed even if they are not listed in the FlagsToDisplay setting. |
FlagsToChoose |
| String | A comma-separated list of custom flags that should display a pop-up with the option to keep remove the flag when performing an action. These flags do not need to be listed in the FlagsToDisplay setting. |
Overview
This system addon displays popup dialog boxes for flags during various system events. Additionally, it provides the option to remove custom flags during these processes either via a choice presented in the dialog box or automatically.
The BorrowingCheckInFromLenderEnabled, BorrowingCheckInFromCustomerEnabled, DocumentDeliveryMarkFoundEnabled, LendingMarkFoundEnabled, and LendingReturnsEnabled settings control which system events the addon runs for.
The FlagsToDisplay setting determines which flags to display dialog boxes for during the enabled system events. Unlike the other flag settings, this can include system flags such as the OCLC Special Message flags. Flags displayed in this way will also display a message about whether or not the flag will be removed.
The FlagsToRemove setting determines which custom flags to remove during the enabled system events. If the flags listed here are not also in the FlagsToDisplay setting, they will be removed silently without any dialog box popping up. System flags cannot be removed by the addon.
The FlagsToChoose setting determines which custom flags should give a staff user should be presented with the choice to remove during the enabled system events. These flags will be displayed in a dialog box similar to those listed in FlagsToDisplay but with the “Yes” and “No” buttons at the bottom to allow the flag to be either removed or kept. These flags do not need to be listed in the FlagsToDisplay setting and should not be listed in the FlagsToRemove setting. Since system flags cannot be removed by the addon, they should not be listed in this setting.
