IBM Support

Collect troubleshooting data for problems with the WebSphere Adapter for SAP

Technote (troubleshooting)


Problem(Abstract)

Collecting data for problems with the WebSphere Adapter for SAP. Gathering this MustGather information before calling IBM support helps familiarize you with the troubleshooting process and saves you time.

Resolving the problem

MustGather technotes provide a detailed description of the documentation required by the IBM Support team to diagnose your problem.

Select the runtime where your problem occurs:

WebSphere Application Server
WebSphere Enterprise Service Bus
WebSphere Message Broker
WebSphere Process Server
IBM Business Process Manager
WebSphere Transformation Extender

WebSphere Application Server

Gather the following documentation for the WebSphere Adapter for SAP running with Rational Application Developer and WebSphere Application Server runtime:


Troubleshooting Development/Discovery time issues:

Following is the information that needs to be gathered for troubleshooting data WebSphere Adapter for SAP issues during discovery process using Rational Application Developer:


Adapter version being used during discovery:
1. Launch the J2C Bean wizard: Go to the Enterprise Explorer of Rational Application Developer for WebSphere Software and click File > New > Other > J2C > J2C Bean.
2. Click Next.
3. In the Resource Adapter Selection window, expand the SAP folder to find the select IBM WebSphere Adapter for SAP Software (IBM : version), where version is the version of the adapter being used.

Project Interchange:
Steps to export the Project Interchange:
1. In the Project Explorer, right-click the project that you want to export, and select Export > Export.

2. Click Other > Project Interchange, and then click Next.

3. Select the projects that you want to export:

  • Click Select All to select all projects in the window.
  • Click Select Referenced to automatically select projects that are referenced by any of the currently selected projects.

4. In the To zip file field, enter the full path, including the ZIP file name, where you want to export the selected projects.

5. If you want to include derived files generated in the project, select the Include derived files check box.

6. Click Finish.



Meta-data discovery logs:
Steps to enable and collect the Meta-data discovery logs:
1. In the J2C Bean Wizard :
-Set the Logging Level property to 'SEVERE' (which is the default value as well)
-Set the Log file output location to Output location where the SAPMetadataDiscovery log
is created. Default value is the .metadata directory of the workspace,Specify a different
output location

2. Recreate the issue.
3. Compress and provide the contents of the ,metadata directory

RFC traces:
Steps to enable and collect the RFC Traces:
1. In the J2C Bean Wizard :
-Set the RFCTraceOn property to 'true'
-Set the RFC Trace Level property to '8' , which outputs verbose debug messages, full
execution path, info messages, errors and warnings
-Set the Folder for RFC trace files property to the directory location where the RFC Traces
are created

2. Recreate the issue

3. Collect the RFC trace files generated.

Note: The trace files are created in the directory where the adapter process has been started by default. The trace file has a .trc file extension and the file name will start with the letters rfc followed by a unique identifier. For example, rfc03912_02220.trc.

Troubleshooting Runtime Issues:

Following is the information that needs to be gathered for troubleshooting data WebSphere Adapter for SAP issues at runtime using WebSphere Application Server runtime:

Adapter version at runtime:
The adapter version can be found in ra.xml file :

If adapter is deployed with embedded mode: <WAS root dir>\profiles\<profile>\installedApps\<CellName>\<AdapterApp>.ear\<AdapterRAR>\META-INF\ra.xml

If adapter is deployed with standalone mode: <WAS root dir>\profiles\<profile>\installedConnectors\<AdapterRAR>\META-INF\ra.xml

Project Interchange:
Steps to export the Project Interchange:
1. In the Project Explorer, right-click the project that you want to export, and select Export > Export.

2. Click Other > Project Interchange, and then click Next.

3. Select the projects that you want to export:

  • Click Select All to select all projects in the window.
  • Click Select Referenced to automatically select projects that are referenced by any of the currently selected projects.

4. In the To zip file field, enter the full path, including the ZIP file name, where you want to export the selected projects.

5. If you want to include derived files generated in the project, select the Include derived files check box.

6. Click Finish.


Logs/Traces:
SystemOut and trace logs:

Following are the steps to enable and collect SystemOut.log and trace.logs at runtime:

1. In the navigation pane of the Administrative console, click Servers > WebSphere application servers.

2. Click the name of the server that you want to work with.

3. Under Troubleshooting, click Logging and tracing.

4. Click Change Log Detail Levels.

5. Specify when you want the change to take effect:

    • For a static change to the configuration, click the Configuration tab.
    • For a dynamic change to the configuration, click the Runtime tab.
6. Set the logging level : that is com.ibm.j2ca.*='all' to capture the detailed level logs/traces.

7. Recreate the issue.

8. Collect the SystemOut.log, System.Err, and the trace.log files located for example in the <install_root>/profiles/profile_name/logs/server_name folder.

First-failure data capture (FFDC)logs:
FFDC feature runs in the background and collects events and errors that occur at runtime.

Following are the steps to collect FFDC logs at runtime:

1. Navigate to FFDC directory where all the FFDC logs are captured. For example:<WAS root dir>\profiles\<profile>\logs\ffdc

2. Compress and provide the contents of ffdc directory.

WebSphere Enterprise Service Bus

Please gather the following documentation for the WebSphere Adapter for SAP running with WebSphere Integration Developer and WebSphere Enterprise Service Bus runtime:

Troubleshooting Development/Discovery time issues:

Following is the information that needs to be gathered for troubleshooting data WebSphere Adapter for SAP issues during discovery process using WebSphere Integration Developer:


Adapter version being used during discovery:
1. Launch the External Service wizard: In the WebSphere Integration Developer, click File > New > External Service
2. Click Next.
3. In the Resource Adapter Selection window, find the IBM WebSphere Adapter for SAP Software (IBM : version), where version is the version of the adapter being used.

Project Interchange:
Steps to export the Project Interchange:
1. In the WebSphere Integration Developer, Select File -Export.

2. Click Other > Project Interchange, and then click Next.

3. Select the projects that you want to export:

  • Click Select All to select all projects in the window.
  • Click Select Referenced to automatically select projects that are referenced by any of the currently selected projects.

4. In the To zip file field, enter the full path, including the ZIP file name, where you want to export the selected projects.

5. If you want to include derived files generated in the project, select the Include derived files check box.

6. Click Finish.



Meta-data discovery logs:
Steps to enable and collect the Meta-data discovery logs:
1. Launch the External Service Wizard .

2. In the Discovery Configuration window, Select the 'Change logging properties for the wizard'
-Set the Logging Level property to 'SEVERE' (which is the default value as well)
-Set the Log file output location to Output location where the SAPMetadataDiscovery log
is created. Default value is the .metadata directory of the workspace,Specify a different
output location

3. Recreate the issue.
4. Compress and provide the contents of the ,metadata directory.

RFC traces:
Steps to enable and collect the RFC Traces:
1. Launch the External Service Wizard ,and proceed to the 'Service Generation and Deployment Configuration' window. In the SAP RFC trace configuration section:
-Set the RFCTraceOn property to 'true'
-Set the RFC Trace Level property to '8' , which outputs verbose debug messages, full
execution path, info messages, errors and warnings
-Set the Folder for RFC trace files property to the directory location where the RFC Traces
are created

2. Recreate the issue.

3. Collect the RFC trace files generated.

Note:The trace files are created in the directory where the adapter process has been started by default. The trace file has a .trc file extension and the file name will start with the letters rfc followed by a unique identifier. For example, rfc03912_02220.trc.

Troubleshooting Runtime Issues:

Following is the information that needs to be gathered for troubleshooting data WebSphere Adapter for SAP issues at runtime using WebSphere Enterprise Service Bus runtime:

Adapter version at runtime:
The adapter version can be found in ra.xml file :

- If WebSphere Enterprise Service Bus is bundled with WebSphere Integration Developer: < WebSphere Integration Developer root dir>\pf\wps\installedApps\widCell\<AdapterApp>.ear\<AdapterApp>\<AdapterRAR>\META-INF\ra.xml

- If WebSphere Enterprise Service Bus is not bundled with WebSphere Integration Developer: <WebSphere Enterprise Service Bus root dir>\profiles\<profile>\installedApps\<CellName>\<AdapterApp>.ear\<AdapterRAR>\META-INF\ra.xm

Project Interchange:
Steps to export the Project Interchange:
1. In the WebSphere Integration Developer, Select File-Export

2. Click Other > Project Interchange, and then click Next.

3. Select the projects that you want to export:

  • Click Select All to select all projects in the window.
  • Click Select Referenced to automatically select projects that are referenced by any of the currently selected projects.

4. In the To zip file field, enter the full path, including the ZIP file name, where you want to export the selected projects.

5. If you want to include derived files generated in the project, select the Include derived files check box.

6. Click Finish.


Logs/Traces:
SystemOut and trace logs:

Following are the steps to enable and collect SystemOut.log and trace.logs at runtime:

1. In the navigation pane of the Administrative console, click Servers > WebSphere application servers.

2. Click the name of the server that you want to work with.

3. Under Troubleshooting, click Logging and tracing.

4. Click Change Log Detail Levels.

5. Specify when you want the change to take effect:

  • For a static change to the configuration, click the Configuration tab.
  • For a dynamic change to the configuration, click the Runtime tab.

6. Set the logging level : that is com.ibm.j2ca.*='all' to capture the detailed level logs/traces.

7. Recreate the issue.

8. Collect the SystemOut.log, System.Err, and the trace.log files located for example in the <install_root>/profiles/profile_name/logs/server_name folder.

First-failure data capture (FFDC)logs:
FFDC feature runs in the background and collects events and errors that occur at runtime.

Following are the steps to collect FFDC logs at runtime:

1. Navigate to FFDC directory where all the ffdc logs are captured. For example:<install root >\profiles\<profile>\logs\ffdc

2. Compress and provide the contents of ffdc directory.


WebSphere Message Broker

Please gather the following documentation for the WebSphere Adapter for SAP running with WebSphere Message Broker Toolkit and WebSphere Message Broker runtime:


Troubleshooting Development/Discovery time issues:

Following is the information that needs to be gathered for troubleshooting data WebSphere Adapter for SAP issues during discovery process using WebSphere Message Broker Toolkit.


Adapter version being used during discovery:
1. Launch the Adapter Connection wizard: In the WebSphere Message Broker Toolkit, click File > New > Adapter Connection.

2. In the Resource Adapter Selection window, find the IBM WebSphere Adapter for SAP Software (IBM : version), where version is the version of the adapter being used.

Project Interchange:

Steps to export the Project Interchange:
1. In the WebSphere Message Broker Toolkit ,Select File -Export.

2. Click Other > Project Interchange, and then click Next.

3. Select the projects that you want to export:

  • Click Select All to select all projects in the window.
  • Click Select Referenced to automatically select projects that are referenced by any of the currently selected projects.

4. In the To zip file field, enter the full path, including the ZIP file name, where you want to export the selected projects.

5. If you want to include derived files generated in the project, select the Include derived files check box.

6. Click Finish.



Meta-data discovery logs:
Steps to enable and collect the Meta-data discovery logs:
1. Launch the Adapter Connection Wizard.

2. In the 'Configure Settings for the Discovery Agent' window, Select the 'Change logging properties for the wizard'
-Set the Logging Level property to 'SEVERE' (which is the default value as well)
-Set the Log file output location to Output location where the SAPMetadataDiscovery log
is created. Default value is the .metadata directory of the workspace, specify a different
output location

3. Recreate the issue.
4. Compress and provide the contents of the ,metadata directory.

RFC traces:
Steps to enable and collect the RFC Traces:
1. Launch the Adapter Connection Wizard ,and proceed to the 'Service Generation and Deployment Configuration' window. In the SAP RFC trace configuration section:
-Set the RFCTraceOn property to 'true'
-Set the RFC Trace Level property to '8' , which outputs verbose debug messages, full
execution path, info messages, errors and warnings
-Set the Folder for RFC trace files property to the directory location where the RFC Traces
are created

2. Recreate the issue.

3. Collect the RFC trace files generated.

Note:The trace files are created in the directory where the adapter process has been started by default. The trace file has a .trc file extension and the file name will start with the letters rfc followed by a unique identifier. For example, rfc03912_02220.trc.

Troubleshooting Runtime Issues:

Following is the information that needs to be gathered for troubleshooting data WebSphere Adapter for SAP issues at runtime using WebSphere Message Broker runtime:

Adapter version at runtime:
The adapter version can be found in ra.xml file:

1. Navigate to the <WebSphere Message Broker root dir>/adapters/prereqs/jars folder.

2. Open the CWYAP_SAPAdapter.jar using any extraction tool to find the manifest.mf file which contains the adapter version information.

Project Interchange:
Steps to export the Project Interchange:
1. In the WebSphere Message Broker Toolkit, Select File-Export.

2. Click Other > Project Interchange, and then click Next.

3. Select the projects that you want to export:

    • Click Select All to select all projects in the window.
    • Click Select Referenced to automatically select projects that are referenced by any of the currently selected projects.
4. In the To zip file field, enter the full path, including the ZIP file name, where you want to export the selected projects.

5. If you want to include derived files generated in the project, select the Include derived files check box.

6. Click Finish.

Logs/Traces:
Service traces:

Following are the steps to gather Service traces:

1. Start trace.

      mqsichangetrace <brokername> -t -e <egroup> -l debug -r -c 100000

2. Put a message on the queue to cause the failure to occur.

3. Stop trace.

      mqsichangetrace <brokername> -t -e <egroup> -l none

4. Retrieve the trace log for the specified component.
      mqsireadlog <brokername> -t -e <egroup> -f -o flowtrace.xml


5. Format the XML trace file.
      mqsiformatlog -i flowtrace.xml -o serviceflowtrace.txt
Note: The service traces when collected also embeds the User traces.


User Trace:
1. Start trace.
    mqsichangetrace <brokername> -u -e <egroup> -f "<Message Flow Name>" -l debug -r -c 50000

<brokername> is the name of your broker
<egroup> is the name of your execution group
You can also start tracing, by going to Operations tab, and right click Message Flow, and click Start Trace

2. Put a message on the input node queue to cause the failure to occur.

3. Stop trace.
    mqsichangetrace <brokername> -u -e <egroup> -f "<Message Flow Name>" -l none

You can also stop tracing, by going to Operations tab, and right click Message Flow, and click Stop Trace

4. Retrieve the trace log for the specified component.
    mqsireadlog <brokername> -u -e <egroup> -f -o flowtrace.xml

5. Format XML tracefile.
    mqsiformatlog -i flowtrace.xml -o userflowtrace.txt
WebSphere Process Server
Gather the following documentation for the WebSphere Adapter for SAP running with WebSphere Integration Developer and WebSphere Process Server runtime:

Troubleshooting Development/Discovery time issues:

Following is the information that needs to be gathered for troubleshooting data WebSphere Adapter for SAP issues during discovery process using WebSphere Integration Developer:

Adapter version being used during discovery:
1. Launch the External Service wizard: In the WebSphere Integration Developer, click File > New > External Service
2. Click Next.
3. In the Resource Adapter Selection window, find the IBM WebSphere Adapter for SAP Software (IBM : version), where version is the version of the adapter being used.

Project Interchange:
Steps to export the Project Interchange:
1. In the WebSphere Integration Developer, Select File -Export.

2. Click Other > Project Interchange, and then click Next.

3. Select the projects that you want to export:

  • Click Select All to select all projects in the window.
  • Click Select Referenced to automatically select projects that are referenced by any of the currently selected projects.

4. In the To zip file field, enter the full path, including the ZIP file name, where you want to export the selected projects.

5. If you want to include derived files generated in the project, select the Include derived files check box.

6. Click Finish.



Meta-data discovery logs:
Steps to enable and collect the Meta-data discovery logs:
1. Launch the External Service Wizard.

2. In the Discovery Configuration window, Select the 'Change logging properties for the wizard'
-Set the Logging Level property to 'SEVERE' (which is the default value as well)
-Set the Log file output location to Output location where the SAPMetadataDiscovery log
is created. Default value is the .metadata directory of the workspace, Specify a different
output location

3. Recreate the issue.
4. Compress and provide the contents of the ,metadata directory.

RFC traces:
Steps to enable and collect the RFC Traces:
1. Launch the External Service Wizard ,and proceed to the 'Service Generation and Deployment Configuration' window. In the SAP RFC trace configuration section:
-Set the RFCTraceOn property to 'true'
-Set the RFC Trace Level property to '8' , which outputs verbose debug messages, full
execution path, info messages, errors and warnings
-Set the Folder for RFC trace files property to the directory location where the RFC Traces
are created

2. Recreate the issue.

3. Collect the RFC trace files generated.

Note: The trace files are created in the directory where the adapter process has been started by default. The trace file has a .trc file extension and the file name will start with the letters rfc followed by a unique identifier. For example, rfc03912_02220.trc.

Troubleshooting Runtime Issues:

Following is the information that needs to be gathered for troubleshooting data WebSphere Adapter for SAP issues at runtime using WebSphere Process Server runtime:

Adapter version at runtime:
The adapter version can be found in ra.xml file:

- If WebSphere Process Server is bundled with WebSphere Integration Developer: < WebSphere Integration Developer root dir>\pf\wps\installedApps\widCell\<AdapterApp>.ear\<AdapterApp>\<AdapterRAR>\META-INF\ra.xml

- If WebSphere Process Server is not bundled with WebSphere Integration Developer: <WebSphere Process Server root dir>\profiles\<profile>\installedApps\<CellName>\<AdapterApp>.ear\<AdapterRAR>\META-INF\ra.xm

Project Interchange:
Steps to export the Project Interchange:
1. In the WebSphere Integration Developer , Select File-Export.

2. Click Other > Project Interchange, and then click Next.

3. Select the projects that you want to export:

  • Click Select All to select all projects in the window.
  • Click Select Referenced to automatically select projects that are referenced by any of the currently selected projects.

4. In the To zip file field, enter the full path, including the ZIP file name, where you want to export the selected projects.

5. If you want to include derived files generated in the project, select the Include derived files check box.

6. Click Finish.

Logs/Traces:
SystemOut and trace logs:

Following are the steps to enable and collect SystemOut.log and trace.logs at runtime:

1. In the navigation pane of the Administrative console, click Servers > WebSphere Application Servers.

2. Click the name of the server that you want to work with.

3. Under Troubleshooting, click Logging and tracing.

4. Click Change Log Detail Levels.

5. Specify when you want the change to take effect:

    • For a static change to the configuration, click the Configuration tab.
    • For a dynamic change to the configuration, click the Runtime tab.
6. Set the logging level : that is com.ibm.j2ca.*='all' to capture the detailed level logs/traces

7. Recreate the issue.

8. Collect the SystemOut.log,System.Err,and the trace.log files located for example in the <install_root>/profiles/profile_name/logs/server_name folder.

First-failure data capture (FFDC) logs:
FFDC feature runs in the background and collects events and errors that occur at runtime.

Following are the steps to collect FFDC logs at runtime:

1. Navigate to ffdc directory where all the ffdc logs are captured. For example:<install root >\profiles\<profile>\logs\ffdc

2. Compress and provide the contents of ffdc directory.

IBM Business Process Manager
Gather the following documentation for the WebSphere Adapter for SAP running with IBM Integration Designer and IBM Business Process Manager runtime:

Troubleshooting Development/Discovery time issues:

Following is the information that needs to be gathered for troubleshooting data for WebSphere Adapter for SAP issues during discovery process using IBM Integration Designer:

Adapter version being used during discovery:
1. Launch the External Service wizard: In IBM Integration Designer, click File > New > External Service
2. Click Next.
3. In the New External Service window, find the IBM WebSphere Adapter for SAP Software (IBM : version), where version is the version of the adapter being used.

Project Interchange:
Steps to export the Project Interchange:
1. In the IBM Integration Designer, Select File -Export.

2. Click Other > Project Interchange, and then click Next.

3. Select the projects that you want to export:

  • Click Select All to select all projects in the window.
  • Click Select Referenced to automatically select projects that are referenced by any of the currently selected projects.

4. In the To zip file field, enter the full path, including the ZIP file name, where you want to export the selected projects.

5. If you want to include derived files generated in the project, select the Include derived files check box.

6. Click Finish.



Meta-data discovery logs:
Steps to enable and collect the Meta-data discovery logs:
1. Launch the External Service Wizard.

2. In the Discovery Configuration window, Select the 'Change logging properties for the wizard'
-Set the Logging Level property to 'SEVERE' (which is the default value as well)
-Set the Log file output location to Output location where the SAPMetadataDiscovery log
is created. Default value is the .metadata directory of the workspace, specify a different
output location

3. Recreate the issue.
4. Compress and provide the contents of the metadata directory.

RFC traces:
Steps to enable and collect the RFC Traces:
1. Launch the External Service Wizard ,and proceed to the 'Service Generation and Deployment Configuration' window. In the SAP RFC trace configuration section:
-Set the RFCTraceOn property to 'true'
-Set the RFC Trace Level property to '8' , which outputs verbose debug messages, full
execution path, info messages, errors and warnings
-Set the Folder for RFC trace files property to the directory location where the RFC Traces
are created

2. Recreate the issue.

3. Collect the RFC trace files generated.

Note: The trace files are created in the directory where the adapter process has been started by default. The trace file has a .trc file extension and the file name will start with the letters rfc followed by a unique identifier. For example, rfc03912_02220.trc.

Troubleshooting Runtime Issues:

Following is the information that needs to be gathered for troubleshooting data WebSphere Adapter for SAP issues at runtime using IBM Business Process Manager runtime:

Adapter version at runtime:
The adapter version can be found in ra.xml file:

<IBM Business Process Manager root dir>\profiles\<profile>\installedApps\<CellName>\<AdapterApp>.ear\<AdapterRAR>\META-INF\ra.xm

Project Interchange:
Steps to export the Project Interchange:
1. In the IBM Integration Designer, Select File-Export.

2. Click Other > Project Interchange, and then click Next.

3. Select the projects that you want to export:

  • Click Select All to select all projects in the window.
  • Click Select Referenced to automatically select projects that are referenced by any of the currently selected projects.

4. In the To zip file field, enter the full path, including the ZIP file name, where you want to export the selected projects.

5. If you want to include derived files generated in the project, select the Include derived files check box.

6. Click Finish.

Logs/Traces:
SystemOut and trace logs:

Following are the steps to enable and collect SystemOut.log and trace.logs at runtime:

1. In the navigation pane of the Administrative console, click Servers > WebSphere Application Servers.

2. Click the name of the server that you want to work with.

3. Under Troubleshooting, click Logging and tracing.

4. Click Change Log Detail Levels.

5. Specify when you want the change to take effect:

  • For a static change to the configuration, click the Configuration tab.
  • For a dynamic change to the configuration, click the Runtime tab.

6. Set the logging level : that is com.ibm.j2ca.*='all' to capture the detailed level logs/traces

7. Recreate the issue.

8. Collect the SystemOut.log, System.Err, and the trace.log files located for example in the <install_root>/profiles/profile_name/logs/server_name folder.

First-failure data capture (FFDC) logs:
FFDC feature runs in the background and collects events and errors that occur at runtime.

Following are the steps to collect FFDC logs at runtime:

1. Navigate to ffdc directory where all the ffdc logs are captured. For example:<install root >\profiles\<profile>\logs\ffdc

2. Compress and provide the contents of ffdc directory.


WebSphere Transformation Extender

Gather the following documentation for the WebSphere Adapter for SAP running with WebSphere Transformation Extender runtime:

  • Adapter version including the Fix Pack level and Interim Fix level

  • WebSphere Transformation Extender version and Fix Pack level

  • Adapter runtime log file. Configure and run the adapter to generate the trace file. This can be done by setting the following option on the adapter execution command line:

    TV <file location relative to the map or absolute path>

All the adapter's runtime tracing information will go to this trace file.
  • If the issue involves the WebSphere Transformation Extender Importer wizard and configuring adapter, provide these log files:
    • Log files located in Eclipse workspace .metadata directory. (In other words, Eclipse <workspace>\.metadata\.log)

    • WebSphere Transformation Extender Launcher logs. If inbound scenario, set the following options in the dtx.ini file:
    • LogTrace=1
    • LogDebug=1
    • LogInfo=1
    • LogWarning=1
    • LogError=1
    • LogFatal=1

For the inbound scenarios, when running the WebSphere Transformation Extender Launcher, provide the logs for the Launcher. The logs could be enabled in the dtx.ini file.

Document information

More support for: WebSphere Adapters Family
Adapter for SAP

Software version: 6.0.2, 6.1, 6.2, 7.0, 7.0.1, 7.5

Operating system(s): AIX, HP-UX, Linux, Solaris, Windows

Software edition: WebSphere

Reference #: 1438193

Modified date: 27 September 2010