MDM71 InfoCollector HowToGuide v2.1

SAP NetWeaver How-To Guide

How to Create an MDM Snapshot Using the MDM Info Collector Tool

Applicable Releases:

SAP NetWeaver Master Data Management (MDM) 7.1

Topic Area: Enterprise Information Management

Capability: Master Data Management

Version 2.0

June 2011

© Copyright 2011 SAP AG. All rights reserved.

No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice.

Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors.

Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation.

IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex, MVS/ESA, AIX, S/390, AS/400, OS/390, OS/400, iSeries, pSeries, xSeries, zSeries, z/OS, AFP, Intelligent Miner, WebSphere, Netfinity, Tivoli, Informix, i5/OS, POWER, POWER5, OpenPower and PowerPC are trademarks or registered trademarks of IBM Corporation.

Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries.

Oracle is a registered trademark of Oracle Corporation.

UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group.

Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc.

HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C®, World Wide Web Consortium, Massachusetts Institute of Technology.

Java is a registered trademark of Sun Microsystems, Inc.

JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape.

MaxDB is a trademark of MySQL AB, Sweden.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.

These materials are provided “as is” without a warranty of any kind, either express or implied, including but not limited to, the implied warranties of merchantability, fitness for a particular purpose, or non-infringement.

SAP shall not be liable for damages of any kind including without limitation direct, special, indirect, or consequential damages that may result from the use of these materials.

SAP does not warrant the accuracy or completeness of the information, text, graphics, links or other items contained within these materials. SAP has no control over the information that you may access through the use of hot links contained in these materials and does not endorse your use of third party web pages nor provide any warranty whatsoever relating to third party web pages.

SAP NetWeaver “How-to” Guides are intended to simplify the product implementation. While specific product features and procedures typically are explained in a practical business context, it is not implied that those features and procedures are the only approach in solving a specific business problem using SAP NetWeaver. Should you wish to receive additional information, clarification or support, please refer to SAP Consulting.

Any software coding and/or code lines / strings (“Code”) included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or grossly negligent.

Disclaimer

Some components of this product are based on Java™. Any code change in these components may cause unpredictable and severe malfunctions and is therefore expressively prohibited, as is any decompilation of these components.

Any Java™ Source Code delivered with this product is only to be used by SAP’s Support Services and may not be modified or altered in any way.

Document History Document Version Description

2.0 Document updated for version 2.0 of MDM Info Collector tool: Added option to run the tool from remote using the SAP MMC (SAP Snap-

In for Microsoft Management Console). See Remotely Running the Tool Using SAP MMC on page 12.

MDM Info Collector now collects information from the Master Data Import Server (MDIS) and the Master Data Syndication Server (MDSS) as well, in addition to the Master Data Server (MDS).

Only a single deployment of the tool is required per SAP system directory (SID). There is no need to install the tool under each MDM instance. See new deployment instructions in Downloading and Deploying the MDM Info Collector on page 5.

Improved configuration of the tool: The run_gui_unix and run_cmd_unix files have been merged in

to a single new file: run_unix The run_gui_win.bat and run_cmd_win.bat files have been

merged into a new single file: run_win.cmd A new parameter, called TOOL_INTERFACE, has been added to the run_unix and run_win.cmd files that allows you choose whether to use the graphical interface (GUI) or the command line interface (CLI) of the tool. See Selecting the Graphical User Interface or Command Line Interface on page 6.

When using the MDM Info Collector CLI, you can now use a dedicated file (input_params.ini) for passing input parameters to the CLI, instead of manually entering them with the command execution. See Running the Command Line Interface (CLI) Startup Script with the Input Parameters File on page 11.

Added Import Port option to GUI and command line field to allow users to specify MDM inbound port code. This enables the tool to collect necessary information related to MDM import failures.

Changes added to the CLI: When entering the time period, you no longer use from: and to:

as prefixes for entering the start and end times, respectively. Instead, you enter two consecutive date/times in the format: <start_datetime> <end_datetime>.

The switch for specifying the output directory of the info package has changed from -o to -dir.

Added new switch, called mp, which enables users to specify the MDM inbound port code.

For more information, see Running the Command Line Without the Input Parameters File on page 19.

Added information about SSL support. See Supporting Secure Sockets Layer (SSL) Protocol on page 7.

1.0 First official release of this guide

Typographic Conventions Type Style Description

Example Text Words or characters quoted from the screen. These include field names, screen titles, pushbuttons labels, menu names, menu paths, and menu options. Cross-references to other documentation

Example text Emphasized words or phrases in body text, graphic titles, and table titles

Example text File and directory names and their paths, messages, names of variables and parameters, source text, and names of installation, upgrade and database tools.

Example text User entry texts. These are words or characters that you enter in the system exactly as they appear in the documentation.

<Example text>

Variable user entry. Angle brackets indicate that you replace these words and characters with appropriate entries to make entries in the system.

EXAMPLE TEXT Keys on the keyboard, for example, F2 or ENTER.

Icons Icon Description

Caution

Note or Important

Example

Recommendation or Tip


June 2011 1

Table of Contents

1. Business Scenario ..........................................................................................................2

2. Prerequisites....................................................................................................................4

3. Deploying and Setting Up the MDM Info Collector.........................................................5 3.1 Downloading and Deploying the MDM Info Collector .................................................5 3.2 Performing First-Time Configuration Steps ................................................................5

3.2.1 Defining the Java Environment Parameters...................................................6 3.2.2 Selecting the Graphical User Interface or Command Line Interface ...............6 3.2.3 Supporting Secure Sockets Layer (SSL) Protocol .........................................7

4. Running the MDM Info Collector .....................................................................................8 4.1 General Usage Instructions .......................................................................................8 4.2 Using the MDM Info Collector GUI ............................................................................9 4.3 Running the Command Line Interface (CLI) Startup Script with the Input

Parameters File ...................................................................................................... 11 4.4 Remotely Running the Tool Using SAP MMC .......................................................... 12

4.4.1 Preparation ................................................................................................. 12 4.4.2 Running MDM Info Collector from Remote via SAP MMC............................ 15 4.4.3 Retrieving SAP MMC Snapshots................................................................. 16

4.5 Additional Information about MDM Info Collector Parameters .................................. 17 4.5.1 Failure Time ............................................................................................... 17 4.5.2 Create Repository Archive .......................................................................... 17 4.5.3 Attachments Directory................................................................................. 18 4.5.4 Size of Split Output Files ............................................................................. 18

5. Appendix ........................................................................................................................ 19 5.1 Running the Command Line Without the Input Parameters File ............................... 19


June 2011 2

1. Business Scenario When you discover a failure with SAP NetWeaver Master Data Management (MDM) and as a result open a message to SAP Customer Support, you will most likely need to send information that is related to your system so that SAP can perform an offline analysis of the problem. Collecting this information manually can be a very difficult, error prone, and time-consuming task. You can run the MDM Info Collector tool to automatically collect the information relating to your MDM setup and landscape, and to package it for you into a compressed ZIP file (referred to in this guide as an info package). The information can then be used by SAP Customer Support to facilitate and expedite the analysis and resolution of a reported failure. All you do is run the tool and attach the resulting info package to your SAP customer message. Benefits of Using MDM Info Collector

Simplifies and accelerates the process of collecting all required information in a single operation. Ensures that basic information for analyzing the problem is collected and provided to SAP. Packages all necessary information together, including optional attachments (such as

documents describing the problem with screenshots). Scope of MDM Info Collector The MDM Info Collector collects information from the following MDM server components:

Master Data Server (MDS) Master Data Import Server (MDIS) Master Data Syndication Server (MDSS)

Important The MDM Info Collector can collect information only from MDM server

components (MDS, MDSS, and MDIS) that are installed on the same machine. If you have multiple MDM instances (for example: MDS, MDS and MDSS) under the same SAP system directory, the tool asks you to choose the MDM instance to connect to:

When you connect to the MDS component, the tool collects information from the MDS only.

When you connect to the MDIS or MDSS component, the tool collects information from the MDS also, since MDS-specific information is also necessary to troubleshoot any issue related to MDIS or MDSS. IMPORTANT: If you run the tool on the MDIS or MDSS, and the MDS is installed on a different machine, you must run the tool separately for each component. For example: (1) For MDM import issues, run the tool on the MDS machine and the MDIS machine. (2) For MDM syndication issues, run the tool on the MDS machine and the MDSS machine.

The tool does not collect information from MDM clients (such as MDM Data Manager or MDM Import Manager) or MDM Java applications.


June 2011 3

Some of the information collected by the MDM Info Collector (this not a complete list): MDM information: profiles, .ini files, version, logs and audits, reports, distributions logs, CLIX

Monitor (and optionally: repository archive and repository verify (check), workflow job counts, and distribution import source files).

Landscape information: network connections, OS settings, details of all MDM instances, running processes, OS services, folder permissions, mounted drives, SAP startup framework (SAPStartSRV service) environment variables, CCMS, and CA Wily Introscope settings. For UNIX/Linux specifically, the nohup.out file, core dump debug info files, and the .mdmdbenv file are also collected.

You can run the MDM Info Collector directly on the MDM server machine or you can execute the tool from any remote Windows desktop (as long as the remote MDM server machine has the execution files installed on it).


June 2011 4

2. Prerequisites Use of the MDM Info Collector requires the following to be installed:

MDM server components of SAP NetWeaver Master Data Management (MDM) 7.1 SP03 and higher

Note The MDM Info Collector supports all platforms that are supported by the MDM servers, as documented in the MDM Product Availability Matrix (PAM). For more information, see http://service.sap.com/pam, and enter MDM in the search area.

Java Virtual Machine (JVM) 1.6.0_07 (SAP JVM 6.1 Patch Level 07) or higher on the MDM machine. You may use any JVM from any vendor that implements Java standards.

Tip You can download SAP JVM 6.1 from the SAP Software Distribution Center. Go to http://service.sap.com/swdc Support Packages and Patches Search for Support Packages and Patches, and then enter JVM 6.1 as a search term.

Recommendation Typically there is no installer for JVM; you only need to copy the JVM program files to your MDM machine. We recommend that you copy the JVM program files to a location that is not part of the MDM installation directory. For example:

On Windows: c:\java\sapjvm_6 On UNIX/Linux: /opt/java/sapjvm_6

Note Since MDM Info Collector is Java-based, it is platform-independent and thereby uses the JVM installed on the local machine to run on your operating system (OS). You must ensure that you install the correct JVM version that is compatible with your OS type (Windows, Linux etc.) and with the 32-bit or 64-bit version of the OS (HP-UX 64-bit, Windows 32-bit, and Windows 64-bit etc.). To ensure that the Java (JVM) on your machine is installed and running properly, navigate to the Java installation directory and run the java –version command. The output should be the version of your JVM (which must be 1.6 or higher).

If you plan to execute the MDM Info Collector on a remote MDM server from a local Microsoft Windows PC, then the SAP MMC (SAP Snap-In for Microsoft Management Console) must be installed on the local machine. See additional prerequisites in Remotely Running the Tool Using SAP MMC on page 12.

http://service.sap.com/pam

http://service.sap.com/swdc


June 2011 5

3. Deploying and Setting Up the MDM Info Collector

This section describes how to download and deploy the MDM Info Collector, and then to perform the initial one-time configuration steps.

3.1 Downloading and Deploying the MDM Info Collector

There is no installer for the MDM Info Collector tool. You download the application files and deploy them to the relevant directory, as described in this section. The instructions in this section apply to both local and remote execution scenarios. In both scenarios, you need to copy the execution files to the MDM server machine from which you want to gather information. As of MDM Info Collector version 2.0, only a single deployment of the tool is required per SAP system directory (SID). There is no need to install the tool under each MDM instance. In other words, you can use the same MDM Info Collector deployment for all instances (all MDM server components: MDS, MDIS, and MDSS) that are located under the same SID.

Note If you are upgrading from version 1 of the tool, delete the old application files and deploy the new version as described below.

Follow these instructions to download and deploy the MDM Info Collector tool:

1. From SAP Note 1522125, download the ZIP file that contains the MDM Info Collector tool. 2. Extract the contents of the ZIP file; this creates a directory called: MDM_infoCollector 3. Copy the MDM_infoCollector directory to the MDM SAP system (SID) directory of the

relevant MDM server component: /usr/sap/<SID> For example, after copying the application files, the directory path should be as follows:

For Windows: C:\usr\sap\MDM\MDM_infoCollector For UNIX: /usr/sap/MDM/MDM_infoCollector

Recommendation For UNIX/Linux, use the <SID>adm user in order to copy the directory to the UNIX machine. This will ensure that the owner of this directory is the <SID>adm user.

4. (For UNIX/Linux only) Set permissions as follows: ...

a. Ensure that the MDM_infoCollector directory with all its subdirectories and files have write permission for the <SID>adm user (for example: mdmadm user).

b. Ensure that the run_unix file and the infoCollector\scripts directory with all its subdirectories and files have execute permission for the <SID>adm user.

3.2 Performing First-Time Configuration Steps After deploying the MDM Info Collector application files, you need to perform a number of initial one-time configuration steps, as described in this section. Note that additional configuration steps may need to be performed each time you execute the tool, however these configurations vary according to the problem and system you may be experiencing problems with; these are described later in the Running the MDM Info Collector section.

https://service.sap.com/sap/support/notes/1522125


June 2011 6

3.2.1 Defining the Java Environment Parameters The startup script of the tool must be able to recognize the Java that is installed on the machine. You can do it by one of the following ways:

Making sure that the Java executable is defined in your environment variables: You can do this as follows:

...

a. Open the Console window (Command Prompt in Microsoft Windows or UNIX Shell window)

b. Run the java -version command. The result must be the version of the Java installed. For example: java version "1.6.0_22" If Java is installed and the above step fails, then you must define the Java executable in the MDM Info Collector startup script, as described in the next bullet (see Adding the path of the Java executable to the MDM Info Collector startup script).

Note If your system is able to recognize the Java executable:

Make sure that that Java version is 1.6.0.07 or higher. There is no need to define the Java executable path in the MDM Info Collector

startup script (as described in the next bullet). However, if you do define a path in the startup script, then note that the path in the startup script overrides the environment variable of your operating system.

Adding the path of the Java executable to the MDM Info Collector startup script: ...

a. Open the MDM_infoCollector directory in the deployed location. b. Depending on your operating system, edit the startup script file:

UNIX/Linux: run_unix

Windows: run_win.cmd c. For the JVM parameter, enter the full path to the directory where the Java executable is

located. For example: JVM=C:\Java\sapjvm_6\bin

d. Save and close the file.

3.2.2 Selecting the Graphical User Interface or Command Line Interface

The MDM Info Collector startup script determines whether to launch the graphical user interface (GUI) or the command line interface (CLI) of the tool. By default, the GUI is set for Windows and the CLI is set for UNIX/Linux. If you want to change the default setting, do the following: ...

1. Depending on your operating system, edit the startup script file: UNIX/Linux: run_unix Windows: run_win.cmd

2. Define the TOOL_INTERFACE parameter as follows: To use the GUI: TOOL_INTERFACE=gui To use the CLI: TOOL_INTERFACE=nogui

3. Save and close the file.


June 2011 7

3.2.3 Supporting Secure Sockets Layer (SSL) Protocol If the MDM listening mode is set to SSL (defined in the Listening Mode parameter in the mds.ini file), you need to perform the following steps. If your MDM is not configured to support SSL, then you can skip this step. ...

1. Make sure the client.pse and sapcrypto.dll files are located in your global share folder. For example (on Windows): c:\usr\sap\MDM\SYS\exe\uc\NTAMD64

2. In the clix.ini file (on Windows, this file should be located on the MDM machine in c:\usr\sap\MDM\MDS00\exe), set the SSL Lib Path=<sapcrypto.dll_location> parameter (where <sapcrypto.dll_location> is the full path to the sapcrypto.dll file). If this parameter is missing from the clix.ini file, then you must add it.


June 2011 8

4. Running the MDM Info Collector

4.1 General Usage Instructions Executing the MDM Info Collector The preferred ways to operate the MDM Info Collector tool are as follows:

Graphical user interface (GUI) Command line interface (CLI) using the input parameters file (input_params.ini)

Note It is possible to run the CLI without the input parameters file, and to supply the relevant parameters in the command line operation. However this is not recommended. For more information, see Running the Command Line Without the Input Parameters File on page 19.

SAP MMC The following table summarizes the tool interfaces and their main usage modes and launch methods. Follow the references for more information.

Tool Interface GUI(1) CLI(1) SAP MMC

Main usage Windows (local)(2) UNIX (local)(2) Remote execution (UNIX or Windows)(3)

How to launch the tool

Tool's startup script on MDM server machine (run_win.cmd file)

Tool's startup script(4) on MDM server machine (run_unix file)

SAP MMC (4) on local Windows PC

More information

Using the MDM Info Collector GUI (page 9)

Running the Command Line Interface (CLI) Startup Script with the Input Parameters File (page 11)

Remotely Running the Tool Using SAP MMC (page 12)

(1) For information about setting the default usage mode, see Selecting the Graphical User Interface or Command Line Interface on page 6.

(2) Local usage means that you directly execute the MDM Info Collector that is installed on the MDM server from which you want to collect information.

(3) By using SAP MMC, you can execute the MDM Info Collector that is installed on a remote MDM server machine. The local machine running SAP MMC is not the MDM server and must be running Windows.

(4) For SAP MMC and CLI with startup script usage, you should provide all your input parameters into the input_params.ini file, which must be located in the MDM_infoCollector directory.

Important Some of the information collected by the MDM Info Collector requires that the MDS is running when the tool is executed. For example, the tool runs various CLIX commands, which connect to a running MDM server, when creating a repository archive or when monitoring the MDS.


June 2011 9

Managing the Output Info Package After executing the tool, the result is a directory containing the output info package, which comprises the collected files that are compressed into ZIP file segments with the following name pattern: <SID>_<Instance_id>_<time_stamp>.part<segment_index>.zip

You can then send the info package to SAP Customer Support; for example, using one of the following options:

Attach it to an SAP customer message (SAP Notes allow multiple attachments, each one up to 4MB)

Upload using SAP Mail Attachment Service (SAPmats) (for each attachment, you need to have an upload area on SAPmats; contact SAP Customer Support for assistance)

Tip Check the size of the output info package. If the info package is very large, especially when including archive files, you should delete it or move it to a new location to save disk space.

4.2 Using the MDM Info Collector GUI ...

1. Log on to the machine where the relevant MDM server component is located, using the SAP system administration user (<SID>adm).

2. Open the MDM_infoCollector directory in the location where you deployed the tool (see Deploying and Setting Up the MDM Info Collector on page 5).

3. Run the relevant script file according to your operating system: UNIX/Linux: run_unix Windows: run_win.cmd

4. In the Connect to MDM Server dialog box, select the relevant MDM instance from the list of available instances that were detected by the tool in its SAP system directory. The MDM Info Collector window appears.


June 2011 10

Note All elements in the GUI apply to the MDS. If you are running the GUI on the MDIS

or the MDSS machines and they do not reside on the MDS machine, then the repository settings are not available.

The details of the selected MDM server component are displayed automatically. The host, TCP port, SID, and instance values are displayed in the GUI once the

tool is connected to the MDM instance. 5. Specify the failure date and time; you can enter a specific time or a time period.

For more information about this setting, see Failure Time on page 17. 6. (Optional) Specify if you want to collect information in relation to a specific repository that is

connected to the failure. We highly recommend that you specify a repository; this provides more accurate information and helps to improve and accelerate the problem analysis. If you choose a specific repository, then you can also do the following:

a. Choose whether you want to execute the verify (check) action on the repository.

Note We highly recommend that you execute the verify (check) action as it may provide important information that can help to improve and accelerate the problem analysis. The verify (check) action may consume a significant of amount system resources while running.

b. Choose whether you want to create a repository archive. Note

We highly recommend that you provide a repository archive as it may provide important information that can help to improve and accelerate the problem analysis. For more information about this option, see Create Repository Archive on page 17.

c. If the MDS is password-protected and you selected to execute a repository verify (check) or create a repository archive, enter the MDS password.

d. If you selected to execute a repository verify (check), enter the user name and password of the repository.

7. (Optional) If your failure is related to an MDM import issue, you can select Import Port. The MDM Info Collector will collect and package the relevant import source files from the MDM distributions directory.

8. (Optional) If you want to provide additional information, such as documents, screenshots, log files, and problem descriptions, specify the directory in which they are stored in the Attachments Directory field. The info package will include all files that are stored in this directory. For more information about this option, see Attachments Directory on page 18.

9. (Optional) If you do not want to use the default output directory for the info package, you can choose a custom output directory. The default directory is: /usr/sap/<SID>/MDM_infoCollector/InfoPack

10. Specify the maximum size (in megabytes) of each ZIP segment of the output info package. For more information about this option, see Size of Split Output Files on page 18.

11. Click Run to start collecting the information. You can follow the progress in the Execution Log pane. When the tool has completed, the status is updated in the Status area. The execution log is also stored in the Summary Report inside the info package.


June 2011 11

Note For UNIX/Linux, the GUI can be viewed only via X-Window that must be enabled on the UNIX/Linux machine.

4.3 Running the Command Line Interface (CLI) Startup Script with the Input Parameters File

This section describes how to execute the command line interface (CLI) of the MDM Info Collector using the tool's startup script with an input parameter file. This is intended for local execution of the tool on the MDM server machine. ...

1. Log on to the machine where the relevant MDM server component is located using the SAP system administration user (<SID>adm).

2. Open the MDM_infoCollector directory in the location where you installed the tool (see Deploying and Setting Up the MDM Info Collector on page 5).

3. Open the input_params.ini file in any text editor. 4. Define the following mandatory parameters in the input_params.ini file and set the

appropriate values, as needed:

MDM_INSTANCE_NUMBER The instance number of the MDM server component. For example, for C:\usr\sap\MDM\MDS00, set the parameter to: MDM_INSTANCE_NUMBER=00

FAILURE_START_TIME (FAILURE_END_TIME)

You can define either a specific time or a time period: To set a specific time of the failure, enter the date and time

in the FAILURE_START_TIME parameter in the format yyyy/MM/dd-HH:mm. Leave the parameter FAILURE_END_TIME empty.

To set a time period, enter the start date and time in the FAILURE_START_TIME parameter and the end date and time to the FAILURE_END_TIME parameter.

For more information about the failure time option, see Failure Time on page 17.

5. (Optional) You can set other parameters in the input_params.ini file, such as choosing a specific repository, executing a repository verify (check), and creating a repository archive. For more information, refer to the documentation in the input_params.ini file.

6. Run the relevant script file according to your operating system: UNIX/Linux: run_unix -paramsFile Windows: run_win.cmd -paramsFile

Note When the MDM Info Collector has finished, an execution log is displayed on the screen. The execution log is also stored in the Summary Report inside the info package.


June 2011 12

4.4 Remotely Running the Tool Using SAP MMC From SAP MMC on your local Windows machine, you can run the MDM Info Collector located on a remote MDM server machine, using the Create Server Side Snapshot functionality that exists in SAP MMC.

The remote machine is defined as the MDM server machine where the MDM Info Collector application files are deployed. The remote machine can be either Windows or UNIX/Linux.

The local machine is defined as the machine where SAP MMC is installed and executed from. The local machine must be Windows.

One of the benefits of using the remote execution option is that you can run the MDM Info Collector that is installed on a UNIX machine without any prior knowledge of UNIX commands. Also, you can run the MDM Info Collector tool even if you do not have direct access permission to the MDM machine (you will however need to provide the user name and password of the <SID>adm user in order to run the tool). The local SAP MMC runs the MDM Info Collector tool that is located on the remote MDM server machine. When you run the tool via SAP MMC, you use the GUI of SAP MMC—you will not see the MDM Info Collector GUI. The MDM Info Collector generates the info package on the MDM server. You can then choose to download it to your local machine when it is created or you can retrieve it (together with other stored snapshots) at a later time.

4.4.1 Preparation ...

1. On the remote MDM server machine, install SAP Instance Framework 720-Patch90 or higher. Note the following:

If you have installed MDM 7.1 SP07 Patch 07 or higher from scratch on a new machine or updated a previous SP, then you already have the required SAP instance framework and you can ignore this step.

If you have updated an existing MDM 7.1 installation to SP07 Patch 07, then run the MDM 7.1 SP07 Patch 07 installer and select the following options:

In the Choose Option Welcome to SAP NetWeaver Master Data Management (MDM) screen, choose SAP MDM Installation Additional Software Life-Cycle Options Update.

In the Define Parameters Update MDM Instances or SAP Instance Framework screen, choose Update SAP Instance Framework and complete the wizard.

If your MDM server is running MDM 7.1 SP03 to SP06, then either update to SP07 (as described in previous bullet) or download and install the supported version (or higher) of SAP instance framework. For more information about updating the SAP instance framework, see SAP Note 1324904. You can download the SAP instance framework from the SAP Software Download Center at http://service.sap.com/swdc Support Packages and Patches Browse our Download Catalog SAP NetWeaver and complementary products SAP MDM SAP NETWEAVER MDM 7.1 Entry by Component Master Data Server MDM INSTALLATION MASTER 7.1 <Relevant Platform> -> MDM 7.1 SP07 Patch 07 (or higher)




June 2011 13

Note After installing the new SAP instance framework on UNIX, you may receive a Permission denied error when you try to connect from SAP MMC. If this happens, navigate to the MDM executable directory and run the following commands:

chown root:sapsys sapuxuserchk chmod u+s,o-rwx sapuxuserchk

For more information, see SAP Note 927637. 2. On the MDM server machine, update the MDM profile files as follows:

If you have installed MDM 7.1 SP07 Patch 07 or higher from scratch on a new machine or updated a previous SP, then you already have the required MDM profile files and you can ignore this step.

If you have updated an existing MDM 7.1 installation to SP07 Patch 07, then run the MDM 7.1 SP07 Patch 07 installer and select the following options:

In the Choose Option Welcome to SAP NetWeaver Master Data Management (MDM) screen, choose SAP MDM Installation Additional Software Life-Cycle Options Update.

In the Define Parameters Update MDM Instances or SAP Instance Framework screen, choose Update MDM Instances and complete the wizard.

If your MDM server is running MDM 7.1 SP03 to SP06, then either update to SP07 (as described in previous bullet) or manually update the MDM instance profiles parameters in the profile files as described below (you need to do this for each instance from which you want to execute the tool remotely).

Note The MDM profile files can be found in the usr/sap/<SID>/SYS/profile directory. For example:

Windows: C:\usr\sap\MDM\SYS\profile UNIX: /usr/sap/MDM/SYS/profile

Edit the relevant file <SID>_<MDS_instance>_machine in any text editor (the file does not have an .ini extension), and add the following: For Windows:

# Maximum number of snapshots per instance, default 10

service/max_snapshots = 10

# Data collector command, default none

service/datcol_command = $(GLOBALHOSTPATH)$(SAPSYSTEMNAME)\MDM_infoCollector\run_win.cmd –s -i $(SAPSYSTEM)

# Data collector timeout, default 300 sec service/datcol_timeout = 3600

# Data collector mandatory part of snapshot, default 0

service/datcol_mandatory = 1

For UNIX/Linux: # Maximum number of snapshots per instance, default 10

service/max_snapshots = 10 # Data collector command, default none

service/datcol_command = /usr/sap/$(SAPSYSTEMNAME)/MDM_infoCollector/run_unix –s -i $(SAPSYSTEM)

# Data collector timeout, default 300 sec



June 2011 14

service/datcol_timeout = 3600

# Data collector mandatory part of snapshot, default 0 service/datcol_mandatory = 1

3. On your local Windows PC (not on the remote MDM server), install SAP MMC 7.20 patch 10 (version: 7200.90.*) or higher. You can obtain SAP MMC in one of the following ways:

Download the MDM 7.1 SP07 Patch 07 Windows installer (for download location, see previous step that discusses downloading the SAP instance framework), extract the contents, navigate to ...\SAPINSTANCE_UC_WINDOWS_X86_64\DBINDEP, and then run the sapmmcX64u.msi file.

Download SAP MMC from the SAP Software Download Center at http://service.sap.com/swdc Search for Software Downloads, (enter MMC as a search keyword).

4. You have checked that the MDM Info Collector is installed under the relevant SID that contains the MDM server component and that the JVM path is set correctly. For more information, see Deploying and Setting Up the MDM Info Collector on page 5.

Important The default maximum number of snapshots stored by SAP MMC on an MDM server machine is 10. If you pass this number, the oldest snapshot is automatically removed. You can change the default setting on the MDM server machine as follows:

i. Log on to the MDM server machine. ii. Open the MDM profile file, located in the

usr\sap\<SID>\SYS\profile\<SID_Instance_Machine> directory, in any text editor. For example (on Windows): C:\usr\sap\MDM\SYS\profile\MDM_MDS00_MyMachine

Note that the profile file does not have a file extension. iii. Change the value of the service/max_snapshots parameter, as needed

(default = 10).



June 2011 15

4.4.2 Running MDM Info Collector from Remote via SAP MMC Runnin g MD M Inf o Collec tor fro m Re mot e via SAP M MC...

1. Open SAP MMC on your local machine. 2. Locate the instance of the MDM server component from which you want to collect information.

If it does not exist, then you can add it; in the SAP Systems context menu, choose Properties, and then open the Fixed tab.

3. In the context menu of the instance, choose All Tasks Create Snapshot.

The Create MMC Snapshots dialog box appears:


June 2011 16

4. In the Create MMC Snapshot dialog box, do the following: a. Select the Server side snapshot creation option. b. (Optional) In the Description field, enter a description of the issue for easy identification

of the snapshot files that will be created (for example: No response from MDS during import).

c. (Optional) In the Collector Parameter field, specify relevant optional switch parameters as you would if you were running the tool via the command line. For more information, see Running the Command Line Without the Input Parameters File on page 19. Examples:

-paramsFile (use this option if you have defined all the parameters in the input_params.ini file that is located on the remote MDM server machine in the deployment directory of MDM Info Collector)

myrep;TLVN60188031A;s;admin; -a -c (this example shows how to manually enter command line input parameters and bypass the input_params.ini file)

Note When running the MDM Info Collector via SAP MMC, you do not enter the following mandatory parameters in the Collector Parameters field. You enter these later in the GUI of SAP MMC (see following steps):

MDM instance number (-i parameter) Date and timeframe (-t parameter)

d. Select the Local snapshot file checkbox and enter the desired output location of the information package on the local machine.

e. Under Logfile analysis in the Time Period area, specify the failure date and time period.

Important The time frame definition should be according to the remote MDM server machine and not according to the local SAP MMC machine. For more information, see Failure Time on page 17.

6. Click OK to execute the tool.

Note The execution log is also stored in the Summary Report inside the info package.

7. Retrieve the info package which is stored as an SAP MMC snapshot (see next section for instructions).

4.4.3 Retrieving SAP MMC Snapshots All snapshots generated by SAP MMC are stored in this location as a ZIP file on the remote MDM server: /usr/sap/<SID>/SYS/global/sapcontrol/snapshots

For example: Windows: C:\usr\sap\MDM\SYS\global\sapcontrol\snapshots UNIX: /usr/sap/MDM/SYS/global/sapcontrol/snapshots

In SAP MMC, open the context menu of the MDM instance and choose All Tasks Open Snapshot. Here you can do the following:

Select a snapshot and download it to your local machine from the MDM server machine Delete a snapshot


June 2011 17

4.5 Additional Information about MDM Info Collector Parameters

4.5.1 Failure Time The MDM Info Collector collects information relative to a specific date and time or a time period, which you specify in the GUI, input parameters file (input_params.ini), SAP MMC, or command line.

Note Entering a specific date and time is the preferred method. When using the specific

time option, the MDM Info Collector automatically adds a buffer of two days before and one day after the time you enter. Therefore you do not need to know the exact time a failure occurred.

Use the time period only in cases where you do not know the approximate date and the hour of the failure time. The maximum recommended time period is two days. The MDM Info Collector automatically adds a buffer of two days before and one day after the time period you enter.

The current time that is set on your machine may be different to the actual time of the time zone where you are located. Be sure to adjust the failure time so that it is synchronized with the time zone of the machine you are collecting information from.

4.5.2 Create Repository Archive The MDM Info Collector is able to create an MDM repository archive on user demand. We highly recommend that you supply a repository archive as it may provide important information that can help to improve and accelerate problem analysis. Note the following:

Archiving may consume a significant amount of system resources while running. To use this option, the MDS must be running when you run the tool. To use this option, the MDM repository must be mounted to the MDS when you run the tool. To save time and disk space, the tool excludes the repository binary large objects tables

(originals, thumbnails and variants). If you prefer to create an archive yourself, you can do so using the MDM Console or CLIX.


June 2011 18

4.5.3 Attachments Directory If you have additional information that can help SAP Customer Support to resolve your problem, you can include them as attachments by placing them in the designated attachments directory—MDM Info Collector will include them in the info package. You can use the default attachments directory or you can define a custom directory. The default attachments directory is: /usr/sap/<SID>/MDM_infoCollector/UserAttachments

Note After the info package is created, the attachment files are moved to a history

directory. The default history directory is: /usr/sap/<SID>/MDM_infoCollector/UserAttachments_History

If you specify a custom directory, then the contents of the directory will not be moved to a history directory.

If you specify a custom directory, you must ensure that the directory has read permissions for the <SID>adm user.

4.5.4 Size of Split Output Files The MDM Info Collector allows you to split the output ZIP info package to smaller segments to facilitate the uploading or sending of the info package to SAP.

Note The maximum size of each file that you can attach to an SAP customer message is 4MB (you can upload more than one file to an SAP customer message). For files that are larger than 4MB, you need to have an upload area on SAP Mail Attachment Service (SAPmats) for each attachment—contact SAP Customer Support for assistance.

If the total size of all the files is less than the segment size you entered, then no segmentation will take place. The default value is 180MB.


June 2011 19

5. Appendix

5.1 Running the Command Line Without the Input Parameters File

Generally, if you choose to use the MDM Info Collector command line interface, you should use the input parameter file (input_params.ini) file to pass parameters to the tool, as described in Running the Command Line Interface (CLI) Startup Script with the Input Parameters File on page 11. However, there are cases when you need to supply necessary parameters, such as the repository specification or create archive switch, with the command line. For example, when running the MDM Info Collector remotely via SAP MMC and you do not have access to the input parameter file or it is not configured according to your needs.

Command Line Usage (for Local Execution on the MDM Server Machine) Use of the MDM Info Collector command line requires the following input: java -jar .\bin\com.sap.mdm.tco.info.collector.jar -i <instance_number> -t <time_specification> [options]

Or:

<startup_script> -i <instance_number> -t <time_specification> [options]

Where: <startup_script> is run_unix for UNIX and run_win.cmd for Windows <instance_number> is the SAP instance number of an MDM server <time_specification> is either a specific time or a time range:

<single_datetime>

<start_datetime> <end_datetime>

where single_datetime, start_datetime, and end_datetime are entered in the format yyyy/MM/dd-HH:mm.

For a description of all the command line options and switches, see Command Line Options (for Local and Remote Execution) on page 20.

Note When using the command line, you must log on to the machine where the relevant MDS is located using the SAP system administration user (<SID>adm).

Basic example (for specific time):

C:\Java\sapjvm_6\bin\java.exe -jar ".\bin\com.sap.mdm.tco.info.collector.jar" –i 00 -t 2011/06/26-15:30

Example with additional parameters, including time range: C:\Java\sapjvm_6\bin\java.exe -jar ".\bin\com.sap.mdm.tco.info.collector.jar" –i 00 -t 2011/06/27-14:00 2010/10/27-15:30 -c -r myrep;TLVN60188031A;s;admin; -a -o c:\temp\infopack -z 4 -u C:\info_for_sap


June 2011 20

Command Line Usage with SAP MMC (for Remote Execution) You can run the MDM Info Collector command line without the input parameters file (input_params.ini) on a remote MDM server machine via SAP MMC on a local Windows machine. Enter the relevant parameters in SAP MMC in the Collector Parameter field. For example:

More information:

For a description of all the command line options and switches, see Command Line Options (for Local and Remote Execution) on page 20.

For a description about executing the command line from remote via SAP MMC with the input parameters file, see Remotely Running the Tool Using SAP MMC on page 12.

Command Line Options (for Local and Remote Execution) The section provides a reference of the parameters that you can use when running the command line interface directly on a local MDM server machine or from remote via SAP MMC.

Note You specify whether the parameters are provided by a parameters file or by a set of values that you pass to the MDM Info Collector tool. The usage syntax is:

Option 1: run_win.cmd -paramsFile The parameters file (input_params.ini) is located in the MDM_infoCollector directory. If you use this option, you cannot add any additional parameters in the command line since all the parameters are already defined in the parameters file.

Option 2: run_win.cmd -i <instance_number> -t <time_specification> [options] Refer to the switches and respective values in the table below.

Switch Value Description

-a[e] (optional) Specifies if you want to create a repository archive. e: Allows you to instruct the tool to separate the archive file from the output info package ZIP file.

Note This option is only available if the -r switch is provided with a

specific MDM repository. The MDS password is required if it is password-protected

(see -p switch)

To use this option, the MDS must be running when you run the tool.

For more information about this option, see Create Repository Archive on page 17.


June 2011 21


-c (optional) Specifies if you want to execute a repository verify (check).

Note This option is only available if the -r switch is provided with a

specific MDM repository. Repository user name and password must be provided (see -r switch).

MDS password is required if it is password-protected (see -p switch)

To use this option, the MDS must be running and the MDM repository must be mounted to MDS when you run the tool.

-dir <custom output location of info package>

(optional)

Specifies the output directory of the info package. If you omit this switch then the default output directory is used: /usr/sap/<SID>/MDM_infoCollector/InfoPack

-i <instance_number>

(Mandatory for command line. Not required when run from SAP MMC.)

Specifies the instance number of the MDS. The MDS is installed in the following directory: /usr/sap/<SID>/<InstanceID>, where <InstanceID> contains the instance number. For example: In the c:\usr\sap\MDM\MDS02 – directory, 02 is the instance number. Usage example: -i 02

-mp

<remote_system_code;port_code> (optional)

Specifies the remote system code and the port code of the MDM inbound port. Usage example: -mp mySys:MyPort

-p <MDS password> (optional)

Specifies the password of the MDS. Only required if all the following conditions apply:

Your MDS is password-protected You have chosen to execute a repository verify (check) (see -c switch) or to create an archive (see -a switch).

Usage example: -p mypswd


June 2011 22


-r <MDM repository>

(optional) Specifies if you want to collect information in relation to a specific repository. We highly recommend that you specify a repository as this helps to improve and accelerate problem analysis. Format: repository_name;DBMSHost;DBMSType[;RepositoryLogin;password]

Where: repository_name is the repository name as appears in mds.ini or in MDM Console

DBMSHost is one of the following values: Oracle_instance DB2_instance

MaxDB_Server_Hostname

SQL_ Server_Hostname

DBMSType is one of the following values: s - for SQL Server o - for Oracle m - for MaxDB d - for IBM DB2 i - for IBM DB2 for i5/OS z - for IBM DB2 for z/OS

RepositoryLogin and password are the user name and password of the repository, respectively. Only required if you choose to run a repository verify (check) (see -c switch)

Usage example: -r myrep;localhost;s;admin;mypswd

-s (optional) Specifies if you want to run the tool in an unattended silent mode. Any user interaction required by the tool is suppressed, and where possible, the tool uses default settings.

-t One of the following: <single_datetime> <start_datetime> <end_datetime>

(Mandatory for command line. Not required when run from SAP MMC.)

Specifies the date and time that the failure occurred. You can either enter a specific date and time or a date and time period. Information that is collected by the tool, such as log files, is collected in relation to the failure time. Format (local date and time of machine): yyyy/MM/dd-HH:mm

Usage examples: Setting a specific date and time: -t 2010/11/01-14:30 Setting a time period: -t 2010/11/01-10:00 2010/11/01-14:30

For more information about this parameter, see Failure Time on page 17.


June 2011 23


-u <root directory for additional attachments>

(optional)

Specifies the root directory where additional information, such as documents, screenshots, log files, and problem descriptions, is placed to be included in the info package. If you omit this switch then the default attachments directory is used: /usr/sap/<SID>/MDM_infoCollector/UserAttachments

Usage example: -u c:\info_for_sap

For more information about this option, see Attachments Directory on page 18.

-v

or -version

(optional) Displays the version of the tool and exits the tool.

-z <maximum size of output ZIP file segments (in megabytes)> (optional)

Specifies the maximum file size of ZIP segments if the total size of the output info package exceeds this value. Usage example: -z 4

For more information about this option, see Size of Split Output Files on page 18.

www.sdn.sap.com/irj/sdn/howtoguides

Date post:	24-Dec-2015
Category:	Documents
Upload:	danieljoseph-castillo
View:	46 times
Download:	11 times

MDM71 InfoCollector HowToGuide v2.1

Documents