SystemMngmtSession

No description is available

Available Methods

• CheckVersion : Check Whether a Particular Version of an Interface is Supported [ BAPI_XMI_CHECK_VERSION ]
  
• DescribeInterface : Query Long Name of an Interface [ BAPI_XMI_DESCRIBE_INTERFACE ]
  
• EnterLogmsg : Enter External Message in XMI Log [ BAPI_XMI_ENTER_LOGMSG ]
  
• GetVersions : Query Supported Versions of XMI Interfaces [ BAPI_XMI_GET_VERSIONS ]
  
• Logoff : Log off an external management tool [ BAPI_XMI_LOGOFF ]
  
• Logon : Log onto an external management tool [ BAPI_XMI_LOGON ]
  
• SelectLog : Selection of Translated Entries in XMI Log [ BAPI_XMI_SELECT_LOG ]
  
• SetAuditlevel : Set Audit Level of an XMI Session [ BAPI_XMI_SET_AUDITLEVEL ]
  
• UploadMsgFormats : Transfer of External Message Formats [ BAPI_XMI_UPLOAD_MSG_FORMATS ]
  

CheckVersion

Use this method to check whether a specific version of a CCMS systemadministration interface is supported by the R/3 System. You can confirm, for example, that the version of an interface that issupported in an agent program, is also supported by the R/3 System.

Further Information

XMI documentation (SAPnet/CCMS)

DescribeInterface

Use this method to query the full name of a CCMS system administration interface.

Further Information

XMI documentation (SAPnet/CCMS)

EnterLogmsg

Use this method to enter a message in the XMI session log. The logcontains all sessions that are controlled with the XMI interface interface or with the CCMS system administration interfaces.

The log has the following characteristics:

Further Information

XMI documentation (SAPnet/CCMS)

GetVersions

Use this method to determine the versions of a CCMS system administration interface that is supported by the R/3 System.

The method delivers a table with the versions that are supported by the R/3 System.

Further Information

XMI documentation (SAPnet/CCMS).

Logoff

Use this method to close a session with a CCMS system administration interface, or to log off the XMI interface completely.

You must then close the RFC connection with the C RFC call rfcClose if you want to log off the R/3 System completely.

Further Information

XMI documentation (SAPnet/CCMS)

Logon

Using this method you can log onto one of the SAP CCMS systemadministration interfaces. This logon is a prerequisite for using the CCMS interface functions.

Logging onto the interface ensures that all accesses to the systemadministration functions are logged. Using the CCMS XMI session
interface, you can also upload language-specific messages from external products.

You can also log onto the XMI interface without having to open a session with other CCMS system administration interfaces.

Background information: XMI Sessions

External system administration tools can process their tasks using oneor more CCMS interfaces. For this reason, the external tool sets up anRFC connection with the R/3 System. Within this RFC connection, thetool must connect separately to each individual interface with which it is to work.

The RFC connection is responsible for authenticating and authorizingthe R/3 System, since a "normal" R/3 logon process runs here. For theduration of the RFC connection, the external tool is therefore loggedonto the R/3 System as a user. During this time, the external program
can connect with one or several interfaces, or break the connection.These system management API connections can be arranged in any sequenceand may also overlap. This means that for the duration of an RFC connection there are several SMAPI connections.

The XMI controls these SMAPI connections and their lifespan. The tool
authenticates itself with each interface again and receives an identification code in return. These session IDs are always the samefor the duration of an RFC connection.

So that external tools do not have to know in advance which interfacesare implemented in a concrete R/3 version in which API version, the XMI
contains functions that inform you of the R/3 version. The XMI istherefore the central contact for querying the current version and the available interfaces.

There is the special case that an XMI session is not opened for an APIbut is used exclusively to execute XMI functions. You can use this not only to query the version of an API but also to load the
language-specific messages.

During a session, each interface contains global variables thatcharacterize the status of the SMAPI connection between a tool and aninterface. If several external tools log onto a CCMS interface, thenstatus information is created for each interface "incarnation" (even for different RFC connections).

Notes

Before you call this function module for the first time, the externalmanagement system must first log onto the R/3 System with an R/3 user name and password (C function RfcOpen).

Further Information

XMI documentation (SAPnet/CCMS)

SelectLog

Use this method to read the XMI session log. You can then format the entries read for display in an external product.

The log contains messages that may originate from the XMI interface,other CCMS system administration interfaces or from an external
product. The log summarizes the activities of all sessions with CCMS system administration interfaces.

Further Information

XMI documentation (SAPnet/CCMS)

SetAuditlevel

Use this method to determine the global audit level for the XMISESSIONlog. The audit level controls which messages are logged with sessions with the CCMS system administration interfaces.

Background information: The audit level and the XMISESSION log

The XMISESSION log contains messages that are transitted by externalproducts, and messages that occur in the CCMS interface functions. Although the XMI log receives a statement for actions that weretriggered externally, developers can also use it to restrict errors when programming external tools.

The routine that stores messages has a parameter that is identified asthe audit level. This audit level determines whether this is a messagethat needs to be logged (audit level=0) or if it is a message that delivers additional information (higher level of detail).

This works as follows: XMISESSION contains a global XMI audit level(default=0). This can be set explicity by an external product usingthis method and has the effect of a filter for transmitted messages.

If an external product logs onto several CCMS interfaces during one RFC
session, then the XMISESSION audit level is the last value that was set.

If the system now generates a message with the target XMISESSION log,the system compares the XMISESSION audit level with the audit level ofmessage function. If the value with the called method is less than or
equal to the global XMI audit level, then the system makes an entry inthe log. For example, if messages are transmitted with audit level 3 -however the XMISESSION audit level is only 2 - then these messages are not stored in the XMI log.

If the global XMI audit level is not set explicitly by the external
tools, it is set at 0 (minimal). This means that only the most important statements are logged.

When you open a new RFC session, the audit level is again set to 0.

Further Information

XMI documentation (SAPnet/CCMS)

UploadMsgFormats

Use this method to upload language-specific message records into theR/3 System. These language-specific variants are used to output the XMI log in the logon language of the R/3 user.

If an external program writes a message in the XMI session log, the
English standard version of the message is included in the log. If thelog is assessed (using Transaction RZ15 or a read operation by the external program), the R/3 System tries to replace the standardmessages with language-specific variants. If the user has logged onto
the system in English or if no translation of a message has been uploaded, the system outputs the English standard text.

Since the system always displays a text, messages only need to beuploaded if the external program is to support displaying messages in other languages than English.

Further Information

XMI documentation (SAPnet/CCMS)