How to upgrade Aperio framework?

UPGAPI command

There is UPGAPI dedicated API command to upgrade Aperio framework.

The upgrade process covers the following steps:

  • checking authority to use crucial commands to make the upgrade (e.g. SAVLIB and RSTLIB)
  • making backup of API framework library
  • exporting all data in Metadata, Control, Configuration and Notification libraries
  • restoring all objects from save file containing entire Aperio framework saved into framework library
  • changing owner of all objects in framework library (by default to the owner already set for Framework library)
  • initializing API Framework
  • updating data in Metadata, Control, Configuration and Notification libraries by making an import from already exported data
To not loose information during upgrade process?

There is the mechanism to restore Aperio elements (Framework library + libraries containing Metadata, Control, Config and Notification related data) under UPGAPI command in case of failure during the upgrade process, but still it’s possible to make a backup copy of Framework library (e.g. by using SAVLIB) and/or export all API data via EXPAPIDTA command.

Manual upgrade

To upgrade manually do the following:

  1. See prerequisite check heading at Installation process description.
  2. Backup metadata, control, notification, config and IAF100AP libraries.
  3. Create temporary library which will be used as destination to export current metadata.
  4. Create temporary library which will be used as destination to export current control data

NOTE: the metadata and control can be exported to the same library.

  1. Make sure that following objects exist in IAF100AP library (these objects exist since API version 1.100):
  • EXPAPIDTA *CMD Export API data
  • IAFC0013 *PGM Import/Export API data
  • IAFR0013 *PGM Import/Export API data
  1. If above objects do not exist in IAF100AP library, then restore them (ONLY THEM) to IAF100AP.
  2. Export current metadata, control, configuration and notification to temporary library. Run command EXPAPIDTA. Set “from” and “to” libraries according to current set up.

NOTE: The export process will overwrite existing data in destination library (“to Library”).

NOTE: The export can also save into save file. Use Device = *SAVF

  1. Add APIPRF as supplemental group profile to users who should have access to API.

NOTE: All objects in IAF100AP library are owned by APIPRF. Administrator can either add supplemental group profile APIPRF to each user who uses API or just change authority for objects in IAF100AP library.

  1. Restore IAF100AP library.
  2. Decide where the metadata information should be placed. Usually the metadata information is placed in API framework library (IAF100AP).
  3. Decide where the control information should be placed. Usually the control information is placed in API framework library (IAF100AP).
  4. Decide where the configuration information will be placed. Usually the configuration information is placed in API framework library (IAF100AP).
  5. Decide where the notification data will be placed. Usually the configuration information is placed in API framework library (IAF100AP).
  6. Add API framework library to current job library list (ADDLIBLE IAF100AP)
  7. If the metadata library is different than API framework library, then add metadata library to current library list.

NOTE: It must be above API framework library (ADDLIBLE XXXXX).

  1. If the control library is different than API framework library, then add control library to current library list.

NOTE: It must be above API framework library (ADDLIBLE XXXXX).

  1. If the configuration library is different than API framework library, then add configuration library to current library list.

NOTE: It must be above API framework library (ADDLIBLE XXXXX).

  1. If the notification data library is different than API framework library, then add notification data library to current library list.

NOTE: It must be above API framework library (ADDLIBLE XXXXX).

  1. Run command INZAPIF to initialize API framework. NOTE: You must provide metadata, control, configuration and notification data libraries.
  • If metadata library is the same as framework library, then enter IAF100AP as metadata library.
  • If control library is the same as framework library, then enter IAF100AP as control library.
  • If configuration library is the same as framework library, then enter IAF100AP as configuration library.
  • If notification data library is the same as framework library, then enter IAF100AP as notification data library.
  • Set mode selection to *ALL
  1. Import metadata and control from temporary library. Run command IMPAPIDTA to load data back from temporary library.