HsvData Type Library Overview

The HsvData type library provides the HsvData object, which gets and sets data in Financial Management applications. The HsvData object is a child of the HsvSession object. Use HsvSession’s Data property to set HsvData object references as shown in the following example:

  Dim cHsvData As HsvData
  Set cHsvData = cHsvSession.Data

The following table lists the methods of the HsvData object.

Table 21. HsvData Object Methods

Method

Description

AddDataToMDDataBuffer

Adds an application’s cell to an HsvMDDataBuffer or HsvMDDataBufferLite object. Any data, description, or line items for the cell will be added.

AttachDocumentToCell

Attaches a previously loaded document to a cell.

ClearAllData

Deletes all data from an application.

ClearAllDescriptionsInSubCube

Removes the cell text from all the cells in a subcube.

ClearDataAuditItems

Deletes the audit history for all data changes that occurred before a given date and time.

ClearInputData

Deletes data from some or all of a subcube’s cells.

ClearInvalidData

Scans for or deletes invalid records.

CopyInputData

Deprecated – use CopyInputDataForMultiple Entities.

CopyInputDataForMultipleEntities

Copies data for one or more entities from one set of cells to another set of cells.

DeleteLineItemDetails

Deletes line item details for the cells that intersect the specified dimension members. Line item descriptions are used to identify the line items to be deleted.

DetachDocumentFromCell

Detaches a document from a cell.

DoCellDescriptionsExist

Indicates whether one or more of the cells for a combination of Scenario, Year, and Entity dimension members contain cell text descriptions.

DoesCellDescriptionExist

Indicates whether a cell contains cell text.

DoesDataExist

Indicates whether any data exists in one or more cells.

DoesSparseDataExist

Indicates whether sparse data exists for the specified cell.

EnumDataAuditItems

Returns data audit information from a given range of audit records that meet the specified filtering criteria.

EnumDataAuditItems2

For internal use.

EnumEntitiesWithDataForScenarioYear

Returns a variant array of Entity ID's that have data for a given scenario and year.

EnumExtractOptions

Returns a two-dimensional array of the data extract options that can be passed to HsvData.Extract. The array includes the options’ names and default values.

EnumLoadOptions

Returns a two-dimensional array of the data load options that can be passed to HsvData.Load. The array includes the options’ names and default values.

Extract

Extracts data into a text file. The file will be created on the application server.

ExtractDataAuditItems

Extracts to a file the data audit information that meets the specified filtering criteria. The filtering criteria include dimension members, date range, application server, and username.

ExtractDrillableRegions

Retrieves all ERPI URL definitions.

ExtractDrillableRegionsByURLNames

Retrieves only the URLs that appear in the input array varabstrURLNames.

FilterMembersThatHaveData

Returns a list of members for the specified dimension for which data exists for the specified POVs.

FilterMembersThatHaveData2

For a specified dimension, returns the filtered of member IDs that have data for any of the specified POVs.

FormatNumberToText

Returns a number as a String. FormatNumberToText scales the number and puts a fixed number of digits to the right of the decimal point.

FormatNumberToText2

Takes a number and returns it as a String, with the option to remove trailing zeroes. FormatNumberToText2 scales the number and puts a fixed number of digits to the right of the decimal point.

FormatStatusToText

Returns a string description of the numeric calculation status passed as the argument.

FormatStoredNumberToText

Converts a number passed as a Double to a String, formatting the String with the decimal and thousands delimiters that you specify.

FormatTextToNumber

Returns a number stored in a String as a Double. FormatTextToNumber also scales the returned number.

FormatTextToStoredNumber

Converts a number passed as a String to a Double.

GetAllDescriptionsInSubCube

Returns an array containing the cell text descriptions of one or more cells that have the same Scenario, Year, and Value dimension members.

GetAllURLNames

Retrieves the full list of URL names currently in Financial Management.

GetAttachedDocumentsToCell

Returns the names and paths of the documents attached to a given cell.

GetBaseDataForAccount

For internal use.

GetCalcStatus

Returns the calculation status of a subcube.

GetCalcStatusStatistics

Returns arrays of flags that indicate which calculation statuses apply to the specified entities and periods of a subcube.

GetCell

Returns the data in a cell, as well as the cell’s status. The data is returned as a Double.

GetCellDescription

Returns the cell text description of a cell.

GetCellDescriptions

Returns the cell text descriptions of one or more cells.

GetCellHistory

Returns the audit history of a cell’s data changes, with cell values returned as Doubles.

GetCellHistory2

Returns the audit history of a cell’s data changes, with cell values returned as formatted strings.

GetCellJournalEntries

Returns arrays containing the data in and IDs of the journal entries for a cell.

GetCellLineItems

Returns arrays of the data and descriptions for the specified cell’s line items. Data is returned in a Double array.

GetCells

Returns the data and statuses of cells. The cells’ data is returned as a Double array.

GetCellsWithRowSuppression

Returns the data and statuses of cells, optionally excluding rows of cells that match specified criteria. You can exclude rows that contain no data, zero, and derived data, as well as rows consisting of invalid intersections.

GetCellsWithRowSuppression2

Returns the data and statuses of cells, optionally excluding rows of cells that match specified criteria.

GetCountOfAttachedDocumentsToCell

Returns a count of the documents attached to a cell.

GetCurrencyCube

Returns an object reference to the HsvCurrencyCube object. The object reference provides access to the subcube identified by the member IDs passed to GetCurrencyCube.

GetDataForAllMetadataCombinations

For internal use.

GetDynamicAccountRulesCache

For internal use.

GetLineItems

Deprecated – superseded by GetCellLineItems.

GetMaxCellTextSize

Returns the maximum number of characters that can be inserted as cell text.

GetMembersThatHaveData

Returns members that have data.

GetMultiServerMaxSyncDelayForChanges

For internal use.

GetNodeCube

Returns an object reference to the HsvNodeCube object. The object reference provides access to the subcube identified by the member IDs passed to GetNodeCube.

GetPhaseSubmissionGridForGivenScenarioPeriod

Returns an array representing the submission groups assigned to the specified combinations of Scenario dimension member, Period dimension members, and submission phases.

GetStatus

Returns the transaction status, metadata status, and calculation status of a cell.

GetStatusEx

Returns the transaction status, metadata status, and calculation status of a cell, as well as additional status information such as whether the cell supports intercompany transactions.

GetStatusUsingPhaseID

Returns the transaction status, metadata status, and calculation status of either a cell or a submission phase.

GetTextCell

Returns the data in a cell, as well as the cell’s status. The data is returned as a String.

GetTextCellLineItems

Returns arrays of the data and descriptions for the specified cell’s line items. Data is returned in a String array.

GetTextCells

Returns Variant arrays containing the data and statuses of cells. GetTextCells also enables you to specify the scaling and the number of decimals for the returned data.

GetTextCellsWithRowSuppression

Returns the data and statuses of cells, optionally applying scaling and formatting, and excluding rows of cells that match specified criteria. You can exclude rows that contain no data, zero, and derived data, as well as rows consisting of invalid intersections.

GetTextCellsWithRowSuppression2

Returns the data and status for rows that are not suppressed.

GetTextLineItems

Deprecated – superseded by GetTextCellLineItems.

GetTransactionData

Populates an HsvTransactionData object with an array of transaction data.

GetUnassignedGroups

Returns the names of submission groups assigned to dimension members but not to submission phases, and of submission groups assigned to submission phases but not to members.

GetURLByName

Returns an XML block representing the specified URL.

GetURLsForCell

Retrieves all URLs whose regions cover a specified POV.

InsertLineItemDetails

Inserts line item descriptions in the cells that intersect the specified dimension members.

IsValidCellText

Indicates whether a string exceeds the application’s maximum cell text size.

lIndexRecordProcessed

For internal use.

Load

Loads data into an application, using a load file on the application server.

LoadDrillableRegions

Loads the definition file for the drillable regions.

SetCalcStatusLocked

Locks the cells for a period in a subcube.

SetCalcStatusLockedForMultipleProcessUnits

Locks the cells for one or more process units.

SetCalcStatusUnlocked

Unlocks the cells for a period in a subcube.

SetCalcStatusUnlockedForMultipleProcessUnits

Unlocks the cells for one or more process units.

SetCell

Sets a cell’s data; you can either insert data or set the cell to Null. Cell data is passed as a Double.

SetCellDescriptions

Inserts cell text into one or more cells.

SetCellLineItems

Appends or updates line items for the specified cell. Line item data is passed in a Double array.

SetCells

Sets data for an array of cells. For each cell in the array, you can either insert data or set the cell to Null. The cells’ data is passed as a Double array.

SetCells2

Sets data for an array of cells and returns the cells’ statuses; if any of the cells are not writable, SetCells2 inserts data in the writable cells.

SetCellsLineItems

Appends or updates line items for the specified cells. Line item data is passed in a Double array.

SetFileForLoad

For internal use.

SetLineItems

Deprecated – superseded by SetCellLineItems.

SetMinMaxPeriod

For internal use.

SetPhaseSubmissionGridForGivenScenarioPeriod

Assigns submission groups to the specified combinations of Scenario dimension member, Period dimension members, and submission phases.

SetTextCell

Inserts data into a cell, passing the data as a String. SetTextCell also enables you to scale the data that is passed.

SetTextCellLineItems

Appends or updates line items for the specified cell. Line item data is passed in a String array.

SetTextCells

Inserts data into cells. The cells’ data is passed in a String array. SetTextCells also enables you to scale the data that is passed.

SetTextCellsLineItems

Appends or updates line items for the specified cells. Line item data is passed in a String array.

SetTextLineItems

Deprecated – superseded by SetTextCellLineItems.

StartLoad

For internal use.

UpdateDataUsingMDDataBuffer

Inserts an HsvMDDataBuffer or HsvMDDataBufferLite object’s cells into the corresponding cells of an application.

varalAggregationMapAddr

For internal use.

For detailed descriptions of these methods, see HsvData Object Methods.