Restore Business Process Service

The Restore Business Process service restores business process data from physical media to a Sterling B2B Integrator restored data location where it can be searched and viewed.

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

Category Description
System Name RestoreService
Graphical Process Modeler (GPM) categories None
Description Restores business process data from physical media to a Sterling B2B Integrator restored data location where it can be searched and viewed.
Business usage This is an internal service that runs from settings in the Archive Manager. It is used to load archived data into a restore area. This data can then be viewed through the appropriate Sterling B2B Integrator user interfaces.
Usage example This service should not be included in a business process; it is used internally for restore processing.
Preconfigured? Yes
Requires third-party files? No
Platform availability All supported Sterling B2B Integrator platforms
Note: You must restore data that was backed up using the same version and patch level as your current installation of Sterling B2B Integrator. Otherwise, the restore will fail.
Related services Backup Business Process service
Application requirements Adequate database space must be available to the service for loading archived data into a restore area. However, Documents on Disk (that is, documents that were stored on the disk when the archive was run) are restored to a special location on the disk.
Initiates business processes? No
Invocation Invoked by the system business process, RestoreService.bp, for restoring business process data from a backup location.
Business process context considerations None
Returned status values None
Restrictions There must be only one configuration of the Restore Business Process service.
Persistence level System Default
Testing considerations None

How the Restore Business Process Service Works

The Restore Business Process service restores business process data that has been backed up and removed from the database and makes it available for viewing. The Restore Business Process service is normally run from the Archive Manager. When restoring archived data, the Restore Business Process service automatically detects if the backed-up data is stored in the incremental backup format introduced in Sterling B2B Integrator 4.1.1 or in the older format. It then restores the data to the restore tables accordingly.

Documents on disk that were backed up with their associated table data are restored to a specially created location on the disk. These documents are not restored to the location from where they were first archived. The specially created location keeps restored data out of the live system, and it also allows you to easily delete a restore.

Implementing the Restore Business Process Service

The Restore Business Process service is preconfigured as RestoreService. Do not create additional configurations. If needed, you can edit the RestoreService configuration of the Restore Business Process service in the Sterling B2B Integrator Admin Console. For basic information about editing service configurations, see Managing Services and Adapters.

Configuring the Restore Business Process Service

You can specify field settings in Sterling B2B Integrator, using the Admin Console.

Field Description
Name Unique and meaningful name for the service configuration. Required. Do not change the preconfigured name.
Description Meaningful description for the service configuration, for reference purposes. Required.
Select a Group Select one of the options:
  • None – Do not include the configuration in a service group at this time.
  • Create New Group – Enter a unique name for a new group, which will be created with this configuration. (You can then add other services to the group as well.)
  • Select Group – If service groups already exist for this service type, they are displayed in the list. Select a group from the list.
Note: For more information about service groups, see Managing Services and Adapters.
Restore Thread Pool Size Maximum number of threads the Restore Business Process service will use for its processing. Required. Default is 8.
Run as User Applies to the scheduling of the business process. Type the user ID to associate with the schedule, or click the icon and select a user ID from the list. Valid value is any valid Sterling B2B Integrator user ID.
Note: This parameter allows someone who does not have rights to a specific business process to run it. If you select Admin as the user ID, you will inherit Administrative rights (for this run of the business process only), and enable the scheduled run.
Use 24 Hour Clock Display If selected, the service will use the 24-hour clock instead of the default 12-hour clock.
Schedule Information about scheduling the business process invoked by the Restore Business Process service. Valid values:
  • Do not use schedule If this field is selected, the service does not run on a schedule.
  • Run based on timer Valid values are the hour and minutes at which to run the service. If you choose to select a time interval, the valid values are the hours and minutes for the intervals. Add or delete selections as necessary. Specify any schedule exclusions or date exclusions. Indicate whether you want the service to run at startup.
  • Run daily Valid values are the hour and minutes at which to run the service, daily. If you choose to select a time interval, the valid values are the hour and minute for the interval. Add or delete selections as necessary. Specify any date exclusions. Indicate whether you want the service to run at startup.
  • Run based on day(s) of the week Valid values are the day of the week, the hour, and the minute that specify when to run the service. If you choose to select a time interval, the valid values are the hours and minutes for the intervals. Add or delete selections as necessary. Specify any date exclusions.
  • Run based on day(s) of the month Valid values are the day of the month, hour, and minute that specify when to run the service. If you choose to select a time interval, the valid values are the hours and minutes for the intervals. Add or delete selections as necessary. Specify any date exclusions.