S3. Bundle Schedule API

Bundle Scheduling API Overview

The XDOC API provides a set of methods that enable applications to programmatically schedule, monitor, and manage document bundling operations. These services support both individual bundle executions and batch processing scenarios, while providing status tracking and access to available Bundle Profile configurations.

Core Methods

Container.BundleSchedule

Schedules a new bundle for a specific Container and Bundle Profile.

Key Functions

  • Creates a new Bundle Package for the specified Container.
  • Initiates the complete Bundle Workflow, including both Package Generation and Package Delivery.
  • Returns a unique PackageId that can be used to track the execution status.

Bundle execution status can be monitored through:

  • API: Container.BundleStatus
  • User Interface: Bundle Manager and Workflow Monitor

Important: BundleSchedule cannot be used with Bundle Profiles configured with a Delivery Type of download. These profiles are intended for interactive user-initiated downloads and do not support background workflow processing.

For detailed parameter definitions and sample XML responses, refer to the BundleSchedule method in the HTTP Server Services API Method Listing.

Container.BundleStatus

Retrieves the current status of a bundle package using its PackageId.

Possible Status Values

Status Description
processing Package generation and/or delivery is still in progress.
success Package generation and delivery completed successfully.
error An error occurred during package generation or delivery.
cancelled Processing was cancelled through the user interface or administrative controls.
paused Processing has been temporarily suspended and may be resumed later.

This method is typically used by external applications to track the progress and outcome of scheduled bundling operations.

Container.BundleStatusBatch

Retrieves bundle status information for an entire batch of bundles.

Unlike BundleStatus, which reports the status of a single package, BundleStatusBatch returns status information based on a Batch Name or Batch Number, making it suitable for monitoring large-scale batch processing operations.

For detailed parameter definitions and sample XML responses, refer to the BundleStatusBatch method in the HTTP Server Services API Method Listing.

Project.BundleProfileList

Returns the list of available Bundle Profiles for a specified Project.

This method allows client applications to:

  • Retrieve configured Bundle Profiles.
  • Display available bundling options to users.
  • Validate Bundle Profile selections before scheduling bundle operations.

For detailed parameter definitions and sample XML responses, refer to the BundleProfileList method in the HTTP Server Services API Method Listing.

Typical Bundle Scheduling Workflow

A common bundle scheduling workflow consists of the following steps:

  1. Retrieve available Bundle Profiles using Project.BundleProfileList.
  2. Select the desired Bundle Profile.
  3. Schedule a bundle using Container.BundleSchedule.
  4. Capture the returned PackageId.
  5. Monitor processing using Container.BundleStatus, or use Container.BundleStatusBatch when tracking a group of related bundle executions.
  6. Review execution details through the XDOC Bundle Manager and Workflow Monitor as needed.

Additional Notes

  • Bundle Scheduling API methods are available in XDOC Build 6111 and later.
  • Bundle execution is performed using the XDOC Workflow Engine and can run asynchronously in the background.
  • Package Generation is executed once per bundle request, while Package Delivery may be retried based on the configured delivery settings and retry policies.
  • Complete parameter definitions and sample XML request/response formats are available in the HTTP Server Services API Method Listing documentation.

This API framework provides a robust mechanism for integrating XDOC bundling capabilities into external applications, automated workflows, and enterprise business processes.