SAP Landscape Management 3.0, Enterprise Edition

Creating Provider Web Service

You use a predefined Web Services Description Language (WSDL) file to provide a web service interface for custom operations and custom notifications.

Context

You download the WSDL file from SAP Landscape Management when you configure a new web service provider definition as follows:

Procedure

  1. Choose Start of the navigation pathAutomation Studio Next navigation step Provider DefinitionsEnd of the navigation path.
  2. Choose Start of the navigation pathCreate Next navigation step Web ServiceEnd of the navigation path.
  3. Enter a name for the provider definition.
  4. Enter the URL for the provider definition.
  5. Optional: Enter a user name and password for testing the connection.

    If you have specified a user name or password, SAP Landscape Management uses the basic authentication method.

  6. Optional: Adjust the timeout in seconds.
  7. Choose Test Connection.
  8. Optional: To modify the script for updating custom properties of the current host, instance, or its parent system, select the Updates Custom Properties checkbox.

    The script returns the following line:

    • [RESULT]:Property:<property name>=<property value>
    • For system properties:

      [RESULT]:SystemProperty:<property name>=<property value>

    • For secure properties:

      [RESULT]:PropertySecure:<property name>=<property value> or [RESULT]:SystemPropertySecure:<property name>=<property value>

  9. Optional: To allow the HTML output of custom scripts, select the Allow HTML Output checkbox.

    You use HTML output for example, to display operation results with different colors or in table format. To use HTML output, use the following format:

    HtmlSectionBegin
    <HTML markup>
    HtmlSectionEnd

    Within a HTML section, you can use HTML markup, javascript will be filtered out.

  10. Define what your provider definition can be used for:
    • To use your provider definition for custom operations, select required entities in the Operation Uses section.
    • To use your provider definition for custom hooks, select the required entities in the Hook Uses section.
    • To use your provider definition for custom provisioning processes, select the Provisioning Replacement checkbox.
      The following additional parameters are also available:
      • SAP_LVM_TARGET_SID

        SAPSYSTEMNAME of the target system

      • SAP_LVM_TARGET_SYSTEM_ID

        SAP Landscape Management system ID of the target system

      • SAP_LVM_SRC_SID

        SAPSYSTEMNAME of the source system

      • SAP_LVM_SRC_SYSTEM_ID

        SAP Landscape Management system ID of the source system

      If you execute the operation on a source instance, you can access the parameters of the corresponding target instance, including custom properties, with the LVM_TARGET_ prefix.

      If you execute the operation on a target instance, you can access the parameters of the corresponding source instance, including custom properties, with the LVM_SRC_ prefix.

    • To use your provider definition for a custom notification, select the Notification checkbox.
    • To execute your provider definition to retrieve all possible values for a custom parameter, select the Parameter Supplier checkbox.

      The following output format is expected, each value in a new line:

      • [ID]: <Value ID>

      • [DESC]: <Description of the preceding ID>

      Only the ID of the selected value is passed as a custom parameter.

      For an example, see SAP Note 1936615 Information published on SAP site Dynamic Values for custom operations in SAP Landscape Management.

    • To execute your provider definition to receive all possible values for a custom parameter, select the Default Value Supplier checkbox.

      The following output format is expected, each value in a new line:

      • [DEFAULT_ID]: <ID of the value as used in the custom operation default replacement>

      • [DEFAULT_VALUE]: <Default value that should be used>

      For an example, see SAP Note 1936615 Information published on SAP site Dynamic Values for custom operations in SAP Landscape Management.

    If a custom operation or a custom hook has references to this provider definition, you cannot deselect the corresponding checkbox.

  11. Choose Create Provider.
  12. Choose the provider definition.
  13. On the General tab, choose Download WSDL.
  14. Save the WSDL file to a location of your choice.

Results

The following execute operations can be executed synchronously or asynchronously:

Execute Operation

Description

executeCustomOperations*

Operations for instances and hosts.

executeCustomHooks*

Hooks for instances and virtual hosts and an operation to get the results asynchronously.

getResults

Operations return a CustomOperationResult as return message.

All operations return a CustomOperationResult as return message.

Next Steps

Adding Parameters