+ All Categories
Home > Documents > Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship...

Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship...

Date post: 21-Apr-2020
Category:
Upload: others
View: 10 times
Download: 0 times
Share this document with a friend
42
Oracle® Data Relationship Management Oracle® Data Relationship Steward Oracle® Data Relationship Management for Oracle Hyperion Enterprise Planning Suite Oracle® Data Relationship Management for Oracle Hyperion Financial Close Suite Oracle® Data Relationship Management Read Only Access Oracle® Data Relationship Governance Oracle® Data Relationship Management Analytics API Guide Release 11.1.2.4.330 Updated: March 2016
Transcript
Page 1: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Oracle® Data Relationship ManagementOracle® Data Relationship StewardOracle® Data Relationship Management for Oracle Hyperion Enterprise PlanningSuiteOracle® Data Relationship Management for Oracle Hyperion Financial Close SuiteOracle® Data Relationship Management Read Only AccessOracle® Data Relationship GovernanceOracle® Data Relationship Management Analytics

API Guide

Release 11.1.2.4.330

Updated: March 2016

Page 2: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Data Relationship Management API Guide, 11.1.2.4.330

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

Authors: EPM Information Development Team

This software and related documentation are provided under a license agreement containing restrictions on use anddisclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement orallowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit,perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilationof this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you findany errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf ofthe U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS:

Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/ordocumentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicableFederal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure,modification, and adaptation of the programs, including any operating system, integrated software, any programs installedon the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs.No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is notdeveloped or intended for use in any inherently dangerous applications, including applications that may create a risk ofpersonal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take allappropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliatesdisclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respectiveowners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used underlicense and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and theAMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademarkof The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and servicesfrom third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of anykind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreementbetween you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurreddue to your access to or use of third-party content, products, or services, except as set forth in an applicable agreementbetween you and Oracle.

Page 3: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Contents

Documentation Accessibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Documentation Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Chapter 1. Data Relationship Management Web Services Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Chapter 2. Using the Data Relationship Management Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Connecting to a Data Relationship Management Application . . . . . . . . . . . . . . . . . . . . . . 11

Time Zone IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Attaching a Web Service Security Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Stateful Session Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Creating a Web Service Client Using JDeveloper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Deleting Temporary Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Chapter 3. Upgrading Existing API Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Changes to Existing Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Changes to Session Params . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Regenerating Web Service Proxy Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Chapter 4. Upgrading Pre-11.1.2 API Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Automator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

BlenderMgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

CategoryMgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

CompareMgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

ExportMgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

GlobalNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

GlyphMgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Hier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

ImportMgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

JobMgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

LocalNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

LogMgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

NodeAccessGroupMgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

iii

Page 4: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

NodeTypeMgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

ProcessInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

PropMgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

QueryMgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

RequestMgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

SessionMgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

SysPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

UserMgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

ValidationMgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

VersionInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

VersionMgr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

iv

Page 5: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website athttp://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle SupportOracle customers that have purchased support have access to electronic support through My Oracle Support.For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

5

Page 6: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

6

Page 7: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Documentation Feedback

Send feedback on this documentation to: [email protected]

Follow EPM Information Development on these social media sites:

LinkedIn - http://www.linkedin.com/groups?gid=3127051&goback=.gmp_3127051

Twitter - http://twitter.com/hyperionepminfo

Facebook - http://www.facebook.com/pages/Hyperion-EPM-Info/102682103112642

Google+ - https://plus.google.com/106915048672979407731/#106915048672979407731/posts

YouTube - https://www.youtube.com/user/EvolvingBI

7

Page 8: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

8

Page 9: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

1Data Relationship Management

Web Services Overview

The Oracle Data Relationship Management web services provide public interfaces for remotelyinteracting with a Data Relationship Management server. The SOAP-based web services can beused for product integration or developing custom applications which require a programmableinterface. Data Relationship Management includes two web service modules:

l DrmService–The primary interface for accessing and managing information in DataRelationship Management

m Master Data Objects–Includes versions, hierarchies, nodes, and properties. The DataRelationship 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 functionalityalong with operations specialized for that object type.

m User Metadata Objects–Includes imports, blenders, queries, compares, exports, books,action scripts, and version variables. The interface includes operations for retrieving,editing, running, and interrogating the results of these objects.

m System Metadata and Security Objects–Objects that the administrator develops as partof the implementation to determine how an application will function and who can accesswhich features and data. These objects include domains, property definitions andcategories, validations, hierarchy groups, node types, system preferences, externalconnections, workflow models and tasks, users and access groups. The interface provideslimited support for the maintenance of these objects. Generally, these objects will beadministered using the Data Relationship Management web client.

l DrmGovernanceService–A specialized interface for processing workflow requests usingOracle Data Relationship Governance

Workflow Data Objects–Includes the ability to create, read, update, delete, validate, andsubmit workflow requests using workflow models.

9

Page 10: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

10

Page 11: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

2Using the Data RelationshipManagement Web Services

In This Chapter

Connecting to a Data Relationship Management Application ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

Attaching a Web Service Security Policy .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

Stateful Session Management.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Creating a Web Service Client Using JDeveloper.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16

Deleting Temporary Files .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16

Data Relationship Management web service modules each provide their own web serviceinterface, which is defined by a Web Service Definition Language (WSDL) document. The WSDLdocuments for the Data Relationship Management web service interfaces are accessible usingthe following URLs (substitute the appropriate server hostname:port):

http://web_server_name:port_number/oracle-epm-drm-webservices/

DrmService?wsdl

http://web_server_name:port_number/oracle-epm-drm-webservices/

DrmGovernanceService?wsdl

The API Reference for each web service interface provides details of the web service interfaceincluding descriptions and examples of operations, types, and parameters:

l Data Relationship Management API Reference

l Data Relationship Governance API Reference

Connecting to a Data Relationship ManagementApplicationAll Data Relationship Management web service operations require a connection to a DataRelationship Management application. Connection information must be passed as a SOAPheader element for each web service call. The AppParameters element in the WSDL provides aschema definition for this SOAP header element. The AppParameters SOAP header elementcontains the following information which is needed to connect to the API Adapter for a DataRelationship Management application:

l serverUrl–URL for the API Adapter configured for a Data Relationship Managementapplication. For example: http://localhost:5240/Oracle/Drm/APIAdapter

11

Page 12: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

l sessionParams–Parameters for the Data Relationship Management user session:

m ProductVersion–Version number for the Data Relationship Management application

m CultureName–Identifier for formatting date, time, and decimal values which are sent toor retrieved from a Data Relationship Management application. Any standard specificculture can be specified.

m UICultureName–Identifies the language used for localized labels and messages returnedby the Data Relationship Management application:

o en-US (English)

o fr-FR (French)

o de-DE (German)

o ja-JP (Japanese)

o zh-CN (Simplified Chinese)

o ko-KR (Korean)

m TimeZoneID–Client time zone identifier (see list of standard time zone IDs).

Examples of sessionParams:

"ProductVersion=11.1.2,CultureName=en-US,UICultureName=en-US,TimeZoneID=Eastern Standard Time"

"ProductVersion=11.1.2,CultureName=fr-CA,UICultureName=fr-FR,TimeZoneID=Eastern Standard Time"

"ProductVersion=11.1.2,CultureName=en-ZA,UICultureName=en-US,TimeZoneID=South Africa Standard Time"

"ProductVersion=11.1.2,CultureName=zh-HK,UICultureName=zh-CN,TimeZoneID=China Standard Time"

"ProductVersion=11.1.2,CultureName=en-GB,UICultureName=en-US,TimeZoneID=China Standard Time"

Time Zone IDsThe following time zone IDs may be used:

Time Zone IDs Time Zone IDs

Afghanistan Standard Time Mauritius Standard Time

Alaskan Standard Time Mid-Atlantic Standard Time

Arab Standard Time Middle East Standard Time

Arabian Standard Time Montevideo Standard Time

Arabic Standard Time Morocco Standard Time

Argentina Standard Time Mountain Standard Time

12

Page 13: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Time Zone IDs Time Zone IDs

Atlantic Standard Time Mountain Standard Time (Mexico)

AUS Central Standard Time Myanmar Standard Time

AUS Eastern Standard Time N. Central Asia Standard Time

Azerbaijan Standard Time Namibia Standard Time

Azores Standard Time Nepal Standard Time

Bahia Standard Time New Zealand Standard Time

Bangladesh Standard Time Newfoundland Standard Time

Canada Central Standard Time North Asia East Standard Time

Cape Verde Standard Time North Asia Standard Time

Caucasus Standard Time Pacific SA Standard Time

Cen. Australia Standard Time Pacific Standard Time

Central America Standard Time Pacific Standard Time (Mexico)

Central Asia Standard Time Pakistan Standard Time

Central Brazilian Standard Time Paraguay Standard Time

Central Europe Standard Time Romance Standard Time

Central European Standard Time Russian Standard Time

Central Pacific Standard Time SA Eastern Standard Time

Central Standard Time SA Pacific Standard Time

Central Standard Time (Mexico) SA Western Standard Time

China Standard Time Samoa Standard Time

Dateline Standard Time SE Asia Standard Time

E. Africa Standard Time Singapore Standard Time

E. Australia Standard Time South Africa Standard Time

E. Europe Standard Time Sri Lanka Standard Time

E. South America Standard Time Syria Standard Time

Eastern Standard Time Taipei Standard Time

Egypt Standard Time Tasmania Standard Time

Ekaterinburg Standard Time Tokyo Standard Time

13

Page 14: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Time Zone IDs Time Zone IDs

Fiji Standard Time Tonga Standard Time

FLE Standard Time Turkey Standard Time

Georgian Standard Time Ulaanbaatar Standard Time

GMT Standard Time US Eastern Standard Time

Greenland Standard Time US Mountain Standard Time

Greenwich Standard Time UTC

GTB Standard Time UTC+12

Hawaiian Standard Time UTC-02

India Standard Time UTC-11

Iran Standard Time Venezuela Standard Time

Israel Standard Time Vladivostok Standard Time

Jordan Standard Time W. Australia Standard Time

Kaliningrad Standard Time W. Central Africa Standard Time

Kamchatka Standard Time W. Europe Standard Time

Korea Standard Time West Asia Standard Time

Libya Standard Time West Pacific Standard Time

Magadan Standard Time Yakutsk Standard Time

Attaching a Web Service Security PolicyData Relationship Management web services are secured using security policies in Oracle WebServices Manager. A client policy must be used by the web service client which matches thesecurity policy configured for the web service being called. JRF-based web service clients mustattach one of the following client-side policies when making calls to the Data RelationshipManagement web services:

l oracle/wss11_saml_token_with_message_protection_client_policy

l oracle/wss11_username_token_with_message_protection_client_policy

l oracle/wss_username_token_client_policy

l oracle/wss_http_token_client_policy

For more information on configuring a web service security policy, refer to the “Securing DataRelationship Management Web Services” section of the Oracle Data Relationship ManagementInstallation Guide. For information on configuring security for a WCF/.NET 3.5 Client, refer to

14

Page 15: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

the “Configuring Microsoft WCF/.NET 3.5 Client” section of the Oracle Fusion MiddlewareInteroperability Guide for Oracle Web Services Manager.

Stateful Session ManagementData Relationship Management web services support an optional stateful session mode whichmay be used as an alternative to the stateless mode available by default. In the stateless mode,each web service operation implicitly creates a user session at the start of the operation andterminates the session at the end of the operation. In the stateful mode, the web service client isresponsible for explicitly creating the user session, managing a session ID for the session, andterminating the session. When multiple web service operations need to be performed to completea particular task, the stateful session mode is beneficial because it minimizes the overhead ofcreating and terminating user sessions.

Creation and termination operations for stateful sessions are included in the DrmService webservice interface. If stateful session support is required for the DrmGovernanceService, proxiesfor both interfaces must be generated to utilize the beginSession and endSession methods in theDrmService interface.

ä To use the stateful session mode, perform the following steps in the Web service clientprogram:

1 Call the beginSession() operation of the DrmService to obtain a session ID from the server. The webservice client program needs to keep track of this session ID as it will be utilized on subsequent webservice calls.

2 Insert the session ID into a custom web service header element named “SessionMaintainParams” withthe “http://drm.webservices.epm.oracle” namespace.

3 Perform the desired web service operations.

4 End the stateful session by calling the endSession() operation of the DrmService interface.

Note: The SessionMaintainParams element in the WSDL provides a schema definition for thisSOAP header element.

Java Example

String sessionId = null; if (stateful) { sessionId = i_drmService.beginSession(); //add the Session Id to a custom Header addSessionIdNodeToHeader((WSBindingProvider)i_drmService, sessionId); //get system preferences SystemPreferenceListType listType = i_drmService.getSysPrefs();

// Insert Session ID in Header and call DRG Webservice with same session ID //to create a workflow request template. addSessionIdNodeToHeader((WSBindingProvider)i_drgService, sessionId);

15

Page 16: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

CreateWorkflowRequestResponseType createWorkflowRequest = null; CreateWorkflowRequestType input = new CreateWorkflowRequestType(); input.setRequest(new BaseRequestType()); input.getRequest().setModelName(“New Financial Account”);

//create a "Shell" of a Workflow request createWorkflowRequest = i_drgServiceIF.createWorkflowRequest(input); //end stateful session i_drmService.endSession(sessionId); }

static void addSessionIdNodeToHeader(WSBindingProvider wsbp, String sessionId) throws ParserConfigurationException { List<Header> allHeaders = new ArrayList<Header>(); if (sessionId != null) { DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();

DocumentBuilder builder = factory.newDocumentBuilder(); Document document = builder.newDocument(); // Create from whole cloth Element root = document.createElementNS(DRM_SERVICE_NAMESPACE, "SessionMaintainParams"); document.appendChild(root);

Element serverUrlNode = (Element) root.appendChild(document.createElementNS(DRM_SERVICE_NAMESPACE, "sessionId")); serverUrlNode.appendChild(document.createTextNode(sessionId)); Header header = new DOMHeader(root); allHeaders.add(header); } wsbp.setOutboundHeaders(allHeaders); } static final String DRM_SERVICE_NAMESPACE = "http://drm.webservices.epm.oracle";

Creating a Web Service Client Using JDeveloperIf you are using JDeveloper to develop a Java-based client, refer to "Developing ApplicationsUsing Web Services" in the Oracle Fusion Middleware User’s Guide for Oracle JDeveloper.

Deleting Temporary FilesWhen W3C Message Transmission Optimization Mechanism (MTOM) is being used, the DataRelationship Management API Web Service generates temporary files during SOAPconversations with the API adapter. These temporary files, named MIME<number>.tmp, arestored in Oracle\Middleware\user_projects\epmsystem1\tmp and can be deleted.

16

Page 17: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Note: If the system is running during the cleanup, you may want to remove only files that areat least a few hours or one day old. Otherwise, if the deployed Data RelationshipManagementWeb Service applications are stopped in Web Logic, then all of these filescan be removed from the temporary directory.

17

Page 18: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

18

Page 19: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

3Upgrading Existing API

Programs

In This Chapter

Changes to Existing Types... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

Changes to Session Params ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22

Regenerating Web Service Proxy Classes... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22

Existing programs written to use the Data Relationship Management web service API availablein previous 11.1.2 releases of the product are compatible with this release with certain exceptionswhich are documented later in this section. For API programs written against a Oracle DataRelationship Management release prior to 11.1.2, those programs must be manually convertedto use the web services API available in this release.

Changes to Existing TypesThe following remotable types were changed in this release.

Note: If you are using any of these types in an existing API program using the 11.1.2.1 webservice, proxy classes need to be regenerated using the current WSDL for the web service.See Regenerating Web Service Proxy Classes.

Table 1 Changes to Remotable Types in the 11.1.2.4.x Releases

Release Type Change

11.1.2.4.330 PropDefType Added elements for storing External Lookup settings:

l externalConnectionName

l operationName

l externalParameterMap

l externalColumnMap

11.1.2.4.330 PropTypeEnum Added new enum value to PropTypeEnum properties of type ExternalLookup. PropDefType uses this enum for field propType External.

11.1.2.4.330 ExternalParameterListType New Element

11.1.2.4.330 ExternalParameterType New Element

19

Page 20: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Release Type Change

11.1.2.4.330 ParameterSourceEnum New Element

11.1.2.4.330 ExternalColumnListType New Element

11.1.2.4.330 ExternalColumnType New Element

11.1.2.4.310 BlenderListPropertyActionEnum New Enum with elements: Replace, Merge, MergeAndSort

11.1.2.4.310 BlenderPropType Added Element: blenderListPropAction

11.1.2.4.310 BlenderType Added Elements: useStoredDefaultParameters,targetVersionFromParam, targetVersionRuntimeParam

11.1.2.4.310 ImportColumnType Added Element: extendAllowedValues

11.1.2.4.310 ImportErrorLevelEnum Added enum element: Info

11.1.2.4.310 ImportType Added elements: runBlenderAfterImport, blenderName,blenderObjectAccess

11.1.2.4.301 GlyphListType New Element

11.1.2.4.301 SessionMaintainParams New Element

11.1.2.4 HierExportType Added elements: hierarchyGroupName, hierarchyGroupFromParam,sourceNodesMethod, hierarchyGroupProperty,hierarchyGroupPropFromParam

11.1.2.4 UserInputType emailAddress element added

11.1.2.4 ImportType Added elements: createBaseOrphanHierarchy, nodesToIgnore,createOrphanBranchHierarchies,orphanHierarchyNameDuplicateDelimiter,maxOrphanHierarchiesToCreate, orphanHierarchyNamePrefix,hierPropertyForTopOrphanParent, orphanHierarchyName,orphanHierarchyDescription, orphanHierarchyTopNodeName,orphanHierarchyTopNodeDescription, runtimeParameters,hierPropertyForNodeType, hierValidationsToAssign

11.1.2.4 ExportType, BaseParamsType, BlenderType,BookType, StartBookByName,StartCompareExportByNameOnHierNode,StartHierExportByName, StartExportByName,StartCompareExportByNameOnHier,StartHierExportByNameOnHierNode,StartImportByName, RunBlenderByName,StartCompareExportByName,StartHierExportByNameOnHierNodes,StartBlenderByName,StartHierExportByNameOnHiers, ImportType

Added element: runtimeParameters

20

Page 21: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Table 2 Changes to Remotable Types in the 11.1.2.3.x Releases

Release Type Change

11.1.2.3.500 ComparisonOperatorEnum Added enum elements: HasCharacters, HasNotCharacters, IsAlpha, IsNotAlpha,IsAlphaNumeric, IsNotAlphaNumeric

11.1.2.3.500 ImageTypeEnum Added enum element: BMP, JPEG, GIF

11.1.2.3.500 ImportDupeModeEnum Added enum element: DoNotLog

11.1.2.3.500 ImportFileStructureEnum Added enum elements: Generation, FixedGeneration

11.1.2.3.500 JobStatusEnum Added enum element: Halted

11.1.2.3.500 LogItemColumnTypeEnum Added enum element: WorkflowRequestID

11.1.2.3.500 PermissionEnum Added enum elements: ManageWorkflowTasks, ManageWorkflowModels,ManageChangeRequests, WorkflowParticipant

11.1.2.3.500 PropValueOriginEnum Added enum element: InheritedDomain

11.1.2.3.500 TxnActionEnum Added enum elements: ActionScriptRun, AdminAddGlyph, AdminDeleteGlyph,AdminUpdateGlyph, AdminAddExternalConnection,AdminUpdateExternalConnection, AdminDeleteExternalConnection,SetControlledProperties, LoadFromFileWarning, LoadFromFile, SaveToFile,AdminAddDomain, AdminUpdateDomain, AdminDeleteDomain,AddDomainToVersion, RemoveDomainFromVersion, AssignNodeToDomain,AddVersionVariable, DeleteVersionVariable, UpdateVersionVariable,AdminSortValidations, ProfilerRun, AdminAddObjectAccessGroup,AdminUpdateObjectAccessGroup, AdminDeleteObjectAccessGroup,QueryObjectAccessGroupChanged, ExportObjectAccessGroupChanged,BookObjectAccessGroupChanged, ImportObjectAccessGroupChanged,BlenderObjectAccessGroupChanged, CompareObjectAccessGroupChanged,ConnectionObjectAccessGroupChanged, AdminAddWorkflowTask,AdminUpdateWorkflowTask, AdminDeleteWorkflowTask,AdminAddWorkflowModel, AdminUpdateWorkflowModel,AdminDeleteWorkflowModel

11.1.2.3.500 ValidationLevelEnum Added enum element: Universal

11.1.2.3 DbImportFilterMethodEnum New enumeration

11.1.2.3 ImportColumnType Added elements: dbColumnName, dbOrderColumn, defaultDomainName,domainColumnName

11.1.2.3 ImportDatabaseType New element

11.1.2.3 ImportFileSourceEnum Added enum element: Database

11.1.2.3 ImportSectionType Added elements: dbTableName, dbFilterKeyColumn

11.1.2.3 PropDefType Added element: propConstraints

11.1.2.3 PropertyConstraintEnforcementEnum New enumeration

21

Page 22: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Table 3 Changes to Remotable Types in the 11.1.2.2 Release

Release Type Change

11.1.2.2 ExportTypel Changed characterEncoding element to codepage element

l Added elements: runValidationsMode, selectedValidations

11.1.2.2 ScriptLoadParamsTypel columnIndices element is changed to a string list

l Added elements: useLabelForPropertyLookup, domainForAddedNodes

11.1.2.2 DataTypeEnum Added enum elements: Domain, VersionVariable, HierarchyGroup

11.1.2.2 VersionTypeEnum Variable element added

11.1.2.2 AddNodeWithProps domainName element added

11.1.2.2 AddNode domainName element added

11.1.2.2 AddOrphanNode domainName element added

11.1.2.2 StartScriptFromFile Changed characterEncoding element to codepage element

Changes to Session ParamsIn release 11.1.2.2, the session parameter “TimeZoneID” replaced the “TimeZoneOffset”parameter. Refer to the list of standard time zone IDs.

Regenerating Web Service Proxy ClassesExisting API programs using methods, objects, or types that changed in the current web serviceAPI must be manually updated.

l If using a JRF-based web service client, refer to the “Developing Applications Using WebServices" section in the Oracle Fusion Middleware User’s Guide for Oracle JDeveloper.

l If using a .Net-based web service client, refer to the “Configuring Microsoft WCF/.NET 3.5Client” section of the Oracle Fusion Middleware Interoperability Guide for Oracle Web ServicesManager.

22

Page 23: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

4Upgrading Pre-11.1.2 API

Programs

In This Chapter

Automator .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24

BlenderMgr .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24

CategoryMgr .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24

CompareMgr.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

ExportMgr .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

GlobalNode ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26

GlyphMgr.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28

Hier .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28

ImportMgr.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29

JobMgr ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30

LocalNode ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30

LogMgr .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

NodeAccessGroupMgr ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

NodeTypeMgr .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

ProcessInfo ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33

PropMgr .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33

QueryMgr.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

RequestMgr.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36

SessionMgr .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37

SysPref .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37

UserMgr .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37

ValidationMgr.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

Version ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39

VersionInfo... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41

VersionMgr.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41

The following mapping tables can be used to manually upgrade custom API programs fromusing the multiple .NET web services offered in release 11.1.1 to the single Fusion Middlewareweb service available in release 11.1.2.1 and later. A separate table is provided for each 11.1.1web service.

23

Page 24: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Automator

Table 4 Automator Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method

GetLoadActionItemBatch Not Currently Supported

GetProcessActionsResult getScriptResults

LoadFile startScriptFromFile

LoadLogCriteria getScriptFromLog

LoadNodeModel getScriptFromModel

ProcessActions startScript

StartLoadFileJob startScriptFromFile

StartLoadLogCriteriaJob getScriptFromLog

StartProcessActionsJob startScript

BlenderMgr

Table 5 BlenderMgr Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

BlenderByID getBlender

DeleteBlenderProfile deleteBlender

FillBlenderProfiles getBlenderNames getBlender

GetBlendJobResults getBlenderResults

ProcessBlend startBlenderByName

SaveBlenderProfile createBlender updateBlender

StartBlendJob startBlender

CategoryMgr

Table 6 CategoryMgr Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method

AddCategory addPropCategory

24

Page 25: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method

DeleteCategory deletePropCategory

ListCategories getPropCategories

ListProperties getPropDefsByCategory

ListUsers getPropCategories

UpdateCategory updatePropCategory

UpdateProperties updatePropCategory

UpdateUsers updatePropCategory

CompareMgr

Table 7 CompareMgr Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

Compare runCompare runCompareByName, startCompare, startCompareByName

Compares getCompareNames

DeleteCriteria deleteCompare

LoadCriteria getCompare

PropCompare runCompare runCompareByName, startCompare, startCompareByName

PropCompares getCompare

Rename updateCompare

RenameCompare runCompare runCompareByName, startCompare, startCompareByName

RenameCompares getCompare getCompareNames

SaveCriteria createCompare updateCompare

ExportMgr

Table 8 ExportMgr Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

BookByID getBook

CloseBookJob Not Applicable

25

Page 26: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

DeleteBook deleteBook

DeleteExport deleteExport

ExportByID getExport

FillBooks getBookNames getBook

FillExports getExportNames getExport

FillTypeDefs Not Currently Supported

GetBookJobCombinedFile getBookResults

GetBookJobExportResult getBookResults

GetBookJobItemCount getBookResultsItemCount

GetExportJobResults getExportResults

IsExportRunnable Not Currently Supported

RunExport startExport startExportByName, startCompareExportByName,startCompareExportByNameOnHier,startCompareExportByNameOnHierNode

RunExportByID startExport startExportByName, startCompareExportByName,startCompareExportByNameOnHier,startCompareExportByNameOnHierNode

SaveBook createBook updateBook

SaveExport createExport updateExport

StartBookJob startBookByName

StartExportJob startExport startExportByName, startCompareExportByName,startCompareExportByNameOnHier,startCompareExportByNameOnHierNode

GlobalNode

Table 9 GlobalNode Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method

ChildNodeCount getGlobalNodeRefCount

ExistsInDB Not Currently Supported

FillChildren getRelatedNodes

FillChildrenQry getGlobalRelatedNodesWithProps

26

Page 27: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method

FillChildrenStrList Not Currently Supported

FillDescendants getRelatedNodes

FillDescendantsQry getRelatedNodesWithProps

FillDescendantsSorted Not Currently Supported

FillPropValue getGlobalNodeProps

FillPropValues getGlobalNodeProps

FillReferencesQry getRelatedNodesWithProps

FillSharedNodes Not Currently Supported

GetAccessLevel Not Applicable

GetLeafAccessLevel Not Applicable

GetLimbAccessLevel Not Applicable

GetNode getGlobalNodes

GetReactivateAccessLevel Not Applicable

GetReactivateLeafAccessLevel Not Applicable

GetReactivateLimbAccessLevel Not Applicable

GetReferenceCount getGlobalNodeRefCount

GetReferences getGlobalNodeReferences

HasChildren getGlobalNodeProps

NextNodeSequence Not Currently Supported

NumChildren getGlobalNodeProps

NumDescendants getGlobalNodeProps

PropOriginByAbbrev getGlobalNodeProps

PropStrValueByAbbrev getGlobalNodePropValues

PropValueByAbbrev getGlobalNodePropValues

PropValueByID getGlobalNodePropValues

PropValuesByAbbrev getGlobalNodePropValues

27

Page 28: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

GlyphMgrTable 10 GlyphMgr Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method

Delete deleteGlyph

GlyphByID getGlyph

Insert addGlyph

LoadGlyphs Not Currently Supported

Update updateGlyph

HierTable 11 Hier Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

AddNode addNode addNodeWithProps

AnnulAllBelow annulNode

AnnulNode annulNode

ChangeTopNode setHierTopNode

CopyNodes copyNode

DeleteNodes deleteNodes deleteNode

DestroyNodes deleteNodes deleteNode

ExtNodeByAbbrev Not Currently Supported

xtNodeByID Not Currently Supported

FillNodeList Not Currently Supported

FillPropValues getHierPropValues getHierProps

FillStrPropValue getHierPropValues getHierProps

GetHier getHier

InactivateNodes inactivateNodes

InsertNode insertNode insertNodes, insertNodeWithProps

MoveNodes moveNodes moveNode

NodeByAbbrev getNode getNodes, getNodeWithProps

28

Page 29: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

NodeByID getNodeByID

PropValueByAbbrev getHierPropValues getHierProps

PropValueByID getHierPropValues getHierProps

ReactivateNodes reactivateNodes reactivateNode

RemoveNodes removeNodes removeNode

SearchForNode searchForNodesInHier

UpdateProps updateHierProps

Verify runValidateHier

VerifyNode runValidateNode

VerifyNodeSelected runValidateNode

VerifySelected runValidateHier

ImportMgrTable 12 ImportMgr Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

DeleteImport deleteImport

FillImportBlocks getImport

FillImportTypeDefs Not Currently Supported

GetImportJobResults getImportResults

ImportBlockByID getImport

IsRunnable Not Currently Supported

RunImport startImport startImportByName

SaveImport updateImport

StartImportJob startImport startImportByName

29

Page 30: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

JobMgrTable 13 JobMgr Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method

CheckJobStatus getJobStatus

LocalNodeTable 14 LocalNode Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

ChildNodeCount getRelatedNodeCount

CopyProps copyNodeProps

ExistsInDB Not Currently Supported

FillAncestors getRelatedNodes

FillAncestorsExt Not Currently Supported

FillAncestorsExtQry getRelatedNodesWithProps

FillChildren getRelatedNodes

FillChildrenExt Not Currently Supported

FillChildrenExtQry getRelatedNodesWithProps

FillChildrenSorted Not Currently Supported

FillChildrenStrList getRelatedNodeNames

FillDescendants getRelatedNodes

FillDescendantsQry getRelatedNodesWithProps

FillDescendantsSorted Not Currently Supported

FillPropValue getNodePropValues

FillPropValues getNodePropValues

FillSiblings getRelatedNodes

FillSiblingsQry getRelatedNodesWithProps

GetAccessLevel getNodeAccessLevel

GetDisplayByString getNodePropValues

GetExtNode Not Currently Supported

30

Page 31: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

GetFiltered Not Currently Supported

GetGlobalNode getGlobalNode getGlobalNodes

GetLeafAccessLevel getNodeAccessLevel

GetLimbAccessLevel getNodeAccessLevel

GetNode getNode getNodes, getNodeWithProps

GetNodeType getNode getNodes

GetNumVisibleChildren Not Currently Supported

GetParentNode getRelatedNodes getNode

GetReactivateAccessLevel Not Currently Supported

GetReactivateLeafAccessLevel Not Currently Supported

GetReactivateLimbAccessLevel Not Currently Supported

HasChildren getRelatedNodeCount

NumChildren getRelatedNodeCount

NumDescendants getRelatedNodeCount

OrderChildren orderChildren

PropOriginByAbbrev getNodeProps

PropStrValueByAbbrev getNodePropValues

PropValueByAbbrev getNodePropValues getNodeProps

PropValueByID getNodePropValues

PropValuesByAbbrev getNodePropValues

UpdateProps updateNodeProps updateNodePropValues

Verify runValidateNode

VerifySelected runValidateNode

LogMgr

Table 15 LogMgr Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method

LoadLogItems getLogItems

31

Page 32: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method

LogItem Not Currently Supported

NodeAccessGroupMgr

Table 16 NodeAccessGroupMgr Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

AddNodeAccessGroup addNodeAccessGroup

DeleteNodeAccessGroup deleteNodeAccessGroup

FillGroupList getNodeAccessGroupNames getNodeAccessGroup

FillUserList getNodeAccessGroupUserList

GroupByID getNodeAccessGroup

UpdateControllingHiers assignControlledProps

UpdateNodeAccessGroup updateNodeAccessGroup

UpdateNodeAccessMembers updateNodeAccessGroup

NodeTypeMgr

Table 17 NodeTypeMgr Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

AddNodeType addNodeType

ApplyNodeTypeCategories Not Currently Supported

ApplyNodeTypeProps Not Currently Supported

ApplyNodeTypeValidations Not Currently Supported

DeleteNodeType deleteNodeType

FillCategoriesByNodeType getNodeTypes

FillNodeTypes getNodeTypes getNodeTypeNames

FillNodeTypesByCategory Not Currently Supported

FillNodeTypesByProperty getNodeTypes

FillNodeTypesByValidation getNodeTypes

32

Page 33: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

FillPropertiesByNodeType getNodeTypes

FillValidationsByNodeType getNodeTypes

GlyphIDByNode Not Currently Supported

GlyphIDByNodeType getNodeTypes

UpdateNodeType Not Currently Supported

ProcessInfo

Table 18 ProcessInfo Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method

GetEngineList Not Applicable

GetEngineProcessID Not Applicable

GetEngineProcessMemoryInfo Not Applicable

GetEngineQueue Not Applicable

GetEngineThreadInfo Not Applicable

GetGlobalMemoryStatus Not Applicable

GetMachineList Not Applicable

PropMgr

Table 19 PropMgr Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

AddPropDef addPropDef

AnyPropDefByAbbrev getPropDef

AnyPropDefByID getPropDef

ControlHierID Not Currently Supported

DefaultByAbbrev getPropDef

DeleteLookupValue updatePropDef

DeletePropDef deletePropDef

33

Page 34: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

DerivedClassDefaultParams Not Currently Supported

DerivedClassDefaults Not Currently Supported

FillControlledProps getControlledPropNames

FillFullPropList getPropDefs getPropDefNames

FillHierPropByAbbrev getPropDefs getPropDefNames

FillHierPropDefs getPropDefs getPropDefNames

FillPropByAbbrev getPropDefs getPropDefNames

FillPropDefs getPropDefs

FillPropsFromPref Not Applicable

FillSelectedPropList getPropDefs getPropDefNames

FillValPropList getPropDefs getPropDefNames

FillVersionPropByAbbrev getPropDefs getPropDefNames

FillVersionPropDefs getPropDefs getPropDefNames

GetAccessGroups getNodeAccessGroupNames

GetAccessLevel getPropDefs

GetCategories getPropDefs

GetPropDefParams getPropDefs

HFillFullPropList getPropDefs getPropDefNames

HFillSelectedPropList getPropDefs getPropDefNames

HierPropDefByAbbrev getPropDefs

HierPropDefByID getPropDefs

HierPropIsValid getPropDefs

InsertLookupValue updatePropDef

ListControllingHiers Not Currently Supported

ListDerivedPropClasses Not Currently Supported

ListLookupValues getPropDef

ListPropDefParams getPropDef

ListPropsByCategory getPropDefsByCategory

34

Page 35: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

LookupByValue getPropDef

NodeCopyPropByAbbrev Not Currently Supported

NodePropIsValid getPropDef

ParamByName getPropDef

PropDefByAbbrev getPropDef

PropDefByID getPropDef

PropIsValid Not Currently Supported

SetCategoryList updatePropDef

SetControllingHier assignControlledProps

SetPropDefParams updatePropDef

TestFormula Not Currently Supported

UpdateListValues updatePropDefListValues

UpdateLookupValue updatePropDef

UpdatePropDef updatePropDef

VersionPropDefByAbbrev getPropDefs getPropDefNames

VersionPropDefByID getPropDefs

VersionPropIsValid getPropDefs

VFillFullPropList getPropDefs getPropDefNames

VFillSelectedPropList getPropDefs getPropDefNames

QueryMgr

Table 20 QueryMgr Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

ComparisonOperators Not Currently Supported

DeleteCriteria deleteQuery

DescrFormula getQuery

GetCriteria getQuery

GetCriteriaByName getQuery

35

Page 36: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

GetParams getQuery

GetParamsByName getQuery

GlobalPropQueries getQueries getQueryNames

IsQueryUsed Not Currently Supported

LocalPropQueries getQueries getQueryNames

ParserFormula getQuery

QueryGlobal runGlobalQuery startQuery

QueryLocal runQuery startQuery

Rename updateQuery

SaveCriteria createQuery, updateQuery

SingleQueryLocal Not Applicable

VerifyFormula Not Currently Supported

RequestMgrTable 21 RequestMgr Method changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

ApproveRequest approveRequest

DeleteRequest deleteRequest

QueryRequests queryRequests

RequestByExternalID getRequestByExternalId

RequestByID getRequestById

SaveRequest createRequest updateRequest

ValidateRequest validateRequest

36

Page 37: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

SessionMgr

Table 22 SessionMgr Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method

AuthenticationMethod Not Applicable

CloseSession Not Applicable

CreateSession Not Applicable

FakeExportSessionInfoArray Not Applicable

ListSessionInfos Not Applicable

PublicKey Not Applicable

SysPref

Table 23 SysPref Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method

AddValue Not Applicable

DeleteValue Not Applicable

GetDBSysPrefs Not Applicable

GetPreferences getSysPrefs

GetSystemValues getSysPrefs

ReadPreferenceValue getSysPrefValue

ReadSystemValue getSysPrefValue

UpdateDBSysPref Not Applicable

UpdateValue Not Currently Supported

UserMgr

Table 24 UserMgr Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

AddUser addUser

AssignUserCategories updateUser

37

Page 38: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

AssignUserNodeAccessGroups updateUser

ChangePassword updateUserPassword

CloneUser copyUser

DeleteUser deleteUser

ListUserAccessGroups getUser

ListUserCategories getUser

ListUserNames getUserNames

ListUserObjects getUserNames getUser

SetPassword setUserPassword

UpdateUser updateUser

UpdateUserLockout updateUserLockout

UserByID getUser

UserByName getUser

ValidationMgr

Table 25 ValidationMgr Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

AddValidation addValidation

CheckAssignedValidation getAssignedHierValidations

DeleteValidation deleteValidation

FillAssignedGlobalValidations getAssignedGlobalValidations

FillAssignedHierValidations getAssignedHierValidations

FillAssignedMoveValidations getAssignedHierValidations

FillAssignedNodeValidations getAssignedNodeValidations

FillAssignedRemoveValidations getAssignedHierValidations

FillAssignedVersionValidations getAssignedVersionValidations

FillFullValidationList getValidations getValidationNames

FillHierValidationList getValidations getValidationNames

38

Page 39: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

FillNodeValidationList getValidations getValidationNames

FillSelectedValidationList Not Currently Supported

FillValidationParams getValidation

FillValidationParamTemplates Not Applicable

FillValidationTemplates Not Applicable

FillVersionValidationList getValidations getValidationNames

IsHierValAssigned getAssignedHierValidations

IsVersionValAssigned getAssignedVersionValidations

SetValidationParams updateValidation

UpdateHierValidations setHierValidations

UpdateValidation updateValidation

UpdateVersionValidations setVersionValidations

ValidationByAbbrev getValidation

ValidationByID getValidation

ValidationIsValid Not Currently Supported

Version

Table 26 Version Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

AddHierarchy addHier

AddOrphan addOrphanNode

Close closeVersion

DeleteHierarchy deleteHier

DeleteOrphanNodes deleteOrphanNodes

DeleteSystemCategory deleteHierGroup

DestroyOrphanNodes deleteOrphanNodes

DisableRTV Not Currently Supported

EnableRTV Not Currently Supported

39

Page 40: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

FillGlobalNodes getGlobalNodes

FillOrphans getOrphanNodes

FillParents getRelatedNodes

FillPropValues getVersionProps

HierByAbbrev getHier

HierByID getHier

ListHierObjects getHiers

ListHierObjectsBySystemCategory getHiers

ListHiers getHierNames

ListHiersBySystemCategory getHierNames

Load openVersion

MergeAbbrevByID Not Currently Supported

MergedAbbrevByID Not Currently Supported

MergedIDByID Not Currently Supported

MergeIDByID Not Currently Supported

MergeLogIDByID Not Currently Supported

NodeByAbbrev getGlobalNode

NodeByID getNodeByID

PropValueByAbbrev getVersionPropValues

PropValueByID getVersionPropValues

RebuildHierNodeTable Not Applicable

Refresh Not Applicable

ReplaceNodeWithNew Not Currently Supported

SearchForNode searchForNodesInVersion

UpdateProps updateVersionProps updateVersionPropValues

ValidateAllLocalNodes Not Currently Supported

Verify runValidateVersion

VerifySelected runValidateVersion

40

Page 41: Oracle® Data Relationship Management · Web Services Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data

VersionInfoTable 27 VersionInfo Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method

GetVersionInfos Not Applicable

VersionMgrTable 28 VersionMgr Method Changes

Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods

AddSystemCategory addHierGroup

AddVersion addVersion

CloseJob Not Applicable

CopyVersion copyVersion

CreateAsOfDate startCreateVersionAsOfDate

CreateAsOfTxnID startCreateAsOfTxnID

DefaultPreviousVersion Not Currently Supported

DefaultVersion Not Currently Supported

FillVersionNameMasterList getVersionNames

GetCopyVersionResults getCopyVersionResults

GetCreateAsOfResults getCreateVersionAsOfDateResults getCreateVersionAsOfTxnIDResults

HasDisconnectedVersions Not Currently Supported

ListAllHierObjects getHiers

ListSystemCategories getHierGroupNames

ListSystemCategoryObjects getHierGroupNames getHierGroup

ListVersionObjects getVersions

ListVersions getVersionNames

StartCopyVersionJob startCopyVersion

StartCreateAsOfDateJob startCreateVersionAsOfDate

StartCreateAsOfTxnIDJob startCreateAsOfTxnID

StartDeleteVersionJob startDeleteVersion

41


Recommended