Using the AquaLogic Service Bus Console

     Previous  Next    Open TOC in new window    View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

Configuration

You use the Configuration module to locate and manage proxy services, business services, alert destinations, SLA alert rules, and the run-time tracing for proxy services.

You can specify operational settings for all services, at the service and global level, and use the global settings to turn on and off monitoring, SLA alerting, and, for proxy services only, pipeline message reporting and pipeline message logging.

Finding and Updating Operational Settings

Use the Smart Search page to easily locate proxy services, business services, alert destinations, and SLA alert rules. Additionally, you can use the Smart Search page to specify service-specific operational settings, with the following exceptions: you cannot set an aggregation interval or specify an alerting or logging severity level. For more information, see Configuring Operational Settings for Proxy Services and Configuring Operational Settings for Business Services.

The run-time effects of the service-level settings depend on their corresponding global settings. You must enable both the global and the service-level settings for a service to be completely enabled at run time. Additionally, the service State must also be enabled. See Enabling Global Settings.

You can enable or disable operational settings only from within a session.

Finding All Services (Proxy and Business Services)

  1. Select Operations > Smart Search.
  2. From the Type drop-down list, select All Services, then click Search. The Summary of All Services page displays the information shown in Table 24-1.
  3. To restrict the number of items in the list or locate specific services:
    • Click the Open icon to display additional search filters. If you specify multiple search criteria, only results that match all the criteria will be returned.
    • Filter by service name. In the Name field, enter the name of the search target or enter wildcard characters (use * and ? as wildcard characters to perform a more general search), then click Search.
    • This search method is preferable if the name of the service is unique across all projects and paths.

    • Filter by service path. In the Path field, enter the path of the search target, which is the project name and the name of the folder in which services reside. You can use * and ? as wildcard characters to perform a more general search. All the services that reside in that path are displayed.
    • The format for the Path field is as follows:
      project-name/root-folder/ . . ./parent-folder

      If a service is directly under the project, the format is as follows: project-name

    • Filter by service name and path. This search method is preferable if there is more than one service with the same name that reside in different paths.
    • Filter by service state. From the State drop-down list, select the state of the service: Enabled or Disabled, then click Search. Select All to ignore the service state filter criteria.
    • Filter by service monitoring. From the Monitoring drop-down list, select the monitoring status of the service: Enabled or Disabled, then click Search. Select All to ignore the service monitoring filter criteria.
    • Filter by service’s SLA alerting setting. From the SLA Alerting drop-down list, select the SLA alerting setting of the service: Enabled or Disabled, then click Search. Select All to ignore the service SLA alerting filter criteria.
    • Table 24-1 Services Summary Information 
      Property
      Description
      Name
      The name assigned to the service. The name is a link to the Operational Settings page. See Configuring Operational Settings for Proxy Services or Configuring Operational Settings for Business Services.
      Path
      The project associated with the service. If the service resides in a project folder, this folder is also listed. The path is displayed in the format:
      project-name/root-folder/ . . ./parent-folder
      The path is a link to the corresponding path in the Project Explorer.
      Type
      The parent service type: proxy service or business service.
      State
      The state of the service: Enabled or Disabled.
      Monitoring
      The monitoring status of the service: Enabled or Disabled.
      SLA Alerting
      The SLA alerting status: Enabled or Disabled, and the level enabled at and above: Normal (N), Warning (W), Minor (Mn), Major (Mj), Critical (C), or Fatal (F).
      Pipeline Alerting
      For proxy services only:
      The pipeline alerting status: Enabled or Disabled, and the level enabled at and above: Normal (N), Warning (W), Minor (Mn), Major (Mj), Critical (C), or Fatal (F).
      Reporting
      For proxy services only:
      The message reporting status of the service: Enabled or Disabled.
      Logging
      For proxy services only:
      The logging status: Enabled or Disabled, and the level enabled at and above: Debug (D), Info (I), Warning (W), or Error (E).
      Tracing
      For proxy services only:
      The run-time tracing status of the proxy service: Enabled or Disabled.
      Actions
      For proxy services: The Edit Message Flow icon is a link to the pipeline for that proxy service.

You can use this page also to do the following:

Finding Proxy Services

  1. Select Operations > Smart Search.
  2. From the Type drop-down list, select Proxy Services, then click Search. The Summary of Proxy Services page displays the information shown in Table 24-2.
  3. To restrict the number of items in the list or locate specific proxy services:
    • Click the Open icon to display additional search filters. If you specify multiple search criteria, only results that match all the criteria will be returned.
    • Filter by proxy service name and path. In the Name and Path fields, enter the name and path of the search target, then click Search. The path is the project name and the name of the folder in which the proxy service resides. You can use * and ? as wildcard characters to perform a more general search.
    • Filter by service state. From the State drop-down list, select the proxy service state: Enabled or Disabled, then click Search. Select All to ignore the service state filter criteria.
    • Filter by service monitoring. From the Monitoring drop-down list, select the monitoring status of the proxy service: Enabled or Disabled, then click Search. Select All to ignore the service monitoring filter criteria.
    • Filter by service’s SLA alerting setting. From the SLA Alerting drop-down list, select the SLA alerting setting of the proxy service: Enabled or Disabled, then click Search. Select All to ignore the service SLA alerting filter criteria.
    • Filter by service’s pipeline alerting setting. From the Pipeline Alerting drop-down list, select the pipeline alerting setting of the proxy service: Enabled or Disabled, then click Search. Select All to ignore the service pipeline alerting filter criteria.
    • Filter by services with message reporting. From the Message Reporting drop-down list, select the message reporting status of the proxy service: Enabled or Disabled, then click Search. Select All to ignore the service message reporting filter criteria.
    • Filter by services with logging. From the Logging drop-down list, select the logging status of the proxy service: Enabled or Disabled, then click Search. Select All to ignore the service logging filter criteria.
    • Filter by services with run-time tracing. From the Tracing drop-down list, select the run-time tracing status of the proxy service: Enabled or Disabled, then click Search. Select All to ignore the service tracing filter criteria.
    • Table 24-2 Proxy Services Summary Information 
      Property
      Description
      Name
      The name assigned to the proxy service. The name is a link to the Operational Settings page. See Configuring Operational Settings for Proxy Services.
      Path
      The project associated with the proxy service. If the service resides in a project folder, this folder is also listed. The path is displayed in the format:
      project-name/root-folder/ . . ./parent-folder
      The path is a link to the corresponding path in the Project Explorer.
      Type
      The parent service type: proxy service.
      State
      The state of the proxy service: Enabled or Disabled.
      Monitoring
      The monitoring status of the proxy service: Enabled or Disabled.
      SLA Alerting
      The SLA alerting status: Enabled or Disabled, and the level enabled at and above: Normal (N), Warning (W), Minor (Mn), Major (Mj), Critical (C), or Fatal (F).
      Pipeline Alerting
      The pipeline alerting status: Enabled or Disabled, and the level enabled at and above: Normal (N), Warning (W), Minor (Mn), Major (Mj), Critical (C), or Fatal (F).
      Reporting
      The message reporting status of the service: Enabled or Disabled.
      Logging
      The logging status: Enabled or Disabled, and the level enabled at and above: Debug (D), Info (I), Warning (W), or Error (E).
      Tracing
      The run-time tracing status of the proxy service: Enabled or Disabled.
      Actions
      The Edit Message Flow icon is a link to the pipeline for that proxy service.

You can use this page also to do the following:

Finding Business Services

  1. Select Operations > Smart Search.
  2. From the Type drop-down list, select Business Services, then click Search. The Summary of Business Services page displays the information shown in Table 24-3.
  3. To restrict the number of items in the list or locate specific business services:
    • Click the Open icon to display additional search filters. If you specify multiple search criteria, only results that match all the criteria will be returned.
    • Filter by business service name and path. In the Name and Path fields, enter the name and path of the search target, then click Search. The path is the project name and the name of the folder in which the business service resides. You can use * and ? as wildcard characters to perform a more general search.
    • Filter by service state. From the State drop-down list, select the business service state: Enabled or Disabled, then click Search. Select All to ignore the service state filter criteria.
    • Filter by service monitoring. From the Monitoring drop-down list, select the monitoring status of the business service: Enabled or Disabled, then click Search. Select All to ignore the service monitoring filter criteria.
    • Filter by business service’s SLA alerting setting. From the SLA Alerting drop-down list, select the SLA alerting setting of the business service: Enabled or Disabled, then click Search. Select All to ignore the service SLA alerting filter criteria.
    • Table 24-3 Business Services Summary Information 
      Property
      Description
      Name
      The name assigned to the business service. The name is a link to the Operational Settings page. See Configuring Operational Settings for Business Services.
      Path
      The project associated with the business service. If the service resides in a project folder, this folder is also listed. The path is displayed in the format:
      project-name/root-folder/ . . ./parent-folder
      The path is a link to the corresponding path in the Project Explorer.
      Type
      The parent service type: business service.
      State
      The state of the business service: Enabled or Disabled.
      Monitoring
      The monitoring status of the business service: Enabled or Disabled.
      SLA Alerting
      The SLA alerting status: Enabled or Disabled, and the level enabled at and above: Normal (N), Warning (W), Minor (Mn), Major (Mj), Critical (C), or Fatal (F).

You can use this page also to do the following:

Finding Alert Destinations

  1. Select Operations > Smart Search.
  2. From the Type drop-down list, select Alert Destinations, then click Search. The Summary of Alert Destinations page displays the information shown in Table 24-4.
  3. To restrict the number of items in the list or locate specific alert destinations:
    • Click the Open icon to display additional search filters. If you specify multiple search criteria, only results that match all the criteria will be returned.
    • Filter by alert destination name and path. In the Name and Path fields, enter the name and path of the search target, then click Search. The path is the project name and the name of the folder in which the alert destination resides. You can use * and ? as wildcard characters to perform a more general search.
    • Filter by alert destination target. In the Target multi-select box, select one or more alert destination targets: SNMP Trap, Reporting, e-mail, or JMS, then click Search. Only alert destinations with at least one of the selected targets will be displayed. Select no alert destination targets to ignore the alert destination filter criteria.
    • Filter by search pattern. In the Search Pattern (Any String) text box, specify any string, then click Search. The system uses the string to search all the Description fields of the alert destinations, as well as the specific detailed fields of the e-mail and JMS destinations. If the string appears in any of the alert destination fields, the alert destinations matching the search criteria are displayed.
    • Table 24-4 Alert Destinations Summary Information 
      Property
      Description
      Name
      The name of the alert destination resource. This field is a link to the View Alert Destination - Configuration page. See Locating Alert Destinations.
      Path
      The project associated with the alert destination. If the alert destination resides in a project folder, this folder is also listed. The path is displayed in the format:
      project-name/root-folder/ . . ./parent-folder
      The path is a link to the corresponding path in the Project Explorer.
      Options
      Click the Delete icon to delete a specific alert destination. A Deletion Warning icon is displayed when other resources reference this resource. You can delete the resource with a warning confirmation. This might result in conflicts due to unresolved references to the deleted resource. See Deleting Alert Destinations.

You can use this page also to do the following:

Finding SLA Alert Rules

  1. Select Operations > Smart Search.
  2. From the Type drop-down list, select SLA Alerts, then click Search. The Summary of SLA Alert Rules page displays the information shown in Table 24-5.
  3. To restrict the number of items in the list or locate specific SLA alert rules:
    • Click the Open icon to display additional search filters. If you specify multiple search criteria, only results that match all the criteria will be returned.
    • Filter by alert rule name. In the Name field, enter the name of the search target or enter wildcard characters (use * and ? as wildcard characters to perform a more general search), then click Search.
    • This search method is preferable if the name of the alert rule is unique across all projects and paths.

    • Filter by parent service path. In the Path field, enter the path of the parent service, which is the project name and the name of the folder in which parent service resides. You can use * and ? as wildcard characters to perform a more general search. All alert rules whose parent services reside in that path are displayed.
    • The format for the Path field is as follows:
      project-name/root-folder/ . . ./parent-folder

      If a service is directly under the project, the format is as follows: project-name

    • Filter by parent service. In the Parent Service field, click Browse to display the Select Service page. Select the parent service from the list and click Submit. Click Clear to remove the parent service filter criteria, or click Search.
    • Note: Your selection in the Parent Service field restricts your choices in the Service Type field.
    • Filter by parent service type. From the Service Type drop-down list, select Proxy Services or Business Services, then click Search. Select All Services to ignore filtering by parent service type criteria.
    • Note: Your selection in the Service Type field restricts your choices in the Parent Service field.
    • Filter by rule state. From the Rule State drop-down list, select the state of the alert rule: Enabled or Disabled, then click Search. Select All to ignore the rule state filter criteria.
    • Filter by severity. From the Severity drop-down list, select to restrict SLA alerts rules to the specified level, then click Search.
    • Select the or above check box to restrict your search to the specified severity level or above (listed from the most inclusive to the most restrictive level): Normal, Warning, Minor, Critical, and Fatal.

      Table 24-5 SLA Alert Rules Summary Information 
      Property
      Description
      Name
      The name assigned to this alert rule. The name is a link to the Alert Rule Configuration page. See Viewing Alert Rule Configurations.
      SLA State
      The status of the alert rule: Enabled or Disabled.
      Description

      Note: This field is hidden by default.

      A description of the alert rule.
      Service Name
      The name of the parent service. The name is a link to the SLA Alert Rules page. See Viewing Alert Rules.
      Path
      The project associated with the parent service of the alert rule. If the parent service of the alert rule resides in a project folder, this folder is also listed. The path is displayed in the format:
      project-name/root-folder/ . . ./parent-folder
      The path is a link to the corresponding path in the Project Explorer.
      Severity
      The severity of the alert that is triggered by this rule: Normal, Warning, Minor, Major, Critical, or Fatal.
      Aggr. Interval
      The length of the aggregation interval in terms of hours and minutes.
      Expiration Date
      The date when this alert rule is no longer in effect.
      Stop Processing

      Note: This field is hidden by default.

      Displays Yes or No.
      Frequency
      The frequency of this alert:
      • Every Time
      • Notify Once

You can use this page also to do the following:

Enabling Global Settings

You can enable or disable all global settings only from within a session. Table 24-6 lists global settings tasks and help topics.

Table 24-6 Global Settings Tasks and Help Topics 
To...
See...
Turn monitoring for all services on and off at the domain level
Turn SLA alerting for all services on and off at the domain level
For proxy services only: Turn pipeline alerts for all proxy services on and off at the domain level
For proxy services only: Turn message reporting for all proxy services on and off at the domain level
For proxy services only: Turn logging output for all proxy services on and off at the domain level

Enabling Global Monitoring of Services

  1. If you have not already done so, click Create to create a new session or click Edit to enter an existing session. See Using the Change Center.
  2. Select Operations > Global Settings.
  3. Select the Enable Monitoring check box for the system to start collecting monitoring statistics for all services whose monitoring is enabled at the service level.
  4. Click Update to save all of the settings on this page.
  5. Alternatively, click Reset at any time during the session to discard your changes and refresh the page with the currently stored settings.
  6. To end the session and deploy the configuration to the run time, click Activate under Change Center.

Disabling Global Monitoring of Services

Note: If you disable monitoring for all services, all statistics collected so far for those services are deleted as well. These statistics cannot be restored using the session Undo function. You can use Undo to enable monitoring again for the services, but the deletion of the statistics is irreversible.
  1. If you have not already done so, click Create to create a new session or click Edit to enter an existing session. See Using the Change Center.
  2. Select Operations > Global Settings.
  3. Clear the Enable Monitoring check box for the system to stop collecting monitoring statistics for all services in your configuration.
  4. Note: This option overrides the Enable Service Monitoring option that you can select for specific business and proxy services. See Configuring Operational Settings for Business Services and Configuring Operational Settings for Proxy Services.
    Note: This option also overrides the Enable SLA Alerting option. If you disable monitoring at the global level, SLA alerting will also be disabled at run time as well, even though the corresponding Enable SLA Alerting check box may be selected. See Enabling SLA Alerts Globally.
  5. Click Update. The monitoring configuration is saved in the current session.
  6. Alternatively, click Reset at any time during the session to discard your changes and refresh the page with the currently stored settings.
  7. To end the session and deploy the configuration to the run time, click Activate under Change Center.

Enabling SLA Alerts Globally

Although you can configure SLA Alerting independently from Monitoring, there is an interaction between the two settings at run time. If global monitoring is enabled, SLA alerting can be enabled or disabled. However, if global monitoring is disabled then SLA alerting will be effectively disabled because SLA alert rule conditions depend on monitoring statistics being evaluated.

  1. If you have not already done so, click Create to create a new session or click Edit to enter an existing session. See Using the Change Center.
  2. Select Operations > Global Settings.
  3. Select the Enable SLA Alerting check box for the system to start evaluating alert rules for all services in your configuration.
  4. Click Update to save all of the settings on this page.
  5. Alternatively, click Reset at any time during the session to discard your changes and refresh the page with the currently stored settings.
  6. To end the session and deploy the configuration to the run time, click Activate under Change Center.

Disabling SLA Alerts Globally

  1. If you have not already done so, click Create to create a new session or click Edit to enter an existing session. See Using the Change Center.
  2. Select Operations > Global Settings.
  3. Clear the Enable SLA Alerting check box for the system to stop evaluating alert rules for all services in your configuration.
  4. Note: This option overrides any SLA Alerting settings that you can select for specific business and proxy services. See Configuring Operational Settings for Business Services and Configuring Operational Settings for Proxy Services.
  5. Click Update. The SLA alerting configuration is saved in the current session.
  6. Alternatively, click Reset at any time during the session to discard your changes and refresh the page with the currently stored settings.
  7. To end the session and deploy the configuration to the run time, click Activate under Change Center.

Enabling Pipeline Alerts Globally

  1. If you have not already done so, click Create to create a new session or click Edit to enter an existing session. See Using the Change Center.
  2. Select Operations > Global Settings.
  3. Select the Enable Pipeline Alerting check box for the system to start executing any pipeline alert actions for proxy services.
  4. Pipeline Alerting has no dependency on global Monitoring.

  5. Click Update to save all of the settings on this page.
  6. Alternatively, click Reset at any time during the session to discard your changes and refresh the page with the currently stored settings.
  7. To end the session and deploy the configuration to the run time, click Activate under Change Center.

Disabling Pipeline Alerts Globally

  1. If you have not already done so, click Create to create a new session or click Edit to enter an existing session. See Using the Change Center.
  2. Select Operations > Global Settings.
  3. Clear the Enable Pipeline Alerting check box for the system to stop executing any pipeline alert actions for proxy services.
  4. Note: This option overrides any Pipeline Alerting settings that you can select for specific proxy services. See Configuring Operational Settings for Proxy Services.
  5. Click Update. The pipeline alerting configuration is saved in the current session.
  6. Alternatively, click Reset at any time during the session to discard your changes and refresh the page with the currently stored settings.
  7. To end the session and deploy the configuration to the run time, click Activate under Change Center.

Enabling Message Reporting Globally

This option controls pipeline Report actions on the message context only. It does not effect SLA alerts or pipeline alerts targeted to the reporting framework.

  1. If you have not already done so, click Create to create a new session or click Edit to enter an existing session. See Using the Change Center.
  2. Select Operations > Global Settings.
  3. Select the Enable Reporting check box to start any pipeline Report actions for all proxy services.
  4. Click Update to save all of the settings on this page.
  5. Alternatively, click Reset at any time during the session to discard your changes and refresh the page with the currently stored settings.
  6. To end the session and deploy the configuration to the run time, click Activate under Change Center.

Disabling Message Reporting Globally

  1. If you have not already done so, click Create to create a new session or click Edit to enter an existing session. See Using the Change Center.
  2. Select Operations > Global Settings.
  3. Clear the Enable Reporting check box to stop any pipeline Report actions for all proxy services.
  4. Note: This option overrides any Message Reporting settings that you can select for specific proxy services. See Configuring Operational Settings for Proxy Services.
  5. Click Update. The message reporting configuration is saved in the current session.
  6. Alternatively, click Reset at any time during the session to discard your changes and refresh the page with the currently stored settings.
  7. To end the session and deploy the configuration to the run time, click Activate under Change Center.

Enabling Logging Globally

If you select Enable Logging, pipeline Log action messages are sent to the WebLogic Server logging service. To be able to view them, you must configure WebLogic Server to forward these messages to the domain log.

  1. If you have not already done so, click Create to create a new session or click Edit to enter an existing session. See Using the Change Center.
  2. Select Operations > Global Settings.
  3. Select the Enable Logging check box to start any pipeline Log actions for all proxy services.
  4. Click Update to save all of the settings on this page.
  5. Alternatively, click Reset at any time during the session to discard your changes and refresh the page with the currently stored settings.
  6. To end the session and deploy the configuration to the run time, click Activate under Change Center.

Disabling Logging Globally

  1. If you have not already done so, click Create to create a new session or click Edit to enter an existing session. See Using the Change Center.
  2. Select Operations > Global Settings.
  3. Clear the Enable Logging check box to stop any pipeline Log actions for all proxy services.
  4. Note: This option overrides any Logging settings that you can select for specific proxy services. See Configuring Operational Settings for Proxy Services.
  5. Click Update. The logging configuration is saved in the current session.
  6. Alternatively, click Reset at any time during the session to discard your changes and refresh the page with the currently stored settings.
  7. To end the session and deploy the configuration to the run time, click Activate under Change Center.

Setting User Preferences

Use this page to customize and persist your console display options and settings. You can update (change) your User Preferences without activating a change session.

Table 24-7 describes the options and controls on the page.

Table 24-7 User Preferences - Options and Controls 
To...
Do This...
Change your Home Page, the page that opens when you launch the console
From the first drop-down list, select any main menu choice: Operations, Resource Browser, Project Explorer, Security Configuration, or System Administration.
From the second drop-down list, select any one of the sub-menu choices. (The contents of the sub-menus dynamically change based on your first menu selection.)
Display Search Filters
Select Yes or No.
By default, search filters are not displayed (closed). By selecting Yes, search filters are always displayed (open).
Display Stage Annotations
Select Yes or No.
By default, pipeline stage annotations are not displayed (closed). By selecting Yes, stage annotations are always displayed (open).
Display Resource Metadata
Select Yes or No.
By default, resource metatdata sections are displayed (open). By selecting No, resource metatdata sections are not displayed (closed).
Change how often the console updates the display of data on the Dashboard
From the Dashboard Refresh Rate drop-down list, select No Refresh, 1, 2, 3, 5, 10, 20, 30 or 60 minutes as the refresh rate for the Dashboard.
The default rate is No Refresh, but you can select another predefined time. For example, if you select 5 minutes, the Dashboard is updated with data every 5 minutes.
WARNING: By selecting a dashboard refresh rate interval other than the default (No Refresh), the browser refreshes the Dashboard at regular intervals. This prevents your session from timing out, even without you interacting with the console.
WARNING: BEA Systems recommends that you use the Dashboard refresh rate feature with caution. You should never leave a console session unattended. While your console session is active others can gain access to it from your machine, without re-authentication.
Change the time interval for displaying historical data for alerts on the Dashboard
From the Alert History Duration drop-down list, select 30 minutes, 1, 2, 3, or 6 hours as the time interval for displaying historical alert data. The default is 30 minutes (displays alerts received within the last 30 minutes) but you can select another predefined duration. For example, if you select 1 hour, the Dashboard displays the alerts received within the last hour.


  Back to Top       Previous  Next