Create and Maintain Batch Groups Using Public API

In addition to managing batch groups using the Mass Batch Actions window, you can now use the Batch Group Management API to associate batches to a group and disassociate batches from a group. Prior to this release you could only group batches using the Mass Batch Actions window.

Use the following steps to use the GME_BTCHGRP_API to create a Group Name, associate batches to a group, and disassociate batches from a group: 

  1. Execute the GME_BTCHGRP_API.CREATE_BATCH_GROUP API, then verify that a new batch group is created. 
  2. Execute the GME_BTCHGRP_API.CREATE_ASSOCIATION API with single or multiple batches, then verify that the batches are associated to the batch group. 
  3. Execute the GME_BTCHGRP_API.REMOVE_ASSOCIATION API with single or multiple batches, then verify that the batches are disassociated from the batch group. 

Using the public API to create a batch group or to associate or disassociate batches to an existing batch group gives you the:

  • Ability to migrate data from other legacy systems.
  • Reduce the manual effort of batch group management using the Mass Batch Actions window.

Steps to enable and configure

You don't need to do anything to enable this feature.

Tips and considerations

If the API validates and returns error messages for corrective actions:

  • Check if the mandatory parameters and context values are entered.
  • Verify that the data type and length specifications are correct.

Key resources