Oracle Hyperion Financial Management

Developer's Guide

Release 11.1.2.3

Financial Management Developer's Guide, 11.1.2.3

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

Authors: EPM Information Development Team

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

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

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

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

U.S. GOVERNMENT RIGHTS:

Programs, software, databases, and related documentation and technical data delivered to U.S. Government customersare "commercial computer software" or "commercial technical data" pursuant to the applicable Federal AcquisitionRegulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, andadaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, tothe extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, CommercialComputer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

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

This software or hardware and documentation may provide access to or information on content, products, and servicesfrom third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of anykind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsiblefor any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Contents

Documentation Accessibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Chapter 1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Prerequisites for Developers and Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

COM Data Type Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Features Exposed by the Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Application Server Tier Type Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Type Libraries for Loading and Extracting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Control for Selecting Dimension Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Additional Architectural Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

About Subcubes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Data Across Multiple Application Servers: Subcube Caching . . . . . . . . . . . . . . . . . . . . . . 54

Values Returned in Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Chapter 2. About the Type Libraries and Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Type Library References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Objects, Properties, and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

HsxClient Type Library Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

HsxClientUI Type Library Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

HsxServer Type Library Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

HsvSession Type Library Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

HsvMetadata Type Library Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

HsvData Type Library Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

HsvCalculate Type Library Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

HsvJournals Type Library Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

HsvSecurityAccess Type Library Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

HsvSystemInfo Type Library Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

HsvProcessFlow Type Library Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

HsvReports Type Library Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

HsvMDArrays Type Library Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

HsvDataCubes Type Library Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

Contents iii

HsvDQI Type Library Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

HsvStarSchemaACM Type Library Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

HsvICM Type Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Type Libraries for Loading and Extracting Information . . . . . . . . . . . . . . . . . . . . . . 124

HsvPOVSelection Type Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

HsvResourceManager Type Library Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

HfmSliceCOM Type Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

Chapter 3. Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Logging a User on to an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Working with Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Getting and Setting Cell Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Getting and Setting User Preferences for Number Formatting . . . . . . . . . . . . . . . . . . . . 139

Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Loading and Extracting Application Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Chapter 4. HfmSliceCOM Type Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

HfmPovCOM Object Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

NumCustomDims . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

HfmPovCOM Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

ConvertToHfmPovStrCOM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

GetAllDims . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

GetCustomMemberAt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

GetCustoms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

GetDimensionMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

GetLeftHandDims . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

GetMemberForCustomDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

GetRightHandDims . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

SetAllDims . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

SetCustomMemberAt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

SetCustoms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

SetDimensionMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

SetLeftHandDims . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

SetRightHandDims . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

HfmSliceCOM Object Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

ArrayReserveSize (Read/Write property) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

NumCustomDims (Read-only property) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

HfmSliceCOM Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

iv Contents

ConvertToHfmSliceStrCOM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

EnumCustomDimIds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

GenerateCartesianProduct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

GetFixedMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

GetMemberArrayForDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

GetMemberAt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

GetNumCells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

GetNumMembers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

GetPovAtIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

InitializeFromPovString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

SetFixedMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

SetMemberArrayForDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

SetMemberAt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Chapter 5. HsxClient Type Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

HsxClient Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

AuthenticateCSSToken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

AuthenticateSecurityAgentCredentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

AuthenticateUserCredentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

AuthenticateUserOnClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

AuthenticateUserOnCluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

AuthenticateUserOnClusterSSO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

AuthenticateUserOnServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

CreateApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

CreateApplicationCAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

CreateApplicationCASWithAccessCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

CreateObjectOnCluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

CreateObjectOnServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

DeleteApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

DeleteApplicationWithAccessCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

DeleteSystemErrors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

DetermineWindowsLoggedOnUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

DisableNewConnections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

DoesUserHaveCreateApplicationRights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

DoesUserHaveSystemAdminRights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

EnableNewConnections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

EnumProhibitConnections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

EnumProvisioningProjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

EnumRegisteredClusterNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Contents v

EnumRegisteredClustersOrServers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

EnumRegisteredServerNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

EnumUserAppPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

EnumUsersOnSystem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

EnumUsersOnSystemEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

EnumUsersOnSystemEx2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

GetApplicationFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

GetClusterInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

GetClustersAndServers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

GetHFMErrorLogRecordSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

GetLogonInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

GetLogonInfoSSO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

GetModifyApplicationInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

GetModifyApplicationStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

GetServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

GetServerOnCluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

GetSSOTokenUsingWebSecurityAgentCredentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

GetWebSecurityAgentSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

IsValidApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

KillUsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

ModifyApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

OpenApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

RegisterApplicationCAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

RegisterApplicationCASWithAccessCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

RegisterCluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

RegisterServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

ScriptableEnumRegisteredClusterNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

ScriptableEnumRegisteredServerNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

ScriptableGetLogonInfoSSO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

ScriptableOpenApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

SetApplicationFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

SetLogonInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

SetLogonInfoSSO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

UnregisterAllClusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

UnregisterCluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

UnregisterServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

UpdateUserAppPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

WarnUsersForShutDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

vi Contents

Chapter 6. HsxClientUI Type Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

HsxClientUI Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

DeleteApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

GetServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Initialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Logon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

OpenApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

RegisterServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

Chapter 7. HsxServer Type Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

HsxServer Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

DeleteSystemErrors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

DeleteSystemErrorsEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

EnumDataSources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

EnumRegisteredDSNs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

GetClustersAndServers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

GetDataSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

GetFileTransfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

GetHFMErrorLogRecordSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

GetSystemDataLinkFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

GetSystemFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

GetXMLErrorFromDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

GetXMLErrorsListFromDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

ScriptableEnumDataSources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

ScriptableEnumRegisteredDSNs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

HsxServer Object Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

CSSEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

Chapter 8. HsvSession Type Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

HsvSession Object Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

Calculate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

ICM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Journals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

ProcessFlow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

SystemInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

HsvSession Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

Contents vii

CreateObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

GetECID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

get_HsvDQI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

GetLicenseExpirationStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

HasSystemChanged . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

HasUserStatusChanged . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

IsBusy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

IsRunningTasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

LockMetadataLoadWithSystemChangeCheck . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

UnlockMetadataLoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

Chapter 9. HsvMetadata Type Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

About Member IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

HsvMetadata Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

EnumCellTextLabels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

EnumConsolidationMethodIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

EnumCustomDimsForApp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

EnumCustomDimsForAppEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

EnumDimProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

EnumExtractOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

EnumLanguages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

EnumLoadOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

EnumMemberProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

Extract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

ExtractModuleConfigurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

GetApplicationAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

GetApplicationAttributeExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

GetApplicationCurrency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

GetApplicationSettingsTimeStamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

GetAppProfileInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

GetByIndexValidationAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

GetCellLevelAccountType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

GetCellLevelAccountTypeExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

GetCellTextIdFromLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

GetCellTextIdsFromLabels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

GetCellTextLabelDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

GetCellTextLabelFromId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

GetConsolidationMethodDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

GetConsolidationMethodInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

viii Contents

GetConsolidationMethodsTimeStamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

GetCurrencyTimeStamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

GetCurrencyValueIDForEntityValueCombination . . . . . . . . . . . . . . . . . . . . . . . . . 214

GetCurrencyValueIDsForEntityValueCombinations . . . . . . . . . . . . . . . . . . . . . . . . 215

GetCustomX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

GetDefaultScaleAndNumDecimal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

GetDefaultValueOfActiveStatusAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

GetDimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

GetDimensionIdFromName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

GetFdmAppName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

GetFrequencyID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

GetICPEntitiesAggregationWeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

GetICPEntitiesAggregationWeightEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

GetMaxCustomDimNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

GetMaxDimId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

GetNumDimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

GetSupportSubmissionPhaseForAccountFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

GetSupportSubmissionPhaseForCustom1Flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

GetSupportSubmissionPhaseForCustom2Flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

GetSupportSubmissionPhaseForCustom3Flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

GetSupportSubmissionPhaseForCustom4Flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

GetSupportSubmissionPhaseForCustomXFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

GetSupportSubmissionPhaseForICPFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

GetUseSubmissionPhaseFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

GetValidationAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

GetValidationAccountMembers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

IsCustomDimValidForApp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

IsCustomMemberValidForAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

IsOrgByPeriodApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

Load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

LoadModuleConfigurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

LoadWithAccessCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

TranslateApplicationAttributeForDisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

TranslateApplicationAttributeForDisplayExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . 229

HsvMetadata Object Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

Currencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

Custom1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

Custom2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

Contents ix

Custom3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

Custom4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

Dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

ICPs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

Periods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

Years . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

IHsvTreeInfo Interface Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

EnumAllMemberIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

EnumAllMemberLabels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

EnumAllParentAndChildIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

EnumAllParentAndChildLabels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

EnumAncestors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

EnumBaseMemberIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

EnumDefaultAncestors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

EnumDefaultAncestorsLabels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

EnumDescendants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

EnumIDsOfChildren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

EnumIDsOfIChildren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

EnumMemberLists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

EnumMembers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

EnumMembers2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

EnumMembersWithAttribValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

EnumParents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

EnumSortedIDsOfChildren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

EnumSortedIDsOfIChildren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

EnumSortedMembers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

FindByDesc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

FindMatchingMembersFromHierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

FindMatchingMembersFromHierarchyByDesc . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

FindMatchingMembersFromHierarchyWildCard . . . . . . . . . . . . . . . . . . . . . . . . . . 253

GetAllPathsToMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

GetAttributeValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

GetDefaultHierarchyPosition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

GetDefaultItemIDHierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

x Contents

GetDefaultMemberID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

GetDefaultParent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

GetDefaultParentLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

GetDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

GetDisplayInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

GetDisplayInfoForSeveralItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

GetItemGeneration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

GetItemID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

GetItemIDQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

GetItemLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

GetLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

GetMemberListID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

GetMemberListName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

GetNumBaseMembers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

GetNumChildren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

GetNumDescendants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

GetNumMembers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

GetNumParents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

GetQualifiedLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

GetTreeCapabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

GetTreeName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

GetTreeTimeStamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

HasChildren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

IsMemberABaseOf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

IsMemberAChildOf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

IsMemberADescendantOf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

SortMembersBasedOnList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273

TranslateAttributeValueForDisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

HsvAccounts Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

GetAccountType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

GetCalcAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

GetICPTopMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

GetIsICP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

GetNumDecimalPlaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

GetPlugAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

GetSecurityClassID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

GetSubmissionGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

GetTopMemberOfValidCustom1Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

GetTopMemberOfValidCustom2Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

Contents xi

GetTopMemberOfValidCustom3Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

GetTopMemberOfValidCustom4Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

GetUserDefined1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

GetUserDefined2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

GetUserDefined3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

GetXBRLTags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

IsCalculated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

IsConsolidated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

IsCustom1AggregationEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

IsCustom2AggregationEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

IsCustom3AggregationEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

IsCustom4AggregationEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

IsICP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

IsICPRestricted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

UsesLineItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

HsvCustom Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

GetAggregationWeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

GetSecurityClassID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

GetSubmissionGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

GetUserDefined1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

GetUserDefined2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

GetUserDefined3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

IsCalculated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

IsSwitchSignEnabledForFlow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

IsSwitchTypeEnabledForFlow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

HsvEntities Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

GetAllowAdjustments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

GetAllowAdjustmentsFromChildren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

GetDefaultValueID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

GetHoldingCompany . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

GetSecurityAsPartnerID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

GetSecurityClassID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

GetUserDefined1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

GetUserDefined2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

GetUserDefined3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

IsChild . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

IsDescendant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

IsICP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

IsOrgByPeriodFilteringOn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

xii Contents

IsSecurityAsPartnerEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

HsvICPs Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

GetSecurityClassID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

GetSubmissionGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

HsvPeriods Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

GetBaseFrequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

GetFrequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

GetNumPeriodsInFrequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

GetPeriodFromFrequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

GetPeriodsInFrequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

HsvScenarios Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

GetPhasedSubmissionStartYear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

EnumPhasedSubmissionStartYears . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

GetDefaultFrequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

GetDefaultView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

GetMaximumReviewLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

GetMissingDataZeroViewForAdjValues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

GetMissingDataZeroViewForNonAdjValues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

GetSecurityClassID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

GetUserDefined1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

GetUserDefined2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

GetUserDefined3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

IsConsolidateYTD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

IsPhasedSubmissionEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

SupportsAccountAllocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

SupportsEmailAlerting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

SupportsProcessFlow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

SupportsTargetSetting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

SupportsTimePeriodAllocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

UsesLineItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

HsvValues Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

GetCurrencyIDFromValueID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

GetValueIDFromCurrencyID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

HsvYears Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

GetYearRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

HsvCurrencies Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

EnumCurrencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

EnumCurrencies2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

GetCurrencyDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

Contents xiii

GetCurrencyID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

GetCurrencyLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

GetCurrencyTranslationOperator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

GetScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

Chapter 10. HsvData Type Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319

About Cell Statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319

Update Mode Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

HsvData Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

AddDataToMDDataBuffer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

AddDataToMDDataBufferExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

AttachDocumentToCell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

AttachDocumentToCellExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

ClearAllData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

ClearAllDescriptionsInSubCube . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

ClearDataAuditItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

ClearDataAuditItemsEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324

ClearInputData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324

ClearInvalidData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

CopyInputData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327

CopyInputDataForMultipleEntities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327

DeleteLineItemDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

DeleteLineItemDetailsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

DetachDocumentFromCell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329

DetachDocumentFromCellExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329

DMELoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329

DoCellDescriptionsExist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329

DoesCellDescriptionExist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

DoesCellDescriptionExistExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

DoesDataExist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

DoesSparseDataExist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

DoesSparseDataExistExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

EnumDataAuditItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

EnumDataAuditItemsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

EnumDataAuditItems2ExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

EnumEntitiesWithDataForScenarioYear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

EnumExtractOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

EnumLoadOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334

Extract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

xiv Contents

ExtractDataAuditItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

ExtractDataAuditItemsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

ExtractDrillableRegions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340

ExtractDrillableRegionsByURLNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340

FilterMembersThatHaveData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341

FilterMembersThatHaveDataExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341

FilterMembersThatHaveData2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

FilterMembersThatHaveData2ExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

FormatNumberToText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

FormatNumberToText2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344

FormatStatusToText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

FormatStoredNumberToText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

FormatTextToNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

FormatTextToStoredNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

GetAllDescriptionsInSubCube . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350

GetAllDescriptionsInSubCubeExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350

GetAllURLNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350

GetAttachedDocumentsToCell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

GetAttachedDocumentsToCellExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

GetBaseDataForAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

GetBaseDataForAccountExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

GetCalcStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

GetCalcStatusEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

GetCalcStatusExExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

GetCalcStatusStatistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

GetCell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

GetCellExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

GetCellDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

GetCellDescriptionExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

GetCellDescriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

GetCellDescriptionsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

GetCellHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356

GetCellHistoryExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356

GetCellHistory2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357

GetCellHistory2ExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357

GetCellJournalEntries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

GetCellJournalEntriesExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

GetCellLineItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

GetCellLineItemsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

Contents xv

GetCells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

GetCellsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

GetCellsWithRowSuppression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

GetCellsWithRowSuppressionExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

GetCellsWithRowSuppression2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

GetCellsWithRowSuppression2ExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

GetCountOfAttachedDocumentsToCell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

GetCountOfAttachedDocumentsToCellExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

GetCurrencyCube . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

GetDataForAllMetadataCombinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

GetDynamicAccountRulesCache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

GetLineItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

GetDataGridExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

GetMaxCellTextSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

GetMembersThatHaveData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

GetMembersThatHaveDataExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

GetMultiServerMaxSyncDelayForChanges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

GetNodeCube . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

GetPhaseSubmissionGridForGivenScenarioPeriod . . . . . . . . . . . . . . . . . . . . . . . . . 365

GetStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

GetStatusEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

GetStatusExExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

GetStatusUsingPhaseID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

GetStatusUsingPhaseIDExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

GetTextCell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367

GetTextCellExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367

GetTextCellLineItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368

GetTextCellLineItemsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368

GetTextCells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368

GetTextCellsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368

GetTextCellsWithRowSuppression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369

GetTextCellsWithRowSuppressionExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369

GetTextCellsWithRowSuppression2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370

GetTextCellsWithRowSuppression2ExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370

GetTextLineItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371

GetTransactionData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372

GetUnassignedGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372

GetURLByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373

GetURLsForCell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374

xvi Contents

InsertLineItemDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

InsertLineItemDetailsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

IsValidCellText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376

Load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376

LoadDrillableRegions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

SetCalcStatusLocked . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

SetCalcStatusLockedForMultipleProcessUnits . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

SetCalcStatusUnlocked . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

SetCalcStatusUnlockedForMultipleProcessUnits . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

SetCell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

SetCellExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

SetCellDescriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383

SetCellDescriptionsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383

SetCellLineItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383

SetCellLineItemsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384

SetCells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384

SetCellsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384

SetCells2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385

SetCells2ExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385

SetCellsLineItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385

SetCellsLineItemsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385

SetFileForLoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

SetLineItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

SetLineItemsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

SetMinMaxPeriod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387

SetPhaseSubmissionGridForGivenScenarioPeriod . . . . . . . . . . . . . . . . . . . . . . . . . . 387

SetTextCell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387

SetTextCellExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387

SetTextCellLineItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388

SetTextCellLineItemsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388

SetTextCells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388

SetTextCellsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

SetTextCellsLineItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

SetTextCellsLineItemsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

SetTextLineItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

StartLoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

StartLoadTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

UpdateDataUsingMDDataBuffer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

ValidateMembersAndConvertToIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

Contents xvii

Chapter 11. HsvCalculate Type Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391

HsvCalculate Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392

Allocate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392

Allocate2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392

CalcEPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393

ChartLogic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393

ChartLogic2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394

Consolidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

Consolidate2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

CustomLogic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

EnumOnDemandRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

ExecuteOnDemandRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

FindOverlappingConsolidation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

GetCOMDLLRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

GetConsolidationProgress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

GetDefaultExchangeRate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

GetDefaultExchangeRateExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

GetEPUInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400

GetEPUInfoEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400

GetVBScriptRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401

IsEntityAnEPUOwner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402

LoadCalcManagerRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402

LoadCalcManagerRules2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402

SetCOMDLLRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402

SetVBScriptRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402

SetVBScriptRules2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404

StopConsolidation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

Translate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

Translate2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407

Chapter 12. HsvJournals Type Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409

Journal Column Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409

Template Column Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

HsvJournals Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411

ClosePeriod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411

GetItemID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412

GetJournalTemplateItemID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412

GetPeriodStatusList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413

IsPeriodOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414

xviii Contents

OpenPeriod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414

IHsvJournalsEx Interface Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

AddJournalGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

ApproveJournals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

DeleteJournals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

DeleteTemplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

EnumJournalGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

EnumJournalGroupsEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

EnumJournalGroupsForScenarioYear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

EnumJournalIDsForExtractFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

GenerateRecurring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

GetEntityJournals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

GetEntityJournalsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

GetEntityJournals2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422

GetEntityJournals2ExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422

GetJournal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423

GetJournalExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423

GetJournal2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425

GetJournal2ExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425

GetJournalDisplayData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426

GetJournalLabelsForIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428

GetJournalQueryDefinitionIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428

GetTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430

GetTemplateExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430

GetTemplateDisplayData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431

GetTemplateLabelsForIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432

GetTemplateQueryDefinitionIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433

GetTextJournal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434

GetTextJournalExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434

GetTextTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436

GetTextTemplateExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436

GetVariance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437

PostJournals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

RejectJournals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440

RemoveAllJournalGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441

RemoveJournalGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441

SaveJournal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441

SaveJournalExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441

SaveTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443

Contents xix

SaveTemplateExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443

SaveTextJournal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445

SaveTextJournalExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445

SaveTextTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

SaveTextTemplateExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

SubmitJournals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

UnpostJournals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451

UnsubmitJournals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452

ValidateLineItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453

ValidateLineItemsExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453

ValidateValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454

IHsvJournalsReport Interface Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454

Report Data Array Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455

GetReportData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456

GetReportDataExtDim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457

GetReportData2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458

GetReportData3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458

Chapter 13. HsvSecurityAccess Type Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

Access Rights Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

Role ID Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462

Task Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462

E-mail Alerting Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462

User Groups - User Type Flag Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462

Identity Type Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463

Search Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463

Security Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464

The Connected User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464

HsvSecurityAccess Object Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464

AddApplicationAdministrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

AddApplicationAdministrator2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

AddOrRemoveApplicationAdministrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

AddOrRemoveApplicationAdministrators2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

AddOrRemoveRolesFromUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466

AddOrRemoveRolesFromUser2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466

AddOrRemoveUsersFromRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467

AddOrRemoveUsersFromRole2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467

AddSecurityClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468

AddSecurityClassWithAccessCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468

xx Contents

AddUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468

AddUser2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468

AddUserEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468

AddUserToRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469

AddUserToRole2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469

AllowRulesLoadForEPMAApp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469

DeleteSecurityClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469

DeleteSecurityClasses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470

DeleteSecurityClassWithAccessCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470

EnumApplicationAdministrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470

EnumApplicationAdministrators2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470

EnumRoles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471

EnumRolesForPrincipal . . . . . . . . . . . . . . . . .