Transcript

Registering Third-Party Systems in the System Landscape Directory

SAP Net Weaver 7.1Vers ion 1.0

Copyright Copyright 2008 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, Excel, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. IBM, DB2, DB2 Universal Database, System i, System i5, System p, System p5, System x, System z, System z10, System z9, z10, z9, iSeries, pSeries, xSeries, zSeries, eServer, z/VM, z/OS, i5/OS, S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise Server, PowerVM, Power Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPower, PowerPC, BatchPipes, BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2 Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX, Intelligent Miner, WebSphere, Netfinity, Tivoli and Informix are trademarks or registered trademarks of IBM Corporation. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. 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. SAP, R/3, xApps, xApp, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP Business ByDesign, 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.

(C) SAP AG

Registering Third-Party Systems in the SLD

2

Icons in Body TextIcon Meaning Caution Example Note Recommendation Syntax

Additional icons are used in SAP Library documentation to help you identify different types of information at a glance. For more information, see Help on Help General Information Classes and Information Classes for Business Information Warehouse on the first page of any version of SAP Library.

Typographic ConventionsType Style Example text Description 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 EXAMPLE TEXT Emphasized words or phrases in body text, graphic titles, and table titles. Technical names of system objects. These include report names, program names, transaction codes, table names, and key concepts of a programming language when they are surrounded by body text, for example, SELECT and INCLUDE. Output on the screen. This includes file and directory names and their paths, messages, names of variables and parameters, source text, and names of installation, upgrade and database tools. Exact user entry. These are words or characters that you enter in the system exactly as they appear in the documentation. Variable user entry. Angle brackets indicate that you replace these words and characters with appropriate entries to make entries in the system. Keys on the keyboard, for example, F2 or ENTER.

Example text

Example text

EXAMPLE TEXT

(C) SAP AG

Registering Third-Party Systems in the SLD

3

Registering Third-Party Systems in System Landscape Directory ........................5 Third-Party Systems Model Description ............................................................7 Registering Third-Party Systems.....................................................................11 Setting Up the Environment to Send Data ...................................................12 Testing the Registration of Third-Party Systems..........................................14 Defining Own Third-Party Products and Software Components in SLD and Export and Import Definitions.......................................................................15 Creating Your Own Data..............................................................................17 Transferring Your Data to sldreg..................................................................19 Appendix A: sldreg DTD..................................................................................20 Appendix B: XML Example..............................................................................23 Appendix C: XML Data Structure ....................................................................27 Appendix D: Mandatory Data Groups..............................................................34 Appendix E: Optional Data Groups .................................................................42 Appendix F: Key and Normal Properties of Classes........................................46 Appendix G: Overview of sldreg Command Line Parameters .........................52 Appendix H: Technical Notes on Using sldreg ................................................54 Appendix I: Supplying Data to the System Landscape Directory directly via HTTP...............................................................................................................55

(C) SAP AG

Registering Third-Party Systems in the SLD

4

Registering Third-Party Systems in System Landscape DirectoryThe System Landscape Directory (SLD) is a central repository of system landscape information that is relevant for the management of the software lifecycle. It contains a description of the system landscape, that is, the software components that are currently installed. The software components are installed on systems that form the entities that are visible to the administrator. An administrator must have knowledge about all the systems that are installed in the landscape and about the versions of the software components that are installed on these systems. This kind of information is stored in the SLD and is called Landscape Description (LD). SLD is also a repository of software components that can theoretically be installed in the landscape. This kind of information is stored in the SLD as Component Repository (CR). SLD data suppliers automatically register the systems on the SLD server and keep the system information up-to-date. They collect and send data about the systems to the SLD. For every newly-discovered system or component, the SLD creates an association to the corresponding entry in the Component Repository. Thus, SLD provides reliable and up-to-date system landscape information.

SLDLD1) B C 2) 2) 1)

SystemSLD Data Supplier

Software ComponentsD B C

CRA

B C

Figure 1: Automatic registration of systems and components For the SLD, applications that do not run on the SAP Application Server are thirdparty systems. Non-ABAP and non-Java SAP systems with unspecified characteristics fall into the same category. These systems register their current

(C) SAP AG

Registering Third-Party Systems in the SLD

5

system landscape data in the SLD using an external data supplier which uses the HTTP/HTTPS protocol.

Note This step is valid only for software solution providers (SSPs) certified by SAP. Besides the registration of the system, a description of your product and software component is required. These data are shipped independently of the installed systems at customer side. SAP collects all these data in a software catalog called PPMS. The PPMS data are shipped on a regular basis (see SAP note 669669). You need a PPMS entry to be visible in SAP Solution Manager. For a PPMS entry you need a contact person at SAP. You can request one from SAP Active Global Support. The registration procedure is typically triggered at startup time of the third-party system and optionally with a slow period (twice a day). Due to this approach, some runtime is required while a plug-in is called at startup. If your software does not have such an active part, the registration process needs to be called at least once during the installation or at every operating system startup. This guide describes in detail the registration of third-party systems in the SLD. In addition, a second guide provides quick description of the standard registration procedure for third-party systems in the SLD. The SLD receives data via the sldreg executable in XML format. This XML has to comply with the document type definition (DTD). This DTD must not be declared in the sent XML, it is validated by the SLD server only. More Information Appendix A: sldreg DTD Appendix C: XML Data Structure SAP Note 1018839

(C) SAP AG

Registering Third-Party Systems in the SLD

6

Third-Party Systems Model DescriptionBasic Third-Party System A simplified model describing a third-party system is shown in the figure below.

SAP_ComputerSystem 0..1SAP_ApplicationSystemHost

* SAP_ApplicationSystem * 0..1SAP_InstalledSWComponentOnApplicationSystem SAP_InstalledProductOnApplicationSystem

* * SAP_InstalledProduct * * SAP_InstalledSoftwareComponen t *SAP_SoftwareComponentType SAP_CollectedSoftwareComponent

*

SAP_InstalledProductImage

SLD CR Content 1 SAP_Product 0..1 SAP_SoftwareComponent

Figure 1: Model of a Third-Party System Each third-party system is an instance of the SAP_ApplicationSystem class. Other instances of SAP_ApplicationSystem are typically specializations (subclasses) of this class. Direct instances are either third-party systems or systems without specific properties modeled. The latter ones are called "unspecific systems" in this document. They are associated with a set of software components that are installed - different instances of the SAP_InstalledSoftwareComponent class. Each software component that is installed on an application system is part of one product that is installed. In most cases, a third-party system includes one software component that belongs to one product that is installed. However, the model also allows a more complicated case - a set of software components to be part of more than one product that is installed.

(C) SAP AG

Registering Third-Party Systems in the SLD

7

The SAP_Product and SAP_SoftwareComponent classes are included in the SLD CR. Unlike SAP products and components, third-party products and software components are not necessarily included in the CR. However, sldreg does not have authorization to create CR instances of third-party products and components. Only if these CR instances are created, sldreg does create the corresponding associations - SAP_SoftwareComponentType and SAP_InstalledProductImage. Therefore, the SLD CR Content for your software has to be either provided with the SAP CR content, or you have to create the third-party products and software components in the SLD yourself. Self-defined CR content can be exported and imported in any other SLD. The registration procedure of third-party systems includes the creation of one instance of the SAP_ApplicationSystem class, one or more instances of the SAP_InstalledSoftwareComponent class, one or more instances of the SAP_InstalledProduct class, and a basic instance of the SAP_ComputerSystem class. For more information, see the ThirdPartySystem.xml example under Registration of Third-Party Systems in SLD - Example Code at http://www.sdn.sap.com/irj/sdn/nw-sld. Optional: Third-Party System Using a Database A third-party system may use a database system. The figure below shows a simplified version of such a model. It covers all classes and associations that are additionally involved.

(C) SAP AG

Registering Third-Party Systems in the SLD

8

SAP_ComputerSystem 0..1SAP_ApplicationSystemHost

1

* SAP_ApplicationSystem *SAP_ApplicationSystemUsingDB SAP_DBInstanceHost

0..1 SAP_DatabaseSystem 1SAP_DBSystemInstance

1..* SAP_DatabaseInstance *

Figure 2: Model of Third-Party System Using a Database

In many cases you also have to register the database system in the SLD repository. This means that you have to create one instance of the SAP_DatabaseSystem class and at least one instance of the SAP_DatabaseInstance class. The model also requires that you associate each instance of the SAP_DatabaseInstance class with exactly one instance of the SAP_DatabaseSystem and the SAP_ComputerSystem classes. In many cases the computer system on which the instances of the SAP_DatabaseInstance class reside, can be different from the computer system on which the third-party system is installed. Thus, the data supplier must provide data about the computer system and host of the SAP_DatabaseInstance classes. For more information, see the ThirdPartySystem_extended.xml example under Registration of Third-Party Systems in SLD - Example Code at http://www.sdn.sap.com/irj/sdn/nw-sld. SAP Only: Support Package The following figure shows the UML part for an applied SAP Support Package associated to an installed software component.

(C) SAP AG

Registering Third-Party Systems in the SLD

9

SAP_ApplicationSystem 0..1SAP_InstalledSWComponentOnApplicationSystem SAP_InstalledSupportPackageSoftwareComponent

* 1 SAP_InstalledSoftwareComponent *SAP_SoftwareComponentType

SAP_InstalledSupportPackage * *SAP_SupportPackageType

SLD CR Content 0..1 SAP_SoftwareComponent 0..1 SAP_SupportPackage

Figure 3: Model of Third-Party System Using an Installed Support Package For SAP internal use, you need to specify an installed software component (SAP_InstalledSoftwareComponent) and an installed Support Package. To do so, create an instance of the SAP_InstalledSupportPackage class and associate this instance with the SAP_InstalledSupportPackageSoftwareComponent association class to the SAP_InstalledSoftwareComponent instance. If the Component Repository (CR) of the SLD contains the respective Support Package, the required association is created automatically. Note Make sure that the Name and Version properties of theSAP_InstalledSupportPackage exactly match the name and version of the

Support Package in the CR data. More Information SLD User Manual SAP NetWeaver 7.1 at http://www.sdn.sap.com/irj/sdn/nwsld

(C) SAP AG

Registering Third-Party Systems in the SLD

10

Registering Third-Party SystemsPrerequisites SLD as of SAP NetWeaver 2004s SPS07 or higher is installed. The SLD server is running. SLD has been configured to receive data. For more information, see the Post-Installation Guide of SAP NetWeaver 7.0 and the User Manual of your SAP NetWeaver version at http://www.sdn.sap.com/irj/sdn/nw-sld. You have a user assigned to the security role DataSupplierLD. Procedure To register third-party systems or unspecific SAP systems in the SLD, you perform the following steps: 1. Set up the environment to send data. For more information, see Setting Up the Environment to Send Data. 2. Test the registration of third-party systems. For more information, see Testing the Registration of Third-Party Systems. 3. Define your own third-party products and software components in SLD and export and import definitions. For more information, see Defining Own Third-Party Products and Software Components in SLD and Export and Import Definitions. 4. Create your own data. For more information, see Creating Your Own Data. 5. Transfer your data usingsldreg. For more information, see Transferring Your Data to sldreg.

(C) SAP AG

Registering Third-Party Systems in the SLD

11

Setting Up the Environment to Send DataThe sldreg executable and the required dynamic linked libraries (DLLs) are located in the directory :\usr\sap\\SYS\exe\run (UNIX: /usr/sap//SYS/exe/run) on the host on which the ABAP or J2EE-based system is installed. Procedure 1. Create a new working directory and set the executable and library path in the way that sldreg can be called. If you use the adm user, the environment is automatically set the right way. Alternatively, you can use the executable directory or a copy of it as a working directory. For more information, see SAP Note 733476. 2. To configure the SLD destination, execute the following command:o sldreg.exe -configure slddest.cfg -usekeyfile

You are prompted to enter the following HTTP connection information: User Name Password Server Host - the host on which the SLD server is running Port - the HTTP/HTTPS port on which the SLD server is running Use HTTPS Note This option is not available in SAP NetWeaver 7.0. You are asked whether you want the information to be written to the slddest.cfg file and the slddest.cfg.key file to be created. For security reasons, we recommend that you use the key file. Note The default location of the slddest.cfg and slddest.cfg.key files in an SAP installation is the :\usr\sap\\SYS\global directory. If the

(C) SAP AG

Registering Third-Party Systems in the SLD

12

configuration files have already been created by other applications, it is not necessary to create new files. The slddest.cfg file contains the encrypted HTTP connection information - user name, password, host, and HTTP/HTTPS port. The slddest.cfg.key file contains the key information that is used for encryption and decryption. You have to protect this file from unauthorized access. Set Read and Write permissions only for the adm user.o

If you do not want to be prompted for the HTTP connection information, execute the following command: sldreg.exe configure slddest.cfg -user -pass host -port -usekeyfile [-usehttps], the last parameter is not available in SAP NetWeaver 2004s.

More Information Appendix G: Overview of sldreg Command Line Parameters Appendix H: Technical Notes on Using sldreg.

(C) SAP AG

Registering Third-Party Systems in the SLD

13

Testing the Registration of Third-Party SystemsProcedure 1. Unzip the RegistrationThirdPartySystemExample.zip archive to your working directory. 2. To import the ExampleCRContent.xml file into your SLD to have needed data for testing purposes, on the SLD Welcome screen, choose Administration Import . 3. Transfer the XML example ThirdPartySystem.xml in one of the following ways:o

To transfer the XML data as a file using sldreg, copy the XML data from Appendix B: XML Example to a file or use example file from the archive. In the command line, execute the following command:sldreg -connectfile slddest.cfg -file ThirdPartySystem.xml

o

To transfer the XML data directly using sldreg and the standard input, execute the following command and proceed as described below:... | sldreg -connectfile slddest.cfg

1. Copy the XML data directly to the standard input. 2. To indicate the end of the input stream, press Ctrl+Z. Result When the data is registered in the SLD server, the HTTP response code is as follows:HTTP response: Success. HTTP status code: 200.

Note To view and remove details about the third-party system ExampleThirdPartySystem on examplehost that you have registered, on the SLD Welcome screen, choose Technical Systems Technical System Type Third Party (Release 7.0) or Other (...) (Release 7.10). To view any errors on the receiver side, on the SLD Welcome screen, choose Administration Log .

(C) SAP AG

Registering Third-Party Systems in the SLD

14

Defining Own Third-Party Products and Software Components in SLD and Export and Import DefinitionsNote This step is valid only for software solution providers (SSPs) certified by SAP. If you have a contact person at SAP, first the meta-data of your software has to be entered in the software catalog at SAP (called PPMS). The PPMS data shipped with SLD are regularly updated on the SAP Service Marketplace (SAP Note 669669). Only products that are part of the PPMS do appear in the SAP Solution Manager. Your SAP contact person sends back the product and software component identifiers to be used. Skip this step if your software meta-data is entered in SAP PPMS. Procedure 1. To create the third-party product and software component in the SLD, on the SLD Welcome screen, choose Home Products . Use capital letters for all names and dot-separated numbers for the versions. For all parameters, set the same values as the ones that you have defined in the environment settings (for more information, see Setting Up the Environment to Send Data). As a technical name of your software unit, you can set any value, for example, EXAMPLE_UNIT. For more information, see Creating and Removing Third-Party Products and Creating and Removing Third-Party Software Components in the User Manual - SLD of SAP NetWeaver at http://www.sdn.sap.com/irj/sdn/nw-sld. 2. The data that already exists in SLD is about products and software components entered in the SAP PPMS (vendor = sap.com). Choose a name and a version pattern that fits to the data coming from SAP. Avoid any name conflict with SAP products and software components to be able to migrate easily to PPMS later on. 3. From the Product dropdown box, select the product you have created. 4. From the table with product versions, select the product and choose Export. 5. Choose Download Link and save the file to a directory of your choice. Note

(C) SAP AG

Registering Third-Party Systems in the SLD

15

The ZIP file contains the instances of all classes that are related to one product version (the product and its software components). If you want to export the data about more than one product, you have to repeat the steps for each product. 6. Insure that product and component definitions are imported to all target SLD.

More Information Updating the Software Catalog in the User Manual - SLD of SAP NetWeaver at http://www.sdn.sap.com/irj/sdn/nw-sld.

(C) SAP AG

Registering Third-Party Systems in the SLD

16

Creating Your Own DataIf you already have defined third-party systems and software components in SLD and export and import definitions or if you have a contact person at SAP, the metadata of your software has first to be entered in the software catalog at SAP (called PPMS). The PPMS data shipped with SLD are regularly updated on the SAP Service Marketplace (SAP Note 669669). Only products that are part of the PPMS do appear in the SAP Solution Manager. Your SAP contact person sends back the product and software component identifiers to be used. More Information: Defining Own Third-Party Products and Software Components in SLD and Export and Import Definitions Prerequisites Java runtime environment 1.4 or higher has been installed. Procedure To create your own data, you can choose one of the following methods: Generating specific system XML from template: 1. Unzip the RegistrationThirdPartySystemExample.zip archive at http://www.sdn.sap.com/irj/sdn/nw-sld to your working directory. 2. Import the ExampleCRContent.xml file into your SLD. 3. Read the comments in the ThirdPartySystem.properties file and adapt this file afterwards to your specific data. 4. Call the ThirdPartySystemXMLGenerator Java class to generate the XML document that is required by sldreg by executing the following command:java com.sap.lcr.tools.xmlTools.ThirdPartySystemXMLGenerator

Examplejava com.sap.lcr.tools.xmlTools.ThirdPartySystemXMLGenerator . ThirdPartySystem.properties ThirdPartySystem.template . ThirdPartySystem.xml

Creating your own specific system XML: 1. The example archive Appendix B: XML Example contains a template and a properties file. To obtain the resulting

(C) SAP AG

Registering Third-Party Systems in the SLD

17

ThirdPartySystem.xml (also contained in the archive) replace the placeholders in the template file with specific values.

Placeholders are, for example, ${ComputerName} or ${LocalSystemName} and they are described in the properties file. More information: Appendix C: XML Data Structure, Appendix D: Mandatory Data Groups, and Appendix E: Optional Data Groups. 2. Create your XML data. Specify the appropriate values of the properties for each instance. More information: Appendix F: Key and Normal Properties of the Classes. 3. Test your XML data by transferring to the SLD. More information: Transferring Your Data to sldreg. 4. To check that no errors had occurred, on the SLD Welcome screen, choose Administration Log . 5. To check that all expected instances are created, on the SLD Welcome screen, choose CIM Instances (Release 7.10) or Administration Content Maintenance (Release 7.0).

(C) SAP AG

Registering Third-Party Systems in the SLD

18

Transferring Your Data to sldregProcedure 1. Transfer your data to sldreg when you start your application, and periodically, for example, twice a day. If this is not possible, the next best alternative is the registration at operating system startup. The absolute minimum is the registration during the installation and upgrade of the system. 2. Use the XML document you produced while creating your own data as template and substitute the hostname string therein at runtime. Alternatively, you may create the XML document from scratch in your software and transfer the document to sldreg via stdout or stdin or file. The value of the host name has to be set dynamically in any case. 3. Provide the additional software, template, and documentation that your customers may need to successfully register your system in the SLD.

(C) SAP AG

Registering Third-Party Systems in the SLD

19

Appendix A: sldreg DTD

#REQUIRED #REQUIRED #IMPLIED #IMPLIED

(C) SAP AG

Registering Third-Party Systems in the SLD

20

(TRUE|FALSE) (TRUE|FALSE) (TRUE|FALSE) (NONE|LONE|ALL)

#REQUIRED "FALSE" "TRUE" "TRUE" "NONE"

(C) SAP AG

Registering Third-Party Systems in the SLD

22

Appendix B: XML Example SAP_ApplicationSystem ExampleThirdPartySystem.SystemHome.examplehost ExampleThirdPartySystem on examplehost SAP_ComputerSystem examplehost examplehost SAP_ApplicationSystem ExampleThirdPartySystem.SystemHome.examplehost

(C) SAP AG

Registering Third-Party Systems in the SLD

23

EXAMPLE_ISC 3 0 123.456 EXAMPLE_ISC 123.456, ExampleThirdPartySystem on examplehost 0 EXAMPLE_PRODUCT example.com 456.789 ExampleThirdPartySystem.SystemHome.examplehost EXAMPLE_PRODUCT, Version 123.456 EXAMPLE_ISC 3 0

(C) SAP AG

Registering Third-Party Systems in the SLD

24

123.456 SAP_ApplicationSystem ExampleThirdPartySystem.SystemHome.examplehost EXAMPLE_ISC 3 0 123.456 EXAMPLE_ISC 123.456 example.com 0

(C) SAP AG

Registering Third-Party Systems in the SLD

25

0 EXAMPLE_PRODUCT example.com 456.789 ExampleThirdPartySystem.SystemHome.examplehost 0 EXAMPLE_PRODUCT example.com 456.789

(C) SAP AG

Registering Third-Party Systems in the SLD

26

Appendix C: XML Data StructureAccording to the sldreg.dtd (see Appendix A: sldreg DTD), the building elements of the XML data are the following: Attributes of the Element supplier_name This is the unique name of the data supplier that is used. The standard registration procedure, provided by SAP for third-party systems, sets the attribute to ThirdPartySystem. supplier_vendor Set the attribute to sap.com, because the feature is provided by SAP. supplier_version Specifies the version of the data supplier that is used. Set the attribute to 1.0. model_version Specifies the model version that is required. Set the attribute to 1.4.30 or higher. Attributes of the Element The element is used to separate the data into logical units. The groups are processed in the order in which they appear. Each element has the following attributes: name All groups that are included in the element must have a unique name. We recommend that you use meaningful group names and, thus, provide information about the purpose of the group. group_type Always set the attribute to GENERIC. Attributes of the and Elements Each group contains one element and one or more elements. The element always includes only one element. The element can include an arbitrary number of elements. Both elements, and , have the following attribute:

(C) SAP AG

Registering Third-Party Systems in the SLD

27

name Specifies the exact CIM class name of the corresponding instance(s). For more information, see Third-Party Systems Model Description. The only instance of the element is associated with the instances of the elements. An association between the instances is defined by the following attributes of the element: association_name Specifies the class name of the association. root_role Specifies the role of the root class in the association. member_role Specifies the role of the member class in the association. Both elements, and , have the following attributes that manage the synchronization with the current state of the SLD server: sync This attribute allows you to synchronize the instances with the state of the SLD server. To improve performance, only set the sync attribute to TRUE in the first group in which an instance is included. In the other groups in which the instance is used, set the sync attribute to FALSE. merge_properties The properties of an instance can be key and normal. The key properties clearly identify the instances of a class. The normal properties are optional. We recommend that you include normal properties only if the instance is synchronized. Many classes and their instances have the Caption normal property. This property is a short description of the instance and has a maximum length of 64 characters. We recommend that you always set the Caption normal property for every instance with this property. The merge_properties attribute handles the additional properties that are not provided by the data supplier. Note that the merge_properties attribute does not take effect if the instance is not synchronized, that is, if you set the sync attribute to FALSE.

(C) SAP AG

Registering Third-Party Systems in the SLD

28

If you set the merge_properties attribute to TRUE, the values of all additional properties of the instance(s) in the SLD repository remain unchanged. If you set the attribute to FALSE, all values of the properties that are not specified are deleted. merge_roots and merge_members These attributes are similar. They specify how the existing associations are treated. The merge_roots attribute is used with the element, whereas the merge_members attribute is used with the element. To keep the associations that exist in the SLD repository, set both attributes to TRUE. Sometimes, however, you have to set these attributes to FALSE. For example, if a instance can be associated with only one instance, set the merge_roots attribute to FALSE. mergeRootClass, mergeMemberClass and mergeAssocClass These attributes are used with the element. Use mergeRootClass filter parameter (in association traversal) for the root class to determine the set of instances that are evaluated for member merging. For example, this value can be used to filter for a super class of the root class instead. If no value is specified, the class name of the root instance is used. mergeMemberClass and mergeAssocClass are analogous to mergeRootClass for the member class or the association class. Examples with Detailed Explanations

Class1

0..1 Association1

*

Class2

Figure 3: Association with Restricted Cardinality Figure 3 above shows two classes - Class1 and Class2. The association, Association1, introduces the relation between these classes. It also shows that the association has a restricted cardinality on the side of Class1. Thus each

(C) SAP AG

Registering Third-Party Systems in the SLD

29

instance of Class2 can be associated with only one instance of Class1. You have to observe the restricted cardinality by correctly setting the merge_roots and merge_members attributes in the group in which these associations are established.Let us assume that Class1 is a and Class2 is a of the group. The instances can be more than one. To observe the restricted cardinality, you have to set the merge_roots attribute to FALSE. Thus, all existing associations between the corresponding instances and any instance of Class1 are deleted. Let us assume that the group includes one instance of Class2, Class2_Inst1, which is already associated with one instance of Class1, Class1_Old. To ensure that the instance of Class2 cannot be associated with a second instance of Class1, you have to set the merge_roots attribute to FALSE. Thus, the existing association, Association1_Old, is deleted. If the instance that is specified is Class1_Old, the association is created again every time. If, however, the instance that is specified is different from Class1_Old, for example, it is Class1_New as it is shown in figure 4 below, the obsolete association is deleted and replaced with a new association every time. In both cases, if you set the merge_roots attribute to FALSE, you observe the restricted cardinality.

Memberclass instance Association1_Old Class1_Old Class2_Inst1

Association1_New Class1_New

Figure 4: Usage of the merge_roots Attribute to Observe the Restricted Cardinality If the instance must be related to only one instance of the element, you have to set the merge_members attribute to FALSE. We recommend that you have exactly one instance in the group. The usage of the merge_roots and merge_members attributes to observe the maximum value of the cardinality is a rare case. The more common case is when the instances are an arbitrary number and they form the full set of instances that must be associated with a instance. In this case, any existing associations with the instances that are not included in

(C) SAP AG

Registering Third-Party Systems in the SLD

30

this set are considered obsolete and, therefore, unnecessary. To delete them, you have to set the merge_members attribute to FALSE. This case is shown in figure 5 below:

Rootclass instance Association1_Inst2 Class1_Inst1 Class2_Inst2

Association1_Inst1

Association1_Inst3 Class2_Inst3

Class2_Inst1 Outdated Memberclass instance

Figure 5: Usage of the merge_members Attribute to Provide the Full Set of Instances Figure 5 above shows the state of the SLD repository after new data is sent by sldreg. Let us suppose that the instance, Class1_Inst1, has been initially associated with two instances, Class2_Inst1 and Class2_Inst2. Sometimes the SLD repository might be outdated and, therefore, has to be updated. For example, if the Class1_Inst1 instance has to be associated only with the Class2_Inst2 and Class2_Inst3 instances, the Class2_Inst1 instance becomes outdated and the association to it has to be deleted. Therefore, you have to set the merge_members attribute to FALSE. Thus, the existing associations, Association1_Inst1 and Association1_Inst2, are deleted. The association, Association1_Inst2, between Class1_Inst1 and Class2_Inst2 is created again. The association between Class1_Inst1 and Class2_Inst3 is created for the first time. As a result, the following rules apply: If the instance that is specified must be the only instance that is associated with each instance that is specified, you have to set the merge_roots attribute to FALSE.

(C) SAP AG

Registering Third-Party Systems in the SLD

31

If the set of instances that is specified forms the full set of instances that must be associated with a instance that is specified, you have to set the merge_members attribute to FALSE. clean Handles the instances which have been previously associated and which are not specified anymore. These instances are called lost instances. In figure 5 above, Class2_Inst1 is a lost instance. The clean attribute has the following possible values:NONE

If you set the attribute to NONE, all lost instances remain in the SLD repository. This case is shown in figure 5 above.LONE

If you set the attribute to LONE, all lost instances, which do not have any remaining associations after data processing, are deleted. Only the isolated lost instances are deleted. In figure 5 above, Class2_Inst1 is presented as an isolated lost instance, because it remains without any associations, after the deletion of the Association1_Inst1 association. To delete the isolated lost instance Class2_Inst1, you have to set the clean attribute to LONE. The result is shown in figure 6 below:

Rootclass instance Association1_Inst2 Class1_Inst1 Class2_Inst2

Association1_Inst1 Association1_Inst3 Class2_Inst3

Class2_Inst1 Outdated Memberclass instance

Figure 6: Usage of the merge_members Attribute and clean = LONEALL

(C) SAP AG

Registering Third-Party Systems in the SLD

32

If you set the attribute to ALL, all lost instances in the SLD repository, both those that are still associated to other instances and those that are not, are deleted. If the lost instances are not isolated, all their existing associations are implicitly deleted. In figure 7 below, the Class2_Inst1 instance is not isolated, because after the obsolete association Association1_Inst1 is deleted, an association to one instance of the OtherClass_Inst1 class still exists. In this case, the only way to delete the Class2_Inst1 instance and all its remaining associations is to set the clean attribute to ALL. The result is shown in figure 7 below:

Rootclass instance Association1_Inst2 Class1_Inst1 Class2_Inst2

Association1_Inst1 Association1_Inst3 Class2_Inst3

Class2_Inst1

OtherAssociation_Inst1 OtherClass_Inst1

Outdated Memberclass instance

Figure 7: Usage of the merge_members Attribute and clean = ALL Note Note that the clean attribute only takes effect if you set the corresponding merge_roots and merge_members attributes to FALSE.

(C) SAP AG

Registering Third-Party Systems in the SLD

33

Appendix D: Mandatory Data Groups

This section describes only the data groups that are mandatory to specify a thirdparty or unspecified SAP system. The approach that is applied is called "from inside to outside". The core class of the model is the SAP_ApplicationSystem class. An inner class is a class that is closer to the core class. To apply the "from inside to outside" approach means to use the "inner" class as a element and the "outer" class as a element. SystemHost Group Use this group to specify the instance of the SAP_ApplicationSystem class. This instance represents the third-party system which is described. The group also registers the instance of the SAP_ComputerSystem class, which is used as a host of the third-party system. The dependency between both instances, the SAP_ApplicationSystemHost association, is also created. Structure of the Group The element includes an instance of the SAP_ApplicationSystem class. You have to fully describe and synchronize it with the SLD repository. The element includes one instance of the SAP_ComputerSystem class. The computer system can already be registered by the data supplier of the J2EE Engine. It is possible, however, that the data supplier is not configured on the host. You only have to specify the key properties and the Caption normal property of the instance. For more information about the key and normal properties of all classes, see Appendix F: Key and Normal Properties of the Classes. Attributes of the Element Set the name attribute to SAP_ApplicationSystem. Set the sync attribute to TRUE, because this is the first group in which the instance is included. You can update the normal properties of a third-party system which is already registered. You have to specify the key properties and the Caption normal property. Set the merge_properties attribute to TRUE to keep the values of the normal properties that are set in the SLD repository and that are not specified in the group. Set the merge_roots attribute to TRUE, because many application systems can be installed on one computer system.

(C) SAP AG

Registering Third-Party Systems in the SLD

34

Set the clean attribute to NONE, because there are no lost instances of the SAP_ApplicationSystem class that have to be deleted. Attributes of the Element Set the name attribute to SAP_ComputerSystem. Set the association_name attribute to SAP_ApplicationSystemHost. Set the root_role attribute to Dependent. Set the member_role attribute to Antecedent. Set the sync attribute to TRUE to register the instance if the data supplier is not configured on this host. Set the merge_properties attribute to TRUE to synchronize the instance with a property merge. Set the merge_members attribute to FALSE, because the model allows each third-party system to be dependent only on one computer system. Set the clean attribute to LONE to delete an isolated computer system that is not specified in this group, but which may exist, from the SLD repository. InstalledSoftwareComponents Use this group to specify all software components that are installed and associated with the third-party system which is described. The software components that are included in this group are the full set of components that are installed on the third-party system. Use the group also to create a set of associations between the software components that are installed and the thirdparty system which is described, that is, associations of type SAP_InstalledSWComponentOnApplicationSystem. Structure of the Group The element includes the instance of SAP_ApplicationSystem, which is already described and synchronized in the previous group. To identify this instance, you have to set only its key properties. The element includes one or more instances of the SAP_InstalledSoftwareComponent class. They appear for the first time and, therefore, you have to fully describe and synchronize them in this group. Besides the key properties, you have to specify some normal properties and the Caption normal property.

(C) SAP AG

Registering Third-Party Systems in the SLD

35

Attributes of the Element Set the name attribute to SAP_ApplicationSystem. Set the sync attribute to FALSE, because the instance is already synchronized with the SLD repository in the previous group. Use the default value, TRUE, of the merge_properties attribute, which, however, does not take effect if the sync attribute is set to FALSE. Set the merge_roots attribute to FALSE, because each software component that is installed can be installed only on one application system. If obsolete associations to other application systems exist, you have to delete them. Set the clean attribute to NONE, because you do not have to delete any instances of the SAP_ApplicationSystem class. Attributes of the Element Set the name attribute to SAP_InstalledSoftwareComponent. Set the association_name attribute toSAP_InstalledSWComponentOnApplicationSystem.

Set the root_role attribute to System. Set the member_role attribute to Software. Set the sync attribute to TRUE to register in the SLD all software components that are installed. Set the merge_properties attribute to TRUE to synchronize the instances with a property merge. Set the merge_members attribute to FALSE, because the set of software components that are installed is the full set of components that are associated with the third-party system. You have to delete any software components which have been previously installed and which are not included in this set. Set the clean attribute to ALL to delete from the SLD repository all obsolete software components that are installed. InstalledProduct Usually all software components that are installed belong to only one product that is installed. However, software components that are installed can belong to several products that are installed. Even if each software component that is installed is part of only one product that is installed, if you apply the "from inside to outside" approach, you can have many groups. For example, if N software

(C) SAP AG

Registering Third-Party Systems in the SLD

36

components that are installed belong to one product that is installed, the number of groups is N. You can reduce the number of groups, if you revert the and elements. This is an intentional violation of the "from inside to outside" approach. Then many groups of this type appear only if the software components that are installed belong to several products that are installed. In the simplest case when only one software component that is installed exists, we recommend that you apply the "from inside to outside" approach. Use the group(s) to register all products that are installed. Use the group(s) to create a set of associations of type SAP_CollectedSoftwareComponents, which specify the membership of the software components that are installed to the corresponding products that are installed. Structure of the Group The element includes an instance of SAP_InstalledProduct class, which you have to fully describe and synchronize in this group. The first element includes one or more instances of the SAP_InstalledSoftwareComponent class. These instances are already synchronized with the SLD repository in the previous group. You have to specify only their key properties. The second element includes the instance of SAP_ApplicationSystem, which is already described and synchronized in the previous group. To identify this instance, you have to set only its key properties. Attributes of the Element Set the name attribute to SAP_InstalledProduct. Set the sync attribute to TRUE because this is the first group in which the instance is included. Set the merge_properties attribute to TRUE to keep the values of the normal properties that are set in the SLD repository and that are not specified in the group. Set the merge_roots attribute to FALSE, because each software component that is installed can be part of only one product that is installed. If obsolete associations to other products that are installed exist, you have to delete them. Set the clean attribute to NONE, because you can delete the obsolete instances of the SAP_InstalledProduct class only in the SLD. For more information, see Cleaning Up Data in SLD User Manual at http://www.sdn.sap.com/irj/sdn/nw-sld.

(C) SAP AG

Registering Third-Party Systems in the SLD

37

Attributes of the first Element Set the name attribute to SAP_InstalledSoftwareComponent. Set the association_name attribute to SAP_CollectedSoftwareComponents. Set the root_role attribute to Collection. Set the member_role attribute to Member. Set the sync attribute to FALSE, because the instances are already synchronized with the SLD repository in the previous group. Use the default value, TRUE, of the merge_properties attribute, which, however, does not take effect, if the sync attribute is set to FALSE. Set the merge_members attribute to FALSE, because the set of software components that are installed is the full set of components that are associated with a product that is installed. Set the clean attribute to NONE, because the obsolete software components that are installed are deleted from the SLD repository in the previous group. Attributes of the second Element Set the name attribute to SAP_ApplicationSystem. Set the sync attribute to FALSE, because the instance is already synchronized with the SLD repository in the previous group. Use the default value, TRUE, of the merge_properties attribute, which, however, does not take effect if the sync attribute is set to FALSE. Set the merge_roots attribute to FALSE, because each software component that is installed can be installed only on one application system. If obsolete associations to other application systems exist, you have to delete them. Set the clean attribute to NONE, because you do not have to delete any instances of the SAP_ApplicationSystem class. InstalledSoftwareComponentToComponentRepository The number of the groups of this type is N, where N is the number of the software components that are installed. Use the group(s) to establish an association between a software component that is installed on the third-party system which is described and the corresponding software component that is registered in the SLD repository.

(C) SAP AG

Registering Third-Party Systems in the SLD

38

Structure of the Group The element includes one of the instances of the SAP_InstalledSoftwareComponent class, which is already specified in the previous groups. The element includes the corresponding instance of the SAP_SoftwareComponent class which belongs to the CR. Only if this instance does exist in the CR, the association of type SAP_SoftwareComponentType can be established. To identify the instance of the SAP_SoftwareComponent class, you have to specify only its key properties. Attributes of the Element Set the name attribute to SAP_InstalledSoftwareComponent. Set the sync attribute to FALSE, because you use the group only to establish an association between two existing instances. Use the default value, TRUE, of the merge_properties attribute, which, however, does not take effect, if the sync attribute is set to FALSE. Set the merge_roots attribute to TRUE, because each software component from the CR can be represented by many software components that are installed. So all existing components of the same type that are installed have to remain in the SLD repository. Set the clean attribute to NONE, because the obsolete instances of the SAP_InstalledSoftwareComponent class are deleted in another group. Attributes of the Element Set the name attribute to SAP_SoftwareComponent. Set the association_name attribute to SAP_SoftwareComponentType. Set the root_role attribute to Dependent. Set the member_role attribute to Antecedent. Set the sync attribute to FALSE, because the instance must be present in the CR of the SLD server. Use the default value, TRUE, of the merge_properties attribute, which, however, does not take effect, if the sync attribute is set to FALSE.

(C) SAP AG

Registering Third-Party Systems in the SLD

39

Set the merge_members attribute to FALSE, because each software component that is installed can be associated with only one software component that is registered in the CR. Set the clean attribute to NONE, because sldreg does not have authorization to delete instances of third-party products and components from the SLD CR.

InstalledProductToComponentRepository The number of groups of this type is N, where N is the number of products that are installed. Use the group(s) to establish an association between a product that is installed and the corresponding product that is registered in the SLD CR. Structure of the Group The element includes one of the instances of the SAP_InstalledProduct class that is already specified in the previous groups. The element includes the corresponding instance of the SAP_Product class that belongs to the CR. Only if this instance does exist in the CR, the association of type SAP_InstalledProductImage can be established. To identify the instance of the SAP_Product class, you have to specify only its key properties. Attributes of the Element Set the name attribute to SAP_InstalledProduct. Set the sync attribute to FALSE, because you use the group only to establish an association between two existing instances. Use the default value, TRUE, of the merge_properties attribute, which, however, does not take effect, if the sync attribute is set to FALSE. Set the merge_roots to TRUE, because each product that is registered in the CR can be represented by many products that are installed. So all existing products of the same type that are installed have to remain in the SLD repository. Set the clean attribute to NONE, because you can delete the obsolete instances of the SAP_InstalledProduct class only in the SLD.

(C) SAP AG

Registering Third-Party Systems in the SLD

40

Attributes of the Element Set the name attribute to SAP_Product. Set the association_name attribute to SAP_InstalledProductImage. Set the root_role attribute to Collection. Set the member_role attribute to Product. Set the sync attribute to FALSE because the instance must be present in the SLD CR. Use the default value, TRUE, of the merge_properties attribute, which, however, does not take effect, if the sync attribute is set to FALSE. Set the merge_members attribute to FALSE, because each product that is installed can be associated with only one product from the CR. Set the clean attribute to NONE, because sldreg does not have authorization to delete instances of third-party products and components from the SLD CR.

(C) SAP AG

Registering Third-Party Systems in the SLD

41

Appendix E: Optional Data GroupsUse the optional groups after the mandatory groups only if a third-party system depends on a database system. DatabaseSystem Group Use the group to create a dependency for a third-party system on a database system because the database system also has to be registered in the SLD repository. Structure of the Group The element includes the instance which represents the third-party system that is descibed. This instance is fully specified in the previous groups and, therefore, you only have to set its key properties. The element includes an instance of the SAP_DatabaseSystem class. You have to fully describe and synchronize this instance in this group. Besides the key properties, you can also set some normal properties. You have to add the Caption normal property. For more information about the key properties and normal properties of all classes, see Appendix F: Key and Normal Properties of the Classes. Attributes of the Element Set the name attribute to SAP_ApplicationSystem. Set the sync attribute to FALSE because the instance is synchronized in another group. Use the default value TRUE of the merge_properties attribute, which, however, does not take effect, if the sync attribute is set to FALSE. Set the merge_roots attribute to TRUE because many application systems might depend on the same database system. Set the clean attribute to NONE, so that obsolete application systems do not appear after data processing. Attributes of the Element Set the name attribute to SAP_DatabaseSystem. Set the association_name attribute to SAP_ApplicationSystemUsingDB. Set the root_role attribute to Dependent. Set the member_role attribute to Antecedent. (C) SAP AG Registering Third-Party Systems in the SLD 42

Set the sync attribute to TRUE to register a new database system or update an existing one. Set the merge_properties attribute to TRUE to keep the values of the normal properties that are set in the SLD repository and that are not specified in the group. Set the merge_members attribute to FALSE because each third-party system only depends on one database system. Set the clean attribute to ALL to delete an obsolete database system from the SLD repository, if it appears after data processing. DatabaseInstances Group Use the group to register all database instances that are attached to a given database system. The database instances that are included in this group are the full set of database instances that are associated with the database system. Use the group also to create a set of associations of type SAP_DBSystemInstance between the database system and the corresponding database instances that belong to it. Structure of the Group The element includes the instance of the SAP_DatabaseSystem class which is described and synchronized in the previous group. To identify this instance, you only have to set its key properties. The element includes one or more instances of the SAP_DatabaseInstance class. They appear for the first time here and, therefore, you have to fully specify them in this group. Besides the key properties and the Caption normal property, you have to set some additional normal properties, the values of which form the different parts of the Name key property. Attributes of the Element Set the name attribute to SAP_DatabaseSystem. Set the sync attribute to FALSE because the instance is already synchronized in the previous group. Use the default value TRUE of the merge_properties attribute, which, however, does not take effect, if the sync attribute is set to FALSE. Set the merge_roots attribute to FALSE because each database instance can be attached to only one database system. Set the clean attribute to NONE because in the previous group it is already set to delete an obsolete database system, if it appears after data processing. (C) SAP AG Registering Third-Party Systems in the SLD 43

Attributes of the Element Set the name attribute to SAP_DatabaseInstance. Set the association_name attribute to SAP_DBSystemInstance. Set the root_role attribute to GroupComponent. Set the member_role attribute to PartComponent. Set the sync attribute to TRUE to register all database instances in the SLD repository. Set the merge_properties attribute to TRUE to keep the values of the normal properties that are set in the SLD repository and that are not specified in the group. Set the merge_members attribute to FALSE, because the set of database instances is the full set of instances that are part of the database system. Set the clean attribute to NONE, because you can only remove the obsolete database instances in the SLD. For more information, see Cleaning Up Data in SLD User Manual SAP NetWeaver 2004s. DatabaseInstanceHost Group is the number of the database instance. The number of groups of this type is N, where N is the number of the database instances. Use the group(s) to register the host of a particular database instance and also to establish an association between the database instance and the corresponding host system, that is, an association of type SAP_DBInstanceHost. Structure of the Group The element includes one of the instances of the SAP_DatabaseInstance class which is already specified in the previous group. To identify this instance, you only have to set its key properties. The element includes an instance of the SAP_ComputerSystem class which is used as the host of the database instance. The computer system can differ for the various database instances and can differ from the computer system on which the third-party system is installed. Therefore, you have to set the key properties and the Caption normal property and you have to synchronize the instance. Attributes of the Element Set the name attribute to SAP_DatabaseInstance.

(C) SAP AG

Registering Third-Party Systems in the SLD

44

Set the sync attribute to FALSE because the instance is already synchronized in the previous group. Use the default value TRUE of the merge_properties attribute, which, however, does not take effect, if the sync attribute is set to FALSE. Set the merge_roots attribute to TRUE because many database instances can reside on the same computer system. Set the clean attribute to NONE because no obsolete database instances can appear after the data processing in this group. Attributes of the Element Set the name attribute to SAP_ComputerSystem. Set the association_name attribute to SAP_DBInstanceHost. Set the root_role attribute to Dependent. Set the member_role attribute to Antecedent. Set the sync attribute to TRUE to register the computer system. Set the merge_properties attribute to TRUE to keep the values of the normal properties that are set in the SLD repository and that are not specified in the group. Set the merge_members attribute to FALSE because the database instance only depends on one computer system. Set the clean attribute to NONE because the obsolete computer system, if it appears after data processing, can only be removed in the SLD.

(C) SAP AG

Registering Third-Party Systems in the SLD

45

Appendix F: Key and Normal Properties of ClassesKey Properties SAP_ApplicationSystem ClassCreationClassName

The name of the class for which you create instances. The correct value in this case is SAP_ApplicationSystem.Name

A compound string which is formed using the following pattern: ... The first part is the internal name of the application system, for example, ExampleThirdPartySystem. Each system which is installed is associated with one main computer system. The name of this computer system is used in the second part to guarantee different systems names. You have to replace with the constant SystemHome, and with the name of the corresponding computer system, which is also known as a host name. By default, host names in the SLD are written in lower case without any network domain, for example ExampleHostname.sap.corp is written examplehostname. As a result, the value of the Name property can be: ExampleThirdPartySystem.SystemHome.examplehostname. SAP_ComputerSystem ClassCreationClassName

The name of the class for which you create instances. The correct value in this case is SAP_ComputerSystem.Name

A unique identifier for the computer system. You can use any type of network name. It must be unique in the system landscape otherwise the network cannot work. By default, host names in the SLD are written in lower case without any network domain. For example ExampleHostname.sap.corp is written as examplehostname. This means that you have to use different SLD for network domains which have name conflicts at this level. SAP_InstalledSoftwareComponent ClassName

(C) SAP AG

Registering Third-Party Systems in the SLD

46

Has the same value as the Name key property of the corresponding SAP_SoftwareComponent instance, for example, EXAMPLE_ISC. You can see the key properties of the SAP_SoftwareComponent class below.SoftwareElementID

Identifies the different software components on a system. It is a 128-bit MD5hash value and is generated by the SLD. Note This key property is automatically generated. The SLD calculates its value using the key properties of the instance and the associated system. End of the note.SoftwareElementState

The only possible value for a software component that is installed on an application system is 3 and means that the state is RUNNING.TargetOperatingSystem

Specifies the operating system environment of the software component. We recommend that you set its value to 0.Version

Has exactly the same value as the Version key property of the corresponding instance of the SAP_SoftwareComponent class, for example, 1.2.0C. Note According to the Common Information Model (CIM) standard, you can add further properties such as the BuildNumber property, which is a string with 64 characters. SAP_InstalledProduct ClassCollectionID

A 128-bit GUID which distinguishes installed products of the same type. Note This key property is automatically generated. The SLD calculates its value using the other key properties of the instance.ProductIdentifyingNumber (numeric type value)

(C) SAP AG

Registering Third-Party Systems in the SLD

47

This key property is propagated from the corresponding SAP_Product instance. It identifies SAP products. Third-party products might not have this number. For third-party products, use the default value 0.ProductName

This key property is propagated from the corresponding SAP_Product instance and is an abbreviation of the product name. The value must exactly match the value of the Name property of the associated SAP_Product instance, for example, Example_Product.ProductVendor

This key property is propagated from the corresponding SAP_Product instance and is the name of the software vendor. We recommend that you use the vendor's name as a URL to avoid naming conflicts. The value of ProductVendor must exactly match the value of the Vendor property of the associated SAP_Product instance, for example, example.com.ProductVersion

This key property is propagated from the corresponding SAP_Product instance and is a version identifier of the product. The value of the property includes alphanumeric characters which are separated by dots (.). The value must exactly match the value of the Version property of the associated SAP_Product instance, for example, 1.2.0C.SystemID

The value of this key property is the same as the value of the Name property of the SAP_ApplicationSystem instance, for example, ExampleThirdPartySystem.SystemHome.examplehostname. The system must be additionally associated with the product that is installed. The installed products are associated indirectly with a third-party system by associations of type SAP_InstalledSWComponentOnApplicationSystem between the system and the software components that are installed. SAP_SoftwareComponent ClassName

An abbreviation of the software component name, written in upper case, for example, EXAMPLE_ISC.Version

A version identifier of the software component. The value of the property includes alphanumeric characters, which are separated by dots (.), for example, 1.2.0C.

(C) SAP AG

Registering Third-Party Systems in the SLD

48

Vendor

The name of the software vendor as a URL, for example, example.com.ElementTypeID

A vendor-specific ID for this software component. Set the value to 0 for each third-party software component. SAP_Product ClassIdentifyingNumber

Identifies SAP products. Third-party products might not have this number. For third-party products, use the default value 0.Name

An abbreviation of the product's name, for example, Example_Product.Vendor

The name of the software vendor. We recommend that you use the vendor's name as a URL to avoid naming conflicts, for example, example.com.Version

A version identifier of the product. The value of the property includes alphanumeric characters, which are separated by dots (.), for example, 1.2.0C. SAP_DatabaseSystem ClassCreationClassName

The name of the class for which you create instances. The correct value in this case is SAP_DatabaseSystem.Name

The name of the database system is formed as a compound name like the names of the other system classes. The first part is the internal database name, for example, ExampleDBSystem. The internal database name has to be a value of the DBName normal property. The second part consists of two pairs of .. The first pair concerns the DBTypeForSAP normal property, which specifies the type of the database system, and the second pair concerns the SystemHome normal property, which specifies a computer name for this database. The normal properties of the SAP_DatabaseSystem class are described below. As a result, the

(C) SAP AG

Registering Third-Party Systems in the SLD

49

value of this property would be:ExampleDBSystem.DBTypeForSAP.SAP.SystemHome.exampledbhost.

SAP_DatabaseInstance ClassCreationClassName

The name of the class for which you create instances. The correct value in this case is SAP_DatabaseInstance.Name

The name of the database instance is formed as a compound name in the same way as the Name property of the corresponding SAP_DatabaseSystem instance. If the database system includes only one database instance, the Name key property of the SAP_DatabaseSystem and SAP_DatabaseInstance instances can be identical. For example, both of them can be: ExampleDBSystem.DBTypeForSAP.SAP.SystemHome.exampledbhost. If more than one database instance exists, only the first part of the name varies for the different database instances, for example, you can replace ExampleDBSystem with ExampleDBSystemInstance1, ExampleDBSystemInstance2, and so on. Normal Properties You can specify normal properties for all classes except for the SAP_Product and SAP_SoftwareComponent, which are classes from the SLD CR. All other classes have the following common normal properties that have the same meaning:Caption

A short textual description of the object with a maximum length of 64 characters. We recommend that you set the Caption normal property for all instances.Description

A textual description of the object with no length restriction. Besides the common normal properties, some classes can have the following normal properties, which you can set or update: SAP_InstalledSoftwareComponent ClassVendor

A string value which must be exactly the same as the value of the Vendor property of the associated SAP_SoftwareComponent instance.

(C) SAP AG

Registering Third-Party Systems in the SLD

50

InstallType

A string value which specifies the way in which the first version of the software component has been installed. The correct value is Other.UpdateType

A string value which specifies the way in which this software element has been updated. The correct value is Other. SAP_InstalledProduct ClassName

An alias for the installed product. This alias may change over time. The maximum length of the alias is 256 characters.InstallType

A string value which specifies the way in which the first version of the product was installed. The correct value is Other. SAP_DatabaseSystem ClassDBName

The internal name of the database system. Its value is the first part of the compound value of the Name key property.DBTypeForSAP

A three-character abbreviation for the database type. It is used as part of the value of the Name key property. The possible values are: ORA, MSS, DB2, DB4, DB6, SAP, ADA, and INF.Manufacturer

The official manufacturer of the database. The possible values are: Oracle, Microsoft, IBM, Informix, SAP, and Unknown.SystemHome

Specifies the name of the main computer for the database system. The property forms the last component of the value of the Name key property. By default, host names in the SLD are written in lower case without any network domain, for example ExampleHostname.sap.corp is written examplehostname.

(C) SAP AG

Registering Third-Party Systems in the SLD

51

Appendix G: Overview of sldreg Command Line ParametersThe following tables offer an overview of the sldreg command line parameters. Data Parameters Parameter[-file ]

Description This parameter is optional. It specifies the XML file that contains the transfer data. If it is not specified, the registration program uses the standard input instead. This parameter is optional. This is the default setting for the data input when no input file is set. If this option is specified, it overrides the file setting.

[-stdin]

This parameter is optional. If it is specified, the XML file that is transferred to the SLD is structured in accordance with an [older DTD. Only use this parameter if you want to transfer data oldtransferdtd] for an SLD of a release lower than 2004s or if you are using the SAPOSCOL as a data source. HTTP Connection Parameters Parameter Description Specifies the file that contains the encrypted HTTP user, password, host, and port information. The data encryption standard (DES) is used to encrypt the HTTP connection information. Specifies the J2EE user for the HTTP connection. You can use this parameter as an alternative to specifying the HTTP connection parameters in a file. This parameter is optional. Specifies the password of the J2EE user for the HTTP connection. If it is not specified, the program uses an empty string. Specifies the host on which the HTTP connection is established. Specifies the number of the port on which the HTTP connection is established.

-connectfile

-user

[-pass ]

-host

-port

(C) SAP AG

Registering Third-Party Systems in the SLD

52

Note You can specify either a connection file or a valid set of HTTP user, password, host and port information. If you specify both, the connection file has priority over the set of HTTP information. Configuration Parameters Parameter Description This parameter starts the configuration of the connection file. The connection information is encrypted and is stored in the file you specify and you can use it in future together with the -connectfile parameter. You have to use this parameter once to save the connection information to a file.

-configure

This parameter is optional. You can only use it in combination with the -configure parameter. If you use this parameter, the system does not use a fixed internal DES key to encrypt the data, but a randomly generated key instead. The key is automatically stored [together with the file that contains the connection data. The name usekeyfile] of this KEY file is created using a combination of the name of the connection parameter file and a KEY file extension. You also have to use this parameter if you set up an HTTP connection and if you want to specify the key for an external file. Additional Parameters Parameters -help -datatrace -httptrace -logfile

Description Displays help information. Activates a full data trace. Activates a trace for the HTTP connection. Specifies the log file to which the program writes outputs, in addition to the standard outputs. By default, the file is named stdout.

Note If you specify an unknown parameter, it is ignored.

(C) SAP AG

Registering Third-Party Systems in the SLD

53

Appendix H: Technical Notes on Using sldregThe sldreg program is only a wrapper for the sldreglib. dynamic link library (DLL). Note that the actual library extension depends on the operating system (OS) platform that you are using. sldreglib is not the only DLL that is required by the sldreg registration program. The list of DLLs that are required includes the following files: SLD registration library: sldreglib. SAP STL port library: sapcpp46. SAP XML parser library: xml63d. Depending on the OS platform, the system searches for the DLLs in the following ways: Microsoft Windows The system searches for the DLLs in the following order: 1. Directory of the sldreg executable. 2. Current working directory. 3. Microsoft Windows system directory, which is specified in the system properties by the windir\system32 environment variable. 4. Microsoft Windows directory, which is specified in the system properties by the windir environment variable. 5. Directories which are specified in the system properties as search directories by the Path environment variable. The individual directory names are separated by a semicolon (;). AIX, HP Tru64 UNIX The directories which contain the DLLs are specified by the LIBPATH environment variable. The individual directory names are separated by a colon (:). Other UNIX systems The directories which contain the DLLs are specified by the LD_LIBRARY_PATH environment variable. The individual directory names are separated by a colon (:).

(C) SAP AG

Registering Third-Party Systems in the SLD

54

Appendix I: Supplying Data to the System Landscape Directory directly via HTTPThe System Landscape Directory (SLD) provides a generic HTTP servlet to process data sent by data suppliers. The servlet is used by the executable sldreg, for example. This chapter describes how you can send data to SLD as a data supplier using any HTTP client in any programming language. Note Readers are expected to be familiar with the HTTP protocol (RFC 2616).2 HTTP Request

A data supplier request sent to SLD must fulfill the following requirements: 1. Send an HTTP POST request to the URL http://:/sld/ds. Alternatively HTTPS can be used if the AS Java is configured accordingly. 2. Specify header Authorization using basic authentication. The specified user must at least have J2EE security role DataSupplierLD. For a typical installation this can be achieved by assigning the user to group SAP_SLD_DATA_SUPPLIER. If the AS Java is configured accordingly, a different authentication scheme may be used, for example certificate-based authentication for HTTPS. 3. Specify header dsxmlversion with value 2.0. 4. Specify header Content-Type with value application/xml; charset=utf8. Recommendation Optionally you may want to specify header User-Agent to identify your data supplier. 5. Add valid SLD data supplier XML encoded in UTF-8 as message body to your POST request (specifying additional HTTP headers appropriate for your transfer coding such as header Content-Length.) Note Additional HTTP headers (Accept headers, for example) may be specified, but are ignored by the server currently.

(C) SAP AG

Registering Third-Party Systems in the SLD

55

3 HTTP Response

If your request is accepted by the server, an HTTP response with response code 200 will be returned. Note Response code 200 does not indicate that your request has been processed successfully. It only indicates that your request has been parsed and queued for (asynchronous) processing. Whether data has been written successfully or not, can be checked with a WBEM client asynchronously only. Your request may be rejected for various reasons. In such a case typical return codes are as follows:400 Bad Request: For example, your XML may be invalid or was sent in

other encoding than UTF-8.401 Unauthorized or 403 Forbidden: You have not specific valid

authentication data or the specified user does not have the necessary permission to supply data to SLD.503 Service Unavailable: The SLD application is not active on the target

server. Note Starting with SAP NetWeaver 7.10, the next major SAP NetWeaver release, any response will include header Server with value SLD/ Bridge where "version" indicates the version of the SLD server (the lowest SLD server version setting this response header is 7.10.115). By checking this response header you can assure that the request has been sent to the correct URL.

(C) SAP AG

Registering Third-Party Systems in the SLD

56


Top Related