Skip to end of metadata
Go to start of metadata

Purpose

The Safeguards application monitors aspects of the SAP Manufacturing Execution application, its databases, and SAP NetWeaver ensuring they are running in the recommended configuration and operation limits to maintain the best performance and stability of SAP Manufacturing Execution. The Safeguard application is available in SAPME 15.1.2.0 and later. As of this writing this functionality has not been backported to previous releases.

Overview

The Safeguards application is a Java EE application running in NetWeaver. It runs Safeguards at periodic intervals - typically once a day - and reports the result to a single dashboard page. Each Safeguard checks a single aspect of SAP ME, its WIP or ODS database, or configuration within NetWeaver.

Installation

The Safeguard functionality is included with the SAPME application. When the SAPME Core application is deployed the Safeguard functionality is also deployed. The Database Tables and Initial Data used by the Safeguard functionality are created through the normal SAPMECTC Configuration Wizard processes. For complete information on deploying and running SAPME and SAPMECTC refer to the SAPME Component Installation or SAPME Component Upgrade Guides.

  • If this is a new installation of SAPME the Safeguard Database Tables and Initial Data are created by the “SAP ME Database Setup for Installation” CTC Task.
  • If this is an upgrade of an existing SAPME system the Safeguard Database Tables and Initial Data are created by the “Configuration task for SAP ME Upgrade” CTC Task.

Using Safeguards

Accessing Safeguards

The Safeguards functionality can be accessed through the Safeguards Link on the "SAP Manufacturing Execution Administration Utilities" page. This page can be accessed at http://<server>:<port>/manufacturing-admin. Where the <server> and <port> values are replaced with the appropriate values for your installation. To access this page the user must have the SAP_ME_ADMINISTRATOR role.

List of Safeguards

The main Safeguards List Page is a list of all of the available safeguards. The Safeguard List Page is sorted alphabetically by the Safeguard Name. From here you can view, edit, delete, and test run safeguards.

Below is an explanation of the safeguards delivered with the application:

SafeguardDescriptionDefault Values
Check Item Table SizeThis safeguard monitors the ITEM table growth. If the ITEM table grows very large, performance of some ME activities begins to decline. This safeguard status becomes a WARNING if the ITEM table has more than 100,000 records and becomes SEVERE if the table contains more than 10,000,000 records.
  • Enabled = True
  • Period = 86400000 ms (or 1 day)
  • Table Name = ITEM
  • Datasource Alias = jdbc/jts/wipPool
  • Warning Threshold = 100000
  • Error Threshold = 10000000
Check ME ODS ConfigurationThis safeguard checks if the ODS database is running.
  • Enabled = True
  • Period = 86400000 ms (or 1 day)
Check ME Oracle / SqlServer ConfigurationThese two safeguards will verify the ME WIP database is configured as described in the SAP ME Installation Guide. This safeguard runs the same report as the "DB Diagnostics Report" activity and sets its status based on whether any parameter is not set correctly or if database statistics are stale. Note that if both safeguards are enabled, one will always report a status of "MALFUNCTION" because that particular database is not present. You should disable the safeguard that does not match your WIP database vendor.
  • Enabled = True
  • Period = 86400000 ms (or 1 day)
  • Stored Procedure Name (Oracle) = me_system_check.check_system
  • Stored Procedure Name (SQL Server) = me_system_check
  • Datasource Alias = jdbc/jts/wipPool
  • Maximum Age of Statistics in Days = 3
ME IDAT Load CheckThis safeguard ensures all SAP ME sites have reloaded their initial data (IDATs) after running the NetWeaver CTC wizard to upgrade the ME Database. There is a second CTC wizard called "ME Configuration after Upgrade" that performs the site IDAT loads.
  • Enabled = True
  • Period = 86400000 ms (or 1 day)
  • Datasource Alias = jdbc/jts/wipPool
ME Logging Configuration

This safeguard ensures the ME logging configuration both within ME and NetWeaver are set to the recommended production settings. Enabling too much logging can slow the performance of SAP ME.

The Log Location "com.sap.me.safeguards" (and its children) are excluded from this check, because the java.util Logger action uses this location to log safeguard warnings and errors.
  • Enabled = True
  • Datasource Alias = jdbc/jts/wipPool
  • Period = 86400000 ms (or 1 day)
  • Log Location = com.sap.me
  • Minimum Location Severity = ERROR

Safeguards Settings May Be Customer-Specific

SAP Manufacturing Execution is used by many different types of manufacturing from highly-complex, low-volume manufacturing to high-speed, high-volume manufacturing. Safeguards are initially configured based on reports that have been collected from our customers. However, some settings may need to be modified to suit different types of manufacturing.

Viewing Safeguard Status

The last executed status of the safeguards can be viewed two ways. In the Safeguard List, hovering your mouse over the safeguard status will display a tooltip showing an explanation of the status:

The second way is to display the Safeguard Status page by clicking the "Safeguard Statuses" link at the top of the Safeguard List page: The Safeguard Status Page is sorted by the Status with the highest error conditions listed first.

Creating a New Safeguard

On the Safeguard List page, a new safeguard can be created by clicking the "New Safeguard" link at the top of the page. The New Safeguard form appears:

Since the properties of the safeguard depend on the Rule ID chosen, the properties do not appear until you've clicked the "Create" button. After clicking "Create", you'll see the Edit Safeguard form where you can change the safeguard properties and add actions to the safeguard.

Rule IDDescription
com.sap.me.safeguards.rules.db.CheckTableSizeRule

This rule is used to check the size of SAPME tables. It can be used against WIP or ODS to issue a warning or error for any table that exceeds the indicated threshold.

Sample property values are as follows

  • Table Name = The name of the table to monitor (i.e. ITEM, SFC_STEP, ACTIVITY_LOG, etc.)
  • Datasource Alias = The NWA datasource name (i.e. jdbc/jts/wipPool for the WIP database, jdbc/jts/odsPool for the ODS database)
  • Warning Threshold = The number of database rows needed before a Warning is triggered. (i.e. 100000)
  • Error Threshold = The number of database rows needed before an Erroris triggered. (i.e. 1000000)
com.sap.me.safeguards.rules.me.config.CheckODSConfigurationRuleThis rule is used to check if SAP ME ODS database has been configured and is accessible. There are no properties for this safeguard..
com.sap.me.safeguards.rules.me.config.CheckWIPOracleConfigurationRule

This rule is used to check if the SAP ME Oracle database meets the recommended configuration.

Sample property values are as follows

  • Stored Procedure Name = The name of the Oracle Stored Procedure to execute(i.e. me_system_check.check_system)
  • Datasource Alias =The NWA datasource name (i.e. jdbc/jts/wipPool for the WIP database)
  • Maximum Age of Statistics in Days = The number of days since statistics were last gathered (i.e. 3)
com.sap.me.safeguards.rules.me.config.CheckWIPSqlServerConfigurationRule

This rule is used to check if the SAP ME Oracle database meets the recommended configuration.

Sample property values are as follows

  • Stored Procedure Name = The name of the SQL Server Stored Procedure to execute(i.e. me_system_check)
  • Datasource Alias =The NWA datasource name (i.e. jdbc/jts/wipPool for the WIP database)
  • Maximum Age of Statistics in Days = The number of days since statistics were last gathered (i.e. 3)
com.sap.me.safeguards.rules.me.config.IDATLoadCheckRule

This rule is used to check that all sites have reloaded their IDATs since the last SAPME database upgrade/migration.

Sample property values are as follows

  • Datasource Alias =The NWA datasource name (i.e. jdbc/jts/wipPool for the WIP database)
com.sap.me.safeguards.rules.me.config.LoggingConfigurationRule

This rule is used to check that the Netweaver logging levels are set to production levels.

Sample property values are as follows

  • Datasource Alias =The NWA datasource name (i.e. jdbc/jts/wipPool for the WIP database)
  • Log Location = The Netweaver Log location to check (i.e. com.sap.me)
  • Minimum Location Severity = the minimum level that logging should be set to (i.e. ERROR). Valid values are ALL, ERROR, DEBUG, INFO, WARNING, PATH, FATAL, and NONE.
custom rulesThere is currently no support for adding custom rules.

Editing a Safeguard

All safeguard fields, except the safeguard's Rule ID, can be changed in the Safeguard Edit form:

Actions can be added by selecting an action next to the "Add Action" label, then pressing the "Add" link. Actions can be removed by clicking the "Remove" link next to an existing Action. Click "Save" to save the safeguard modifications.

Safeguard Test Run

A safeguard can be run immediately to test the safeguard parameters by clicking the "Test Run" link on the Safeguard List page. Running a safeguard in this manner does not save the result so it will not appear in the Safeguard Status page or affect the Last Run value on the Safeguard List Page. In addition a "Test Run" of a safeguard will not execute any the assigned actions.

Deleting a Safeguard

Not all safeguards can be deleted. Those shipped as part of the safeguards application are, generally, not deletable. Safeguards you create can be deleted. If a safeguard can be deleted, there will be a "Delete" link on the right side of the safeguard in the Safeguard List page:

Clicking the "Delete" link will take you to a confirmation page:

Clicking "Delete" on the Delete Safeguard confirmation page will permenantly delete that safeguard.

Safeguard Actions

When a safeguard runs, it generates a status and then executes each of its assigned actions with that status. The list of available actions can be shown by clicking the "Action List" button on the Safeguard List page.

Below is an explanation of the actions delivered with the safeguards application:

ActionDescriptionAdditional Information
java.util LoggerThis action writes the status to a log file using the java.util.Logger API.
  • This is a developer level logging that can be used for any java level application server.
  • These log entries can be accessed in the NetWeaver Administrator (NWA). Set the view to Developer Traces and filter the Category field on com.sap.me.safeguards.actions.LogAction.
NetWeaver LoggerThis action writes the status to the NetWeaver Category logger, /Applications/Safeguards.
  • These log entries can be accessed in the NetWeaver Administrator (NWA). Set the view to SAP Logs and filter the Category field on /Applications/Safeguards.
Send EmailThis action generates an email from the safeguard status and sends it to the configured email server to be delivered. It has several properties which must be configured to operate properly.

Send Email Action Properties

  • SMTP Host = The name of the SMTP Server mail host
  • Charset = The character set used for the email. (Default is UTF-8)
  • Minimum Severity = The minimum severity level at which an email is sent. (Default is WARNING)
  • SMTP Port = The port of the SMTP Server mail host.
  • Recipient List = A comma separated list of the email recipients.
  • Reply-To Email = The reply to email address.

Creating a New Action

A new action can be created by pressing the "New Action" button on the Action List page. The New Action form appears:

Enter the action name, a description, and choose the action class. Clicking the "Create" button will create the new action and take you to the Edit Action form where you can assign values to the action's properties, if it has any.

Action ClassDescription
com.sap.me.safeguards.actions.LogAction
  • This action class is used to write the safeguard status to a log file using the java.util.Logger API.
  • The default Action java.util Logger uses this action class.
com.sap.me.safeguards.actions.NetWeaverCategoryLogAction
  • This action class is used to write the safeguard status to the NetWeaver Category logger, /Applications/Safeguards.
  • The default Action NetWeaver Logger uses this action class.
com.sap.me.safeguards.actions.EmailAction
  • This action class is used to send an email when the safeguard matches the appropriate criteria..
  • The default Action Send Email uses this action class.

Editing an Action

Actions can be edited by pressing the "Edit" button on the Action List page. This takes you to the Edit Action form:

Some actions have no properties to change. If an action does have editable properties, hovering over the property name will provide a description of the property in a tooltip. Click "Save" to save the changes. These changes will be effective the next time the action executes. Once an Action Class has been selected it cannot be changed. If you want to change the Action Class of an Action you will need to create a new Action.

Deleting an Action

An action is deleted by pressing the "Delete" button on the right side of the action shown in the Action List page. The Delete Action confirmation form is displayed:

Clicking the "Delete" button permanently deletes the action.

Actions that are in use by a safeguard cannot be deleted. If you try to delete a used action an error will occur indicating it is in use. The error message will show the total number of safeguard using the action and will list up to the first 3 safeguards that are using the action.

Related Content

Related Documents

.

Related SAP Notes/KBAs

.

  • No labels