Readiness Check Version2

Dr. Julia Hambrock Mission Critical Support

Readiness Check A compilation of simple and advanced checks for the Exchange Infrastructure 3.0 22. August 2005

Readiness Check

Content:

1 Introduction.....................................................................................................................3

2 Basic Checks ..................................................................................................................4

2.1 SLDCHECK ..................................................................................................................................................4

2.2 SXI_CACHE..................................................................................................................................................5

2.3 RFC Connections ........................................................................................................................................6

2.4 Testing the connection to the Integration Builder...................................................................................7

2.5 Testing the availability of the JAVA applications....................................................................................8

2.6 Testing the CPA Cache / Cache Connectivity Test .................................................................................9

2.7 Runtime Workbench (RWB) .....................................................................................................................11

2.8 Adapter Monitor Page...............................................................................................................................12

3 Advanced Checks.........................................................................................................13

3.1 SLD Associations......................................................................................................................................13

3.2 Availability of all deployed JAVA services.............................................................................................14

3.3 Testing cache notifications of the Integration Directory ......................................................................15

3.4 Small Scenario ..........................................................................................................................................16

4 Additional tests for existing Scenarios ......................................................................17

4.1 Configuration Test ....................................................................................................................................17

Readiness Check

1 Introduction The following graphic shows the components that make up the SAP Exchange Infrastructure as well as some business systems running applications that are integrated through the exchange. The SAP Exchange Infrastructure consists of the following functional components: Integration Builder, Integration Repository, Integration Directory, Integration Server, Integration Engine, Business Process Engine, Adapter Engine, Runtime Workbench (RWB) and System Landscape Directory (SLD)

Most of these components have to exchange information during runtime of the Exchange Infrastructure. Thus, it is essential that each component can be accessed and that the communication between them is set up correctly. However, major changes of the XI infrastructure, especially when applying patches or when changing hostnames in the context of a High Availability setup, are potentially critical for the correct collaboration of the XI components.

Therefore we recommend to carry out a set of simple checks that test the basic communication paths between the XI components and strive to ensure a smooth runtime after a software patch or HA setup. These checks are divided into 2 groups: the first group is meant to be carried out by everyone and requires little to no knowledge about XI. The second group of checks is addressed to XI experts, e. g. developers or XI system administrators, and require a basic understanding of the Exchange Infrastructure.

Readiness Check

2 Basic Checks

This group of checks can be carried out easily, with a small expenditure of time and does not require extended XI know how.

2.1 SLDCHECK

The SLDCHECK is a useful transaction that tests several things:

• Do the RFC connections SAPSLDAPI and LCRSAPRFC work?

• Are the server access settings in transaction SLDAPICUST correct?

• Is it possible to read data from the SLD and the Exchange Profile?

• Does the Integration Server have a Business System defined?

Procedure

Log into the client of the Integration Server and call transaction SLDCHECK. This will open up a browser window which allows you to log into the SLD and thereby check if the SLD can be accessed by a dialog user. After verifying that you can logon to the SLD, go back to the R/3 window and check for the following successful checks:

� In the section “Properties of RFC destination SAPSLDAPI” there should be the statement “RFC Ping successful”

� In the section “Calling function LCR_LIST_BUSINESS_SYSTEMS” there should be the statement “Function call terminated successfully” and you should be able to see a list of a few business systems

� In the section “Calling function LCR_GET_OWN_BUSINESS_SYSTEM” there should be a statement “Function call terminated successfully” and you should see the business system of the integration server.

� In the section “Calling function LCR_GET_BS_DETAILS” there should be a statement “Function call terminated successfully”. Check if the URL given in this section corresponds to http://<host>:80<sysnr>/sap/xi/engine?type=entry

� In the section “Properties of RFC destination LCRSAPRFC” there should be the statement “RFC Ping successful”

� In the section “Calling function EXCHANGE_PROFILE_GET_PARAMETER” there should be the statement “Function call terminated successfully”.

Troubleshooting

If you should experience errors while carrying out this check, use the online help for the SLD which provides a detailed problem analysis scenario:

http://help.sap.com/saphelp_nw04/helpdata/en/78/20244134a56532e10000000a1550b0/content.htm

Readiness Check

2.2 SXI_CACHE

Transaction sxi_cache lists most of the content of the Integration Directory. This information is used by the Integration Server during runtime and it is thus critical that this information is always up to date. A cache refresh is usually carried out automatically, but for testing purposes it can also be started manually. By carrying out a manual cache refresh several things can be tested, the most important being:

• Connection to the SLD and the Integration Builder

• Correct entries in the SLD

Procedure

Log into the client of the Integration Server and call transaction SXI_CACHE. Start a manual cache refresh via XI Runtime Cache -> Start Complete Cache Refresh (Shift + F6). This will trigger a background job that can be seen in transaction SM58 (its name is SAI_CACHE3_REFRESH_BACKGROUND). Once this is finished check transaction SXI_CACHE for:

� a green light for the XI Runtime Cache status, saying “cache contents are up-to date”

Troubleshooting

If you should observe a red light or a warning, navigate to the reported problems/erors (this is available for support packages �4). In case the exception does not make sense to you, open an OSS ticket for the component BC-XI.

Readiness Check

2.3 RFC Connections

Only two RFC connections are tested during the SLDCHECK, that is SAPSLDAPI and LCRSAPRFC. The remaining RFC connections can be tested via transaction SM59. These connections are used to connect to the Java Runtime.

Procedure

Log into the client of the Integration Server and call transaction SM59. Test the following connections one at a time by double clicking on them and then pressing the button “Test connection”:

� AI_DIRECTORY_JCOSERVER (TCP/IP connection)

� AI_RUNTIME_JCOSERVER (TCP/IP connection)

A successful test of the connections should look like this:

� INTEGRATION_DIRECTORY_HMI (HTTP connection, use the XIISUSER to authenticate). Is the Path Prefix set to “/dir/CacheRefresh” as recommended since SP1 of XI 3.0?

Note that a HTTP 500 response is a successful test for this connection.

Readiness Check

2.4 Testing the connection to the Integration Builder

Transaction SPROXY (a transaction usually used for the creation of proxies) provides 4 checks that can be used even if no proxies have been created in the XI landscape. The following aspects are tested:

• The address of the Integration Builder

• The HTTP connection of the Integration Server

• The Integration Builder is running

• The data of the Integration Builder is understood

Procedure

Log into the client of the Integration Server and call transaction SPROXY. Start the checks by going to GoTo -> Connection Test. This will give you a pop-up in which the tests can be started by clicking on the program names highlighted in red.

� The test SPROX_CHECK_IFR_ADDRESS should give you the status: OK: address maintained.

� The test SPROX_CHECK_HTTP_COMMUNICATION should give you the information that the communication is working.

� The test SPROX_CHECK_IFR_RESPONSE should give you a valid XML document.

� The test SPROX_CHECK_IFR_CONNECTION should give you the information that the communication is working.

Readiness Check

2.5 Testing the availability of the JAVA applications

Procedure:

To test if the J2EE Engine itself is available, open a browser window and call the following URL: http://<host>:5<sysnr>00.

� This test is successful if you can see the documentation page of the J2EE Engine

Log into the client of the Integration Server and call transaction SXMB_IFR. This will bring up a browser window with 4 links: Integration Directory, Integration Repository, Runtime Workbench and System Landscape Directory (SLD). The SLD has already been tested in the first check, so only the first three components have to be tested at this point.

� Check if you can click on the link for the Integration Repository and log into the application.

� Check if you can click on the link for the Integration Directory and log into the application.

� Check if you can click on the link for the Runtime Workbench and log into the application.

Readiness Check

2.6 Testing the CPA Cache / Cache Connectivity Test

The cache of the Adapter Engine is called CPA Cache. It contains information about all adapters that run on the J2EE Engine. Thus, it is important that the refresh of this cache is working correctly.

Procedure:

Open a browser window and call the URL: http://<host>:5<sysnr>00/CPACache/refresh?mode=full. Use the XIDIRUSER to authenticate yourself, it is the only user that is allowed to carry out a CPA Cache Refresh.

� The test is successful if you get the message that the cache refresh has been carried out in xyz milliseconds. Please note that any additional text. e. g. “The XML page cannot be displayed” or “invalid at the top level of the document”, points at an error.

Troubleshooting:

1) Note 741214 gives valuable hints about possible reasons for errors. 2) In case of the error message “invalid at the top level of the document” the viewing of the source code of the respective Explorer page gives detailed information about the error.

Since SPS12 the Runtime Workbench offers a Cache Connectivity Test. You use this function to check whether both steps for updating the runtime cache are functioning correctly: 1) Notification of the components with cache data (consumers) using a cache refresh and 2) Retrieval and update of cache data by the consumer. In this procedure, a change list with a test object is created in the Integration Repository and released, and the Integration Directory is notified. The Integration Directory in turn notifies the relevant consumers, who then retrieve the test data and update their runtime cache accordingly.

Procedure

Log into the client of the Integration Server and call transaction SXMB_IFR. This will bring up a browser window with a link to the RWB. Once logged in, go to the ‘Component Monitoring’ choose ‘All’ from the dropdown menu of the field “Component with Status” and hit the “Display” button. Navigate to the Test by using the “Cache Connectivity Test” Button. To start the test hit the Button “Start Test”. Please note that you will at first see yellow triangles that indicate that the test is still ongoing (the cache notifications and updates need some time) and that you will have to hit “Refresh Display”.

� Check if all Cache Refreshes could be carried out, that is all components with cache data show a green light.

Readiness Check

In the above screenshot two Adapter Engines show a red light. These Adapter Engines are decentral Adapter Engines and were not online during the Cache Connectivity Test. Clicking on them enables troubleshooting of the problem, in this case “Unable to establish http connection”:

Readiness Check

2.7 Runtime Workbench (RWB)

The Runtime Workbench is the central monitoring tool of the Exchange Infrastructure. It offers self and status tests for most of the XI components: Integration Server, SLD; RWB, Adapter Framework, J2SE Adapter Engines, integrated Business Systems, Proxy Runtimes and Mapping Runtime.

Procedure:

Log into the client of the Integration Server and call transaction SXMB_IFR. This will bring up a browser window with a link to the RWB. Once logged in, go to the ‘Component Monitoring’ choose ‘All’ from the dropdown menu of the field “Component with Status” and hit the “Display” button.

� In the list of components mark the radio button of the entries one by one and check if you get green lights displayed at the bottom of the page

Readiness Check

2.8 Adapter Monitor Page

With XI 3.0 the adapters that connect the Exchange Infrastructure to the integrated business systems have been moved from the J2SE Adapter Engine into the J2EE Adapter Framework. They can be monitored with the so-called Adapter Monitor. It provides a simple green light / red light monitoring.

Procedure:

Until SP9: Open a browser window and call the URL: http://<host>:5<sysnr>00/AdapterFramework/monitor/monitor.jsp. You will see a list of Adapters, sorted by namespace. � SP9: Log on to the RWB start page and navigate to “Component Monitoring”. Choose display of all components and select the appropriate Adapter Engine. Click on the button “Adapter-Monitoring”.

� Check that the Adapters that are in use, display a green light. If you observe a red light, have a look at the Error messages and inform the respective Application People. Note that the content of this Adapter Monitor varies with the support package of your XI. It was introduced in SP4 and extended in each of the subsequent SPs.

Readiness Check

3 Advanced Checks

The following tests take up more time and require a certain degree of insight into the architecture of the Exchange Infrastructure, especially for the last check of this chapter.

3.1 SLD Associations

For several application processes it is required that the XI components all belong to the same ‘domain’. This domain and the associations of this domain are set during start-up of the system. However, when changing the hostname of the Integration Server the associations may become inconsistent and it is necessary to recheck / recreate them.

Procedure:

Log into the client of the Integration Server and call transaction SXMB_IFR. This will bring up a browser window with a link to the SLD. Once logged in go to the link “Technical Infrastructure” and choose “Exchange Infrastructure” from the drop down menu.

� Check if the Integration Server has a Domain assigned (in the screenshot below the Domain of the XI 3.0 Integration Server YIS is pwdf2031).

� Check if for the above Domain there are all components registered as well: Adapter Engine, Integration Directory, Integration Repository and RWB.

� Check if there are other Domains that are no longer used.

Troubleshooting:

See note 764176 if you find any inconsistencies.

Readiness Check

3.2 Availability of all deployed JAVA services

Apart from the main JAVA applications that have been checked in chapter 0 there are more services running in the JAVA VM. These can only be checked via the Visual Administrator.

Procedure:

Start the Visual Administrator and drill down to server -> services -> deploy. On the right side of the Visual Administrator choose the radio button ‘Applications’.

� Check that all services that are listed, are marked with a blue check.

� Make sure that none is marked with a red cross

Troubleshooting:

Should a service be marked with a red cross, try to start it manually. If a exclamation mark appear, click on the book symbol to get a more detailed explanation about the error.

Readiness Check

3.3 Testing cache notifications of the Integration Directory

For the development of scenarios it has to be ensured that the newly created information about objects (interface determinations, mappings etc.) is transmitted to the two components that need the information at runtime: the Adapter Framework and the Integration Server. The Integration Directory provides you with a Notification Service that is available via the menu entry “Environment” at the top of the user interface. This notification shows green/red status lights of cache notifications to the Integration Server as well as to the Adapter Framework.

Since the creation or the change of an existing object is required to carry out this test, it is NOT recommended for productive systems.

Procedure:

Log into the Integration Directory and open an existing object. You may also create a new one if you prefer. If you choose to open an existing object, go into the edit mode afterwards and make a small change (like removing and subsequently adding a character in the description of the object). This small change is needed to be able to save and activate the object again. After saving and activating the cache notifications are started automatically.

� Check if both notifications are executed successfully, that is they show a green light.

Readiness Check

3.4 Small Scenario

The ultimate test to ensure that the XI landscape is working correctly is to create a little scenario and carry it out. In this way all development tools as well as the runtime is tested. This does not require as much time as the development of scenarios for your business processes since a very easy set-up can be chosen and since this procedure could be documented within your company.

A suggestion would be to create a File Adapter for the Integration Server. This File Adapter would poll a *.txt file from a test folder, convert it into an XML and send it to the XI Integration Server. Create a simple mapping, for example rename the XML tags of your test file, that is then carried out in the Integration Server. The endpoint can again be a simple File Adapter that would store the mapped file into an archive folder.

If you need a more detailed description about how to set up a scenario, we recommend to implement the demo scenario for which SAP provides a detailed documentation as well as delivers the relevant objects in the Integration Repository (Software Component Version SAP Basis 640). The demo scenario can be found at help.sap.com -> Documentation -> SAP NetWeaver -> choose English or German. In the new window select “Process Integration” -> Exchange Infrastructure. In the now visible XI documentation drill down to Overview -> Demo Examples. The start page can also be accessed via http://help.sap.com/saphelp_nw04/helpdata/en/50/26414d5f462f4fb384094056d46175/content.htm.

Readiness Check

4 Additional tests for existing Scenarios

4.1 Configuration Test

Since SP12 of XI 3.0 there is the opportunity to test the configuration of your scenarios. The test is called “configuration test” and is part of the Integration Builder Directory. During the configuration test, the individual pipeline services of the Integration Server are called, and the change to the message in each case is simulated in the individual processing steps.

The advantage of this test is the detailed test report after having executed the test. If there are errors, it is possible to navigate to the relevant configuration objects and to see the errors on the “Error Log” tab page. Detailed information can be found in the online documentation: http://help.sap.com/saphelp_nw04/helpdata/en/6b/874a4273bb3830e10000000a155106/frameset.htm

Procedure:

Log on to the Integration Builder Directory and go to Tools -> Test Configuration. Define the input parameters like header data and a payload if required. Then start the test for the either the whole pipeline (”Run”) or for single pipeline steps (“Step Over”).

� Check if all pipeline steps are executed successfully, that is they show a green light for a single step and that the status is the black/white flag for a successful processing of the whole pipeline.

Readiness Check Version2

Documents

Transcript of Readiness Check Version2