Uploading cartridges

Upload a cartridge for use in Step-up Analytics actions.

Before you begin

Download IBM® StoredIQ® cartridges from IBM Fix Central to your local drive. Cartridges can also be acquired from IBM Services or IBM Business Partners.

About this task

Procedure

To upload a cartridge:

  1. Select Cartridges from the side navigation bar in the IBM StoredIQ Administrator user interface.
    For each cartridge in IBM StoredIQ, the following information is displayed:
    Table 1. Cartridges
    Cartridge column name Description
    Name The display name of the cartridge. You enter that name when you upload a cartridge.
    Cartridge name The cartridge name, which must be unique within the IBM StoredIQ instance. The name is retrieved from the cartridge.properties file in the cartridge.
    Supported results The search filter terms that the cartridge logic makes available as indexed annotations ia:filterterm. This information is retrieved from the cartridge.
    Status The cartridge status, such as Pending, Processing, Failed, and Available.
    Creation date The date that a cartridge is uploaded.
  2. Click Upload Cartridge in the Cartridge pane.
    The Upload Cartridge window appears.
  3. Enter a display name for the cartridge in the Name field.
    You can change the display name when you update the cartridge.
  4. Accept the terms of the license that is contained in the cartridge.
    The Choose File button is not active until the license is accepted.
  5. Click Save.
    The cartridge validates automatically.
  6. Select a cartridge after validation is complete.
    The Details section is populated with this information:
    Details field Description
    Status The cartridge status, such as Pending, Processing, Failed, and Available
    Last Run The date that the cartridge analytics were last applied by running a Step-up Analytics action
    Last Update The date when the cartridge was last updated
    Last error The error message for a failed upload or update
    Version The version of the cartridge
    Description The cartridge description which is retrieved from the cartridge
    Language supported The document languages that the cartridge can annotate
    Total infosets using cartridge The total number of infosets to which the cartridge logic was applied
    Total active step-up analytics executions using cartridge The number of active Step-ups Analytics executions that use this cartridge
    Total step-up analytics actions using cartridge The number of Step-up Analytics actions that use this cartridge