DB Monitor Service

How the DB Monitor Service Works

The DB Monitor service sends notification, as configured by the Sterling B2B Integrator event alert system, of any recommended maintenance. If the DB Monitor service determines that the system administrator needs to rebuild the index, or analyze database tables, the service will produce a primary document that provides information about the recommended maintenance. The DB Monitor service will also provide notification if key database health thresholds are exceeded. By default, the system will send an e-mail to the system administrator.

The preconfigured instance of the DB Monitor service, named DBMonitorService, has an associated business process named Schedule_DBMonitorService that performs all the available actions of the DB Monitor service by using default values for each. The DBMonitorService instance is scheduled to run each Monday at 4:00 A.M. You can change the run day and time using the Scheduler.

If you create a new instance of the DB Monitor service and specify a schedule in the service configuration, the system will create an associated business process using the name of your instance (minus any spaces) preceded by Schedule_. For example, if you name your instance My DB Monitor Service, the business process name will be Schedule_MyDBMonitorService. If you do not use a schedule in the service configuration, a business process will not automatically be created.

You can change settings by editing the BPML in the associated business process. You can also use the DB Monitor service in your own business process and specify settings in the Graphical Process Monitor, or directly in your BPML.

Implementing the DB Monitor Service

Configuring the DB Monitor Service

Creating a Service Configuration in the Admin Console

Use the field definitions in the following table to create a new configuration of the DB Monitor service.

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 – 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.
Run As User	Type the user ID to associate with the schedule, or click the icon and select a user ID from the list. Valid values: Any valid Sterling B2B Integrator user ID.
Use 24 Hour Clock Display	Check the box to use the 24-hour clock instead of the default 12-hour clock.
Schedule	Specify the scheduling information for running the Auto Terminate service. Valid values: Do not use schedule If you select this field, 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 each day. 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. Note: Any value except Do not use schedule will cause a Schedule_InstanceName business process to be automatically created. See How the DB Monitor Service Works for more information. If you select Do not use schedule, you must specify service settings in the GPM.

Setting Up the Service in the GPM

Use the field definitions in the following table to set up the service configuration in the GPM:

Business Process Example

The following example illustrates a business process containing the DB Monitor service. The following BPML is from the Schedule_DBMonitorService business process invoked by the DB Monitor service.

<process name="Schedule_DBMonitorService">
  <sequence name="Start">
    <operation name="SetLock">
      <participant name="SystemLockService"/>
      <output message="Xout">
        <assign to="LOCK_KEY">DBMonitorService_Lock</assign>
        <assign to="DURATION">86400000</assign>
        <assign to="CLEAR_ON_START_UP">true</assign>
        <assign to="." from="*"></assign>
      </output>
      <input message="Xin">
        <assign to="." from="*"></assign>
      </input>
    </operation> 
Check for database percentage grown beyond threshold since last check
    <sequence name="Process">
      <operation name="DBMonitorService_1">
        <participant name="DBMonitorService"/>
        <output message="Xout">
          <assign to="ACTION">CHECK_DB_GROWN</assign>
          <assign to="MAX_PERCENT_GROWN">30</assign>
          <assign to="SAVE_STATUS">true</assign>
          <assign to="." from="*"></assign>
        </output>
        <input message="Xin">
          <assign to="." from="*"></assign>
        </input>
      </operation>

Check for database percentage full.

      <operation name="DBMonitorService_2">
        <participant name="DBMonitorService"/>
        <output message="Xout">
          <assign to="ACTION">CHECK_DB_FULL</assign>
          <assign to="MAX_PERCENT_FULL">80</assign>
          <assign to="SAVE_STATUS">true</assign>
          <assign to="." from="*"></assign>
        </output>
        <input message="Xin">
          <assign to="." from="*"></assign>
        </input>
      </operation> 
Check for whether or not the database should be re-indexed
      <operation name="DBMonitorService_3">
        <participant name="DBMonitorService"/>
        <output message="Xout">
          <assign to="ACTION">CHECK_DB_INDEX</assign>
          <assign to="REBUILD_INDEXES">true</assign>
          <assign to="ANALYZE">true</assign>
          <assign to="DO_All_TABLE">false</assign>
          <assign to="." from="*"></assign>
        </output>
        <input message="Xin">
          <assign to="." from="*"></assign>
        </input>
      </operation>
      <sequence name="UnLock">
        <operation name="UnLock">
          <participant name="SystemLockService"/>
          <output message="Xout">
            <assign to="ACTION">unlock</assign>
            <assign to="LOCK_KEY">DBMonitorService_Lock</assign>
            <assign to="." from="*"></assign>
          </output>
          <input message="Xin">
            <assign to="." from="*"></assign>
          </input>
        </operation>
        <onFault>
          <assign to="UnLock_Msg" append="true">Failed to obtain a unlock!</assign>
        </onFault>
      </sequence>
      <onFault>
        <operation>
          <participant name="SystemLockService"/>
          <output message="Xout">
            <assign to="ACTION">unlock</assign>
            <assign to="LOCK_KEY">DBMonitorService_Lock</assign>
            <assign to="." from="*"></assign>
          </output>
          <input message="Xin">
            <assign to="." from="*"></assign>
          </input>
        </operation>
      </onFault>
    </sequence>
    <onFault>
      <assign to="Lock_Msg" append="true">Failed to obtain a lock!</assign>
    </onFault>
  </sequence> 
</process>

Parameters Passed From Service to Business Process

The following table contains the parameters passed from the DB Monitor service to the business process: