The capacity change transaction

The Capacity Change transaction is used for setting up events that involve capacity changes

Invoked by

  • The createResourcePool() API
  • The changeresourcePool() API
  • The overrideResourcePoolCapacity() API
  • The manageCapacityReservation() API
  • The cancelReservation() API
  • The reserveItemInventory() API
  • Any other API that is capable of allocating capacity against external resource pool

Attributes

The following are the attributes for this transaction:

Table 1. Capacity change attributes
Attribute Value
Base Transaction ID CAPACITY_CHANGE
Base Document Type General
Base Process Type General
Abstract Transaction No
APIs Called None

Events raised

This transaction raises the following events:

  • ON_CAPACITY_ADJUSTMENT

    This event is raised for every standard capacity adjustment when the createResourcePool() API or changeResourcePool() APIs are invoked. It publishes detailed information about the standard capacity adjustments.

    Key Data: INSTALL_DIR/xapidocs/api_javadocs/dbd/ CAPACITY_CHANGE_ON_CAPACITY_ADJUSTMENT_dbd.txt

    Data Published: INSTALL_DIR/xapidocs/api_javadocs/XSD/HTML/ INV_CAPACITY_CHANGE.ON_CAPACITY_ADJUSTMENT.xml

  • ON_OVERRIDE_CAPACITY

    This event is raised for every adjustment of overridden capacity when the overrideResourcePoolCapacity() API is invoked. It publishes detailed information about the changes in the overridden capacity.

    Key Data: INSTALL_DIR/xapidocs/api_javadocs/dbd/ CAPACITY_CHANGE_ON_OVERRIDE_CAPACITY_dbd.txt

    Data Published:INSTALL_DIR/xapidocs/api_javadocs/XSD/HTML/ INV_CAPACITY_CHANGE.ON_OVERRIDE_CAPACITY.xml

  • EXTERNAL_CAPACITY_CHANGE

    This event is raised when capacity consumptions are changed. This event is raised when the cancelReservation() API or reserveItemInventory() API or any other API that is capable of changing external capacity is invoked. It publishes detailed information about the changed capacity of external resource pools.

    Key Data: INSTALL_DIR/xapidocs/api_javadocs/dtd/YFS_CAPACITY_CHANGE.EXTERNAL_CAPACITY_CHANGE_dtd.txt

    Data Published: INSTALL_DIR/xapidocs/api_javadocs/XSD/HTML/YFS_CAPACITY_CHANGE.EXTERNAL_CAPACITY_CHANGE.xml

Note: When defining the EXTERNAL_CAPACITY_CHANGE event, you should not call the changeOrder API as a result of this event. Doing so could cause the API to raise the event that called it, creating an infinite cycle.
  • CAPACITY_CHANGE.ON_STD_CAPACITY_FILLED

    This event is raised when consumption exceeds standard capacity defined for the day. This event is raised when the manageCapacityReservation() API is invoked.

    Key Data: INSTALL_DIR/xapidocs/api_javadocs/dtd/INV_CAPACITY_CHANGE.ON_STD_CAPACITY_FILLED_dtd.txt

    Data Published:INSTALL_DIR/xapidocs/api_javadocs/XML/INV_CAPACITY_CHANGE.ON_STD_CAPACITY_FILLED.xml

  • CAPACITY_CHANGE.ON_STD_CAPACITY_FREED

    This event is raised when consumption is freed and standard capacity becomes available for the day. This event is raised when the manageCapacityReservation() API is invoked.

    Key Data: INSTALL_DIR/xapidocs/api_javadocs/dtd/INV_CAPACITY_CHANGE.ON_STD_CAPACITY_FREED_dtd.txt

    Data Published:INSTALL_DIR/xapidocs/api_javadocs/XML/INV_CAPACITY_CHANGE.ON_STD_CAPACITY_FREED.xml