Follow these steps to update a cartridge from an older version.
About this task
This procedure applies to all cartridges but the GovernanceDataClasses cartridge, which is created only if IBM®
StoredIQ® is configured for integration with a governance catalog. This cartridge is automatically updated whenever relevant information in the governance catalog changes. For details, see The GovernanceDataClasses cartridge.
Procedure
-
Select a cartridge from the list.
-
Click Update from the top of the window.
The Update Cartridge window opens.
-
Optionally, you can change the display name of the cartridge.
- Make sure the license agreement is accepted.
-
Click Choose File to select a new version of the previously uploaded cartridge from the directory of your desktop.
The new cartridge must have the same cartridge name as the cartridge that it is being updated. The cartridge name is given in the cartridge.properties file that is contained in the cartridge. However, previously processed documents are reindexed during a rerun of the respective actions only if the cartridge's version number changed. Otherwise, any new cartridge logic is applied only to newly processed documents, which can result in inconsistencies. The cartridge version is also set in the cartridge.properties file. For more information about the properties file, see the developerWorks recipe Developing Regular Expression Cartridges for StoredIQ.
-
Click Save.
If the cartridge that is provided in the update is invalid or if an unexpected error occurs during the update process, an error message is returned and displayed in the Last Error field of the Details pane. If an error occurs, the previously uploaded version of the cartridge remains available.
If Step-up Analytics executions are active, the Update button is not active. The number of active Step-up Analytics executions is given in the Total active Step-up Analytics executions using this cartridge field in the Details section.
What to do next
When cartridges are updated, use your best judgment to decide whether you must rerun the respective Step-up Analytics actions. While you should rerun them when the updates provide new supported results, you might want to hold off on doing so for performance or detection quality improvements. When you rerun the respective actions, all documents are processed whether or not they were modified since the last run.
Do not forget to create new infosets after you apply the new logic.