Web Service API Reference - DrmWebService

boolean updateIfExists: If True and the node exists, then update the properties for the node; if the node exists and this flag is False, then skip property updates.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: addNodeAccessGroup

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Creates a node access group; this method allows one to associate existing users.

Input Parameters:

NodeAccessGroupType nodeAccessGroup: Node access group input object.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: addNodeType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Creates a node type; this method allows one to associate properties, categories, validations, and a glyph.

Input Parameters:

string name: Name of the node type.

string descr: Description of the node type.

StringListType propNameList: Property definition names to associate with this node type.

StringListType categoryNameList: The property category names to associate with this node type.

StringListType validationList: The validation definition names to associate with this node type.

string glyphName: The glyph name to associate with this node type.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: addNodeWithProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Creates a node; this method allows one to specify properties to update.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

string parentName: Parent node name field.

string nodeName: Node name field.

string nodeDescription:

string domainName: Domain name field.

boolean isLeaf: Field indicating if node is a leaf node.

PropListType propList: The list of properties and their values to set on the node.

boolean updateIfExists: If True and the node exists, then update the properties for the node; if the node exists and this flag is False, then skip property updates.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: addOrphanNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Creates a node but does not associate that node to a parent node.

Input Parameters:

string versionName: Version name field.

string nodeName: Node name field.

string nodeDescription:

string domainName: Domain name field.

boolean isLeaf: Field indicating whether node is a leaf node.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: addPropCategory

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Creates a property category; this method allows one to set the properties.

Input Parameters:

string propCategoryName: Property category name field.

string descr: Property category description field.

PropCategoryTypeEnum propCategoryType: An enumeration value indicating the type of property category.

StringListType propNameList: A list of property definition names to associate with this property category.

boolean availableUserCategory: Flag indicating whether the category should be saved as a user category.

int order: The order in which the property category appears in the property editor.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: addPropDef

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Creates a property definition.

Input Parameters:

PropDefType propDef: A property definition object field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: addUser

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Creates a user definition.

Input Parameters:

UserInputType userInput: User input object field.

string password: The password to set for this new user.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: addValidation

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Creates a validation definition.

Input Parameters:

string name: The validation name field.

string descr: Validation description.

string displayLabel: The label for the validation.

ValidationTypeEnum allowedType: An enumeration indicating how the validation can be executed.

boolean cascade: Flag indicating whether the validation is to be implicitly assigned via inheritance.

int columnWidth: (To be deprecated)

ValidationLevelEnum level: The validation level defines the scope of a business rule.

ValidationParamListType parameters: Parameters that are used by the validation during execution.

boolean setup: Flag that indicates whether the server should check the validity of the parameters.

int sortOrder: The sort order of the property definition within a category.

string validationClass: The type class of validation.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: addVersion

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Creates a version; depending on the input parameter dbConnect, the version will either be disconnected or persisted to the data store.

Input Parameters:

string versionName: Version name field.

string versionDescr: Description field.

boolean dbConnect: Flag that indicates whether the version should be persisted to the data store. If False, the version resides only in memory.

Output Parameters:

VersionType version: The version object field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: annulNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Removes the node from the hierarchy and deletes it if it is an orphan (For example, if a node has the same parent in all hierarchies in which it exists, then an annul results in the deletion of the node.) A node may only be Annulled if it has no children. If the target node has descendents, all nodes below it may be Annulled by setting annulChildNodes to true, which is equivalent to using "Annul All Below" in the DRM Web Client.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

boolean annulChildNodes: Specify "true" to Annul all nodes below the selected node. Specify "false" to Annul the selected node. The selected node may only be Annuled if it has no children.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: approveRequest

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Approves a request.

Input Parameters:

int requestId: ID of the request header.

Output Parameters:

RequestValidationResultType requestValidationResult: The request validation result. Returned when one validates a request.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: assignControlledProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Assigns a global, inheriting property to a hierarchy. This will control what hierarchy a property value is inherited from.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

string propName: Property definition name.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: beginSession

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Begins a stateful webservice session and returns a session Id which can be used for subsequent calls.

Output Parameters:

<input>

</input>

</output>

</fault>

</operation>

Operation: copyNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Copies a node and inserts that node under a Parent.

Input Parameters:

string versionName: Version name of the source node.

string hierName: Hierarchy name of the source node.

string nodeName: Node name of the source node.

string targetHierName: Hierarchy name that the node will be copied to.

string targetParentName: Parent node that the new node will be inserted as a child.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: copyNodeProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Copies a node's specified property values to an existing node.

Input Parameters:

NodeLocatorType sourceNodeLocator: Source locator indicating version, hierarchy and node.

NodeLocatorType targetNodeLocator: Target locator indicating version, hierarchy and node.

PropCopyModeEnum propCopyMode: Mode that indicates to the server which type of properties should be copied.

StringListType selectedPropNameList: If copy mode is set to selected; this list will contain the properties to copy.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: copyNodesAcrossVersions

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Copies one or more nodes from one version to another.

Input Parameters:

NodeLocatorType targetNodeLocator: Target locator indicating version, hierarchy and node.

boolean copyAsSibling: Flag indicating if the node(s) should be made siblings of the target node.

NodeLocatorListType sourceNodeLocators: List of source locators indicating version, hierarchy, and node.

boolean copyDescendantsAcrossVersions: Flag indicating whether descendant nodes should be copied.

boolean copyGlobalPropsAcrossVersions: Flag indicating whether global properties should be copied.

boolean copyLocalPropsAcrossVersions: Flag indicating whether local properties should be copied.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: copyUser

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Creates a user based upon an existing user.

Input Parameters:

string existingUserName: User name of the user to copy.

string userName: User name desired for the new user.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: copyVersion

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous job to copy a version and its contents.

Input Parameters:

string sourceVersion: Name of the version to copy.

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Deletes a blender.

Input Parameters:

string blenderName: Blender name to delete.

ObjectAccessEnum access: Object access of the blender to delete.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: deleteBook

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Deletes a book.

Input Parameters:

string bookName: Book name to delete.

ObjectAccessEnum access: Object access of the book to delete.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: deleteCompare

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Deletes a compare.

Input Parameters:

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: deleteExport

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Deletes an export.

Input Parameters:

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: deleteHier

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Deletes a hierarchy within a version.

Input Parameters:

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: deleteImport

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Deletes an import.

Input Parameters:

string importName: Name of the import to delete.

ObjectAccessEnum access: Object access of the import to delete.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: deleteNode

</output>

</fault>

</operation>

Operation: deleteNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Deletes one or more nodes within a hierarchy. Enables you to specify Merge nodes as well as destroy the nodes (if they exist under more than one parent)

Input Parameters:

Deletes a property category.

Input Parameters:

<input>

</input>

</output>

</fault>

</operation>

Operation: deleteQuery

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Deletes a query.

Input Parameters:

Input Parameters:

string versionName: Version name field.

Output Parameters:

ValidationListType validations: The assigned global node validations.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getAssignedHierValidations

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns validations assigned at the hierarchy level.

Input Parameters:

HierLocatorType hierLocator: Hierarchy locator object to identify a hierarchy within a version.

Output Parameters:

ValidationListType validations: Assigned hierarchy validations.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns validations assigned at the version level.

Input Parameters:

string versionName: Version name field.

Output Parameters:

ValidationListType validations: Assigned version validations.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getBlender

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a blender.

Input Parameters:

string blenderName: Blender name.

ObjectAccessEnum access: Object access of the blender.

Output Parameters:

<input>

</input>

</output>

</fault>

</operation>

Operation: getBlenderResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the blender results of the asynchronous Method startBlenderByName.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

BlenderResultsType blenderResult: Blender results object.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getBook

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a book.

Input Parameters:

string bookName: Book name.

ObjectAccessEnum access: Object access of the book.

Output Parameters:

BookType book: Represents the response for a book type.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getBookItemResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the individual book item results of the asynchronous startBookByName method.

Input Parameters:

BookItemResults bookResults: Asynchronous job results of a book run.

Output Parameters:

base64Binary content: Byte array of compressed bytes. Use the deflate algorithm to decompress the content.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getBookNames

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a string list of book names.

Output Parameters:

StringListType stringList: A list of strings field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getBookResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the results of the asynchronous startBookByName method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

base64Binary content: Byte array of compressed bytes. Use the deflate algorithm to decompress the content.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getBookResultsItemCount

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the number of book items results from the startBookByName method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

int intVal: Primitive int value.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getCompare

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the compare definition.

Input Parameters:

string compareName: Compare name.

ObjectAccessEnum access: Object access of the compare.

Output Parameters:

<input>

</input>

</output>

</fault>

</operation>

Operation: getCompareResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the hierarchy compare type results from the asynchronous operation.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

CompareResultType compareResult: Results of a compare operation.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getControlledPropNames

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a string list of global inheriting property names for a hierarchy.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

Output Parameters:

StringListType stringList: A list of strings field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getCopyVersionResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the results from the asynchronous startCopyVersion method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

JobInfoType jobStatus: JobInfoType type.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getCreateVersionAsOfDateResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the results from the asynchronous startCreateVersionAsOfDate method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

AsOfVersionResultType asOfVersion: AsOfVersionResultType field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getCreateVersionAsOfTxnIDResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the results from the asynchronous startCreateAsOfTxnID method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

AsOfVersionResultType asOfVersion: AsOfVersionResultType field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getDeleteVersionResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the results from the asynchronous startDeleteVersion method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

JobInfoType jobStatus: JobInfoType type.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getDomainByName

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a single domain.

Input Parameters:

string domainName: Domain name.

Output Parameters:

DomainType domain: Domain field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getDomains

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a list of all domains.

Output Parameters:

DomainTypeListType domainList: Domain list field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getExport

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a export definition.

Input Parameters:

string exportName: Export name.

ObjectAccessEnum access: Object access.

Output Parameters:

ExportType export: Export output type.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getExportDefs

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a list of exports, allowing filtering by a list of object access and/or export classes.

Input Parameters:

ObjectAccessListType accessList: Object access level list.

StringListType exportClassList: Export class list.

Output Parameters:

ExportDefListType exportDefsList: Export definitions list field.!

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getExportDimensionTree

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Method for retrieving the dimensions and column sets for an export instance when run against the specified version

Input Parameters:

string version: Version name field.

string export: Export field.

ObjectAccessEnum objectAccess: Object access field.

Output Parameters:

<input>

</input>

</output>

</fault>

</operation>

Operation: getExportResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the results from the asynchronous startExport method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

base64Binary content: Byte array of compressed bytes. Use the deflate algorithm to decompress the content.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getGlobalNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a global node within a version.

Input Parameters:

string versionName: Version name field.

string nodeName: Node name field.

StringListType propNameList: List of properties to return.

PropValueListTypeEnum returnPropValueListType: Enumeration indicating how the properties should be returned.

Output Parameters:

GlobalNodeWithPropValuesType globalNode: A response object that represents a global node object and property values.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getGlobalNodePropValues

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns specified property values for a global node within a version. This method can return property values as a name value pair OR as a values-only object.

Input Parameters:

string versionName: Version name field.

string nodeName: Node name field.

StringListType propNameList: List of properties to return.

PropValueListTypeEnum propValueListType: Enumeration indicating how the properties should be returned.

Output Parameters:

PropValueFlexListType propValueFlexList: A field that includes a list of PropValueFlexListType objects.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getGlobalNodeProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns specified property values for a global node within a version. This method returns property values as a list of PropType objects.

Input Parameters:

string versionName: Version name field.

string nodeName: Node name field.

StringListType propNameList: List of properties to return.

Output Parameters:

PropListType propList: Return list type field of PropListType types.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getGlobalNodeRefCount

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the number of references of a globalNode.

Input Parameters:

GlobalNodeLocatorType globalNodeLocator: Global node locator object to identify a global node.

Output Parameters:

int intVal: Primitive int value.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns one or more global nodes within a version. This method enables you to specify the global nodes and their property values to return.

Input Parameters:

string versionName: Version name field.

StringListType nodeNameList: List of node names to retrieve.

StringListType propNameList: List of properties to return.

PropValueListTypeEnum returnPropValueListType: Enumeration indicating how the properties should be returned.

Output Parameters:

GlobalNodeWithPropValuesListType globalNodeList: An array of global nodes.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getGlobalQueryResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the query results of the asynchronous startGlobalQuery method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

GlobalQueryResultType globalQueryResult: A query results for a global query.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getGlyph

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a glyph.

Input Parameters:

string glyphName: Name of the glyph to return.

Output Parameters:

GlyphType glyph: Glyph type object.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns all glyphs in the drm application.

Output Parameters:

GlyphListType glyphList: The list of glyphs in the DRM Application.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getHier

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a hierarchy within a version.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

Output Parameters:

HierType hier: The hierarchy object type.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getHierGroup

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a hierarchy group.

Input Parameters:

string name: The hierarchy group name to return.

Output Parameters:

HierGroup hierGroup: The hierarchy group type object.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getHierGroupNames

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns all hierarchy group names.

Output Parameters:

StringListType stringList: A list of strings field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getHierNames

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a list of hierarchy names within a version.

Input Parameters:

string versionName: Version name field.

Output Parameters:

StringListType stringList: A list of strings field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getHierPropValues

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns specified property values for a hierarchy. This method can return property values as a name value pair OR as a values-only object.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType propNameList: List of properties to return.

PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

Output Parameters:

PropValueFlexListType propValueFlexList: A field that includes a list of PropValueFlexListType objects.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getHierProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns specified property value objects for a hierarchy.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType propNameList: List of properties to return.

Output Parameters:

PropListType propList: Return list type field of PropListType types.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getHierTopNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a hierarchy top node.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType propNameList: List of properties to return.

PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

Output Parameters:

NodeWithPropValuesType node: A return type for a node and its property values.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getHiers

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a list of hierarchies for a given version.

Input Parameters:

string versionName: Version name field.

StringListType hierNameList: List of hierarchies to return.

Output Parameters:

HierListType hierList: The hierarchy group list type object.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getHiersByFilter

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Gets hierarchies based upon a filter. The following rules apply when using this operation.

If required param is null or empty an DrmServiceException will be thrown.
Operation will take the required param "versionNames" and iterate through each verison and apply filters if supplied.
If the optional versionFilters are supplied then attempt to include or exclude the versions supplied based upon the version filter.
If hier filters are supplied, then apply those filters on every hierarchy of the version being evaluated. The hierarchies that match the criteria will be included. If the hier filters param is empty then all hiers within a version will be included in the result set.

Input Parameters:

StringListType versionNames: (Required) List of versions to evaluate for the filtered list of hierarchies.

QueryPropListType versionPropFilters: (Optional) Contains a list of QueryPropType objects that represent one or more filters to apply to a Version. The QueryPropType type contains two String fields (propDefName, comparisonStringValue).

QueryPropListType hierPropFilters: (Optional) Contains a list of QueryPropType objects that represent one or more filters to apply to a Hierarchy. The QueryPropType type contains two String fields (propDefName, comparisonStringValue).

Output Parameters:

HierListType hierList: The hierarchy group list type object.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getImport

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns an import definition.

Input Parameters:

string importName: The import name to return.

ObjectAccessEnum access: The object access of the import.

Output Parameters:

<input>

</input>

</output>

</fault>

</operation>

Operation: getImportResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the import results from the asynchronous startImport OR startImportByName methods.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

ImportResultsType importResults: The results of an import run.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getJobStatus

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a asynchronous job object; the job object contains information about status and any exceptions that may have occurred.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

JobInfoType jobStatus: JobInfoType type.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getLogItems

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns transaction log items.

Input Parameters:

</operation>

Operation: getNodeAccessGroup

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a node access group.

Input Parameters:

string nodeAccessGroupName: Node access group name to return.

Output Parameters:

NodeAccessGroupType nodeAccessGroup: An object representing a node access group.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getNodeAccessGroupNames

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a list of node access group names.

Output Parameters:

StringListType stringList: A list of strings field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getNodeAccessGroupUserList

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a list of users for a node access group.

Input Parameters:

string nodeAccessGroupName: Node access group name.

Output Parameters:

StringListType stringList: A list of strings field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a node given a node ID.

Input Parameters:

StringListType propNameList: List of properties to return.

Output Parameters:

<input>

</input>

</output>

</fault>

</operation>

Operation: getNodeTypes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns an array of node type objects.

Output Parameters:

NodeTypeTypeListType nodeTypeList: A return list type for a node type.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getNodeWithProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a node and specified PropType objects.

Input Parameters:

StringListType requestedProps: List of properties to return.

int maxNodes: The maximum number of nodes to return in the result.

Output Parameters:

<input>

</input>

</output>

</fault>

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a list of specified property definition names.

Input Parameters:

ObjectScopeEnum propDefLevel: An enumeration indicating the scope of the property definition.

Output Parameters:

StringListType stringList: A list of strings field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getPropDefs

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns an array list of specified property definition objects.

Input Parameters:

ObjectScopeEnum propDefLevel: An enumeration indicating the scope of the property definition.

Output Parameters:

PropDefListType propDefList: Return list type for property definitions.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the property compare type results from the asynchronous operation.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

CompareResultType compareResult: Results of a compare operation.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getQueries

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns an array list of specified query objects.

Input Parameters:

boolean global: Flag indicating if global queries should be returned.

StringListType queryNameList: The list of queries to return.

Output Parameters:

QueryListType queryList: Field for a queryListType object.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getQuery

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a query by name.

Input Parameters:

string queryName: The name of the query.

ObjectAccessEnum access: The object access of the query.

Output Parameters:

<input>

</input>

</output>

</fault>

</operation>

Operation: getQueryResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns query results for the asynchronous startQuery method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

QueryResultType queryResult: A list type of queryResultType types.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getRelatedNodeCount

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the related node count for a given node given the input of: ancestors, children, descendants, siblings.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

RelationshipEnum relationship: An enumeration indicating what types of nodes to return (Children, Descendants, and so on).

boolean visibleOnly: Flag indicating that visible children should only be returned.

boolean includeLeaves: Flag to include leaf nodes.

Output Parameters:

int intVal: Primitive int value.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getRelatedNodeNames

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns related node names for a given node given the input of: ancestors, children, descendants, siblings.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

RelationshipEnum relationship: An enumeration indicating what types of nodes to return (i.e. Children, Descendants, etc).

Output Parameters:

StringListType stringList: A list of strings field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getRelatedNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the related nodes for a node given the input of: ancestors, children, descendants, siblings.

Input Parameters:

string versionName: Version name field.

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

CompareResultType compareResult: Results of a compare operation.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getRequestByExternalId

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a request by external ID.

Input Parameters:

string externalId: The free-form field on a request object.

Output Parameters:

RequestHeaderListType requestHeaderList: List of request headers.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the results of the asynchronous startSaveVersion method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

JobInfoType jobStatus: JobInfoType type.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getScriptFromLog

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a list of action items from transaction log criteria.

Input Parameters:

LogCriteriaType logCriteria: An object representing criteria for transaction history.

Output Parameters:

ActionItemListType getScriptFromLogResponse: List of action item objects.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getScriptFromModel

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a list of action items for modeling a node.

Input Parameters:

string versionName: Version name field.

string nodeName: Node name field.

string newNodeName: The new node name to create.

string newNodeDescr: The new node description.

StringListType hierNameList: The list of hierarchies the existing node exists in.

PropCopyModeEnum propCopyMode: An enumeration indicating what type of properties should be included.

StringListType propNameList: If the copy mode is selected then this list of properties will be evaluated in the node model operation.

Output Parameters:

ActionItemListType getScriptFromModelResponse: List of action items.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getScriptResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns the results of the asynchronous startScript method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

ActionItemResultListType actionItemList: List of action items.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getSysPrefValue

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a system preference value.

Input Parameters:

string systemPreferenceName: The name of the system preference to return.

Output Parameters:

StringResponseType result: The result of the GetSysPrefValue operation.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getSysPrefs

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns all of the system preferences.

Output Parameters:

SystemPreferenceListType systemPreferences: The list result of system preference values.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getUser

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a user by name.

Input Parameters:

string userName: The user name of the user to retrieve.

Output Parameters:

UserType user: Represents a user object.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getUserNames

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a list of user names.

Output Parameters:

StringListType stringList: A list of strings field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getValidation

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a validation.

Input Parameters:

string validationName: The name of the validation to retrieve.

Output Parameters:

ValidationDefinitionType validation: The validation object.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getValidationNames

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a list of validation names.

Output Parameters:

<input>

</input>

</output>

</fault>

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a Name/Value pair list of properties for each version name passed in as input.

Input Parameters:

StringListType versionNames: List of Versions to get properties for.

StringListType propNameList: List of properties to return.

Output Parameters:

PropMapListType propMapList:

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getVersionMigrationExportResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Polls the status of an existing version migration export job.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

JobInfoType jobStatus: JobInfoType type.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getVersionMigrationImportResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Polls the status of an existing version migration import job.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

<input>

</input>

</output>

</fault>

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a list of version objects.

Input Parameters:

boolean isIncludeVariables: Includes version variables in the list of versions returned.

Output Parameters:

VersionListType versionList: List type of versionType objects.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getVersionPropValues

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns version level property values for a version. This method can return property values as a name value pair OR as a values-only object.

Input Parameters:

string versionName: Version name field.

StringListType propNameList: List of properties to return.

PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

Output Parameters:

PropValueFlexListType propValueFlexList: A field that includes a list of PropValueFlexListType objects.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getVersionProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns an array of specified version level property types.

Input Parameters:

string versionName: Version name field.

StringListType propNameList: List of properties to return.

Output Parameters:

PropListType propList: Return list type field of PropListType types.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getVersionVariable

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a version variable object.

Input Parameters:

string versionVariableName: Version variable name.

Output Parameters:

VersionVariableType versionVariable: Version variable field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getVersionVariables

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns a list of version variable objects.

Output Parameters:

VersionVariableListType versionVariableList: Version variable list field

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getVersions

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns an array of specified versions.

Input Parameters:

StringListType versionNameList: A list of version names.

Output Parameters:

VersionListType versionList: List type of versionType objects.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: getVersionsByFilter

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns versions objects based upon version and hierarchy filters.

Input Parameters:

SearchVersionTypeList searchVersionTypes: (Required) List of VersionTypeEnum enumerations.

SearchVersionStatusList searchVersionStatuses: (Required) List of VersionStatusEnum enumerations.

QueryPropListType hierPropFilters: (Optional) Contains a list of QueryPropType objects that represent one or more filters for a hierarchy. The QueryPropType type contains two string fields (propDefName, comparisonStringValue).

Output Parameters:

VersionListType versionList: List type of versionType objects.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: inactivateNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Inactivates a node.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name to inactivate.

string mergeNodeName: The name of the node to merge this inactive node to (if merging is enabled).

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: inactivateNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Inactivates specified nodes.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType nodeNameList: List of nodes to inactivate.

StringListType mergeNodeNameList: List of node names to merge the corresponding nodeNameList with (if merging is enabled).

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: insertNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Inserts a node under a parent node in a hierarchy.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

string targetParentName: The existing parent node name to insert this node under.

NameValueListType propNameValueList: Name/Value Pair list field for property definition name and value for the node property value.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: insertNodeWithProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Inserts a node under a parent node in a hierarchy. This method also updates node properties that are specified in the input parameters.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

string targetParentName: The existing parent node name to insert this node under.

PropListType propList: Array of properties to update.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: insertNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Inserts one or more nodes under a parent node.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType nodeNameList: List of nodes to insert under a new parent.

string targetParentName: The existing parent node name to insert this node under.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: moveNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Moves a node to a new parent node in a hierarchy.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

string targetParentName: The name of the new parent node.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: moveNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Moves one or more nodes to new parent node in a hierarchy.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType nodeNameList: List of node names to move.

string targetParentName: The name of the new parent node.

</input>

</output>

</fault>

</operation>

Operation: orderChildren

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Orders children nodes for a given parent node.

Input Parameters:

NodeLocatorType nodeLocator: Node locator object representing a node within a hierarchy.

StringListType nodeNames: List of nodes to order. The sequence of this list will be used to order the children.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: queryRequests

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Returns request headers given query criteria.

Input Parameters:

RequestQueryParamsType requestQueryParams: Field for request query parameters.

Output Parameters:

RequestHeaderListType requestHeaderList: List of request headers.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: reactivateNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Reactivates a inactive node.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: reactivateNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Reactivates one or more inactive nodes.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType nodeNameList: List of node names to reactivate.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: removeNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Removes a parent child relationship for a node within a hierarchy; the node is not physically deleted.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: removeNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Removes a parent child relationship for one or more nodes within a hierarchy; the nodes are not physically deleted.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType nodeNameList: A list of node names to remove.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: runBlenderByName

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Runs an existing blender and returns the results.

Input Parameters:

string blenderName: The name of a blender.

string sourceVersionName: The source version name.

string targetVersionName: The target version name.

ObjectAccessEnum access: Access level of the blender to run.

string newVersionName: If present, the new version name that will be created as a result of the blend operation instead of blending into the target version.

string newVersionDescr: If present, the new version description that will be created as a result of the blend operation instead of blending into the target version.

int timeoutDuration: A timeout value in milliseconds to stop waiting for blender results.

NameValueListType runtimeParameters: The list of parameters to add to/override the saved default runtime parameters.

Output Parameters:

BlenderResultsType blenderResult: Blender results object.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: runCompare

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Runs a compare given compareCriteria and a string list of properties to return with the results.

Input Parameters:

CompareType compareCriteria: The compare criteria to be used to run the compare.

StringListType returnPropNameList: List of property values to return after the compare.

Output Parameters:

CompareResultType compareResult: Results of a compare operation.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: runCompareByName

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Runs a compare given a compare name. This method runs an existing compare.

Input Parameters:

string compareName: The compare name to run.

string fromVersionName: The source version name for the compare.

string toVersionName: The target version name for the compare.

ObjectAccessEnum access: Access level of the compare to run.

StringListType returnPropNameList: List of property values to return after the compare.

NameValueListType runtimeParameters: the list of parameters to add to/override the saved default runtime parameters.

Output Parameters:

CompareResultType compareResult: Results of a compare operation.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: runGlobalQuery

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Runs a global query and returns the query results.

Input Parameters:

QueryType query: The query criteria for the global query.

StringListType propNameList: List of property values to return after the query.

Output Parameters:

GlobalQueryResultType globalQueryResult: A query results for a global query.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: runQuery

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Rusn a local query and returns the query results.

Input Parameters:

StringListType validationNameList: List of validation names to run for the node.

boolean recurse: Flag indicating if the validation should run the node specified and its descendants.

int maxNodes: The maximum number of validation results to return.

StringListType propNameList: List of properties to return in the validation results.

Output Parameters:

QueryResultType queryResult: A list type of queryResultType types.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: runValidateVersion

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Runs batch validations on a given version and returns the results.

Input Parameters:

string versionName: Version name field.

StringListType validationNameList: List of validation names to run for the version.

int maxNodes: The maximum number of validation results to return.

StringListType propNameList: List of properties to return in the validation results.

Output Parameters:

VersionValidationResultType validationResult: The version validation results.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: searchForNodesInHier

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Finds nodes within a hierarchy given a search value.

Input Parameters:

string versionName: Version name field.

string versionName: Version name field.

string hierName: Hierarchy name field.

string topNodeName: The top node name.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: setHierValidations

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Assigns validations at the hierarchy level (RealTime or Batch).

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType validationNameList: List of validation names.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: setUserPassword

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Updates an internal user's password.

Input Parameters:

string userName: The username field.

string newPassword: The new password for the user.

PasswordExpireEnum passwordExpireType: An enumeration indicating how the password should expire.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: setVersionValidations

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Assigns validations at the version level (RealTime or Batch).

Input Parameters:

string versionName: Version name field.

StringListType validationNameList: List of version names.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: setVersionVariable

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Assigns an existing version to an existing version variable.

Input Parameters:

string variable: Variable name field.

string version: Version name field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startBlenderByName

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts a asynchronous blender job.

Input Parameters:

string blenderName: The blender name field.

string sourceVersionName: The source version name.

CompareType compareCriteria: The compare criteria to be used for the compare.

StringListType returnPropNameList: List of properties to return in the results.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startCompareByName

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous compare job by compare name. The following compare types are supported by this operation(hierarchy, property, rename).

Input Parameters:

string compareName: The compare name field.

string fromVersionName: The from version name field.

string toVersionName: The to version name field.

ObjectAccessEnum access: The object access field for the book.

StringListType returnPropNameList: List of properties to return in the results.

NameValueListType runtimeParameters: The list of parameters to add to/override the saved default runtime parameters.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startCompareExportByName

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous compare export job by export name.

Input Parameters:

string exportName: The name of the compare export.

string fromVersionName: The from version name field.

string toVersionName: The to version name field.

ObjectAccessEnum access: The object access level of the export.

NameValueListType runtimeParameters: The list of parameters to add to/override the saved default runtime parameters.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startCompareExportByNameOnHier

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts a asynchronous compare export for a hierarchy.

Input Parameters:

string exportName: The name of the compare export.

string fromVersionName: The from version name field.

string fromHierName: The from hierarchy name field.

string toVersionName: The to version name field.

string toHierName: The to hierarchy name field.

ObjectAccessEnum access: Access level of the export to run.

NameValueListType runtimeParameters: The list of parameters to add to/override the saved default runtime parameters.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startCompareExportByNameOnHierNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous compare export for a node.

Input Parameters:

string exportName: The name of the compare export.

string fromVersionName: The from version name field.

HierNodeNamePairType fromHierNode: The from hierarchy name field.

string toVersionName: The to version name field.

HierNodeNamePairType toHierNode: The to hierarchy name field.

ObjectAccessEnum access: Access level of the export to run.

NameValueListType runtimeParameters: The list of parameters to add to/override the saved default runtime parameters.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startCopyVersion

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous copy version job.

Input Parameters:

string sourceVersionName: The name of the version to copy.

string destVersionName: The new name of the version.

string destDescr: The new description field of the version.

boolean clearApproval: Flag indicating that the approval flags should be cleared.

boolean clearChanged: Flag indicating that the changed on properties should be cleared.

boolean dbConnect: Flag indicating that the version should be persisted to the data store.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startCreateAsOfTxnID

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous job to create a as of version based upon transaction Id.

Input Parameters:

string versionName: Version name field.

int endTxnId: Ending transaction ID field.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startCreateVersionAsOfDate

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous job to create a as of version based upon a date.

Input Parameters:

string versionName: Version name field.

dateTime asOfDateTime: A date time value to create the version snapshot.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startDeleteVersion

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts ann asynchronous job to delete a version.

Input Parameters:

string versionName: Version name field.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startExport

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous export job using a export definition of the following allowed types. Note: The base type ExportType should not be passed in as input.

TransLogExportType
PropListExportType
EPMArchitectExportType
LookupExportType
VersionExportType
HierDiffExportType
HierExportType
HierCompareExportType
MergeLogExportType
GenerationExportType
XmlHierExportType

Input Parameters:

ExportType export: The export type field.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startExportByName

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous export job for a saved export definition; the types of exports supported by this operation are:

TransLogExportType
PropListExportType
EPMArchitectExportType
LookupExportType
VersionExportType
HierDiffExportType
HierExportType
HierCompareExportType
MergeLogExportType
GenerationExportType
XmlHierExportType

Input Parameters:

string exportName: The export name to run.

ObjectAccessEnum access: Access level of the export to run.

string fromVersionName: The from version name field.

string toVersionName: The to version name field.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startGlobalQuery

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous query job using query definition. Also returns specified properties for query matches.

Input Parameters:

QueryType query: The query criteria field.

StringListType propNameList: List of properties to return in the results.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startHierExportByName

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous job for an existing hierarchy export definition.

Input Parameters:

string exportName: The export name to run.

string versionName: Version name field.

boolean includeAllHiers: Flag indicating that the export should include all hierarchies.

ObjectAccessEnum access: Access level of the export to run.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startHierExportByNameOnHierNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous job for an existing hierarchy export definition. This method enables you to specify only one node per hierarchy as the node to export from.

Input Parameters:

string exportName: The export name to run.

string versionName: Version name field.

HierNodeNamePairType hierNode: The hierarchy node field.

ObjectAccessEnum access: Access level of the export to run.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startHierExportByNameOnHierNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous job for an existing hierarchy export definition. This method enables you to specify nodes per hierarchy as the node to export from.

Input Parameters:

string exportName: The export name to run.

string versionName: Version name field.

HierNodeNamePairListType hierNodeList: A list type with hierarchy/node pairs.

ObjectAccessEnum access: Access level of the export to run.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startHierExportByNameOnHiers

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous job for an existing hierarchy export definition. This method enables you to set a list of hierarchies within a version to export; each hierarchy specified is exported from its top node.

Input Parameters:

string exportName: The export name to run.

string versionName: Version name field.

StringListType hierNameList: A list type fo hierarchy names.

ObjectAccessEnum access: Access level of the export to run.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startImport

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous job to import given an import definition.

Input Parameters:

ImportType importProfile: The import profile field.

base64Binary compressedFileContent: Byte array of compressed bytes that represent the script file. The deflate algorithm should be used to compress the content.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startImportByName

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous job to import given an import definition.

Input Parameters:

string importName: The import name field.

base64Binary compressedFileContent: Byte array of compressed bytes that represent the file. The deflate algorithm should be used to compress the content.

ObjectAccessEnum access: Access level of the import.

string versionName: Version name field. This field value will be used as the name of the version.

string versionDescription: Version description field. This field value will be used as the description of the version.

NameValueListType runtimeParameters: The list of parameters to add to/override the saved default runtime parameters.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startQuery

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous job for a query given a query definition.

Input Parameters:

QueryType query: Query criteria field.

StringListType propNameList: List of properties to return in the results.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startSaveVersion

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous job to save a version.

Input Parameters:

string versionName: Version name field.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts an asynchronous action script given a action script file.

Input Parameters:

ScriptLoadParamsType scriptLoaderParams: Field describes the action script content to be processed.

int codePageNumber: Code page number field.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startVersionMigrationExport

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start a job that generates a version migration file from an existing version.

Input Parameters:

StringListType versionNames: Version names field.

string externalConnection: Name of the external connection.

string filename: File name field.

Output Parameters:

JobInfoType jobInfo: Job info field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: startVersionMigrationImport

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Starts a job that loads versions from a version migration file.

Input Parameters:

NameValueListType versionAbbrevMapping: Version abbrev mapping.

string externalConnection: Name of the external connection.

string filename: File name field.

Output Parameters:

<input>

</input>

</output>

</fault>

</operation>

Operation: updateBook

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Updates an existing book.

Input Parameters:

<input>

</input>

</output>

</fault>

</operation>

Operation: updateDomain

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Updates an existing domain.

Input Parameters:

string name: Name of the domain.

string qualifier: Qualifier for the domain.

boolean qualifierSuffix: Boolean specifying if the qualifier is a suffix of prefix.

<input>

</input>

</output>

</fault>

</operation>

Operation: updateHierPropValues

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Updates property values for a hierarchy given a namevalue list type object.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

NameValueListType propValueList: A name value list type field that indicates the properties and their values.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: updateHierProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Updates property values for a hierarchy given a list of proptype objects.

Input Parameters:

Updates a nodes property values by specifying list of name/value types.

Input Parameters:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

NameValueListType propNameValueList: Name/Value Pair list field for property definition name and value for the node property value.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: updateNodeProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Updates a nodes property values given a list of proptype object.

Input Parameters:

Location: DrmService.wsdl

Updates a property definitions list values.

Input Parameters:

string propDefName: Property definition name for a list type property definition.

StringListType listValues: List of values to update the property with.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: updateQuery

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Updates an existing query.

Input Parameters:

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: updateUser

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Updates an existing user.

Input Parameters:

<input>

</input>

</output>

</fault>

</operation>

Operation: updateUserPassword

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Updates a password for a user other than the current user.

Input Parameters:

string userName: The existing user name field.

string oldPassword: The old password field.

string newPassword: The new password field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: updateValidation

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Updates an existing validation.

Input Parameters:

ValidationDefinitionType validation: The validation object field.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: updateVersionPropValues

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Updates a versions property values by specifying list of name/value types.

Input Parameters:

string versionName: Version name field.

NameValueListType propValueList: List type of nameValueListType for properties and their values.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: updateVersionProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Updates a versions property values by specifying an array of proptype objects.

Input Parameters:

string versionName: Version name field.

PropListType propList: List type of PropListType for properties and their values.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: validateRequest

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Validates an existing request.

Input Parameters:

RequestType request: The request to validate.

boolean saveIfSuccessful: Flag indicating that the request should be saved if the validation was successful.

Output Parameters:

RequestValidationResultType requestValidationResult: The request validation result. Returned when one validates a request.

+Operation Definition

</operation>

+Binding Operation Definition

<input>

</input>

</output>

</fault>

</operation>

Operation: validateRequest

Elements

Element: AppParameters

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

This type is to be passed in the soap header.

Fields:

string serverUrl: API adapter URL of the DRM Server. Example: http://localhost:5240/Oracle/Drm/APIAdapter?wsdl

string sessionParams: Represents session parameters for the DRM server. Example: ProductVersion=11.1.2;CultureName=en-US;TimeZoneOffset=-360

+Element Definition

Element: DrmServiceException

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Exception class for Web Service methods.

Fields:

string Message: Exception message.

int Code: Error code value for the message.

+Element Definition

Referenced By:

Message: DrmServiceException

Element: SessionMaintainParams

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

This type is to be passed in the soap header.

Fields:

string sessionId: The session id that is to be passed in by the client when stateful session is desired. This value is initially obtained from the beginSession operation.

+Element Definition

Element: addDomain

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Domain input parameter.

Fields:

string name: Domain name field.

string qualifier: Qualifier text field.

boolean qualifierSuffix: Qualifier suffix boolean field. Determines if the qualifier is a suffix or prefix.

string delimiter: Delimiter field.

boolean canDeleteNodes: Boolean specifying if domain nodes can be deleted from versions.

boolean canEditLeaf: Boolean specifying if domain nodes can have the Leaf property edited

boolean canEditQualifier: Boolean specifying if the qualifier can be edited after saving the domain.

DomainValidationAssignmentListType validations: The validation definition names to associate with this node type.

+Element Definition

Referenced By:

Message: addDomain

Element: addDomainResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add domain output parameter.

+Element Definition

Referenced By:

Message: addDomainResponse

Element: addGlyph

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Glyph input parameter.

Fields:

string name: Name of glyph.

string descr: Description of glyph.

string imageData: Base-64 string value of the byte data.

ImageTypeEnum imageTypeEnum: Currently supported image types are PNG.

+Element Definition

Referenced By:

Message: addGlyph

Element: addGlyphResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add glyph output parameter.

+Element Definition

Referenced By:

Message: addGlyphResponse

Element: addHier

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add hierarchy parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string descr: Hierarchy description field.

string topNodeName: Top node name field.

string topNodeDescr: Top node description field.

+Element Definition

Referenced By:

Message: addHier

Element: addHierGroup

Namespace: http://drm.webservices.epm.oracle

string versionName: Version name field.

string hierName: Hierarchy name field.

string parentName: Parent node name field.

string nodeName: Node name field.

string nodeDescription:

boolean isLeaf: Field indicating whether node is a leaf node.

string domainName: Domain name field.

NameValueListType propNameValueList: Name/value pair list field for property definition name and value for the node property value.

boolean updateIfExists: If True and the node exists, then update the properties for the node; if the node exists and this flag is False, then skip property updates.

+Element Definition

Referenced By:

Message: addNode

Element: addNodeAccessGroup

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add node type input parameter.

Fields:

string name: Name of the node type.

string descr: Description of the node type.

StringListType propNameList: Property definition names to associate with this node type.

StringListType categoryNameList: The property category names to associate with this node type.

StringListType validationList: The validation definition names to associate with this node type.

string glyphName: The glyph name to associate with this node type.

+Element Definition

Referenced By:

Message: addNodeType

Element: addNodeTypeResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add node type output parameter.

+Element Definition

Referenced By:

Message: addNodeTypeResponse

Element: addNodeWithProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add node with properties input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string parentName: Parent node name field.

string nodeName: Node name field.

string nodeDescription:

string domainName: Domain name field.

boolean isLeaf: Field indicating if node is a leaf node.

PropListType propList: The list of properties and their values to set on the node.

boolean updateIfExists: If True and the node exists, then update the properties for the node; if the node exists and this flag is False, then skip property updates.

+Element Definition

Referenced By:

Message: addNodeWithProps

Element: addNodeWithPropsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add node with properties output parameter.

+Element Definition

Referenced By:

Message: addNodeWithPropsResponse

Element: addOrphanNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add Orphan node input parameter.

Fields:

string versionName: Version name field.

string nodeName: Node name field.

string nodeDescription:

string domainName: Domain name field.

boolean isLeaf: Field indicating whether node is a leaf node.

+Element Definition

Referenced By:

Message: addOrphanNode

Element: addOrphanNodeResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add Orphan node output parameter.

+Element Definition

Referenced By:

Message: addOrphanNodeResponse

Element: addPropCategory

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add property category input parameter.

Fields:

string propCategoryName: Property category name field.

string descr: Property category description field.

PropCategoryTypeEnum propCategoryType: An enumeration value indicating the type of property category.

StringListType propNameList: A list of property definition names to associate with this property category.

boolean availableUserCategory: Flag indicating whether the category should be saved as a user category.

int order: The order in which the property category appears in the property editor.

+Element Definition

Referenced By:

Message: addPropCategory

Element: addPropCategoryResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add property category output parameter.

+Element Definition

Referenced By:

Message: addPropCategoryResponse

Element: addPropDef

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add property definition input parameter.

Fields:

PropDefType propDef: A property definition object field.

+Element Definition

Referenced By:

Message: addPropDef

Element: addPropDefResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add property definition output parameter.

+Element Definition

Referenced By:

Message: addPropDefResponse

Element: addUser

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add user input parameter.

Fields:

UserInputType userInput: User input object field.

string password: The password to set for this new user.

+Element Definition

Referenced By:

Message: addUser

Element: addUserResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add user output parameter.

+Element Definition

Referenced By:

Message: addUserResponse

Element: addValidation

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add validation definition input parameter.

Fields:

string name: The validation name field.

string descr: Validation description.

string displayLabel: The label for the validation.

ValidationTypeEnum allowedType: An enumeration indicating how the validation can be executed.

boolean cascade: Flag indicating whether the validation is to be implicitly assigned via inheritance.

int columnWidth: (To be deprecated)

ValidationLevelEnum level: The validation level defines the scope of a business rule.

ValidationParamListType parameters: Parameters that are used by the validation during execution.

boolean setup: Flag that indicates whether the server should check the validity of the parameters.

int sortOrder: The sort order of the property definition within a category.

string validationClass: The type class of validation.

+Element Definition

Referenced By:

Message: addValidation

Element: addValidationResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add validation definition output parameter.

+Element Definition

Referenced By:

Message: addValidationResponse

Element: addVersion

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add version input parameter.

Fields:

string versionName: Version name field.

string versionDescr: Description field.

boolean dbConnect: Flag that indicates whether the version should be persisted to the data store. If False, the version resides only in memory.

+Element Definition

Referenced By:

Message: addVersion

Element: addVersionResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Add version output parameter.

Fields:

VersionType version: The version object field.

+Element Definition

Referenced By:

Message: addVersionResponse

Element: annulNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Annul node input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

boolean annulChildNodes: Specify "true" to Annul all nodes below the selected node. Specify "false" to Annul the selected node. The selected node may only be Annuled if it has no children.

+Element Definition

Referenced By:

Message: annulNode

Element: annulNodeResponse

Referenced By:

Message: beginSession

Element: beginSessionResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Begin Session output parameter.

Fields:

string return: Stateful session Id value.

+Element Definition

Referenced By:

Message: beginSessionResponse

Element: closeVersion

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Close version input parameter.

Fields:

string versionName: Version name field.

+Element Definition

Referenced By:

Message: closeVersion

Element: closeVersionResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Close version output parameter.

+Element Definition

Referenced By:

Message: closeVersionResponse

Element: copyNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Copy node input parameter.

Fields:

string versionName: Version name of the source node.

string hierName: Hierarchy name of the source node.

string nodeName: Node name of the source node.

string targetHierName: Hierarchy name that the node will be copied to.

string targetParentName: Parent node that the new node will be inserted as a child.

+Element Definition

Referenced By:

Message: copyNode

Element: copyNodeProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Copy node properties input parameter.

Fields:

Element: copyNodesAcrossVersions

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Copy node across versions input parameter.

Fields:

NodeLocatorType targetNodeLocator: Target locator indicating version, hierarchy and node.

boolean copyAsSibling: Flag indicating if the node(s) should be made siblings of the target node.

NodeLocatorListType sourceNodeLocators: List of source locators indicating version, hierarchy, and node.

boolean copyDescendantsAcrossVersions: Flag indicating whether descendant nodes should be copied.

boolean copyGlobalPropsAcrossVersions: Flag indicating whether global properties should be copied.

boolean copyLocalPropsAcrossVersions: Flag indicating whether local properties should be copied.

+Element Definition

Referenced By:

Message: copyNodesAcrossVersions

Element: copyNodesAcrossVersionsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Copy node across versions output parameter.

Fields:

JobInfoType jobInfo: Job info field.

+Element Definition

Referenced By:

Message: copyNodesAcrossVersionsResponse

Element: copyUser

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Copy user input parameter.

Fields:

string existingUserName: User name of the user to copy.

string userName: User name desired for the new user.

+Element Definition

Referenced By:

Message: copyUser

Element: copyUserResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Copy user output parameter.

+Element Definition

Referenced By:

Message: copyUserResponse

Element: copyVersion

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Copy version input parameter.

Fields:

string sourceVersion: Name of the version to copy.

string targetVersion: Name of the new version.

string targetDescr: Description of the new version.

boolean clearApproval: Flag indicating whether the approval flags should be cleared.

boolean clearChanged: Flag indicating whether the changed on properties should be cleared.

boolean dbConnect: Flag indicating whether the version should be persisted to the data store.

+Element Definition

Referenced By:

Message: copyVersion

Element: copyVersionResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Copy version output parameter.

+Element Definition

Referenced By:

Message: copyVersionResponse

Element: createBlender

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Create blender input parameter.

Fields:

BlenderType blender: The input parameter for a blender.

+Element Definition

Referenced By:

Message: createBlender

Element: createBlenderResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Create blender output parameter.

+Element Definition

Referenced By:

Message: createBlenderResponse

Element: createBook

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Create book input parameter.

Fields:

BookType book: The input parameter for a book.

+Element Definition

Referenced By:

Message: createBook

Element: createBookResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Create book output parameter.

+Element Definition

Referenced By:

Message: createBookResponse

Element: createCompare

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Create compare input parameter.

Fields:

CompareType compare: The input parameter for creating a compare.

+Element Definition

Referenced By:

Message: createCompare

Element: createCompareResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Create compare output parameter.

+Element Definition

Referenced By:

Message: createCompareResponse

Element: createExport

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Create export input parameter.

Fields:

ExportType export: The input parameter for creating an export.

+Element Definition

Referenced By:

Message: createExport

Element: createExportResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Create export output parameter.

+Element Definition

Referenced By:

Message: createExportResponse

Element: createImport

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Create import input parameter.

Fields:

ImportType importDef: The input parameter for creating an import.

+Element Definition

Referenced By:

Message: createImport

Element: createImportResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Create import output parameter.

+Element Definition

Referenced By:

Message: createImportResponse

Element: createQuery

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Create query input parameter.

Fields:

QueryType query: The input parameter for creating a query.

+Element Definition

Referenced By:

Message: createQuery

Element: createQueryResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Create query output parameter.

+Element Definition

Referenced By:

Message: createQueryResponse

Element: createRequest

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Create request input parameter.

Fields:

RequestType request: The input parameter for creating a request.

+Element Definition

Referenced By:

Message: createRequest

Element: createRequestResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Create request output parameter.

+Element Definition

Referenced By:

Message: createRequestResponse

Element: deleteBlender

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete blender input parameter.

Fields:

string blenderName: Blender name to delete.

ObjectAccessEnum access: Object access of the blender to delete.

+Element Definition

Referenced By:

Message: deleteBlender

Element: deleteBlenderResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete blender output parameter.

+Element Definition

Referenced By:

Message: deleteBlenderResponse

Element: deleteBook

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete book input parameter.

Fields:

string bookName: Book name to delete.

ObjectAccessEnum access: Object access of the book to delete.

+Element Definition

Referenced By:

Message: deleteBook

Element: deleteBookResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete book output parameter.

+Element Definition

Referenced By:

Message: deleteBookResponse

Element: deleteCompare

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete compare input parameter.

Fields:

string compareName: Compare name to delete.

ObjectAccessEnum access: Object access of the compare to delete.

+Element Definition

Referenced By:

Message: deleteCompare

Element: deleteCompareResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete compare output parameter.

+Element Definition

Referenced By:

Message: deleteCompareResponse

Element: deleteDomain

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete domain input parameter.

Fields:

string name: Domain name field.

+Element Definition

Referenced By:

Message: deleteDomain

Element: deleteDomainResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete domain output parameter.

+Element Definition

Referenced By:

Message: deleteDomainResponse

Element: deleteExport

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete export input parameter.

Fields:

string exportName: Export name to delete.

ObjectAccessEnum access: Object access of the export to delete.

+Element Definition

Referenced By:

Message: deleteExport

Element: deleteExportResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete export output parameter.

+Element Definition

Referenced By:

Message: deleteExportResponse

Element: deleteGlyph

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete glyph input parameter.

Fields:

string glyphName: Glyph name to delete.

+Element Definition

Referenced By:

Message: deleteGlyph

Element: deleteGlyphResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete glyph output parameter.

+Element Definition

Referenced By:

Message: deleteGlyphResponse

Element: deleteHier

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete hierarchy input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

+Element Definition

Referenced By:

Message: deleteHier

Element: deleteHierGroup

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete import input parameter.

Fields:

string importName: Name of the import to delete.

ObjectAccessEnum access: Object access of the import to delete.

+Element Definition

Referenced By:

Message: deleteImport

Element: deleteImportResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete import output parameter.

+Element Definition

Referenced By:

Message: deleteImportResponse

Element: deleteNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete node input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

string mergeNodeName: Name of a node to merge with (if merging is desired and enabled).

boolean destroyNode: Flag indicating that the node should be permanently deleted if the node becomes an orphan after merging.

+Element Definition

Referenced By:

Message: deleteNode

Element: deleteNodeAccessGroup

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete node type input parameter.

Fields:

string nodeTypeName: Name of the node type to delete.

+Element Definition

Referenced By:

Message: deleteNodeType

Element: deleteNodeTypeResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete node type output parameter.

+Element Definition

Referenced By:

Message: deleteNodeTypeResponse

Element: deleteNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete nodes input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType nodeNameList: List of nodes to delete.

StringListType mergeNodeNameList: Name of the nodes to merge with (if merging is desired and enabled).

boolean destroyNodes: Flag indicating that the nodes should be permanently deleted if the nodes become orphans after merging.

+Element Definition

Referenced By:

Message: deleteNodes

Element: deleteNodesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete nodes output parameter.

+Element Definition

Referenced By:

Message: deleteNodesResponse

Element: deleteOrphanNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete Orphan nodes input parameter.

Fields:

string versionName: Version name field.

StringListType nodeNames: List of orphan nodes to permanently delete.

StringListType mergeNodes: Name of the nodes to merge with (if merging is desired and enabled).

+Element Definition

Referenced By:

Message: deleteOrphanNodes

Element: deleteOrphanNodesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete Orphan nodes output parameter.

+Element Definition

Referenced By:

Message: deleteOrphanNodesResponse

Element: deletePropCategory

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete property category input parameter.

Fields:

string propCategoryName: Name of the property category to delete.

+Element Definition

Referenced By:

Message: deletePropCategory

Element: deletePropCategoryResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete property category output parameter.

+Element Definition

Referenced By:

Message: deletePropCategoryResponse

Element: deletePropDef

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete property input parameter.

Fields:

string propDefName: Name of the property definition to delete.

+Element Definition

Referenced By:

Message: deletePropDef

Element: deletePropDefResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete property output parameter.

+Element Definition

Referenced By:

Message: deletePropDefResponse

Element: deleteQuery

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete query input parameter.

Fields:

string queryName: Name of the query to delete.

ObjectAccessEnum objectAccess: Object access of the query to delete.

+Element Definition

Referenced By:

Message: deleteQuery

Element: deleteQueryResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete query output parameter.

+Element Definition

Referenced By:

Message: deleteQueryResponse

Element: deleteRequest

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete request input parameter.

Fields:

int requestId: ID of the request to delete.

+Element Definition

Referenced By:

Message: deleteRequest

Element: deleteRequestResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete request output parameter.

+Element Definition

Referenced By:

Message: deleteRequestResponse

Element: deleteUser

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete user input parameter.

Fields:

string userName: User name of the user to delete.

+Element Definition

Referenced By:

Message: deleteUser

Element: deleteUserResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete user output parameter.

+Element Definition

Referenced By:

Message: deleteUserResponse

Element: deleteValidation

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete validation input parameter.

Fields:

string validationName: Name of the validation to delete.

+Element Definition

Referenced By:

Message: deleteValidation

Element: deleteValidationResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Delete validation output parameter.

+Element Definition

Referenced By:

Message: deleteValidationResponse

Element: endSession

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

End Session input parameter.

Fields:

string sessionId: Stateful session Id value.

+Element Definition

Referenced By:

Message: endSession

Element: endSessionResponse

Get blender input parameter.

Fields:

string blenderName: Blender name.

ObjectAccessEnum access: Object access of the blender.

+Element Definition

Referenced By:

Message: getBlender

Element: getBlenderNames

Get blender results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

+Element Definition

Referenced By:

Message: getBlenderResults

Element: getBlenderResultsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get blender results output parameter.

Fields:

BlenderResultsType blenderResult: Blender results object.

+Element Definition

Referenced By:

Message: getBlenderResultsResponse

Element: getBook

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get book input parameter.

Fields:

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

+Element Definition

Referenced By:

Message: getBookResults

Element: getBookResultsItemCount

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get book results item count input parameter.

Fields:

Fields:

string compareName: Compare name.

ObjectAccessEnum access: Object access of the compare.

+Element Definition

Referenced By:

Message: getCompare

Element: getCompareNames

Get hierarchy compare results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

+Element Definition

Referenced By:

Message: getCompareResults

Element: getCompareResultsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get hierarchy compare results output parameter.

Fields:

CompareResultType compareResult: Results of a compare operation.

+Element Definition

Referenced By:

Message: getCompareResultsResponse

Element: getControlledPropNames

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get controlled property names input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

+Element Definition

Referenced By:

Message: getControlledPropNames

Element: getControlledPropNamesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get controlled property names output parameter.

Fields:

StringListType stringList: A list of strings field.

+Element Definition

Referenced By:

Message: getControlledPropNamesResponse

Element: getCopyVersionResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get copy version results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

+Element Definition

Referenced By:

Message: getCopyVersionResults

Element: getCopyVersionResultsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get copy version results output parameter.

Fields:

JobInfoType jobStatus: JobInfoType type.

+Element Definition

Referenced By:

Message: getCopyVersionResultsResponse

Element: getCreateVersionAsOfDateResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get Create version as of date results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

+Element Definition

Referenced By:

Message: getCreateVersionAsOfDateResults

Element: getCreateVersionAsOfDateResultsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get create version as of date results output parameter.

Fields:

AsOfVersionResultType asOfVersion: AsOfVersionResultType field.

+Element Definition

Referenced By:

Message: getCreateVersionAsOfDateResultsResponse

Element: getCreateVersionAsOfTxnIDResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get create version as of txn ID results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

+Element Definition

Referenced By:

Message: getCreateVersionAsOfTxnIDResults

Element: getCreateVersionAsOfTxnIDResultsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get Create version as of txn ID results output parameter.

Fields:

AsOfVersionResultType asOfVersion: AsOfVersionResultType field.

+Element Definition

Referenced By:

Message: getCreateVersionAsOfTxnIDResultsResponse

Element: getDeleteVersionResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get delete version results input parameter.

Fields:

+Element Definition

Referenced By:

Message: getDomains

Element: getDomainsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get domains output parameter.

ExportDefListType exportDefsList: Export definitions list field.!

+Element Definition

Referenced By:

Message: getExportDefsResponse

Element: getExportDimensionTree

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get export dimension tree input parameter.

Fields:

string version: Version name field.

string export: Export field.

ObjectAccessEnum objectAccess: Object access field.

+Element Definition

Referenced By:

Message: getExportDimensionTree

Element: getExportDimensionTreeResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get export dimension tree output parameter.

Fields:

ExportDimensionTreeType exportDimensionTree: Export dimension tree.

+Element Definition

Referenced By:

Message: getExportDimensionTreeResponse

Element: getExportNames

Get export results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

+Element Definition

Referenced By:

Message: getExportResults

Element: getExportResultsResponse

Namespace: http://drm.webservices.epm.oracle

PropValueFlexListType propValueFlexList: A field that includes a list of PropValueFlexListType objects.

+Element Definition

Referenced By:

Message: getGlobalNodePropValuesResponse

Element: getGlobalNodeProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get global node properties input parameter.

Fields:

Get global nodes input parameter.

Fields:

string versionName: Version name field.

StringListType nodeNameList: List of node names to retrieve.

StringListType propNameList: List of properties to return.

PropValueListTypeEnum returnPropValueListType: Enumeration indicating how the properties should be returned.

+Element Definition

Referenced By:

Message: getGlobalNodes

Element: getGlobalNodesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get global nodes output parameter.

Fields:

GlobalNodeWithPropValuesListType globalNodeList: An array of global nodes.

+Element Definition

Referenced By:

Message: getGlobalNodesResponse

Element: getGlobalQueryResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get global query results input parameter.

Fields:

+Element Definition

Referenced By:

Message: getGlyphs

Element: getGlyphsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get glyphs output parameter.

Fields:

GlyphListType glyphList: The list of glyphs in the DRM Application.

+Element Definition

Referenced By:

Message: getGlyphsResponse

Element: getHier

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get hierarchy output parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

+Element Definition

Referenced By:

Message: getHier

Element: getHierGroup

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get hierarchy group input parameter.

Fields:

string name: The hierarchy group name to return.

+Element Definition

Referenced By:

Message: getHierGroup

Element: getHierGroupNames

Get hierarchy property values input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType propNameList: List of properties to return.

PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

+Element Definition

Referenced By:

Message: getHierPropValues

Element: getHierPropValuesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get hierarchy property values output parameter.

Fields:

PropValueFlexListType propValueFlexList: A field that includes a list of PropValueFlexListType objects.

+Element Definition

Referenced By:

Message: getHierPropValuesResponse

Element: getHierProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get hierarchy properties input parameter.

Fields:

Get hierarchy top node input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType propNameList: List of properties to return.

PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

+Element Definition

Referenced By:

Message: getHierTopNode

Element: getHierTopNodeResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get hierarchy top node output parameter.

Fields:

NodeWithPropValuesType node: A return type for a node and its property values.

+Element Definition

Referenced By:

Message: getHierTopNodeResponse

Element: getHiers

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get hierarchies input parameter.

Fields:

string versionName: Version name field.

StringListType hierNameList: List of hierarchies to return.

+Element Definition

Referenced By:

Message: getHiers

Element: getHiersByFilter

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Gets hierarchies based upon a filter.
Below are the params and and explanation of the params.
The following rules apply when using this operation.

If required param is null or empty an DrmServiceException will be thrown.
Operation will take the required param versionNames and iterate through each verison and attempt to apply filters if supplied.
Taking the results set from action above, apply the version filters if there are any and attempt to narrow the version list. If version filters are not supplied as input then the list of versions from #2 will be used as input into #4. If there are version filters then proceed and apply those filters and narrow the list of versions to be included into a subset.
If Hier filters are supplied then apply those filters on every hierarchy in every version listed in #2's result set. The hierarchies that match the criteria will be included. If the hier filters input param is empty then all hiers within a version will be included in the result set.

Fields:

string importName: The import name to return.

ObjectAccessEnum access: The object access of the import.

+Element Definition

Referenced By:

Message: getImport

Element: getImportNames

Get import results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

+Element Definition

Referenced By:

Message: getImportResults

Element: getImportResultsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get import results output parameter.

Fields:

ImportResultsType importResults: The results of an import run.

+Element Definition

Referenced By:

Message: getImportResultsResponse

Element: getJobStatus

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get job status input parameter.

Fields:

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

StringListType propNameList: List of properties to return.

PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

+Element Definition

Referenced By:

Message: getNode

Element: getNodeAccessGroup

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get node access group input parameter.

Fields:

string nodeAccessGroupName: Node access group name to return.

+Element Definition

Referenced By:

Message: getNodeAccessGroup

Element: getNodeAccessGroupNames

Get node by ID input parameter.

Fields:

HierLocatorType hierLocator: A hierarchy locator object representing a hierarchy in a version.

string name: The name of the node to return.

+Element Definition

Referenced By:

Message: getNodeByID

Element: getNodeByIDResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get node By ID output parameter.

Fields:

NodeType node: The node object.

+Element Definition

Referenced By:

Message: getNodeByIDResponse

Element: getNodePropValues

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get node property values input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

StringListType propNameList: List of properties to return.

PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

+Element Definition

Referenced By:

Message: getNodePropValues

Element: getNodePropValuesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get node property values output parameter.

Fields:

PropValueFlexListType propValueFlexList: A field that includes a list of PropValueFlexListType objects.

+Element Definition

Referenced By:

Message: getNodePropValuesResponse

Element: getNodeProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get node properties input parameter.

Fields:

Location: DrmService.wsdl

Get node type names input parameter.

+Element Definition

Referenced By:

Message: getNodeTypeNames

Element: getNodeTypeNamesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get node type names output parameter.

Fields:

StringListType stringList: A list of strings field.

+Element Definition

Referenced By:

Message: getNodeTypeNamesResponse

Element: getNodeTypes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get node types input parameter.

+Element Definition

Referenced By:

Message: getNodeTypes

Element: getNodeTypesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get node types output parameter.

Fields:

NodeTypeTypeListType nodeTypeList: A return list type for a node type.

+Element Definition

Referenced By:

Message: getNodeTypesResponse

Element: getNodeWithProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get node with properties input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

StringListType propNameList: List of properties to return.

+Element Definition

Referenced By:

Message: getNodeWithProps

Element: getNodeWithPropsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get node with properties output parameter.

Fields:

NodeWithPropsType nodeWithProps: A return type that includes a node and its property objects.

+Element Definition

Referenced By:

Message: getNodeWithPropsResponse

Element: getNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get nodes input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType nodeNameList: List of node names.

StringListType propNameList: List of properties to return.

PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

+Element Definition

Referenced By:

Message: getNodes

Element: getNodesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get nodes output parameter.

Fields:

NodeWithPropValuesListType nodeList: A return type for a list of nodes and their property values.

+Element Definition

Referenced By:

Message: getNodesResponse

Element: getOrphanNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get orphan nodes input parameter.

Fields:

string versionName: Version name field.

StringListType requestedProps: List of properties to return.

int maxNodes: The maximum number of nodes to return in the result.

+Element Definition

Referenced By:

Message: getOrphanNodes

Element: getOrphanNodesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get Orphan nodes output parameter.

Fields:

GlobalQueryResponseType queryResults: A global query result.

+Element Definition

Referenced By:

Message: getOrphanNodesResponse

Element: getPropCategories

Get property compare results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

+Element Definition

Referenced By:

Message: getPropertyCompareResults

Element: getPropertyCompareResultsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get property compare results output parameter.

Fields:

CompareResultType compareResult: Results of a compare operation.

+Element Definition

Referenced By:

Message: getPropertyCompareResultsResponse

Element: getQueries

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get Queries input parameter.

Fields:

boolean global: Flag indicating if global queries should be returned.

StringListType queryNameList: The list of queries to return.

+Element Definition

Referenced By:

Message: getQueries

Element: getQueriesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get queries output parameter.

Fields:

QueryListType queryList: Field for a queryListType object.

+Element Definition

Referenced By:

Message: getQueriesResponse

Element: getQuery

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get query input parameter.

Fields:

string queryName: The name of the query.

ObjectAccessEnum access: The object access of the query.

+Element Definition

Referenced By:

Message: getQuery

Element: getQueryNames

Get query results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

+Element Definition

Referenced By:

Message: getQueryResults

Element: getQueryResultsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get query results output parameter.

Fields:

QueryResultType queryResult: A list type of queryResultType types.

+Element Definition

Referenced By:

Message: getQueryResultsResponse

Element: getRelatedNodeCount

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get related node count input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

RelationshipEnum relationship: An enumeration indicating what types of nodes to return (Children, Descendants, and so on).

boolean visibleOnly: Flag indicating that visible children should only be returned.

boolean includeLeaves: Flag to include leaf nodes.

+Element Definition

Referenced By:

Message: getRelatedNodeCount

Element: getRelatedNodeCountResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get related node count output parameter.

Fields:

int intVal: Primitive int value.

+Element Definition

Referenced By:

Message: getRelatedNodeCountResponse

Element: getRelatedNodeNames

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get related node names input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

RelationshipEnum relationship: An enumeration indicating what types of nodes to return (i.e. Children, Descendants, etc).

+Element Definition

Referenced By:

Message: getRelatedNodeNames

Element: getRelatedNodeNamesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get related node names output parameter.

Fields:

StringListType stringList: A list of strings field.

+Element Definition

Referenced By:

Message: getRelatedNodeNamesResponse

Element: getRelatedNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get related nodes input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

RelationshipEnum relationship: An enumeration indicating what types of nodes to return (i.e. Children, Descendants, etc).

StringListType propNameList: List of properties to return.

PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

+Element Definition

Referenced By:

Message: getRelatedNodes

Element: getRelatedNodesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get related nodes output parameter.

Fields:

NodeWithPropValuesListType nodeList: A return type for a list of nodes and their property values.

+Element Definition

Referenced By:

Message: getRelatedNodesResponse

Element: getRelatedNodesWithProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get related nodes with properties input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

RelationshipEnum relationship: An enumeration indicating what types of nodes to return (i.e. Children, Descendants, etc).

StringListType propNameList: List of properties to return.

+Element Definition

Referenced By:

Message: getRelatedNodesWithProps

Element: getRelatedNodesWithPropsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get related nodes with properties output parameter.

Fields:

NodeWithPropsListType nodeWithPropsList: A return type that includes a list of nodes and their node property objects.

+Element Definition

Referenced By:

Message: getRelatedNodesWithPropsResponse

Element: getRenameCompareResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get rename compare results input parameter.

Fields:

Fields:

Fields:

string versionName: Version name field.

string nodeName: Node name field.

string newNodeName: The new node name to create.

string newNodeDescr: The new node description.

StringListType hierNameList: The list of hierarchies the existing node exists in.

PropCopyModeEnum propCopyMode: An enumeration indicating what type of properties should be included.

StringListType propNameList: If the copy mode is selected then this list of properties will be evaluated in the node model operation.

+Element Definition

Referenced By:

Message: getScriptFromModel

Element: getScriptFromModelResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get action script from model output parameter.

Fields:

ActionItemListType getScriptFromModelResponse: List of action items.

+Element Definition

Referenced By:

Message: getScriptFromModelResponse

Element: getScriptResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get action script results input parameter.

Fields:

Message: getValidation

Element: getValidationNames

StringListType versionNames: List of Versions to get properties for.

StringListType propNameList: List of properties to return.

+Element Definition

Referenced By:

Message: getVersionListPropValues

Element: getVersionListPropValuesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get Version List Prop Values output parameter.

Fields:

PropMapListType propMapList:

+Element Definition

Referenced By:

Message: getVersionListPropValuesResponse

Element: getVersionMigrationExportResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get version migration export output parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

+Element Definition

Referenced By:

Message: getVersionMigrationExportResults

Element: getVersionMigrationExportResultsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get version migration export results output parameter.

Fields:

JobInfoType jobStatus: JobInfoType type.

+Element Definition

Referenced By:

Message: getVersionMigrationExportResultsResponse

Element: getVersionMigrationImportResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get version migration inport results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

+Element Definition

Referenced By:

Message: getVersionMigrationImportResults

Element: getVersionMigrationImportResultsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get version migration import results output parameter.

Fields:

JobInfoType jobStatus: JobInfoType type.

+Element Definition

Referenced By:

Message: getVersionMigrationImportResultsResponse

Element: getVersionNames

Get version property values input parameter.

Fields:

string versionName: Version name field.

StringListType propNameList: List of properties to return.

PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

+Element Definition

Referenced By:

Message: getVersionPropValues

Element: getVersionPropValuesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get version property values output parameter.

Fields:

PropValueFlexListType propValueFlexList: A field that includes a list of PropValueFlexListType objects.

+Element Definition

Referenced By:

Message: getVersionPropValuesResponse

Element: getVersionProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Get version properties input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name to inactivate.

string mergeNodeName: The name of the node to merge this inactive node to (if merging is enabled).

+Element Definition

Referenced By:

Message: inactivateNode

Element: inactivateNodeResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Inactivate node output parameter.

+Element Definition

Referenced By:

Message: inactivateNodeResponse

Element: inactivateNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Inactivate nodes input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType nodeNameList: List of nodes to inactivate.

StringListType mergeNodeNameList: List of node names to merge the corresponding nodeNameList with (if merging is enabled).

+Element Definition

Referenced By:

Message: inactivateNodes

Element: inactivateNodesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Inactivate nodes output parameter.

+Element Definition

Referenced By:

Message: inactivateNodesResponse

Element: insertNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Insert node input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

string targetParentName: The existing parent node name to insert this node under.

NameValueListType propNameValueList: Name/Value Pair list field for property definition name and value for the node property value.

+Element Definition

Referenced By:

Message: insertNode

Element: insertNodeResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Insert node output parameter.

+Element Definition

Referenced By:

Message: insertNodeResponse

Element: insertNodeWithProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Insert node with properties input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

string targetParentName: The existing parent node name to insert this node under.

PropListType propList: Array of properties to update.

+Element Definition

Referenced By:

Message: insertNodeWithProps

Element: insertNodeWithPropsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Insert node with properties output parameter.

+Element Definition

Referenced By:

Message: insertNodeWithPropsResponse

Element: insertNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Insert nodes input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType nodeNameList: List of nodes to insert under a new parent.

string targetParentName: The existing parent node name to insert this node under.

+Element Definition

Referenced By:

Message: insertNodes

Element: insertNodesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Insert nodes output parameter.

+Element Definition

Referenced By:

Message: insertNodesResponse

Element: moveNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Move node input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

string targetParentName: The name of the new parent node.

+Element Definition

Referenced By:

Message: moveNode

Element: moveNodeResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Move node output parameter.

+Element Definition

Referenced By:

Message: moveNodeResponse

Element: moveNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Move nodes input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType nodeNameList: List of node names to move.

string targetParentName: The name of the new parent node.

+Element Definition

Referenced By:

Message: moveNodes

Element: moveNodesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Move nodes output parameter.

+Element Definition

Referenced By:

Message: moveNodesResponse

Element: openVersion

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Open version input parameter.

Fields:

string versionName: Version name field.

+Element Definition

Referenced By:

Message: openVersion

Element: openVersionResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Open version output parameter.

+Element Definition

Referenced By:

Message: openVersionResponse

Element: orderChildren

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Order children input parameter.

Fields:

NodeLocatorType nodeLocator: Node locator object representing a node within a hierarchy.

StringListType nodeNames: List of nodes to order. The sequence of this list will be used to order the children.

+Element Definition

Referenced By:

Message: orderChildren

Element: orderChildrenResponse

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType nodeNameList: List of node names to reactivate.

+Element Definition

Referenced By:

Message: reactivateNodes

Element: reactivateNodesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Reactivate nodes output parameter.

+Element Definition

Referenced By:

Message: reactivateNodesResponse

Element: removeNode

Namespace: http://drm.webservices.epm.oracle

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType nodeNameList: A list of node names to remove.

+Element Definition

Referenced By:

Message: removeNodes

Element: removeNodesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Remove nodes output parameter.

+Element Definition

Referenced By:

Message: removeNodesResponse

Element: runBlenderByName

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Run blender by name input parameter.

Fields:

string blenderName: The name of a blender.

string sourceVersionName: The source version name.

string targetVersionName: The target version name.

ObjectAccessEnum access: Access level of the blender to run.

string newVersionName: If present, the new version name that will be created as a result of the blend operation instead of blending into the target version.

string newVersionDescr: If present, the new version description that will be created as a result of the blend operation instead of blending into the target version.

int timeoutDuration: A timeout value in milliseconds to stop waiting for blender results.

NameValueListType runtimeParameters: The list of parameters to add to/override the saved default runtime parameters.

+Element Definition

Referenced By:

Message: runBlenderByName

Element: runBlenderByNameResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Run blender by name output parameter.

Fields:

BlenderResultsType blenderResult: Blender results object.

+Element Definition

Referenced By:

Message: runBlenderByNameResponse

Element: runCompare

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Run compare input parameter.

Fields:

CompareType compareCriteria: The compare criteria to be used to run the compare.

StringListType returnPropNameList: List of property values to return after the compare.

+Element Definition

Referenced By:

Message: runCompare

Element: runCompareByName

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Run compare by name input parameter.

Fields:

string compareName: The compare name to run.

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Run global query input parameter.

Fields:

QueryType query: The query criteria for the global query.

StringListType propNameList: List of property values to return after the query.

+Element Definition

Referenced By:

Message: runGlobalQuery

Element: runGlobalQueryResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Run global query output parameter.

Fields:

GlobalQueryResultType globalQueryResult: A query results for a global query.

+Element Definition

Referenced By:

Message: runGlobalQueryResponse

Element: runQuery

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Run query input parameter.

Fields:

QueryType query: The query criteria for the local query.

StringListType propNameList: List of property values to return after the query.

+Element Definition

Referenced By:

Message: runQuery

Element: runQueryResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Run query output parameter.

Fields:

QueryResultType queryResult: A list type of queryResultType types.

+Element Definition

Referenced By:

Message: runQueryResponse

Element: runValidateHier

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Run validate hierarchy input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType validationNameList: List of validation names to run for the hierarchy.

int maxNodes: The maximum number of results to return for the validation run.

StringListType propNameList: List of properties to return in the validation results.

+Element Definition

Referenced By:

Message: runValidateHier

Element: runValidateHierResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Run validate hierarchy output parameter.

Fields:

HierValidationResultType validationResult: The results of a hierarchy level validation run.

+Element Definition

Referenced By:

Message: runValidateHierResponse

Element: runValidateNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Run validate node input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

StringListType validationNameList: List of validation names to run for the node.

boolean recurse: Flag indicating if the validation should run the node specified and its descendants.

int maxNodes: The maximum number of validation results to return.

StringListType propNameList: List of properties to return in the validation results.

+Element Definition

Referenced By:

Message: runValidateNode

Element: runValidateNodeResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Run Validate node output parameter.

Fields:

QueryResultType queryResult: A list type of queryResultType types.

+Element Definition

Referenced By:

Message: runValidateNodeResponse

Element: runValidateVersion

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Run Validate version input parameter.

Fields:

string versionName: Version name field.

StringListType validationNameList: List of validation names to run for the version.

int maxNodes: The maximum number of validation results to return.

StringListType propNameList: List of properties to return in the validation results.

+Element Definition

Referenced By:

Message: runValidateVersion

Element: runValidateVersionResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Run Validate version output parameter.

Fields:

VersionValidationResultType validationResult: The version validation results.

+Element Definition

Referenced By:

Message: runValidateVersionResponse

Element: searchForNodesInHier

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Search For nodes in hierarchy input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string propName: Property name field.

string searchString: The search criteria value. An asterisk (*) can be supplied as a wildcard character.

int maxNodes: The maximum number of nodes to return in the result.

StringListType returnPropNameList: List of properties to return in the results.

+Element Definition

Referenced By:

Message: searchForNodesInHier

Element: searchForNodesInHierResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Search For nodes in hierarchy output parameter.

Fields:

QueryResultType queryResult: A list type of queryResultType types.

+Element Definition

Referenced By:

Message: searchForNodesInHierResponse

Element: searchForNodesInVersion

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Search For nodes In a version input parameter.

Fields:

string versionName: Version name field.

string propName: Property name field.

string searchString: The search criteria value. An asterisk (*) can be supplied as a wildcard character.

int maxNodes: The maximum number of nodes to return in the result.

StringListType returnPropNameList: List of properties to return in the results.

+Element Definition

Referenced By:

Message: searchForNodesInVersion

Element: searchForNodesInVersionResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Search For nodes in a version output parameter.

Fields:

QueryResultListType queryResultList: A list response type for query results.

+Element Definition

Referenced By:

Message: searchForNodesInVersionResponse

Element: setHierTopNode

Namespace: http://drm.webservices.epm.oracle

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType validationNameList: List of validation names.

+Element Definition

Referenced By:

Message: setHierValidations

Element: setHierValidationsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Set hierarchy validations output parameter.

+Element Definition

Referenced By:

Message: setHierValidationsResponse

Element: setUserPassword

Namespace: http://drm.webservices.epm.oracle

string versionName: Version name field.

StringListType validationNameList: List of version names.

+Element Definition

Referenced By:

Message: setVersionValidations

Element: setVersionValidationsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Set version validations output parameter.

+Element Definition

Referenced By:

Message: setVersionValidationsResponse

Element: setVersionVariable

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Set version variable input parameter.

Fields:

string variable: Variable name field.

string version: Version name field.

+Element Definition

Referenced By:

Message: setVersionVariable

Element: setVersionVariableResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Set version variable output parameter.

+Element Definition

Referenced By:

Message: setVersionVariableResponse

Element: startBlenderByName

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start blender by name input parameter.

Fields:

string blenderName: The blender name field.

string sourceVersionName: The source version name.

string targetVersionName: The target version name.

ObjectAccessEnum access: The object access level of the blender.

string newVersionName: If present, the new version name that will be created as a result of the blend operation instead of blending into the target version.

string newVersionDescr: If present, the new version description that will be created as a result of the blend operation instead of blending into the target version.

NameValueListType runtimeParameters: The list of parameters to add to/override the saved default runtime parameters.

+Element Definition

Referenced By:

Message: startBlenderByName

Element: startBlenderByNameResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start blender by name output parameter.

Fields:

JobInfoType jobInfo: Job info field.

+Element Definition

Referenced By:

Message: startBlenderByNameResponse

Element: startBookByName

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start book by name input parameter.

Fields:

string bookName: The book name field.

ObjectAccessEnum access: The object access field for the book.

string fromVersionName: The current version name.

string toVersionName: The previous version name.

+Element Definition

Referenced By:

Message: startBookByName

Element: startBookByNameResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start book by name output parameter.

Fields:

JobInfoType jobInfo: Job info field.

+Element Definition

Referenced By:

Message: startBookByNameResponse

Element: startCompare

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start compare input parameter.

Fields:

CompareType compareCriteria: The compare criteria to be used for the compare.

StringListType returnPropNameList: List of properties to return in the results.

+Element Definition

Referenced By:

Message: startCompare

Element: startCompareByName

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start compare by name input parameter.

Fields:

string compareName: The compare name field.

string fromVersionName: The from version name field.

string toVersionName: The to version name field.

ObjectAccessEnum access: The object access field for the book.

StringListType returnPropNameList: List of properties to return in the results.

NameValueListType runtimeParameters: The list of parameters to add to/override the saved default runtime parameters.

+Element Definition

Referenced By:

Message: startCompareByName

Element: startCompareByNameResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start compare by name output parameter.

Fields:

JobInfoType jobInfo: Job info field.

+Element Definition

Referenced By:

Message: startCompareByNameResponse

Element: startCompareExportByName

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start compare export by name input parameter.

Fields:

string exportName: The name of the compare export.

string fromVersionName: The from version name field.

string toVersionName: The to version name field.

ObjectAccessEnum access: The object access level of the export.

NameValueListType runtimeParameters: The list of parameters to add to/override the saved default runtime parameters.

+Element Definition

Referenced By:

Message: startCompareExportByName

Element: startCompareExportByNameOnHier

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start compare export by name on hierarchy input parameter.

Fields:

string exportName: The name of the compare export.

string fromVersionName: The from version name field.

string fromHierName: The from hierarchy name field.

string toVersionName: The to version name field.

string toHierName: The to hierarchy name field.

ObjectAccessEnum access: Access level of the export to run.

NameValueListType runtimeParameters: The list of parameters to add to/override the saved default runtime parameters.

+Element Definition

Referenced By:

Message: startCompareExportByNameOnHier

Element: startCompareExportByNameOnHierNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start compare export by name on hierarchy node input parameter.

Fields:

string exportName: The name of the compare export.

string fromVersionName: The from version name field.

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start copy version input parameter.

Fields:

string sourceVersionName: The name of the version to copy.

string destVersionName: The new name of the version.

string destDescr: The new description field of the version.

boolean clearApproval: Flag indicating that the approval flags should be cleared.

boolean clearChanged: Flag indicating that the changed on properties should be cleared.

boolean dbConnect: Flag indicating that the version should be persisted to the data store.

+Element Definition

Referenced By:

Message: startCopyVersion

Element: startCopyVersionResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start copy version output parameter.

Fields:

JobInfoType jobInfo: Job info field.

+Element Definition

Referenced By:

Message: startCopyVersionResponse

Element: startCreateAsOfTxnID

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start create as of transaction ID input parameter.

Fields:

string versionName: Version name field.

int endTxnId: Ending transaction ID field.

+Element Definition

Referenced By:

Message: startCreateAsOfTxnID

Element: startCreateAsOfTxnIDResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start create as of transaction ID output parameter.

Fields:

JobInfoType jobInfo: Job info field.

+Element Definition

Referenced By:

Message: startCreateAsOfTxnIDResponse

Element: startCreateVersionAsOfDate

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start create version as of date input parameter.

Fields:

Fields:

Location: DrmService.wsdl

Start global query input parameter.

Fields:

QueryType query: The query criteria field.

StringListType propNameList: List of properties to return in the results.

+Element Definition

Referenced By:

Message: startGlobalQuery

Element: startGlobalQueryResponse

Namespace: http://drm.webservices.epm.oracle

JobInfoType jobInfo: Job info field.

+Element Definition

Referenced By:

Message: startHierExportByNameOnHierNodeResponse

Element: startHierExportByNameOnHierNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start hierarchy export by name on hierarchy nodes input parameter.

Fields:

string exportName: The export name to run.

string versionName: Version name field.

HierNodeNamePairListType hierNodeList: A list type with hierarchy/node pairs.

ObjectAccessEnum access: Access level of the export to run.

+Element Definition

Referenced By:

Message: startHierExportByNameOnHierNodes

Element: startHierExportByNameOnHierNodesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start hierarchy export by name on hierarchy nodes output parameter.

Fields:

JobInfoType jobInfo: Job info field.

+Element Definition

Referenced By:

Message: startHierExportByNameOnHierNodesResponse

Element: startHierExportByNameOnHiers

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start hierarchy export by name on hierarchies input parameter.

Fields:

Location: DrmService.wsdl

Start import input parameter.

Fields:

ImportType importProfile: The import profile field.

base64Binary compressedFileContent: Byte array of compressed bytes that represent the script file. The deflate algorithm should be used to compress the content.

+Element Definition

Referenced By:

Message: startImport

Element: startImportByName

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start import by name input parameter.

Fields:

string importName: The import name field.

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start query input parameter.

Fields:

Fields:

Fields:

StringListType versionNames: Version names field.

string externalConnection: Name of the external connection.

string filename: File name field.

+Element Definition

Referenced By:

Message: startVersionMigrationExport

Element: startVersionMigrationExportResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start version migration export output parameter.

Fields:

JobInfoType jobInfo: Job info field.

+Element Definition

Referenced By:

Message: startVersionMigrationExportResponse

Element: startVersionMigrationImport

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Start version migration import input parameter.

Fields:

Update blender output parameter.

+Element Definition

Referenced By:

Message: updateBlenderResponse

Element: updateBook

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update book input parameter.

Fields:

BookType book: Book to be updated.

+Element Definition

Referenced By:

Message: updateBook

Element: updateBookResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update book output parameter.

+Element Definition

Referenced By:

Message: updateBookResponse

Element: updateCompare

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update compare input parameter.

Fields:

CompareType compare: Compare to be updated.

+Element Definition

Referenced By:

Message: updateCompare

Element: updateCompareResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update compare output parameter.

+Element Definition

Referenced By:

Message: updateCompareResponse

Element: updateDomain

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update domain input parameter.

Fields:

string name: Name of the domain.

string qualifier: Qualifier for the domain.

boolean qualifierSuffix: Boolean specifying if the qualifier is a suffix of prefix.

string delimiter: Domain delimiter field.

boolean canDeleteNodes: Boolean specifying if nodes can be deleted from the domain.

boolean canEditLeaf: Boolean specifying if leaf nodes can be edited from the domain.

boolean canEditQualifier: Boolean specifyin if the qualifier can be edited after saving the domain.

DomainValidationAssignmentListType validations: Validation.

+Element Definition

Referenced By:

Message: updateDomain

Element: updateDomainResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update domain output parameter.

+Element Definition

Referenced By:

Message: updateDomainResponse

Element: updateExport

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update export input parameter.

Fields:

ExportType export: Export to be updated.

+Element Definition

Referenced By:

Message: updateExport

Element: updateExportResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update export output parameter.

+Element Definition

Referenced By:

Message: updateExportResponse

Element: updateGlyph

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update glyph input parameter.

Fields:

GlyphType updateGlyph: Glyph to be updated.

+Element Definition

Referenced By:

Message: updateGlyph

Element: updateGlyphResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update glyph output parameter.

+Element Definition

Referenced By:

Message: updateGlyphResponse

Element: updateHierGroup

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update hierarchy group input parameter.

Fields:

HierGroup hierGroup: Hierarchy group to be updated.

+Element Definition

Referenced By:

Message: updateHierGroup

Element: updateHierGroupResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update hierarchy group output parameter.

+Element Definition

Referenced By:

Message: updateHierGroupResponse

Element: updateHierPropValues

Namespace: http://drm.webservices.epm.oracle

string versionName: Version name field.

string hierName: Hierarchy name field.

PropListType propList: A list type object for the PropListType type.

+Element Definition

Referenced By:

Message: updateHierProps

Element: updateHierPropsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update hierarchy properties output parameter.

+Element Definition

Referenced By:

Message: updateHierPropsResponse

Element: updateImport

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update import input parameter.

Fields:

ImportType importDef: The import definition object.

+Element Definition

Referenced By:

Message: updateImport

Element: updateImportResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update import output parameter.

+Element Definition

Referenced By:

Message: updateImportResponse

Element: updateNodeAccessGroup

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update node access group input parameter.

Fields:

NodeAccessGroupType updateNodeAccessGroup: The node access group object.

+Element Definition

Referenced By:

Message: updateNodeAccessGroup

Element: updateNodeAccessGroupResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update node access group output parameter.

+Element Definition

Referenced By:

Message: updateNodeAccessGroupResponse

Element: updateNodePropValues

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update node property values input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

NameValueListType propNameValueList: Name/Value Pair list field for property definition name and value for the node property value.

+Element Definition

Referenced By:

Message: updateNodePropValues

Element: updateNodePropValuesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update node property values output parameter.

+Element Definition

Referenced By:

Message: updateNodePropValuesResponse

Element: updateNodeProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update node properties input parameter.

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

PropListType propList: A list of property values to update for the node.

+Element Definition

Referenced By:

Message: updateNodeProps

Element: updateNodePropsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update node properties output parameter.

+Element Definition

Referenced By:

Message: updateNodePropsResponse

Element: updatePropCategory

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update property category input parameter.

Fields:

PropCategoryType propertyCategory: Property category field.

+Element Definition

Referenced By:

Message: updatePropCategory

Element: updatePropCategoryResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update property category output parameter.

+Element Definition

Referenced By:

Message: updatePropCategoryResponse

Element: updatePropDef

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update property definition input parameter.

Fields:

PropDefType propDef: The property definition field.

+Element Definition

Referenced By:

Message: updatePropDef

Element: updatePropDefListValues

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update property definition list values input parameter.

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update query input parameter.

Fields:

QueryType query: Query type field.

string renameName: If supplied a new name to give the query criteria.

+Element Definition

Referenced By:

Message: updateQuery

Element: updateQueryResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update query output parameter.

+Element Definition

Referenced By:

Message: updateQueryResponse

Element: updateRequest

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update request input parameter.

Fields:

RequestType request: The request object field.

+Element Definition

Referenced By:

Message: updateRequest

Element: updateRequestResponse

Update user lockout output parameter.

+Element Definition

Referenced By:

Message: updateUserLockoutResponse

Element: updateUserPassword

Namespace: http://drm.webservices.epm.oracle

ValidationDefinitionType validation: The validation object field.

+Element Definition

Referenced By:

Message: updateValidation

Element: updateValidationResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update validation definition output parameter.

+Element Definition

Referenced By:

Message: updateValidationResponse

Element: updateVersionPropValues

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update version property values input parameter.

Fields:

string versionName: Version name field.

NameValueListType propValueList: List type of nameValueListType for properties and their values.

+Element Definition

Referenced By:

Message: updateVersionPropValues

Element: updateVersionPropValuesResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update version property values output parameter.

+Element Definition

Referenced By:

Message: updateVersionPropValuesResponse

Element: updateVersionProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update version properties input parameter.

Fields:

string versionName: Version name field.

PropListType propList: List type of PropListType for properties and their values.

+Element Definition

Referenced By:

Message: updateVersionProps

Element: updateVersionPropsResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Update version properties output parameter.

+Element Definition

Referenced By:

Message: updateVersionPropsResponse

Element: validateRequest

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Validate request input parameter.

Fields:

RequestType request: The request to validate.

boolean saveIfSuccessful: Flag indicating that the request should be saved if the validation was successful.

+Element Definition

Referenced By:

Message: validateRequest

Element: validateRequestResponse

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Validate request output parameter.

Fields:

RequestValidationResultType requestValidationResult: The request validation result. Returned when one validates a request.

+Element Definition

Referenced By:

Message: validateRequestResponse

Types

Type: AccessLevelEnum

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Enumeration indicating the access level permissions.

+Type Definition

Fields:

SuccessStateEnum successState: Result of the processed action item.

string returnValue: Return value of the Item.

string statusMsg: Message indicating whether the action item was successful.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: ActionItemResultListType

Type: ActionItemType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string actionType: An action type; possible values: Activate, Add, AddHier, AddInsert, AddOrphan, AffectedNode, Annul, AnnulAllBelow, AssignHierValidations, AssignVersionValidations, ChangeGlobalProps, ChangeHierTopNode, ChangeProp, ClearPropsBelow, Delete, DeleteHier, DeleteOrphan, Destroy, Inactivate, Insert, LockProp, Move, NodeExists, NodeExistsInHier, NodeHasAsParent, PropCompare, PropQuery, Remove, RemoveDupProps, RemoveHierPropValue, RemoveProp, RemoveVersionPropValue, UpdateHierPropValue, UpdateVersionPropValue.

int minParamCount: Minimum number of accepted parameters.

int maxParamCount: Maximum number of accepted parameters.

StringListType params: Parameters field.

boolean skipFlag: Boolean specifying if the field item should be skipped.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: ActionItemListType

Type: AddDomain

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string name: Domain name field.

string qualifier: Qualifier text field.

boolean qualifierSuffix: Qualifier suffix boolean field. Determines if the qualifier is a suffix or prefix.

string delimiter: Delimiter field.

boolean canDeleteNodes: Boolean specifying if domain nodes can be deleted from versions.

boolean canEditLeaf: Boolean specifying if domain nodes can have the Leaf property edited

boolean canEditQualifier: Boolean specifying if the qualifier can be edited after saving the domain.

DomainValidationAssignmentListType validations: The validation definition names to associate with this node type.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: addDomain

Type: AddGlyph

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string name: Name of glyph.

string descr: Description of glyph.

string imageData: Base-64 string value of the byte data.

ImageTypeEnum imageTypeEnum: Currently supported image types are PNG.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: addGlyph

Type: AddHier

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string descr: Hierarchy description field.

string topNodeName: Top node name field.

string topNodeDescr: Top node description field.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: addHier

Type: AddHierGroup

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string name: Hierarchy group name field.

string descr: Hierarchy group description field.

int order: Sort order field for the hierarchy group.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: addHierGroup

Type: AddNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string parentName: Parent node name field.

string nodeName: Node name field.

string nodeDescription:

boolean isLeaf: Field indicating whether node is a leaf node.

string domainName: Domain name field.

NameValueListType propNameValueList: Name/value pair list field for property definition name and value for the node property value.

boolean updateIfExists: If True and the node exists, then update the properties for the node; if the node exists and this flag is False, then skip property updates.

+Type Definition

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string parentName: Parent node name field.

string nodeName: Node name field.

string nodeDescription:

string domainName: Domain name field.

boolean isLeaf: Field indicating if node is a leaf node.

PropListType propList: The list of properties and their values to set on the node.

boolean updateIfExists: If True and the node exists, then update the properties for the node; if the node exists and this flag is False, then skip property updates.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: addNodeWithProps

Type: AddOrphanNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

string nodeName: Node name field.

string nodeDescription:

string domainName: Domain name field.

boolean isLeaf: Field indicating whether node is a leaf node.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: addOrphanNode

Type: AddPropCategory

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string propCategoryName: Property category name field.

string descr: Property category description field.

PropCategoryTypeEnum propCategoryType: An enumeration value indicating the type of property category.

StringListType propNameList: A list of property definition names to associate with this property category.

boolean availableUserCategory: Flag indicating whether the category should be saved as a user category.

int order: The order in which the property category appears in the property editor.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: addPropCategory

Type: AddPropDef

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

PropDefType propDef: A property definition object field.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: addPropDef

Type: AddUser

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

UserInputType userInput: User input object field.

string password: The password to set for this new user.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: addUser

Type: AddValidation

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string name: The validation name field.

string descr: Validation description.

string displayLabel: The label for the validation.

ValidationTypeEnum allowedType: An enumeration indicating how the validation can be executed.

boolean cascade: Flag indicating whether the validation is to be implicitly assigned via inheritance.

int columnWidth: (To be deprecated)

ValidationLevelEnum level: The validation level defines the scope of a business rule.

ValidationParamListType parameters: Parameters that are used by the validation during execution.

boolean setup: Flag that indicates whether the server should check the validity of the parameters.

int sortOrder: The sort order of the property definition within a category.

string validationClass: The type class of validation.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: addValidation

Type: AddVersion

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

string versionDescr: Description field.

boolean dbConnect: Flag that indicates whether the version should be persisted to the data store. If False, the version resides only in memory.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: addVersion

Type: AnnulNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

boolean annulChildNodes: Specify "true" to Annul all nodes below the selected node. Specify "false" to Annul the selected node. The selected node may only be Annuled if it has no children.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: annulNode

Type: AppParameters

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string serverUrl: API adapter URL of the DRM Server. Example: http://localhost:5240/Oracle/Drm/APIAdapter?wsdl

string sessionParams: Represents session parameters for the DRM server. Example: ProductVersion=11.1.2;CultureName=en-US;TimeZoneOffset=-360

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: AppParameters

Type: ApproveRequest

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

int requestId: ID of the request header.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: approveRequest

Type: ArrayOfFlatFileActionColEnum

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

FlatFileActionColEnum FlatFileActionColEnum: Array of FlatFileActionColumnEnum.

+Type Definition

</sequence>

</complexType>

Type: AsOfMethodEnum

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

+Type Definition

</restriction>

</simpleType>

Type Hierarchy:

string

AsOfMethodEnum

Referenced By:

Type: VersionParamsType

Type: AsOfVersionResultResponseType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

AsOfVersionResultType asOfVersion: AsOfVersionResultType field.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getCreateVersionAsOfTxnIDResultsResponse
Element: getCreateVersionAsOfDateResultsResponse

Type: AsOfVersionResultType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

VersionType newVersion: Name of the newly created version.

StringListType errorList: String list of errors that can occur while creating an as of.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: AsOfVersionResultResponseType

Type: AssignControlledProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string propName: Property definition name.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: assignControlledProps

Type: AutoIncrementIdColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

int dummy: (To be deprecated)

+Type Definition

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

NodeColumnType

AutoIncrementIdColumnType

Referenced By:

Type: ExportColumnListType

Type: Base64BinaryResponseType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

base64Binary content: Byte array of compressed bytes. Use the deflate algorithm to decompress the content.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getBookResultsResponse
Element: getBookItemResultsResponse
Element: getExportResultsResponse

Type: BaseDefType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

ObjectAccessEnum objectAccess: Object Access.

string name: Name field.

int id: Id field.

+Type Definition

</sequence>

</complexType>

Type Hierarchy:

BaseDefType

ExportDefType

Type: BaseNodeRequestItemType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

int requestId: The system-generated ID for the request the item belongs to.

int itemId: The system-generated ID for the request item.

RequestActionEnum action: An enumeration indicating the type of request item.

string customValue: Free-form field to be used updated by external systems.

string hierName: Hierarchy name field.

string nodeName: Node name field.

string nodeDescription:

+Type Definition

</sequence>

</extension>

</complexContent>

</complexType>

Type Hierarchy:

RequestItemType

HierRequestItemType

BaseNodeRequestItemType

NodeActivateRequestItemType

NodeMergeRequestItemType

NodeDeleteRequestItemType

NodeInactivateRequestItemType

NodeMoveRequestItemType

NodePropRequestItemType

NodePropRemoveRequestItemType

NodePropUpdateRequestItemType

NodeRemoveRequestItemType

NodeRequestItemType

NodeAddRequestItemType

NodeAddInsertRequestItemType

NodeInsertRequestItemType

Referenced By:

Type: RequestItemListType

Type: BaseParamsType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string descr: Description of compare or query criteria.

boolean markNodes: Indicates that the result of the query or compare should Mark nodes.

boolean expandToMarkedNodes: Indicates that the result tree should be expanded.

boolean showList: Indicates that the result display should show a list of the results.

NameValueListType runtimeParameters: This parameter has two purposes:

On saving the Query or Compare: The list of name/value pairs to save as the default runtime parameters for variable substitution when the Query or Compare runs.
On running the Query or Compare: The list of parameters to add to/override the saved default runtime parameters.

+Type Definition

</sequence>

</complexType>

Type Hierarchy:

BaseParamsType

CompareType

QueryType

Type: BlenderHierSetListType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

BlenderHierSetType blenderHierSet: Is a list of blenderHierSetType objects.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: BlenderType

Type: BlenderHierSetType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string sourceHierName: Indicates the source hierarchy to blend from.

string sourceTopNodeName: Indicates the source node to blend from.

string targetHierName: Indicates the target hierarchy to blend the Source into.

string targetTopNodeName: Indicates the target node to blend into.

BlenderPropListType blenderPropList: The list of blenderPropType objects. Each object represents the properties to blend.

int hierSetId: The ID of the hierarchy set. A blender profile can have one or many hierarchy Sets.

boolean processActivations: Flag indicating to process node activations (inactivate and reactivate) from the target to the source.

boolean processAdds: Flag indicating to insert any nodes existing only in the source hierarchy to the target hierarchy.

boolean processHierValAssignments: Flag indicating to process the hierarchy level validation assignments from the source to the target.

boolean processRemoves: Flag indicating to remove any nodes existing only in the target hierarchy according to the setting in the Remove Mode list and the Remove Indicator list.

boolean processStructure: Flag indicating to blend structural elements, such as hierarchies and nodes.

PropSelectModeEnum propSelectMode:
Enumeration indicating how to process the properties.

All - (Excluding Val/Access) All properties are blended; excludes properties used for node-level validations and for node access group- , leaf- , and limb-level settings.
None - No properties are blended.
Selected - Selected properties are blended.

RemoveModeEnum removeMode:
Enumeration indicating how to process Removes.

Remove - Node is immediately removed during blending.
Mark - Node is marked for later removal.

string removeIndicatorPropName: If RemoveMode is set to Mark, this field contains the property name that indicates that the node is flagged to be removed.

boolean useProfileDefaults: to use default values for all hierarchy/top node sets. You set the profile defaults for properties on the Properties tab. If you clear this option, you can choose which hierarchies should use the defaults and which should not when you select hierarchy/top node pairs.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: BlenderHierSetListType

Type: BlenderListPropertyActionEnum

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Enumeration that controls how Group, ListGroup and MultiNodes properties are blended.

+Type Definition

</restriction>

</simpleType>

Type Hierarchy:

string

BlenderListPropertyActionEnum

Referenced By:

Type: BlenderPropType

Type: BlenderProfileStatusEnum

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

+Type Definition

</restriction>

</simpleType>

Type Hierarchy:

string

BlenderProfileStatusEnum

Referenced By:

Type: BlenderResultsType

Type: BlenderPropListType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

BlenderPropType blenderProp: List of blenderPropType types

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: BlenderType
Type: BlenderHierSetType

Type: BlenderPropType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string propName: Property name field.

ValuePropagateModeEnum propagateMode:
Enumeration that indicates how to process properties when blending.

Force - Property is assigned for every node in the target, whether that property is defined at that node, is inherited, or is derived.
Difference - Populates the property for any node where the value is different, regardless of how that property is populated in the target.
Defined - Property is blended only when it is specifically defined for the node in the source.

Fields:

BlenderProfileStatusEnum status: Enumeration indicating the status of the blend operation.

string statusDescr: Description of the result status.

boolean isSuccess: If the blender operation does not abort, this flag is True.

StringListType errors: List of errors for the blend operation.

boolean lastPropPassClear: Indicates whether the from and to property values were identical on the final pass.

boolean lastStructPassClear: Indicates whether the from and to nodes were identical on the final pass.

int propPassCount: Number of passes the blender runs to resolve property updates.

int structPassCount: Number of passes the blender runs to resolve structure differences.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: BlenderResultsResponseType

Type: BlenderType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

ObjectAccessEnum objectAccess: Object access enumeration.

string name: Name of blender.

int id: The system-generated ID of the object.

string descr: Description of the object.

string sourceVersionName: Source version to blend from.

VersionParamsType sourceVersionParams: Parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.

string targetVersionName: The version to blend the source version into.

VersionParamsType targetVersionParams: Parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.

boolean createNewVersion: To blend changes into a copy of the selected target version. If you select this option, you must specify a name and description for the new version.

string newVersionName: Version name to be used if createNewVersion is set to True.

string newVersionDescr: Version description to be used if createNewVersion is set to True.

boolean blendAllHiers: Flag indicating to blend all hierarchies in the selected versions. If set to True, the Use Profile Defaults For All hierarchy Sets option is required.

boolean useDefaultForAllHiers:
Flag to use default values for all hierarchy/top node sets. The corresponding fields in this type apply.

defaultProcessActivations
defaultProcessAdds
defaultProcessHierValAssignments
defaultProcessRemoves
defaultProcessStructure
defaultPropSelectMode
defaultPropagateLocks
defaultPropagateMode
defaultRemoveIndicatorPropName
defaultRemoveMode
defaultSelectedPropListId

If you deselect this option, you can choose which hierarchies should use the defaults and which should not when you select hierarchy/top node pairs.

boolean allowHierCreation: Flag indicating that hierarchies are to be created during the blender operation.

BlenderPropListType blenderPropList: List of blenderProps to blend.

boolean processVersionValAssignments: Flag indicating to process version-level validation assignments from the source to the target

boolean allowLeafPromotion: Flag indicating to promote a node with children in the source to a limb in the target

boolean disableRTValidation: Flag indicating whether to turn off the real-time validations on the target version before blending or not.

string logFile: If blender is created for batch client purposes, this field contains the log file name to be used on the batch client when writing blender results.

int maxErrors: Value sets the maximum errors that can occur during processing before the blender stops without completion.

int maxPasses: Value determines the maximum attempts the blender performs in reconciling the source and target versions to prevent the blender from running indefinitely in the case of irresolvable conflicts. Recommended value is 3.

BlenderHierSetListType hierSets: One or more blenderHierSet objects, which include source and target hierarchy and top node and options for how to process the sets.

int hierSetsId: System-generated ID of the hierarchy set.

boolean defaultProcessActivations: Default value to process node activations (inactivate and reactivate) from the target to the source.

boolean defaultProcessAdds: Default value to blend structural elements, such as hierarchies and nodes.

boolean defaultProcessHierValAssignments: Default to process the hierarchy-level validation assignments from the source to the target.

boolean defaultProcessRemoves:
Default to remove any nodes existing only in the target hierarchy according to the setting in the Remove Mode list and the Remove Indicator list. If you selected Process Removes, select one of the following Remove Modes:

Remove - Node is immediately removed during blending.
Mark - Node is marked for later removal.
When the Remove Mode is set to Mark, the Remove Indicator option designates which property contains the value showing that the node is flagged to be removed. The remove indicator property must be created as a local, Boolean property.

boolean defaultProcessStructure: Default to blend structural elements, such as hierarchies and nodes.

PropSelectModeEnum defaultPropSelectMode: Default Mode value indicating if the properties to be processed: Selected, None, or All (excluding validation and node access group properties).

boolean defaultPropagateLocks: Default value indicating that you want inheritance locks in the source to be blended to the target.

ValuePropagateModeEnum defaultPropagateMode: Default value that determines how a property is to be populated in the target.

string defaultRemoveIndicatorPropName: Property name that is set to True when a node is flagged to be removed (When using "Mark" Remove node). This property must be a local, Boolean property.

RemoveModeEnum defaultRemoveMode: Default mode that indicates how nodes are to be treated when removing nodes from the source to target version.

int defaultSelectedPropListId: If property selection is set to "Selected," this field indicates which property IDs are to be used.

boolean clearStatusProps: Flag to instruct the blender to set all blender status property values to False during processing.

boolean populateStatusProps: Flag to instruct the blender to set all blender status property values to True during processing.

string versionBlendedPropName: Name of the property that is set to True if the version has been blended {Version Level Boolean Defined Property}.

string hierBlendedPropName: The name of the property that is set to True if the hierarchy has been blended {Hierarchy Level Boolean Defined Property}.

string nodeGlobalAddedPropName: Name of the property that is set to True if the node had global properties changed by the blend {Global node Level Boolean Defined Property}.

string nodeAddedPropName: Name of the property that is set to True if the node was created by the blend {Global node Level Boolean Defined Property}.

string nodeGlobalChangedPropName: The name of the property that will be set to True if the node had global properties changed by the blend {Global node Level Boolean Defined Property}.

string nodeChangedPropName: The name of the property that will be set to True if the node had local properties changed by the blend {Local node Level Boolean Defined Property}.

string nodeMovedPropName: The name of the property that will be set to True if the node was moved by the blend {Local node Level Boolean Defined Property}.

string leafPromotedPropName: The name of the property that will be set to True if the node was promoted from a leaf to a limb by the blend {Global node Level Boolean Defined Property}.

int userId: User name of the user who creates the object.

NameValueListType runtimeParameters: This parameter has two purposes:

On saving the Blender: The list of name/value pairs to save as the default runtime parameters for variable substitution when the Blender runs.
On running the Blender: The list of parameters to add to/override the saved default runtime parameters.

boolean useStoredDefaultParameters: Flag that indicates to use parameters that are stored with the Blender.

boolean targetVersionFromParam: Flag to indicate that the target version is specified by a runtime parameter.

string targetVersionRuntimeParam: Target version name to use if useStoredDefaultParameters is equal to true.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: UpdateBlender
Type: BlenderResponseType
Type: CreateBlender

Type: BookItemListType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

BookItemType bookItem: One or more BookItemType objects.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: BookType

Type: BookItemResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

JobInfoType jobInfo: The jobInfoType object.

int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

int bookItemIndex: Includes job information about the book item that was executed.

+Type Definition

</sequence>

</extension>

</complexContent>

</complexType>

Type Hierarchy:

JobResultRetrievalInputType

BookItemResults

Referenced By:

Element: getBookResultsItemCount
Element: getCompareResults
Element: getGlobalQueryResults
Element: getJobStatus
Element: getQueryResults
Element: getPropertyCompareResults
Element: getRenameCompareResults
Element: getDeleteVersionResults
Element: getExportResults
Element: getVersionMigrationImportResults
Element: getCreateVersionAsOfTxnIDResults
Element: getBlenderResults
Element: getImportResults
Element: getScriptResults
Element: getCopyVersionResults
Element: getSaveVersionResults
Element: getCreateVersionAsOfDateResults
Element: getVersionMigrationExportResults
Element: getBookResults
Type: GetBookItemResults

Type: BookItemType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

ObjectAccessEnum objectAccess: Object access enumeration field.

string exportName: Name of the export.

int exportId: System-generated ID for the export.

int sortOrder: The order in which the export definition will appear in the book.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: BookItemListType

Type: BookResponseType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

BookType book: Represents the response for a book type.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getBookResponse

Type: BookType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

ObjectAccessEnum objectAccess: Object access enumeration.

string name: Name of the book definition.

int id: The system-generated ID of the book.

string descr: Description of the object.

string displayLabel: The label of the book.

VersionParamsType currentVersionParams: The current version parameters. Parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.

VersionParamsType previousVersionParams: The previous version parameters. Parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.

boolean outputToClient: If set to True, then the output of the book run operation can be retrieved with the getBookResults operation. The result will be a ZIP file.

boolean combineIntoSinglefile: If True, then each export result that is run as a result of the book run is combined into one file.

string combinedFileConnection: The external connection name for the combined file.

string combinedFilename: The filename of the combined file.

int combinedFileCodePage:

string preFilename: The filename of the pre file.

string preFileConnection: The external connection name for the pre file Connection.

BookItemListType items: List of book items for this book.

string postFilename: The filename of the post file.

string postFileConnection: The external connection name for the post file Connection.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: CreateBook
Type: BookResponseType
Type: UpdateBook

Type: BoolFormatEnum

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

An enumeration for formatting booleans during an export. For example, if the BoolFormatEnum is specified as "YesNo," then the exported result will be either Yes or No as the result value.

+Type Definition

</restriction>

</simpleType>

Type Hierarchy:

string

BoolFormatEnum

Referenced By:

Type: BoolPropColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

int dummy: (To be deprecated)

string propName: Property definition name.

BoolFormatEnum BoolFormat: Boolean Format Enumeration.

boolean Negate: Flag to return the opposite of the default value.

+Type Definition

</sequence>

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

NodeColumnType

PropColumnType

BoolPropColumnType

Referenced By:

Type: ExportColumnListType

Type: BooleanParamMethodEnum

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

An enumeration indicating a True or False value for a param.

+Type Definition

</restriction>

</simpleType>

Type Hierarchy:

string

BooleanParamMethodEnum

Referenced By:

Type: RequestQueryParamsType

Type: CalculatedDataColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

string fieldName: Property name for the column.

+Type Definition

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

DataColumnType

CalculatedDataColumnType

Referenced By:

Type: ExportColumnListType

Type: CalculatedNodeColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

int dummy: (To be deprecated)

+Type Definition

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

NodeColumnType

CalculatedNodeColumnType

CalculatedSequenceColumnType

GenAncestorSequenceColumnType

GenNodeSequenceColumnType

Referenced By:

Type: ExportColumnListType

Type: CalculatedSequenceColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

int dummy: (To be deprecated)

int level: Field indicating level of the node.

+Type Definition

</sequence>

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

NodeColumnType

CalculatedNodeColumnType

CalculatedSequenceColumnType

GenAncestorSequenceColumnType

GenNodeSequenceColumnType

Referenced By:

Type: ExportColumnListType

Type: CharacterEncodingEnum

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

An enumeration indicating encoding to be used.

+Type Definition

Fields:

QueryResultType fromResult: The from query result. The from contents can vary depending on the compare criteria. For example, for a structure, differences compare, the from result would include any node in the from version/hierarchy/node pair that was not present in the to version/hierarchy/node pair.

QueryResultType toResult: The to query result. The to contents can vary depending on the compare criteria. For example, for a structure, differences compare, the To result would include any node in the to version/hierarchy/node pair that was not present in the from version/hierarchy/node pair.

QueryResultType fromRenameResult: The rename from query result. The from contents can vary depending on the compare criteria. For example, for a structure, differences compare, the from result would include any node in the from version/hierarchy/node pair that was not present in the to version/hierarchy/node pair.

QueryResultType toRenameResult: The rename to query result. The to contents can vary depending on the compare criteria. For example, for a structure, differences compare, the To result would include any node in the to version/hierarchy/node pair that was not present in the from version/hierarchy/node pair.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: CompareResultResponseType

Type: CompareType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string descr: Description of compare or query criteria.

boolean markNodes: Indicates that the result of the query or compare should Mark nodes.

boolean expandToMarkedNodes: Indicates that the result tree should be expanded.

boolean showList: Indicates that the result display should show a list of the results.

NameValueListType runtimeParameters: This parameter has two purposes:

On saving the Query or Compare: The list of name/value pairs to save as the default runtime parameters for variable substitution when the Query or Compare runs.
On running the Query or Compare: The list of parameters to add to/override the saved default runtime parameters.

ObjectAccessEnum objectAccess: The object access of the compare.

string name: The compare definition name.

int id: The system-generated ID for the compare.

CompareTypeEnum compareType: Enumeration indicating a hierarchy, property, or rename compare type.

VersionParamsType fromVersionParams: Source parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction id.

VersionParamsType toVersionParams: Target parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.

NodeLocatorType fromNode: The node in the hierarchy to use as a basis for the compare operation.

NodeLocatorType toNode: The node in the hierarchy to use as a basis for the compare operation.

boolean showDifferences: Flag indicating whether the compare result should show differences or similarities.

boolean compareLeafs: Flag indicating whether the compare operation should consider node leafs for processing.

boolean compareLimbs: Flag indicating if the compare operation should consider node limbs for processing.

StringListType propsToCompare: String list of properties to evaluate during a property compare.

boolean expandList: Flag indicating that the results should be expanded in the user interface.

FilterChildrenEnum filterChildren: Flag indicating if the compare should exclude or include children during the compare operation.

boolean isInclusive: Includes the node that is used in the criteria.

string joinProp: Field for the join property. By default, compares map nodes from each hierarchy that have the same name. You can also join nodes based on other properties. For example, if a property named SortCode has a unique key in the specified hierarchies, then this property is used to identify differences between nodes having the same SortCode in each hierarchy.

QueryType query: The query type to be used as a inclusion filter.

boolean checkForRename: A flag indicating whether the server should treat renamed nodes the same for comparison purposes.

boolean isUserDefined: Flag indicating if this is a user defined compare instead of a system defined compare. A user-defined compare is is usually created through the compare interface; a system compare can be created for compare or export purposes and does not show up in the compare select screen.

string userName: The user name that owns the compare.

int userId: The user ID of the user who owns the compare.

+Type Definition

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

string constantValue: Represents a constant value for a export column.

+Type Definition

</sequence>

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

ConstantColumnType

DynamicColumnType

GenAncestorDynamicColumnType

GenNodeDynamicColumnType

GenPostDynamicColumnType

GenPreDynamicColumnType

Referenced By:

Type: ExportColumnListType

Type: ControllingHierType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName:

string hierName:

+Type Definition

</sequence>

</complexType>

Type: CopyNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name of the source node.

string hierName: Hierarchy name of the source node.

string nodeName: Node name of the source node.

string targetHierName: Hierarchy name that the node will be copied to.

string targetParentName: Parent node that the new node will be inserted as a child.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: copyNode

Type: CopyNodeProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

NodeLocatorType sourceNodeLocator: Source locator indicating version, hierarchy and node.

NodeLocatorType targetNodeLocator: Target locator indicating version, hierarchy and node.

PropCopyModeEnum propCopyMode: Mode that indicates to the server which type of properties should be copied.

StringListType selectedPropNameList: If copy mode is set to selected; this list will contain the properties to copy.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: copyNodeProps

Type: CopyNodesAcrossVersions

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

NodeLocatorType targetNodeLocator: Target locator indicating version, hierarchy and node.

boolean copyAsSibling: Flag indicating if the node(s) should be made siblings of the target node.

NodeLocatorListType sourceNodeLocators: List of source locators indicating version, hierarchy, and node.

boolean copyDescendantsAcrossVersions: Flag indicating whether descendant nodes should be copied.

boolean copyGlobalPropsAcrossVersions: Flag indicating whether global properties should be copied.

boolean copyLocalPropsAcrossVersions: Flag indicating whether local properties should be copied.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: copyNodesAcrossVersions

Type: CopyUser

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string existingUserName: User name of the user to copy.

string userName: User name desired for the new user.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: copyUser

Type: CopyVersion

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string sourceVersion: Name of the version to copy.

string targetVersion: Name of the new version.

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string paramName: Parameter name field.

string paramValue: Parameter value field.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: CustomExportParamListType

Type: DataColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

string fieldName: Property name for the column.

+Type Definition

</sequence>

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

DataColumnType

CalculatedDataColumnType

Referenced By:

Type: ExportColumnListType

Type: DataTypeEnum

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Enumeration representing the DataType of a property definition.

+Type Definition

</restriction>

</simpleType>

Type Hierarchy:

string

DataTypeEnum

Referenced By:

Type: SystemPreferenceType
Type: ValidationParamInputType
Type: PropDefParamType
Type: PropDefType

Type: DateParamMethodEnum

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Enumeration representing the type of DateParamsType.

+Type Definition

</restriction>

</simpleType>

Type Hierarchy:

string

DateParamMethodEnum

Referenced By:

Type: DateParamsType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

DateParamMethodEnum method: Indicates whether this date type object represents a point in time or a range.

dateTime date: Date value.

dateTime endDate: End date in a range.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: RequestQueryParamsType

Type: DatePropColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

int dummy: (To be deprecated)

string propName: Property definition name.

string DateFormat: String representation indicating how the date is to be formatted.

+Type Definition

</sequence>

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

NodeColumnType

PropColumnType

DatePropColumnType

Referenced By:

Type: ExportColumnListType

Type: DbFieldTypeEnum

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Enumeration indicating what type of database field.

+Type Definition

</restriction>

</simpleType>

Type Hierarchy:

string

DbFieldTypeEnum

Referenced By:

Type: ExportColumnType

Type: DbImportFilterMethodEnum

</sequence>

</complexType>

Referenced By:

Element: deleteDomain

Type: DeleteExport

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string exportName: Export name to delete.

ObjectAccessEnum access: Object access of the export to delete.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: deleteExport

Type: DeleteGlyph

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string glyphName: Glyph name to delete.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: deleteGlyph

Type: DeleteHier

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: deleteHier

Type: DeleteHierGroup

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string groupName: Name of the hierarchy group to delete.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: deleteHierGroup

Type: DeleteImport

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string importName: Name of the import to delete.

ObjectAccessEnum access: Object access of the import to delete.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: deleteImport

Type: DeleteNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType nodeNameList: List of nodes to delete.

StringListType mergeNodeNameList: Name of the nodes to merge with (if merging is desired and enabled).

boolean destroyNodes: Flag indicating that the nodes should be permanently deleted if the nodes become orphans after merging.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: deleteNodes

Type: DeleteOrphanNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

Location: DrmService.wsdl

Fields:

Fields:

int domainID: Domain ID field.

string name: Name of the domain.

string qualifier: Qualifier field.

boolean qualifierSuffix: Boolean field specifying if the qualifier is a suffix or prefix.

string delimiter: Delimiter field.

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string validationName: Validation name.

ValidationTypeEnum value: Value field.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: DomainValidationAssignmentListType

Type: DrmServiceException

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string Message: Exception message.

int Code: Error code value for the message.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: DrmServiceException

Type: DynamicColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

string constantValue: Represents a constant value for a export column.

string uniqueName:

+Type Definition

</sequence>

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

ConstantColumnType

DynamicColumnType

GenAncestorDynamicColumnType

GenNodeDynamicColumnType

GenPostDynamicColumnType

GenPreDynamicColumnType

Referenced By:

Type: ExportColumnListType

Type: EPMArchitectExportColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

int dummy: (To be deprecated)

string propName: Property definition name.

boolean isMemberKey: Is member key.

boolean isParentKey: is parent key.

boolean isPropertyArray: Is property array.

boolean isMemberLevel: Is member level.

boolean isCustomColumn: Is custom column.

EpmArchitectExportColumnArrayPropItemListType propertyArrayValues: Property array values.

+Type Definition

</sequence>

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

NodeColumnType

PropColumnType

EPMArchitectExportColumnType

Referenced By:

Type: ExportColumnListType

Type: EPMArchitectExportType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

ObjectAccessEnum objectAccess: Object access.

string name: Name.

int id: Id.

string descr: Description.

string exportClass: Export class.

VersionParamsType currentVersionParams: Current version params.

VersionParamsType previousVersionParams: Previous version params.

boolean useQuotedStrings: Use quoted strings.

string recordDelimiter: Record delimiter.

boolean useFixedWidth: Use fixed width.

boolean insertHeaderFooterBlankLines: Insert header footer blank lines.

int codePage: Code page.

boolean hasColumnHeaders: Has column headers.

ExportColumnListType columns: Columns.

CustomExportParamListType customParams: Custom params.

string queryName: Query name.

string validationName: Validation name.

boolean includeInactive: Include inactive.

ExportOutputModeEnum outputMode: Output mode.

string fileName: File name.

string includeFileConnection: Include file connection.

boolean dbClearOnVersion: Db clear on version.

boolean dbClearTable: Db clear table.

string dbConnectionString: Db connection string.

string dbExportDAL: Db export dal.

boolean dbOutputEnabled: Db output enabled.

string dbPassword: Db password.

string dbTableName: Db table name parameter.

boolean dbUseFastAppends: Db use fast appends.

boolean dbUseFastDeletes: Db use fast deletes.

boolean dbUseTransactions: Db use transactions.

string dbUserName: Db user name.

string dbVendor: Db vendor.

string delimiter: Delimiter.

string header: Header.

string footer: Footer.

StringListType fromList: From list.

string fromStrValue: From str value.

StringListType toList: To list.

string toStrValue: To string value.

string userName: User name.

int userId: User id.

boolean hasWarning: Has warning.

StringListType warningMessages: Warning Messages.

ExportRunValidationModeEnum runValidationsMode: Run validations mode.

StringListType selectedValidations: Selected validations.

NameValueListType runtimeParameters: The list of name/value pairs to use at runtime for variable substituion in constant columns, hier group filtering and downstream queries. If populated on adding or saving an export, the list is persisted to the database as the default paramters to use. When popualted for running an export they are used for that run only and are not persisted.

EpmaTargetApplicationEnum targetApplication: Target application field.

string dimensionProperty: Dimension property field.

string dimensionTypeProperty: Dimension Type Property field.

string memberKeyProperty: Member key property field.

string parentKeyProperty: Parent key property field.

QueryType propQuery: Property query field.

boolean includeImplictlySharedNodes: Include implicitly shared nodes field.

+Type Definition

</sequence>

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportType

EPMArchitectExportType

Referenced By:

Type: CreateExport
Type: UpdateExport
Type: ExportResponseType
Type: StartExport

Type: EpmArchitectExportColumnArrayPropItemListType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

ExportColumnType exportColumn: Export Column.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: HierDiffExportType
Type: ExportType
Type: GenerationExportType

Type: ExportColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

+Type Definition

</sequence>

</complexType>

Type Hierarchy:

ExportColumnType

ConstantColumnType

DynamicColumnType

GenAncestorDynamicColumnType

GenNodeDynamicColumnType

GenPostDynamicColumnType

GenPreDynamicColumnType

DataColumnType

CalculatedDataColumnType

LogItemColumnType

NodeColumnType

AutoIncrementIdColumnType

CalculatedNodeColumnType

CalculatedSequenceColumnType

GenAncestorSequenceColumnType

GenNodeSequenceColumnType

PropColumnType

BoolPropColumnType

DatePropColumnType

EPMArchitectExportColumnType

GenPropColumnType

GenAncestorPropColumnType

GenNodePropColumnType

GenPostPropColumnType

GenPrePropColumnType

NodePropColumnType

Referenced By:

Type: ExportColumnListType

Type: ExportDefListType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

ExportDefType exportDef: Export definition.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: ExportDefsResponseType

Type: ExportDefType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

ObjectAccessEnum objectAccess: Object Access.

string name: Name field.

int id: Id field.

string exportClass: Export definition type.

+Type Definition

</sequence>

</extension>

</complexContent>

</complexType>

Type Hierarchy:

BaseDefType

ExportDefType

Referenced By:

Type: ExportDefListType

Type: ExportDefsResponseType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

ExportDefListType exportDefsList: Export definitions list field.!

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getExportDefsResponse

Type: ExportDimensionTreeNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string dimensionName: Dimension name.

string dimensionType: Dimension type.

boolean dimensionTypeValid: Dimension type valid.

string dimensionTypeInvalidMessage: Dimension type invalid message.

StringListType hierarchiesInDimension: hierarchies in dimension.

StringListType columnsInDimension: Columns in dimension.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: ExportDimensionTreeNodeListType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

ExportDimensionTreeNode exportDimensionTreeNode: Export dimension tree node.

+Type Definition

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

+Type Definition

</restriction>

</simpleType>

Type Hierarchy:

string

ExportOutputModeEnum

Referenced By:

Type: ExportType

Type: ExportResponseType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

ObjectAccessEnum objectAccess: Object access.

string name: Name.

int id: Id.

string descr: Description.

string exportClass: Export class.

VersionParamsType currentVersionParams: Current version params.

VersionParamsType previousVersionParams: Previous version params.

boolean useQuotedStrings: Use quoted strings.

string recordDelimiter: Record delimiter.

boolean useFixedWidth: Use fixed width.

boolean insertHeaderFooterBlankLines: Insert header footer blank lines.

int codePage: Code page.

boolean hasColumnHeaders: Has column headers.

ExportColumnListType columns: Columns.

CustomExportParamListType customParams: Custom params.

string queryName: Query name.

string validationName: Validation name.

boolean includeInactive: Include inactive.

ExportOutputModeEnum outputMode: Output mode.

string fileName: File name.

string includeFileConnection: Include file connection.

boolean dbClearOnVersion: Db clear on version.

boolean dbClearTable: Db clear table.

string dbConnectionString: Db connection string.

string dbExportDAL: Db export dal.

boolean dbOutputEnabled: Db output enabled.

string dbPassword: Db password.

string dbTableName: Db table name parameter.

boolean dbUseFastAppends: Db use fast appends.

boolean dbUseFastDeletes: Db use fast deletes.

boolean dbUseTransactions: Db use transactions.

string dbUserName: Db user name.

string dbVendor: Db vendor.

string delimiter: Delimiter.

string header: Header.

string footer: Footer.

StringListType fromList: From list.

string fromStrValue: From str value.

StringListType toList: To list.

string toStrValue: To string value.

string userName: User name.

int userId: User id.

boolean hasWarning: Has warning.

StringListType warningMessages: Warning Messages.

ExportRunValidationModeEnum runValidationsMode: Run validations mode.

StringListType selectedValidations: Selected validations.

NameValueListType runtimeParameters: The list of name/value pairs to use at runtime for variable substituion in constant columns, hier group filtering and downstream queries. If populated on adding or saving an export, the list is persisted to the database as the default paramters to use. When popualted for running an export they are used for that run only and are not persisted.

+Type Definition

</sequence>

</complexType>

Type Hierarchy:

ExportType

EPMArchitectExportType

HierCompareExportType

HierDiffExportType

HierExportType

GenerationExportType

XmlHierExportType

LookupExportType

MergeLogExportType

PropListExportType

TransLogExportType

VersionExportType

Referenced By:

Type: CreateExport
Type: UpdateExport
Type: ExportResponseType
Type: StartExport

Type: ExternalColumnListType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

ExternalColumnType externalColumn: A list of columns from an external operation that will be mapped from an External Lookup property selection.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: PropDefType

Type: ExternalColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string name: Column from an external operation.

string property: Property name that an external operation column will be mapped to.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: ExternalColumnListType

Type: ExternalParameterListType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

ExternalParameterType externalParameter: A list of parameters for an external operation.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: PropDefType

Type: ExternalParameterType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

string constantValue: Represents a constant value for a export column.

string uniqueName:

+Type Definition

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

ConstantColumnType

DynamicColumnType

GenAncestorDynamicColumnType

Referenced By:

Type: ExportColumnListType

Type: GenAncestorPropColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Column type that represents ancestors node names of a given node.

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

int dummy: (To be deprecated)

string propName: Property definition name.

+Type Definition

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

NodeColumnType

PropColumnType

GenPropColumnType

GenAncestorPropColumnType

Referenced By:

Type: ExportColumnListType

Type: GenAncestorSequenceColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

int dummy: (To be deprecated)

int level: Field indicating level of the node.

+Type Definition

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

NodeColumnType

CalculatedNodeColumnType

CalculatedSequenceColumnType

GenAncestorSequenceColumnType

Referenced By:

Type: ExportColumnListType

Type: GenNodeDynamicColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

string constantValue: Represents a constant value for a export column.

string uniqueName:

+Type Definition

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

ConstantColumnType

DynamicColumnType

GenNodeDynamicColumnType

Referenced By:

Type: ExportColumnListType

Type: GenNodePropColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

int dummy: (To be deprecated)

string propName: Property definition name.

+Type Definition

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

NodeColumnType

PropColumnType

GenPropColumnType

GenNodePropColumnType

Referenced By:

Type: ExportColumnListType

Type: GenNodeSequenceColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

int dummy: (To be deprecated)

int level: Field indicating level of the node.

+Type Definition

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

NodeColumnType

CalculatedNodeColumnType

CalculatedSequenceColumnType

GenNodeSequenceColumnType

Referenced By:

Type: ExportColumnListType

Type: GenPostDynamicColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

string constantValue: Represents a constant value for a export column.

string uniqueName:

+Type Definition

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

ConstantColumnType

DynamicColumnType

GenPostDynamicColumnType

Referenced By:

Type: ExportColumnListType

Type: GenPostPropColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

int dummy: (To be deprecated)

string propName: Property definition name.

+Type Definition

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

NodeColumnType

PropColumnType

GenPropColumnType

GenPostPropColumnType

Referenced By:

Type: ExportColumnListType

Type: GenPreDynamicColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

string constantValue: Represents a constant value for a export column.

string uniqueName:

+Type Definition

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

ConstantColumnType

DynamicColumnType

GenPreDynamicColumnType

Referenced By:

Type: ExportColumnListType

Type: GenPrePropColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

int dummy: (To be deprecated)

string propName: Property definition name.

+Type Definition

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

NodeColumnType

PropColumnType

GenPropColumnType

GenPrePropColumnType

Referenced By:

Type: ExportColumnListType

Type: GenPropColumnType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string title: Title.

ExportColumnLayoutEnum layout: Layout.

string layoutString: Layout string.

ExportColumnCaseEnum changeCaseTo: Change case to.

boolean excludeDefault: Exclude default.

string defaultValue: Default value.

string formatClass: Format class.

boolean isPrimaryKey: Is primary key.

string key: Key.

boolean pivot: Pivot.

boolean useQuotedStrings: Use quoted strings.

boolean isFixedWidth: Is fixed width.

int width: Width.

int padChar: Pad char.

string dbFieldName: Db field name.

DbFieldTypeEnum dbFieldType: Db field type.

int dbFieldLen: Db field length.

boolean dbKeyField: Db key field.

int dummy: (To be deprecated)

string propName: Property definition name.

+Type Definition

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportColumnType

NodeColumnType

PropColumnType

GenPropColumnType

GenAncestorPropColumnType

GenNodePropColumnType

GenPostPropColumnType

GenPrePropColumnType

Referenced By:

Type: ExportColumnListType

Type: GenerationExportType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

ObjectAccessEnum objectAccess: Object access.

string name: Name.

int id: Id.

string descr: Description.

string exportClass: Export class.

VersionParamsType currentVersionParams: Current version params.

VersionParamsType previousVersionParams: Previous version params.

boolean useQuotedStrings: Use quoted strings.

string recordDelimiter: Record delimiter.

boolean useFixedWidth: Use fixed width.

boolean insertHeaderFooterBlankLines: Insert header footer blank lines.

int codePage: Code page.

boolean hasColumnHeaders: Has column headers.

ExportColumnListType columns: Columns.

CustomExportParamListType customParams: Custom params.

string queryName: Query name.

string validationName: Validation name.

boolean includeInactive: Include inactive.

ExportOutputModeEnum outputMode: Output mode.

string fileName: File name.

string includeFileConnection: Include file connection.

boolean dbClearOnVersion: Db clear on version.

boolean dbClearTable: Db clear table.

string dbConnectionString: Db connection string.

string dbExportDAL: Db export dal.

boolean dbOutputEnabled: Db output enabled.

string dbPassword: Db password.

string dbTableName: Db table name parameter.

boolean dbUseFastAppends: Db use fast appends.

boolean dbUseFastDeletes: Db use fast deletes.

boolean dbUseTransactions: Db use transactions.

string dbUserName: Db user name.

string dbVendor: Db vendor.

string delimiter: Delimiter.

string header: Header.

string footer: Footer.

StringListType fromList: From list.

string fromStrValue: From str value.

StringListType toList: To list.

string toStrValue: To string value.

string userName: User name.

int userId: User id.

boolean hasWarning: Has warning.

StringListType warningMessages: Warning Messages.

ExportRunValidationModeEnum runValidationsMode: Run validations mode.

StringListType selectedValidations: Selected validations.

NameValueListType runtimeParameters: The list of name/value pairs to use at runtime for variable substituion in constant columns, hier group filtering and downstream queries. If populated on adding or saving an export, the list is persisted to the database as the default paramters to use. When popualted for running an export they are used for that run only and are not persisted.

int maxTopNodes: (To be deprecated)

NodeLocatorListType nodesToExpand: List of node locator objects to identify the top nodes to export from.

boolean pushDown: Flag to automatically repeat nodes down to the defined level in the export structure.

string pushDownNode: Constant to push the repeat nodes from: BottomLeaf, Bottom, Root are possible values.

boolean recurse: Select to include output for all nodes below the top node. If False, only the top node is included (which is typically not the desired result).

int bottomLevel: Determines the maximum depth of the export structure

string bottomLevelProp: Property that determines the maximum depth of the export structure. This value can be defined as a hierarchy-level, integer property

QueryType query: Query to include

boolean removeDuplicates: Select to use the primary key (defined on the column Options tab) to suppress.

string repeatNumProp: References a local, node-level, integer property that repeats a node within an export structure.

boolean tabbedTree: Set to True to indent the nodes for each level of a hierarchy using tab characters to produce a structured output format.

boolean includeLeafs: Flag to include leaf nodes in the export results.

boolean includeLimbs: Flag to include limb nodes in the export results.

IncludeFileModeEnum includeFileMode: Enumeration indicating whether the nodes located in the includeFileName should be included or excluded.

string includeFileName: The name of the file on the external connection to use for filtering (include or exclude) nodes.

boolean includeImplicitlySharedNodes: Set to True to include descendant nodes below shared limb nodes that are explicitly shared. Implicit shared nodes are exported only if not filtered out by another option.

string hierarchyGroupName: If sourceNodesMethod is equal to HierarchyGroup then this is the hierarchy group name to use or a parameterized value representing the HierarchyGroup name.

boolean hierarchyGroupFromParam: If sourceNodesMethod is equal to HierarchyGroup then this param indicates if the hierarchyGroupName is an actual HierarchyGroup or a parameterized value that should be substituted at runtime.

ExportSourceNodesMethod sourceNodesMethod: Enumeration to indicate to either use a list of top nodes or a hierarchy group to export.

string hierarchyGroupProperty: If sourceNodesMethod method is equal to HierarchyGroup then this param indicates the hierarchy group property to use, or a parameterized value representing the HierarchyGroup property.

boolean hierarchyGroupPropFromParam: If sourceNodesMethod method is equal to HierarchyGroup then this param indicates if the hierarchyGroupProperty is an actual HierarchyGroup property name or a parameterized value that should be substituted at runtime.

QueryType exclusionQuery: Query to be used to exclude nodes.

int exclusionQueryId: Query ID to be used to exclude nodes.

StringListType genPreColumnList: String list of properties to export at the beginning of each row.

ExportColumnListType genPreColumns: Array of properties to export at the beginning of each row.

StringListType genAncestorColumnList: String list of node properties for the ancestor list of the specified bottom node.

ExportColumnListType genAncestorColumns: Array of node properties for the ancestor list of the specified bottom node

StringListType genNodeColumnList: String list of properties for the specified bottom node.

ExportColumnListType genNodeColumns: Array of properties for the specified bottom node.

StringListType genPostColumnList: String list of properties to export at the end of each row.

ExportColumnListType genPostColumns: Array of properties to export at the end of each row.

boolean groupRepeatedColumns: If set to True, repeated columns are grouped property in the ancestor columns.

boolean blankRepeatedLevels: Prevents repeated nodes from appearing in the output. If cleared, a node may be repeated in the output to achieve the specified level.

int maxSystemLevel: A threshold value to control the number of ancestors exported.

boolean processRootToNode: Select to set the export order (if not selected, the order is node to Root.) For example, if node A is a parent to node B and this option is selected, then the output is A,B. Otherwise, with this box unchecked, it is B,A.

boolean useInvertedLevelProp: The Oracle Essbase level methodology is used where the leaves are at 0 and count up. For a node that has multiple branches under it, the node is the largest of the possible values.

+Type Definition

</sequence>

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ObjectAccessEnum access: Object access of the blender.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getBlender

Type: GetBook

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string bookName: Book name.

ObjectAccessEnum access: Object access of the book.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getBook

Type: GetBookItemResults

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

BookItemResults bookResults: Asynchronous job results of a book run.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getBookItemResults

Type: GetCompare

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

Element: getGlyphsResponse

Type: GetHier

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType propNameList: List of properties to return.

PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getHierPropValues

Type: GetHierProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType propNameList: List of properties to return.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getHierProps

Type: GetHierTopNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType propNameList: List of properties to return.

PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getHierTopNode

Type: GetHiers

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

StringListType hierNameList: List of hierarchies to return.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getHiers

Type: GetHiersByFilter

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

StringListType versionNames: (Required) List of versions to evaluate for the filtered list of hierarchies.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getHiersByFilter

Type: GetImport

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string importName: The import name to return.

ObjectAccessEnum access: The object access of the import.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getImport

Type: GetLogItems

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

LogCriteriaType logCriteria: An object representing criteria for transaction history.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getLogItems

Type: GetNode

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

HierLocatorType hierLocator: A hierarchy locator object representing a hierarchy in a version.

string name: The name of the node to return.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getNodeByID

Type: GetNodePropValues

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

StringListType nodeNameList: List of node names.

StringListType propNameList: List of properties to return.

PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getNodes

Type: GetOrphanNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

Location: DrmService.wsdl

Fields:

boolean global: Flag indicating if global queries should be returned.

StringListType queryNameList: The list of queries to return.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getQueries

Type: GetQuery

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string queryName: The name of the query.

ObjectAccessEnum access: The object access of the query.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getQuery

Type: GetRelatedNodeCount

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

RelationshipEnum relationship: An enumeration indicating what types of nodes to return (Children, Descendants, and so on).

boolean visibleOnly: Flag indicating that visible children should only be returned.

boolean includeLeaves: Flag to include leaf nodes.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getRelatedNodeCount

Type: GetRelatedNodeNames

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

RelationshipEnum relationship: An enumeration indicating what types of nodes to return (i.e. Children, Descendants, etc).

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getRelatedNodeNames

Type: GetRelatedNodes

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

string hierName: Hierarchy name field.

string nodeName: Node name field.

RelationshipEnum relationship: An enumeration indicating what types of nodes to return (i.e. Children, Descendants, etc).

StringListType propNameList: List of properties to return.

PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getRelatedNodes

Type: GetRelatedNodesWithProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

string nodeName: Node name field.

string newNodeName: The new node name to create.

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

Fields:

string versionName: Version name field.

StringListType propNameList: List of properties to return.

PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getVersionPropValues

Type: GetVersionProps

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

Fields:

</sequence>

</complexType>

Referenced By:

Type: GetGlobalNodeReferencesResponse

Type: GlobalNodeResponseType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

GlobalNodeType queryResult: Query result.

+Type Definition

</sequence>

</complexType>

Type: GlobalNodeType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string name: The name of the node.

int id: The system-generated ID of the node.

string descr: Description of the object.

string versionName: Version name field.

boolean isLeaf: Field indicating if node is a Leaf node.

boolean isInactive: Flag indicating that the node is inactive.

int childCount: The number of children the node has.

boolean isNodeApproved: Flag indicating that the node has been approved.

+Type Definition

Fields:

string name: The name of the node.

int id: The system-generated ID of the node.

string descr: Description of the object.

string versionName: Version name field.

boolean isLeaf: Field indicating if node is a Leaf node.

boolean isInactive: Flag indicating that the node is inactive.

int childCount: The number of children the node has.

boolean isNodeApproved: Flag indicating that the node has been approved.

PropValueFlexListType propValueList: A list of property values.

+Type Definition

</sequence>

</extension>

</complexContent>

</complexType>

Type Hierarchy:

GlobalNodeType

GlobalNodeWithPropValuesType

Referenced By:

Type: GlobalNodeResponseType
Type: GlobalNodeWithPropValuesListType
Type: GlobalNodeWithPropValuesResponseType

Type: GlobalQueryResponseType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

GlobalQueryResultType globalQueryResult: A query results for a global query.

+Type Definition

</sequence>

</complexType>

Referenced By:

Element: getGlobalQueryResultsResponse
Element: runGlobalQueryResponse
Type: GetOrphanNodesResponse

Type: GlobalQueryResultType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string versionName: Version name field.

int nodeCount: The number of nodes in the result.

GlobalNodeWithPropValuesListType nodes: An list type that represents the global nodes for the result.

boolean maxNodesExceeded: Flag indicating that the maximum number of nodes threshold was reached during the query run.

StringListType requestedPropNames: List of properties to return.

+Type Definition

</sequence>

</complexType>

Type Hierarchy:

GlobalQueryResultType

VersionValidationResultType

Referenced By:

Type: GlobalQueryResponseType

Type: GlyphListType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

GlyphType glyphs: List of glyphs.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: GetGlyphsResponse

Type: GlyphType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

string name: The name of the glyph.

int id: The system-generated ID of the glyph.

string descr: Description of the glyph.

string imageData: Base-64 string value of the byte data.

ImageTypeEnum imageTypeEnum: An enumeration indicating the image type; currently supported image types are PNG.

+Type Definition

</sequence>

</complexType>

Referenced By:

Type: GetGlyphResponse
Type: GlyphListType
Type: UpdateGlyph

Type: HierAddRequestItemType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

int requestId: The system-generated ID for the request the item belongs to.

int itemId: The system-generated ID for the request item.

RequestActionEnum action: An enumeration indicating the type of request item.

string customValue: Free-form field to be used updated by external systems.

string hierName: Hierarchy name field.

string hierDescr: The hierarchy description.

string topNodeName: The name of the top node.

string topNodeDescr: The description of the top node.

+Type Definition

</sequence>

</extension>

</complexContent>

</complexType>

Type Hierarchy:

RequestItemType

HierRequestItemType

HierAddRequestItemType

Referenced By:

Type: RequestItemListType

Type: HierCompareExportType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

ObjectAccessEnum objectAccess: Object access.

string name: Name.

int id: Id.

string descr: Description.

string exportClass: Export class.

VersionParamsType currentVersionParams: Current version params.

VersionParamsType previousVersionParams: Previous version params.

boolean useQuotedStrings: Use quoted strings.

string recordDelimiter: Record delimiter.

boolean useFixedWidth: Use fixed width.

boolean insertHeaderFooterBlankLines: Insert header footer blank lines.

int codePage: Code page.

boolean hasColumnHeaders: Has column headers.

ExportColumnListType columns: Columns.

CustomExportParamListType customParams: Custom params.

string queryName: Query name.

string validationName: Validation name.

boolean includeInactive: Include inactive.

ExportOutputModeEnum outputMode: Output mode.

string fileName: File name.

string includeFileConnection: Include file connection.

boolean dbClearOnVersion: Db clear on version.

boolean dbClearTable: Db clear table.

string dbConnectionString: Db connection string.

string dbExportDAL: Db export dal.

boolean dbOutputEnabled: Db output enabled.

string dbPassword: Db password.

string dbTableName: Db table name parameter.

boolean dbUseFastAppends: Db use fast appends.

boolean dbUseFastDeletes: Db use fast deletes.

boolean dbUseTransactions: Db use transactions.

string dbUserName: Db user name.

string dbVendor: Db vendor.

string delimiter: Delimiter.

string header: Header.

string footer: Footer.

StringListType fromList: From list.

string fromStrValue: From str value.

StringListType toList: To list.

string toStrValue: To string value.

string userName: User name.

int userId: User id.

boolean hasWarning: Has warning.

StringListType warningMessages: Warning Messages.

ExportRunValidationModeEnum runValidationsMode: Run validations mode.

StringListType selectedValidations: Selected validations.

NameValueListType runtimeParameters: The list of name/value pairs to use at runtime for variable substituion in constant columns, hier group filtering and downstream queries. If populated on adding or saving an export, the list is persisted to the database as the default paramters to use. When popualted for running an export they are used for that run only and are not persisted.

CompareType compare: A compare type for this hierarchy compare export.

boolean includeAdditions: Includes all nodes in the target (to) hierarchy that are not in the source (from) hierarchy.

string addCode: Add code.

boolean includePropUpdates: Include property updates.

string propUpdateCode: Property update code.

boolean includeMoves: Include moves.

string moveCode: Move code.

boolean includeDeletions: Include deletions.

string deletionCode: Deletion code.

boolean includeRenames: Include renames.

string renameCode: Rename code.

boolean includeMerges: Include merges.

string mergeCode: Merge code.

boolean removeDuplicates: Remove duplicates.

QueryType exclusionQueryName: Name of the query used to exclude nodes.

int exclusionQueryId: Id of the query used to exclude nodes.

+Type Definition

</sequence>

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportType

HierCompareExportType

Referenced By:

Type: CreateExport
Type: UpdateExport
Type: ExportResponseType
Type: StartExport

Type: HierDiffExportType

Namespace: http://drm.webservices.epm.oracle

Location: DrmService.wsdl

Fields:

ObjectAccessEnum objectAccess: Object access.

string name: Name.

int id: Id.

string descr: Description.

string exportClass: Export class.

VersionParamsType currentVersionParams: Current version params.

VersionParamsType previousVersionParams: Previous version params.

boolean useQuotedStrings: Use quoted strings.

string recordDelimiter: Record delimiter.

boolean useFixedWidth: Use fixed width.

boolean insertHeaderFooterBlankLines: Insert header footer blank lines.

int codePage: Code page.

boolean hasColumnHeaders: Has column headers.

ExportColumnListType columns: Columns.

CustomExportParamListType customParams: Custom params.

string queryName: Query name.

string validationName: Validation name.

boolean includeInactive: Include inactive.

ExportOutputModeEnum outputMode: Output mode.

string fileName: File name.

string includeFileConnection: Include file connection.

boolean dbClearOnVersion: Db clear on version.

boolean dbClearTable: Db clear table.

string dbConnectionString: Db connection string.

string dbExportDAL: Db export dal.

boolean dbOutputEnabled: Db output enabled.

string dbPassword: Db password.

string dbTableName: Db table name parameter.

boolean dbUseFastAppends: Db use fast appends.

boolean dbUseFastDeletes: Db use fast deletes.

boolean dbUseTransactions: Db use transactions.

string dbUserName: Db user name.

string dbVendor: Db vendor.

string delimiter: Delimiter.

string header: Header.

string footer: Footer.

StringListType fromList: From list.

string fromStrValue: From str value.

StringListType toList: To list.

string toStrValue: To string value.

string userName: User name.

int userId: User id.

boolean hasWarning: Has warning.

StringListType warningMessages: Warning Messages.

ExportRunValidationModeEnum runValidationsMode: Run validations mode.

StringListType selectedValidations: Selected validations.

NameValueListType runtimeParameters: The list of name/value pairs to use at runtime for variable substituion in constant columns, hier group filtering and downstream queries. If populated on adding or saving an export, the list is persisted to the database as the default paramters to use. When popualted for running an export they are used for that run only and are not persisted.

CompareType compare: A compare type for this hierarchy compare export.

int nodeNameWidth: The width of the name column in the export results.

int parentNameWidth: The width of the parent column in the export results.

boolean includeAdditions: Includes all nodes in the target (to) hierarchy that are not in the source (from) hierarchy.

boolean includeDeletions: Includes all nodes in the source (from) hierarchy that are not in the target (to) hierarchy.

boolean inlcudeMergeNodes: Includes merge information in the export (if the merge feature is enabled.)

boolean includePropUpdates: Includes all nodes that have different values in the specified list of properties in the compared hierarchies.

boolean includeRenames: Includes all nodes that have different names but the same internal nodeID in the compared hierarchies.

boolean inlcudeStructureChanges: A structure section will be exported if there are structural changes between the source and target.

boolean includeSummary: Include a summary of the differences in the export result. Example: #Additions, #Deletions, #New, #Structure, #Old

ExportColumnListType extraColumns: (To be deprecated)

+Type Definition

</sequence>

</extension>

</complexContent>

</complexType>

Type Hierarchy:

ExportType

HierDiffExportType

Referenced By:

Type: CreateExport
Type: UpdateExport
Type: ExportResponseType
Type: StartExport

Type: HierExportType