Sapass

 Simplify SAP R/3 development with Excel VBA/VB RFC  
Home> Bapi>MonitorTreeElement



Index

MonitorTreeElement

MonitorTreeElement


No description is available


11-Dec-2005


Methods

Available Methods


  • DisableAlertGeneration : Switch Off Alert Generation for a Monitor Tree Element [ BAPI_SYSTEM_MTE_DISABLEALGEN ]
  • EnableAlertGeneration : Switch on Alert Generation for a Monitor Tree Element [ BAPI_SYSTEM_MTE_ENABLEALGEN ]
  • GetAlerts : Read Alerts for a Monitor Tree Element [ BAPI_SYSTEM_MTE_GETALERTS ]
  • GetGeneralProperties : Read General Properties of a Monitor Tree Element [ BAPI_SYSTEM_MTE_GETGENPROP ]
  • GetMessageLogCurrentValue : Read Current Values of a Log Attribute [ BAPI_SYSTEM_MTE_GETMLCURVAL ]
  • GetMessageLogHistory : Read Value History of a Log Attribute [ BAPI_SYSTEM_MTE_GETMLHIS ]
  • GetMessageLogProperties : Read Specific Properties of a Log Attribute [ BAPI_SYSTEM_MTE_GETMLPROP ]
  • GetPerformanceAttrCurrentValue : Read the Current Performance Values [ BAPI_SYSTEM_MTE_GETPERFCURVAL ]
  • GetPerformanceAttrHistory : Read the Performance Data History [ BAPI_SYSTEM_MTE_GETPERFHIS ]
  • GetPerformanceAttrProperties : Read the Properties Specific to Performance Attributes [ BAPI_SYSTEM_MTE_GETPERFPROP ]
  • GetStatusMessageAttrProperties : Read the Properties Specific to a Status Attribute [ BAPI_SYSTEM_MTE_GETSMPROP ]
  • GetStatusMessageAttrValue : Read Current Status Attribute Values [ BAPI_SYSTEM_MTE_GETSMVALUE ]
  • GetTidByName : Read TID for a Uniquely-Named MTE [ BAPI_SYSTEM_MTE_GETTIDBYNAME ]
  • GetTree : Read Subtree Expanded by Monitor Tree Element [ BAPI_SYSTEM_MTE_GETTREE ]
  • Reset : Reset Properties for Monitor Tree Element [ BAPI_SYSTEM_MTE_RESET ]
  • SetGeneralProperties : Set the General Properties of an MTE [ BAPI_SYSTEM_MTE_SETGENPROP ]
  • SetMessageLogProperties : Set the Specific Message Log Properties [ BAPI_SYSTEM_MTE_SETMLPROP ]
  • SetPerformanceAttrProperties : Set the Specific Performance Attribute Properties [ BAPI_SYSTEM_MTE_SETPERFPROP ]
  • SetStatusMessageAttrProperties : Set the Specific Status Attribute Properties [ BAPI_SYSTEM_MTE_SETSMPROP ]
  • SplitData : Splits the Data for a Node into Logical Units [ BAPI_SYSTEM_MTE_SPLITTDATA ]

11-Dec-2005


DisableAlertGeneration

DisableAlertGeneration


This tool can be used to switch off alert generation for the specified monitor tree element.

Use SystemMonitorTreeElement.EnableAlertGeneration to switch alert generation back on.


11-Dec-2005


EnableAlertGeneration

EnableAlertGeneration


This tool can be used to switch on alert generation for a specified monitor tree element.

Use SystemMonitorTreeElement.DisableAlertGeneration to switch alert generation off.


11-Dec-2005


GetAlerts

GetAlerts


This tool reports a table containing the alert IDs (AIDs) belonging to the monitor tree element.

Use the SystemAlert.GetDetails method to display alert properties for an Alert ID.


11-Dec-2005


GetGeneralProperties

GetGeneralProperties


This function reports the general properties of a monitor tree element.These general properties are valid for all monitor tree element types.

Notes

There are special tools for determining properties for a specific monitor tree element. For example,
SystemMonitorTreeElement.GetPerfProperties reports the properties of a performance attribute.


11-Dec-2005


GetMessageLogCurrentValue

GetMessageLogCurrentValue


This tool reports the current message container values, in particular the current external management tool message.

Further Information

XAL documentation


11-Dec-2005


GetMessageLogHistory

GetMessageLogHistory


This tool can be used to determine the value history of a message container within any time interval.

Notes

The "value history" of a message container mainly consists of a sectionof the monitored log file. The "values" of a message container are therefore generally lines from just such a log file.



11-Dec-2005


GetMessageLogProperties

GetMessageLogProperties


This tool is used to determine the specific properties of a log attribute.


11-Dec-2005


GetPerformanceAttrCurrentValue

GetPerformanceAttrCurrentValue


This tool reports the current performance message values.

Notes

Use the SystemMonitorTreeElement.GetPerfHistory tool to determine the value history.


11-Dec-2005


GetPerformanceAttrHistory

GetPerformanceAttrHistory


This tool returns the value history of the specified performance message.

In this context, the value history contains performance messages collected and reported during a specified time interval.

Notes

Use the SystemMonitorTreeElement.GetPerfCurrentValue tool to determine the current performance messages.



11-Dec-2005


GetPerformanceAttrProperties

GetPerformanceAttrProperties


This tool returns the specific properties of a performance message.


11-Dec-2005


GetStatusMessageAttrProperties

GetStatusMessageAttrProperties


This tool reports the specific Customizing properties of a single message.

Further Information

XAL documentation


11-Dec-2005


GetStatusMessageAttrValue

GetStatusMessageAttrValue


This tool returns the current single message value. This includes thetime of the message as well as the triggered and translated external management tool message.

Notes

In contrast to performance messages and message containers, value
histories do not exist for single messages as this would not make any sense in this context.

However, a message container could be used to collect as many single message values as desired.

Further Information

XAL documentation


11-Dec-2005


GetTidByName

GetTidByName


This tool returns the MTE ID (TID) corresponding to a specified monitor tree element "long name".

Notes

A monitor tree element "long name" consists of the system, context,object and attribute names. This four-part name is globally unique.


Any sum or virtual nodes are not contained within the "long name" of a monitor tree element but are indicated by "...".

The "short name" of a monitor tree element is the name of the monitortree element itself. You can determine the short name by using the
SystemMonitorTreeElement.GetGeneralProperties method, for example.


11-Dec-2005


GetTree

GetTree


This tool returns the subtree expanded by the specified monitor tree element.

You can then use the SysteMonitorTreeElement.SplittData method to split the data for a subtree node into logical units.

Notes

The user can also specify the subtree view as well as how deep the nodes of the subtree should go.


Further Information

XAL documentation


11-Dec-2005


Reset

Reset


This tool resets a monitor tree element to its status just after it was created.

This means that all active alerts are lost (the alert history remains however).


11-Dec-2005


SetGeneralProperties

SetGeneralProperties


This method is used to change the general properties of a monitor tree element (MTE).

The properties can be changed:

  • For the MTE class the MTE is assigned to. This means that the propertychanges are valid for all MTEs belonging to the MTE class.

  • For the individual MTE. The changes then overwrite the properties "inherited" from the MTE class.
  • In addition, the variant for which the properties are to be changed canbe specified. Note that the owner of a variant must be identical to thecompany name used in the XMI logon. Variants that are specified explicitly are created using Transaction RZ21.


    If no variant is specified, the changes will be made for the variantthat has the same name as the company name used for the XMI logon. If avariant with this name does not exist, the system creates it automatically.


    11-Dec-2005


    SetMessageLogProperties

    SetMessageLogProperties


    This method is used to change the specific properties of a log attribute.

    The properties can be changed:

  • For the MTE class the log attribute is assigned to. This means that theproperty changes are valid for all log attributes belonging to the MTE class.

  • For the individual log attribute. The changes then overwrite the properties "inherited" from the MTE class.
  • In addition, the variant for which the properties are to be changed canbe specified. Note that the owner of a variant must be identical to the
    company name used in the XMI logon. Variants that are specified explicitly are created using Transaction RZ21.

    If no variant is specified, the changes will be made for the variantthat has the same name as the company name used for the XMI logon. If a
    variant with this name does not exist, the system creates it automatically.


    11-Dec-2005


    SetPerformanceAttrProperties

    SetPerformanceAttrProperties


    This method is used to change the specific properties of a performance attribute.

    The properties can be changed:

  • For the MTE class the performance attribute is assigned to. This meansthat the property changes are valid for all performance attributes belonging to the MTE class.

  • For the individual performance attribute. The changes then overwrite the properties "inherited" from the MTE class.
  • In addition, the variant for which the properties are to be changed canbe specified. Note that the owner of a variant must be identical to the
    company name used in the XMI logon. Variants that are specified explicitly are created using Transaction RZ21.

    If no variant is specified, the changes will be made for the variantthat has the same name as the company name used for the XMI logon. If a
    variant with this name does not exist, the system creates it automatically.


    11-Dec-2005


    SetStatusMessageAttrProperties

    SetStatusMessageAttrProperties


    This method is used to change the specific properties of a status attribute.

    The properties can be changed:

  • For the MTE class the status attribute is assigned to. This means thatthe property changes are valid for all status attributes belonging to the MTE class.

  • For the individual status attribute. The changes then overwrite the properties "inherited" from the MTE class.
  • In addition, the variant for which the properties are to be changed canbe specified. Note that the owner of a variant must be identical to the
    company name used in the XMI logon. Variants that are specified explicitly are created using Transaction RZ21.

    If no variant is specified, the changes will be made for the variantthat has the same name as the company name used for the XMI logon. If a
    variant with this name does not exist, the system creates it automatically.


    11-Dec-2005


    SplitData

    SplitData


    This function is used to split the available data for a monitor tree element into logical units.

    Notes

    This tool is used only to simplify the interface. If the externalmanagement tool has enough information about the individual parameters,
    this function can be implemented on the client-side as well (this wouldimprove performance compared to this tool, as this tool is called on a R/3 System using an RFC).

    Further Information

    XAL documentation


    11-Dec-2005