Oracle Hyperion Data Relationship Management Web Service API Developer's Guide

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, 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, 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 DRM 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's 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.html) provides details of the web service interface including a description of operations and their parameters.

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

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 currently available are:

o ProductVersion - the version number for the Data Relationship Management application

o CultureName - identifier for formatting date, time, and decimal values

o TimeZoneOffset - the offset of the client's timezone in relation to GMT

For example:

ProductVersion=11.1.2

CultureName=en-US

TimeZoneOffset=-360

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.

Top of Document

Using JDeveloper to Create a Web Service Client

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

Top of Document

Upgrading Existing API Programs

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

Automator

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

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

Top of Document

CategoryMgr

Pre-11.1.2 Web Service Method	11.1.2.1 Web Service Method
AddCategory	addPropCategory
DeleteCategory	deletePropCategory
ListCategories	getPropCategories
ListProperties	getPropDefsByCategory
ListUsers	getPropCategories
UpdateCategory	updatePropCategory
UpdateProperties	updatePropCategory
UpdateUsers	updatePropCategory

CompareMgr

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

Top of Document

ExportMgr

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
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

Top of Document

GlobalNode

Pre-11.1.2 Web Service Method	11.1.2.1 Web Service Method
ChildNodeCount	getGlobalNodeRefCount
ExistsInDB	Not Currently Supported
FillChildren	getRelatedNodes
FillChildrenQry	getGlobalRelatedNodesWithProps
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

Top of Document

GlyphMgr

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

Hier

Pre-11.1.2 Web Service Method

11.1.2.1 Web Service Method

Alternate 11.1.2.1 Methods

addNodeWithProps

deleteNode

deleteNode

Not Currently Supported

ExtNodeByID

Not Currently Supported

FillNodeList

Not Currently Supported

getHierProps

getHierProps

insertNodes, insertNodeWithProps

moveNode

getNodes, getNodeWithProps

getHierProps

getHierProps

reactivateNode

removeNode

ImportMgr

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

JobMgr

Pre-11.1.2 Web Service Method	11.1.2.1 Web Service Method
CheckJobStatus	getJobStatus

Top of Document

LocalNode

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
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

Top of Document

LogMgr

Pre-11.1.2 Web Service Method	11.1.2.1 Web Service Method
LoadLogItems	getLogItems
LogItem	Not Currently Supported

NodeAccessGroupMgr

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

Top of Document

NodeTypeMgr

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
FillPropertiesByNodeType	getNodeTypes
FillValidationsByNodeType	getNodeTypes
GlyphIDByNode	Not Currently Supported
GlyphIDByNodeType	getNodeTypes
UpdateNodeType	Not Currently Supported

ProcessInfo

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

Top of Document

PropMgr

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
DerivedClassDefaultParams	Not Currently Supported
DerivedClassDefaults	Not Currently Supported
FillControlledProps	getControlledPropNames
FillFullPropList	getPropDefs	getPropDefNames
FillHierPropByAbbrev	getPropDefs	getPropDefNames
FillHierPropDefs	getPropDefs	getPropDefNames
FillPropByAbbrev	getPropDefs	getPropDefNames
FillPropDefs	getPropDefs	getPropDefNames
FillPropsFromPref	Not Applicable
FillSelectedPropList	getPropDefs	getPropDefNames
FillValPropList	getPropDefs	getPropDefNames
FillVersionPropByAbbrev	getPropDefs	getPropDefNames
FillVersionPropDefs	getPropDefs	getPropDefNames
GetAccessGroups	getNodeAccessGroupNames
GetAccessLevel	getPropDef
GetCategories	getPropDef
GetPropDefParams	getPropDef
HFillFullPropList	getPropDefs	getPropDefNames
HFillSelectedPropList	getPropDefs	getPropDefNames
HierPropDefByAbbrev	getPropDef
HierPropDefByID	getPropDef
HierPropIsValid	getPropDef
InsertLookupValue	updatePropDef
ListControllingHiers	Not Currently Supported
ListDerivedPropClasses	Not Currently Supported
ListLookupValues	getPropDef
ListPropDefParams	getPropDef
ListPropsByCategory	getPropDefsByCategory
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	getPropDef
VersionPropIsValid	getPropDef
VFillFullPropList	getPropDefs	getPropDefNames
VFillSelectedPropList	getPropDefs	getPropDefNames

Top of Document

QueryMgr

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
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

RequestMgr

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

Top of Document

SessionMgr

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

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

Top of Document

UserMgr

Pre-11.1.2 Web Service Method	11.1.2.1 Web Service Method	Alternate 11.1.2.1 Methods
AddUser	addUser
AssignUserCategories	updateUser
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

Top of Document

ValidationMgr

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
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

Top of Document

Version

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
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

VersionInfo

Pre-11.1.2 Web Service Method	11.1.2.1 Web Service Method
GetVersionInfos	Not Applicable

Top of Document

VersionMgr

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
StartSaveVersionJob	startSaveVersion
UpdateSystemCategory	updateHierGroup
VersionByAbbrev	getVersion
VersionByID	getVersion

Top of Document