This topic discusses the enums used in the migration framework.

Classes

PacketCategory

Each migration packet must have a category attribute that is set to one of these categories

NameValueDescription
PacketCategory.CATEGORY_MANDATORY0This packet must be installed for successful migration
PacketCategory.CATEGORY_OPTIONAL1This packet is completely optional. An example would be an early port of an upcoming feature
PacketCategory.CATEGORY_HELPER2This packet provides some helper functionality aimed at customizers

PacketState

  The packet state is written and read from the data item Status and can have the following values

NameValueDescription
PacketState.NEW0A migration packet that was not part of a migration yet
PacketState.INSTALLED1A migration packet that ran successfully
PacketState.SKIPPED2Deprecated
PacketState.FAILED3A migration packet that ran unsuccessfully
PacketState.PENDING4A migration packet that has a dependency on another packet, but the other packet does not have the necessary state
PacketState.UNNECESSARY5A migration packet that was deemed unnecessary for the previous migration