How To…Generate XSD Schemas from Existing MDM Repositories · The default XSD File Name is...

16
SAP NetWeaver How-To Guide How To…Generate XSD Schemas from Existing MDM Repositories Applicable Releases: SAP NetWeaver MDM 7.1 Topic Area: Information Management Capability: Master Data Management Version 1.0 October 2009

Transcript of How To…Generate XSD Schemas from Existing MDM Repositories · The default XSD File Name is...

Page 1: How To…Generate XSD Schemas from Existing MDM Repositories · The default XSD File Name is “Schema” and if that needs to be changed, Enter the new name against the field XSD

SAP NetWeaver

How-To Guide

How To…Generate XSD Schemas

from Existing MDM Repositories

Applicable Releases:

SAP NetWeaver MDM 7.1

Topic Area:

Information Management

Capability:

Master Data Management

Version 1.0

October 2009

Page 2: How To…Generate XSD Schemas from Existing MDM Repositories · The default XSD File Name is “Schema” and if that needs to be changed, Enter the new name against the field XSD

© Copyright 2009 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.

Page 3: How To…Generate XSD Schemas from Existing MDM Repositories · The default XSD File Name is “Schema” and if that needs to be changed, Enter the new name against the field XSD

Document History

Document Version Description

1.00 First official release of this guide

Page 4: How To…Generate XSD Schemas from Existing MDM Repositories · The default XSD File Name is “Schema” and if that needs to be changed, Enter the new name against the field XSD

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

Page 5: How To…Generate XSD Schemas from Existing MDM Repositories · The default XSD File Name is “Schema” and if that needs to be changed, Enter the new name against the field XSD

Table of Contents

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

1.1 Use Cases ................................................................................................................ 1

1.2 Limitations ................................................................................................................ 1

2. Introduction ..................................................................................................................... 1

3. Step-by-Step Solution ..................................................................................................... 2

3.1 Extracting the plug-in and Installation ........................................................................ 2

3.2 Generating XSD from MDM 7.1 Repository ............................................................... 3

3.3 Exporting and Importing of the XSD into the MDM Console ....................................... 7

4. Appendix .......................................................................................................................... 9

4.1 Setting default values................................................................................................ 9

4.2 Supported Data Types ............................................................................................ 10

Page 6: How To…Generate XSD Schemas from Existing MDM Repositories · The default XSD File Name is “Schema” and if that needs to be changed, Enter the new name against the field XSD

How To…Generate XSD Schemas from Existing MDM Repositories

October 2009 1

1. Business Scenario

Very often implementation projects require standard Inbound and Outbound interfaces that are based

on MDM repository structures. In order to reduce the implementation effort it would be useful to have

the possibility of generating an XML Schema (XSD) from an existing repository. Since this functionality

is still not available for MDM 7.1, we explain in this guide how to generate an XSD from an existing

MDM 7.1 repository using an eclipse plug-in that is delivered along with the document.

This is a standard eclipse plug-in which could be integrated with the Development Environment/Editor

and it provides a visual representation of the structures that form the part of the interfaces. The plug-in

could be downloaded here.

1.1 Use Cases

The solution provided here is relevant for the development of customer specific repositories that must

be quickly and smoothly connected to an existing landscape via XML messaging.

1.2 Limitations

The tool is an eclipse plug-in and hence, Eclipse must be installed in the system for using the

tool. The plug-in would work with NetWeaver Developer Studio version 7.1 based on Eclipse 3.3

and upwards.

Mappings of the remote keys of attribute values work only if the key mappings are activated for

the respective attributes.

The solution provided here is applicable only for SAP NetWeaver MDM 7.1 repositories.

Please check Appendix for a list of the supported data types.

2. Introduction

In this how-to guide we present a solution that is based on the standard MDM XML-Repository

description, and a JAVA application that generates an XSD interface description from an available

MDM Repository.

The plug-in is delivered as a zip file. The plug-in needs to be stored in the plugins directory of SAP

NetWeaver Developer Studio. This plug-in could be used for generating the XSD and it also provides a

visual representation of the schema structure. It also enables the user to double click and navigate into

different components.

CAUTION

The delivered plug-in is used to generate an XSD file and the choice of its usage is totally at the discretion of the user. SAP does not provide any kind of support in using

this tool.

Page 7: How To…Generate XSD Schemas from Existing MDM Repositories · The default XSD File Name is “Schema” and if that needs to be changed, Enter the new name against the field XSD

How To…Generate XSD Schemas from Existing MDM Repositories

October 2009 2

3. Step-by-Step Solution

There are different steps to be followed for using the plug-in. The steps to install the plug-in and

generate the XSD file and then, importing into the MDM Console is explained below.

3.1 Extracting the plug-in and Installation

The delivered plug-in contains a jar file and 2 folders. The following steps explain how to install the

tool. ...

1. Extract the contents of the zip file into a folder in the local system.

2. Verify that a jar file (com.sap.nwrig.mdm.plugins_7.1.2.2.jar) and 2 folders

(com.sap.mdm.tech.mdm4j_1.0.0 and com.sap.mdm.schema_1.0.0) are present in the

extracted folder.

We need to copy the MDM Java APIs that is compatible with the MDM Server into the folder

com.sap.mdm.tech.mdm4j_1.0.0

Now the folders and the plug-in extracted from the rar file, along with the applicable Java APIs are

present in the extracted folder.

CAUTION

The default contents of the extracted folders should not be changed at all. The folder com.sap.mdm.tech.mdm4j_1.0.0 contains another folder META-INF with a meta file. The contents of this folder should not be changed at all as the functioning of the tool is based

on the information present in this file.

Note

When there is an upgrade of the MDM Server, the existing Java APIs (jar files) in the folder com.sap.mdm.tech.mdm4j_1.0.0 need to be replaced with the jar files

corresponding to the upgraded version.

Page 8: How To…Generate XSD Schemas from Existing MDM Repositories · The default XSD File Name is “Schema” and if that needs to be changed, Enter the new name against the field XSD

How To…Generate XSD Schemas from Existing MDM Repositories

October 2009 3

3. Copy the contents of the extracted folder to the plugins directory of SAP NetWeaver

Development Environment. Now the plugins directory contains the jar file and 2 folders – one of

them containing the MDM java APIs. (If the IDE is already running, it needs to be restarted for

being able to use the plug-in).

3.2 Generating XSD from MDM 7.1 Repository

We can generate the XSD file and also see a pictorial representation in the SAP NetWeaver

Developer studio. This is done as explained below. ...

1. Create a New Project in the development Environment. Fill in the Name of the Project and other

details and click on Finish.

Page 9: How To…Generate XSD Schemas from Existing MDM Repositories · The default XSD File Name is “Schema” and if that needs to be changed, Enter the new name against the field XSD

How To…Generate XSD Schemas from Existing MDM Repositories

October 2009 4

2. Create a folder inside the this project folder by right clicking on this project and then clicking on

New -> Folder. Select the parent folder, enter the name of the new folder and then click on

Finish.

3. Right click on this folder and select New -> Other. Locate “Mdm Wizards” and then Click on

“Generate XSD From Schema” under “Mdm Wizards”.

Page 10: How To…Generate XSD Schemas from Existing MDM Repositories · The default XSD File Name is “Schema” and if that needs to be changed, Enter the new name against the field XSD

How To…Generate XSD Schemas from Existing MDM Repositories

October 2009 5

4. Enter the MDM Server URL and click on the button “Refresh Connection”.

5. All the available repositories in the MDM Server are displayed in the “MDM Repository” drop

down. Select the MDM Repository when prompted and wait for a few seconds. Enter the

Repository user and password (incase the repository has a password). Click on “Refresh

Connection”.

Page 11: How To…Generate XSD Schemas from Existing MDM Repositories · The default XSD File Name is “Schema” and if that needs to be changed, Enter the new name against the field XSD

How To…Generate XSD Schemas from Existing MDM Repositories

October 2009 6

6. Select the Repository region when prompted and wait for a few seconds. The default XSD

File Name is “Schema” and if that needs to be changed, Enter the new name against the field

XSD file name. Click on “Next”.

7. Select the main tables in this screen for generating the XSD.

Page 12: How To…Generate XSD Schemas from Existing MDM Repositories · The default XSD File Name is “Schema” and if that needs to be changed, Enter the new name against the field XSD

How To…Generate XSD Schemas from Existing MDM Repositories

October 2009 7

8. Click on “Finish” button for generating the XSD file.

The XSD file is generated and visualization is provided on the screen. The “Elements” and “Types”

could be seen on the screen and it also provides forward navigation. We can see more details by

double-clicking on the respective elements.

3.3 Exporting and Importing of the XSD into the MDM

Console

We need to export the XSD generated in the previous step and this XSD needs to be imported into the

MDM Console. ...

1. Right click on the folder created in the previous steps and choose Export. Choose “File System”

as the option in the next screen. Click on “Next”.

Page 13: How To…Generate XSD Schemas from Existing MDM Repositories · The default XSD File Name is “Schema” and if that needs to be changed, Enter the new name against the field XSD

How To…Generate XSD Schemas from Existing MDM Repositories

October 2009 8

2. Click on the XSD file and also specify the target directory. Click on “Finish”.

In the destination directory, a folder would be created with the XSD file inside the folder.

The XSD file thus generated needs to be imported into the console for the specific MDM repository.

For achieving this, an Administrator needs to login to the MDM Console and add the file to the “XML

Schemas”.

The Schema description is used by the MDM Syndicator in the standard syndication process. More

details about this process and the MDM Syndicator could be accessed here at the help portal, under

Functional Components.

Page 14: How To…Generate XSD Schemas from Existing MDM Repositories · The default XSD File Name is “Schema” and if that needs to be changed, Enter the new name against the field XSD

How To…Generate XSD Schemas from Existing MDM Repositories

October 2009 9

4. Appendix

4.1 Setting default values

We can set default values for the server URL and the user. For this, navigate to Window ->

Preferences -> Mdm Client Preferences, in the eclipse editor.

We can save the default MDM Server URL and also the default MDM user in here.

Page 15: How To…Generate XSD Schemas from Existing MDM Repositories · The default XSD File Name is “Schema” and if that needs to be changed, Enter the new name against the field XSD

How To…Generate XSD Schemas from Existing MDM Repositories

October 2009 10

4.2 Supported Data Types

The Data Types supported by the XSD Generator tool is given in the table below.

MDM Type XSD Type Comments

Auto ID integer

Boolean xsd:boolean

Currency decimal

GM Time xsd:datetime

Html string Limited to 255 chars

Integer integer

Literal Date xsd:datetime

Literal Time xsd:datetime

Lookup [Flat] Complex type

Lookup [Flat] (multi-valued) array of Complex type table specific

Lookup [Hierarchy] Complex type

Lookup [Hierarchy] (multi-valued) array of Complex type table specific

Lookup [Qualified Flat] (multi-

valued)

Complex type

Lookup [Taxonomy] (multi-valued) Complex type table specific, including attributes

field

Lookup Ext. Binary Object not supported

Lookup Image not supported

Lookup PDF not supported

Measurement complex type Value type of Decimal

UOM type of string

Measurement (multi-valued) Array of Measurement

Measurement Single string No ISO code

Name Complex type

Real decimal

Text string Complex type for multilingual text

Text Block not supported

Text Large string

Text Normalized string Normalized

User Stamp string

Page 16: How To…Generate XSD Schemas from Existing MDM Repositories · The default XSD File Name is “Schema” and if that needs to be changed, Enter the new name against the field XSD

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