Index Business Process Service

The Index Business Process service sets all completed or terminated business process data to be ready for archiving or purging. Creates an entry for each completed or terminated business process in the WF_INST_S table, and updates several tables.

The following table provides an overview of the Index Business Process service:

System name Index_Service
Graphical Process Modeler (GPM) categories All Services, System
Description Sets all completed or terminated business process data to be ready for archiving or purging. Creates an entry for each completed or terminated business process in the WF_INST_S table, and updates these tables:
  • WORKFLOW_CONTEXT
  • DOCUMENT
  • DOCUMENT_EXTENSION
  • DATA_TABLE
  • CORRELATION_SET
  • WORKFLOW_LIFESPAN
  • DOCUMENT_LIFESPAN
  • WORKFLOW_DATA
Business usage This service selects all complete and terminated business processes and flags them for archive or purge.
Usage example Sterling B2B Integrator runs a business process with the Index Business Process service information. BMPL can run manually or by schedule.
Preconfigured? No
Requires third-party files? No
Platform availability All supported Sterling B2B Integrator platforms.
Related services Archive Business Process service, Purge service.
Application requirements No
Initiates business processes? No
Invocation Runs by only the internal scheduler.
Business process context considerations No
Returned status values The following status values are returned after this service runs in a business process:
  • 100s – Workflow engine error, for example, the service is deactivated
  • 200s – System error, for example database error
  • 300s – The service configuration error.
Restrictions There can be only one configuration per server of this service.

Implementing the Index Business Process Service

To implement the Index Business Process service, complete the following tasks:
  1. Create an Index Business Process service configuration. For information, see Managing Services and Adapters.
  2. Configure the Index Business Process service. For information, see Configuring the Index Business Process Service.
  3. Use the Index Business Process service in a business process.

Configuring the Index Business Process Service

To configure the Index Business Process service, you must specify settings for the following fields in Sterling B2B Integrator:

Field Description
Name Unique and meaningful name for the service configuration. Required.
Description Meaningful description for the service configuration, for reference purposes. Required.
Select a Group Select one of the options:
  • None – You do not want to include this configuration in a group at this time.
  • Create New Group – You can enter a name for a new group in this field, which will then be created along with this configuration.
  • Select Group – If you have already created one or more groups for this service type, they are displayed in the list. Select a group from the list.
Run As User Enter the user ID to associate with this service when run.
Do not use schedule If field is selected, it does not get scheduled to run.
Run service based on timer every Valid values are the hour and minutes at which to run the service. Indicate whether you want the service to run at startup.
Run service daily at Valid values are the hour and minutes at which to run the service, daily. Indicate whether you want the service to run at startup.
Run service weekly on Valid values are the day of the week, the hour, and the minutes at which to run the service. Indicate whether you want the service to run at startup.