Scribd Logo
Upload

Welcome to Scribd!

  • 300 views

    DRM Api

    Uploaded by

    javvadh
    The Data Relationship Management Web Service API is the public interface for remotely interacting with the Data Relationship Management server. This SOAP-based web service can be used for product integration or to develop custom Data Relationship Management applications or clients. The API does NOT have services to cover the maintenance of these objects.

    Copyright:

    Attribution Non-Commercial (BY-NC)
    Download as PDF, TXT or read online from Scribd

    DRM Api

    Uploaded by

    javvadh
    300 views3 pages
    The Data Relationship Management Web Service API is the public interface for remotely interacting with the Data Relationship Management server. This SOAP-based web service can be used for product integration or to develop custom Data Relationship Management applications or clients. The API does NOT have services to cover the maintenance of these objects.

    Original Title

    drm_api

    Copyright

    © Attribution Non-Commercial (BY-NC)

    Available Formats

    PDF, TXT or read online from Scribd

    Did you find this document useful?

    Is this content inappropriate?

    The Data Relationship Management Web Service API is the public interface for remotely interacting with the Data Relationship Management server. This SOAP-based web service can be used for product integration or to develop custom Data Relationship Management applications or clients. The API does NOT have services to cover the maintenance of these objects.

    Copyright:

    Attribution Non-Commercial (BY-NC)
    Download as PDF, TXT or read online from Scribd
    Download as pdf or txt
    300 views3 pages

    DRM Api

    Uploaded by

    javvadh
    The Data Relationship Management Web Service API is the public interface for remotely interacting with the Data Relationship Management server. This SOAP-based web service can be used for product integration or to develop custom Data Relationship Management applications or clients. The API does NOT have services to cover the maintenance of these objects.

    Copyright:

    Attribution Non-Commercial (BY-NC)
    Download as PDF, TXT or read online from Scribd
    Download as pdf or txt
    of 3

    Oracle® Hyperion Data Relationship Management, Fusion Edition

    Release 11.1.2.0.00

    Web Service API Developer's Guide


    Overview............................................................................................................................... 1
    API Interface ........................................................................................................................ 2
    Prerequisites ......................................................................................................................... 2
    Security................................................................................................................................. 2
    Using the Data Relationship Management Web Service API .................................................. 3
    Using JDeveloper to Create a Web Service Client .................................................................. 3

    Overview
    The Data Relationship Management Web Service Application Programming Interface is the public
    interface for remotely interacting with the Data Relationship Management Server. This SOAP-based
    web service can be used for product integration or to develop custom Data Relationship Management
    applications or clients.

    Data Relationship Management Features

    The Data Relationship Management Web Service API contains most of the functionality available in the
    user interface. The services can be broken down into three major categories:

    • Master Data Objects - Include Versions, Hierarchies, Nodes, and Properties. The Data
    Relationship Management Web Service API includes a complete set of interfaces to create,
    retrieve, maintain, and save these objects. Each object has a standard set of services along
    with services specialized for that object type.

    • User Metadata Objects - Include Imports, Blenders, Queries, Compares, Exports, Books, and
    Action Scripts. The Web Service API includes services for retrieving, editing, running, and
    interrogating the results of these objects.

    • System Metadata and Security Objects - Objects that the administrator develops as part of
    the implementation and used by the Data Relationship Management server to determine how it
    will function and who can access which features and data. These objects include Property
    Definitions and Categories, Node Types, System Preferences, External Connections, Users and
    Node Access Groups. The Data Relationship Management Web Service API does NOT have
    services to cover the maintenance of these objects. Any need to create, view, edit, or delete
    these objects will need to be done through the appropriate forms of the Data Relationship
    Management user interface.
    API Interface
    The Web Service's interface is defined by a WSDL document. The Web Service is implemented in Java
    and is deployed to the Oracle WebLogic Application Server as a J2EE Web Application.

    This document assumes you have a working knowledge of:

    • Web Services

    • WSDL

    • XML

    • XML Schema (XSD)

    • SOAP

    For additional information on Web Services, see Oracle Fusion Middleware Introducing Web Services
    11g Release 1.

    See the Data Relationship Management Installation Guide for details on the requirements and
    deployment procedures for the Data Relationship Management Web Service API.

    Prerequisites
    The Data Relationship Management Web Service must be deployed to an Oracle WebLogic 11g Release
    1 server as described in the Data Relationship Management Installation Guide.

    Security
    It is vitally important to use HTTPS/SSL for web service communications to keep information passed in
    the web service calls secure. If HTTPS/SSL is not used, all information passed in the web service call
    will be in clear text, including the information passed in the SOAP header (which includes the Data
    Relationship Management username and password). HTTPS/SSL must be used for both the Data
    Relationship Management Web Service deployed on WebLogic as well as the Data Relationship
    Management API Adapter. See the section "Installing and Configuring the Data Relationship
    Management Web Service API" in the Data Relationship Management Installation Guide for details on
    how to configure the Web Service and the API Adapter for HTTPS/SSL. For additional information on
    Web Service Security on WebLogic, see
    http://download.oracle.com/docs/cd/E12839_01/web.1111/e13713/overview.htm#insertedID0.

    Each web service call should be made using the HTTPS protocol. Also, the URL value contained in the
    DrmConnectInfo.serverUrl should be specified with the HTTPS protocol. For example: https://[DRM
    hostname]:5240/Oracle/APIAdapter should be used for the DrmConnectInfo.serverUrl value.
    Using the Data Relationship Management Web Service API
    The interface for the Data Relationship Management Web Service API is defined by its WSDL
    document. To view the WSDL document, see:
    http://download.oracle.com/docs/cd/E12839_01/apirefs.1111/e13952/taskhelp/webservices/ViewWsdl
    .html.

    The Data Relationship Management Web Service is stateless. Each web service call executes within its
    own Data Relationship Management session. A new session is created at the beginning of the call and
    closed at the end of the call.

    Connection and authentication information must be passed in the soap header of each web service call
    in the form of a DrmSoapHeader. The DrmSoapHeader contains the information needed to connect to
    Data Relationship Management. The contents of the DrmSoapHeader are described below:

    • DrmConnectInfo.serverUrl: the URL pointing to DRM's ApiAdapter. For example: http://[DRM


    Hostname]:[DRM ApiAdapter port (5240 by default)]/Oracle/Drm/APIAdapter.

    • DrmConnectInfo.sessionParams: Typically: "ProductVersion=11.1.2"

    • DrmConnectInfo.authInfo.username: Data Relationship Management username

    • DrmConnectInfo.authInfo.password: Data Relationship Management password

    To test a web service using the WebLogic Administration Console, see:

    http://download.oracle.com/docs/cd/E12839_01/apirefs.1111/e13952/taskhelp/webservices/TestAWe
    bService.html

    Using JDeveloper to Create a Web Service Client


    If you are using JDeveloper to develop a Java-based client, refer to the following sections in
    JDeveloper's online help: "Using Existing Web Services in Applications" and "Creating Web Service
    Proxies".

    Copyright © 2010, Oracle and / or its affiliates. All rights reserved.


    http://www.oracle.com

    You might also like