Oracle® Hyperion Data Relationship Management, Fusion Edition Release 11.1.2.2.
Oracle® Hyperion Data Relationship Management, Fusion Edition Release 11.1.2.2.000 Web Service API Developer's Guide Overview ............................................................................................................................... 2 About the Data Relationship Management Web Service ........................................................ 2 Using the Data Relationship Management Web Service ......................................................... 3 Time Zone IDs ..................................................................................................................... 4 Using JDeveloper to Create a Web Service Client .................................................................. 6 New Features in This Release ................................................................................................ 6 Methods .............................................................................................................................. 6 Types .................................................................................................................................. 6 Upgrading Existing API Programs ......................................................................................... 7 Upgrading 11.1.2.1 API Programs ....................................................................................... 7 Changes to Existing Types....................................................................................................... 7 Regenerating Web Service Proxy Classes .................................................................................. 7 Upgrading Pre-11.1.2 API Programs ................................................................................... 8 Automator ............................................................................................................................. 8 BlenderMgr ........................................................................................................................... 8 CategoryMgr ......................................................................................................................... 8 CompareMgr ......................................................................................................................... 9 ExportMgr ............................................................................................................................. 9 GlobalNode ......................................................................................................................... 10 GlyphMgr ............................................................................................................................ 11 Hier .................................................................................................................................... 11 ImportMgr .......................................................................................................................... 12 JobMgr ............................................................................................................................... 13 LocalNode ........................................................................................................................... 13 LogMgr ............................................................................................................................... 14 NodeAccessGroupMgr ........................................................................................................... 14 NodeTypeMgr ...................................................................................................................... 15 ProcessInfo ......................................................................................................................... 15 PropMgr .............................................................................................................................. 15 QueryMgr ............................................................................................................................ 17 RequestMgr ......................................................................................................................... 18 SessionMgr ......................................................................................................................... 18 SysPref ............................................................................................................................... 18 UserMgr .............................................................................................................................. 19 ValidationMgr ...................................................................................................................... 19 Version ............................................................................................................................... 20 VersionInfo ......................................................................................................................... 21 VersionMgr .......................................................................................................................... 22 Overview The Oracle® Hyperion 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, action scripts, and version variables. 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 domains, property definitions and categories, validations, hierarchy groups, node types, system preferences, external connections, users and node access groups. The Data Relationship Management Web Service API has limited support for the maintenance of these objects. Generally, these objects will be created, edited, or deleted using the Data Relationship Management user interface. Top of Document About the Data Relationship Management Web Service The Data Relationship Management Web Service Application Programming Interface (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 Data Relationship Management Web Service is implemented in Java and is deployed to the Oracle WebLogic Application Server as a J2EE Web Application. The Web Service communicates with the Data Relationship Management Server via the API Adapter. The Data Relationship Management Web Service depends on the Oracle Web Services Manager (OWSM) for policy management and security of service infrastructure. See the “Deploying and Configuring the Data Relationship Management Web Service API” chapter of the Oracle Hyperion Data Relationship Management Installation Guide for details on the deployment and configuration procedures for the Data Relationship Management Web Service API. Top of Document Using the Data Relationship Management Web Service A Web service interface is defined by a Web Service Definition Language (WSDL) document. Following is the typical URL to the Data Relationship Management Web Service WSDL (substitute the appropriate server hostname:port): http://<web_server_name>:8001/oracle-epm-drm-webservices/DrmService?wsdl The Oracle Hyperion Data Relationship Management API Reference (drm_api_ref_11122.html) provides details of the Web service interface including a description of operations and their parameters. The Data Relationship Management Web Service is stateless. Each Web service call executes within its own Oracle® Hyperion Data Relationship Management session. A new session is created at the beginning of each call and closed at the end of the call. The Web Service API is secured using Web service security (WS-*) mechanisms. Web service clients must attach one of the following policies when making calls to the Data Relationship Management Web Service: wss11_saml_token_with_message_protection_client_policy wss11_username_token_with_message_protection_client_policy wss_username_token_service_policy wss_http_token_service_policy Connection information must be passed as a SOAP header for each Web service call. The AppParameters element, defined in the DrmService.wsdl document, provides a schema definition for this SOAP header. The AppParameters SOAP header contains the following information which is needed to connect to the Data Relationship Management API Adapter: serverUrl - URL for the API adapter configured for a Data Relationship Management application For example: http://localhost:5240/Oracle/Drm/APIAdapter sessionParams - Parameters for the Data Relationship Management user session The sessionParams that are available are: o ProductVersion - Version number for the Data Relationship Management application o CultureName - Identifier for formatting date, time, and decimal values. Any standard specific culture can be specified. o UICultureName – Identifier for language selection to use for exception messages from the Data Relationship Management application server: en-US (English) fr-FR (French) de-DE (German) ja-JP (Japanese) zh-CN (Simplified Chinese) ko-KR (Korean) o TimeZoneID – Client TimeZone identifier (see list of standard time zone IDs below) sessionParams example: ProductVersion=11.1.2 CultureName=en-US UICultureName=fr-FR TimeZoneID=Tokyo Standard Time Time Zone IDs The following time zone IDs may be used: Afghanistan Standard Time Alaskan Standard Time Arab Standard Time Arabian Standard Time Arabic Standard Time Argentina Standard Time Atlantic Standard Time AUS Central Standard Time AUS Eastern Standard Time Azerbaijan Standard Time Azores Standard Time Bahia Standard Time Bangladesh Standard Time Canada Central Standard Time Cape Verde Standard Time Caucasus Standard Time Cen. Australia Standard Time Central America Standard Time Central Asia Standard Time Central Brazilian Standard Time Central Europe Standard Time Central European Standard Time Central Pacific Standard Time Central Standard Time Central Standard Time (Mexico) China Standard Time Dateline Standard Time E. Africa Standard Time E. Australia Standard Time E. Europe Standard Time E. South America Standard Time Eastern Standard Time Egypt Standard Time Ekaterinburg Standard Time Fiji Standard Time FLE Standard Time Georgian Standard Time GMT Standard Time Greenland Standard Time Greenwich Standard Time GTB Standard Time Hawaiian Standard Time India Standard Time Iran Standard Time Israel Standard Time Jordan Standard Time Kaliningrad Standard Time Kamchatka Standard Time Korea Standard Time Magadan Standard Time Mauritius Standard Time Mid-Atlantic Standard Time Middle East Standard Time Montevideo Standard Time Morocco Standard Time Mountain Standard Time Mountain Standard Time (Mexico) Myanmar Standard Time N. Central Asia Standard Time Namibia Standard Time Nepal Standard Time New Zealand Standard Time Newfoundland Standard Time North Asia East Standard Time North Asia Standard Time Pacific SA Standard Time Pacific Standard Time Pacific Standard Time (Mexico) Pakistan Standard Time Paraguay Standard Time Romance Standard Time Russian Standard Time SA Eastern Standard Time SA Pacific Standard Time SA Western Standard Time Samoa Standard Time SE Asia Standard Time Singapore Standard Time South Africa Standard Time Sri Lanka Standard Time Syria Standard Time Taipei Standard Time Tasmania Standard Time Tokyo Standard Time Tonga Standard Time Turkey Standard Time Ulaanbaatar Standard Time US Eastern Standard Time US Mountain Standard Time UTC UTC+12 UTC-02 UTC-11 Venezuela Standard Time Vladivostok Standard Time W. Australia Standard Time W. Central Africa Standard Time W. Europe Standard Time West Asia Standard Time West Pacific Standard Time Yakutsk Standard Time Top of Document Using JDeveloper to Create a Web Service Client If you are using JDeveloper to develop a Java-based client, refer to "Developing Applications Using Web Services" in the Oracle Fusion Middleware User’s Guide for Oracle JDeveloper. Top of Document New Features in This Release Methods The following methods are new in this release: addDomain updateDomain deleteDomain getDomainByName getDomains getExport getExportDefs getExportDimensionTree getVersionObjectNames getVersionObjects getVersionVariable getVersionVariables setVersionVariable startVersionMigrationExport startVersionMigrationImport getVersionMigrationExportResults getVersionMigrationImportResults Types The following types are new in this release: DomainType AddDomain UpdateDomain ExportDefType BaseDefType DomainValidationAssignmentListType DomainValidationAssignmentType ExportDimensionTreeType EpmaTargetApplicationEnum ExportDimensionTreeNodeListType ExportDimensionTreeNode VersionVariableType ExportRunValidationModeEnum AutoIncrementIdColumnType EPMArchitectExportColumnType EPMArchitectExportColumnArrayPropItemListType EPMArchitectExportColumnArrayPropItemType EPMArchitectExportType Top of Document Upgrading Existing API Programs Upgrading 11.1.2.1 API Programs The API changes in this release are noted below. Detailed information on each method or type can be found in the 11.1.2.2 API Reference. Changes to Existing Types The following remotable types have been changed in this release. Note: If you are using any of these types in an existing API program using the 11.1.2.1 Web service, proxy classes need to be regenerated using the WSDL for the 11.1.2.2 Web service. See Regenerating Web Service Proxy Classes instructions. Type Change ExportType Changed characterEncoding element to codepage element Added elements: runValidationsMode, selectedValidations ScriptLoadParamsType columnIndices element is changed to a string list Added elements: useLabelForPropertyLookup, domainForAddedNodes DataTypeEnum Added enum elements: Domain, VersionVariable, HierarchyGroup VersionTypeEnum Variable element added AddNodeWithProps domainName element added AddNode domainName element added AddOrphanNode domainName element added StartScriptFromFile Changed characterEncoding element to codepage element Regenerating Web Service Proxy Classes Existing API programs using methods, objects, or types changed in the 11.1.2.2 Web service API must be manually updated. To regenerate proxy uploads/s1/ drm-api-guide.pdf
Documents similaires










-
31
-
0
-
0
Licence et utilisation
Gratuit pour un usage personnel Attribution requise- Détails
- Publié le Nov 17, 2022
- Catégorie Administration
- Langue French
- Taille du fichier 0.6239MB