Sterling Control Center Service

The Sterling Control Center service handles requests from the Sterling Control Center including file transfer activity history, business process history, perimeter service status, and adapter status.

The following table provides an overview of the Sterling Control Center service:

Category Description
System Name Sterling Control Center Service
Graphical Process Modeler (GPM) category Applications > IBM® > Sterling Control Center
Description This service handles requests from the Sterling Control Center. The types of requests include file transfer activity history, business process history, perimeter service status, and adapter status.
Business usage Sterling B2B Integrator uses this service to communicate with the Sterling Control Center to adhere to specific service level agreements and to be notified in advance if conformance to service level windows is in jeopardy. Sterling B2B Integrator also uses this service to be alerted about file transfer activity, business process activity, and different adapter status in general.
Usage example A trading partner attempts to transfer a file, but the connection drops and the transfer does not complete. This causes a visibility event to be generated in Sterling B2B Integrator. The Sterling Control Center receives the information about the event through a SOAP request to the Sterling Control Center service in Sterling B2B Integrator. The Sterling Control Center generates an alert because the configured service level criteria have been missed. Appropriate parties are notified and mitigating action can be taken.
Preconfigured? Yes
Requires third-party files? No third-party files are required.
Platform availability All supported Sterling B2B Integrator platforms
Related services None
Application requirements Used at a system level by the Sterling Control Center product. Must be referenced in the definition of a Sterling B2B Integrator Web Services Manager configuration.
Initiates business processes? This service does not initiate business processes.
Invocation This service is invoked from a Web service.
Business process context considerations None
Returned status values Possible status values that can be returned from this service are:
  • 0 - Success
  • 1 - Error
Restrictions None
Persistence level None
Testing considerations Debug information for this service can be found in the Sterling Control Center service log files.

Implementing the Sterling Control Center Service

This service is used at a system level by the Sterling Control Center product. It must be referenced in the definition of a Sterling B2B Integrator Web Services Manager configuration.

Configuring the Sterling Control Center Service

The Sterling Control Center service is configured upon installation of Sterling B2B Integrator. Settings for the following fields are provided for reference:

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 Group of services or services of the same type that can act as peers. A Service Group name is used in BPML in place of the Service Configuration name. Service Groups show up in the GPM as if they were Service Configurations. Select a Service Group to associate with this service. Valid values are:
  • None – You do not want to include this configuration in a group at this time (default).
  • Create New Group – You can enter a name for a new group in this field, which is then 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.
For more information about service groups see Managing Services and Adapters.

Parameters Passed from the Business Process to Service

The following table describes the parameters passed from the business process to the Sterling Control Center service:

Field Description
RequestType Request type sent from the Sterling Control Center to the Sterling Control Center service. Required. Valid values are:
  • getHistory
  • getBPHistory
  • getInfo
  • getStatus
  • getLicense
  • OpsCommand
  • runSql
FromDate A date and time value that specifies when to get business process or AFT activity history. Required if Request Type = getHistory or getBPHistory.
ProtocolList A comma-delimited list of protocol activities for the Control Center to monitor. Valid values include:
  • FTP
  • Sterling Connect:Direct®
  • SFTP
  • HTTP
  • AS2
  • WebDAV
Optional. Valid if Request Type = getHistory.
RecordLimit Specifies the total number of activity history records to return to Control Center in a single request from Control Center. Optional. Valid if Request Type = getHistory or getBPHistory. Valid value is any number less than or equal to 5000. Default is 5000.
Command The Ops Command to execute in Sterling B2B Integrator. Required if Request Type = Command. Valid values are:
  • ADAPTERSTATUS
  • consolidatedstatus
  • LISTADAPTERS
  • LISTPERIMETERCLIENTS
Sql SQL to execute in Sterling B2B Integrator. Required if Request Type = Sql. Valid value is any valid SQL. For example, an SQL to get all the business process names.
BpExclusionList A list of BPs for the Control Center to not collect activity history. Required if Request Type is getBPHistory. Valid value is any business process name. Default is SOA_RequestHandler.

Parameters Passed from Service to Business Process

The following table describes the parameters passed from the Sterling Control Center service to the business process:

Parameter Description
PrimaryDocument A primary document is created to return the results of the requests. The contents of the primary document vary based of the request type.