HsvMetadata Object Properties and Methods

The HsvMetadata object provides properties that access subordinate objects for the various Financial Management dimensions, and methods that return metadata-related information and that load and extract metadata files on application servers. Assign HsvMetadata object references with the HsvSession object’s Metadata property; for more information, see Metadata.

The following table lists the HsvMetadata object’s properties, and Table 11 lists the object’s methods.

Table 10. HsvMetadata Object Properties

Property	Description
Accounts	Sets object references to the HsvAccounts object, and also sets references to the IHsvTreeInfo interface for use with the Account dimension.
Currencies	Sets object references to the HsvCurrencies object.
Custom1	Sets object references to the HsvCustom object and the IHsvTreeInfo interface for use with the Custom 1 dimension.
Custom2	Sets object references to the HsvCustom object and the IHsvTreeInfo interface for use with the Custom 2 dimension.
Custom3	Sets object references to the HsvCustom object and the IHsvTreeInfo interface for use with the Custom 3 dimension.
Custom4	Sets object references to the HsvCustom object and the IHsvTreeInfo interface for use with the Custom 4 dimension.
Dimension	Sets object references to the IHsvTreeInfo interface. This property takes an integer parameter that identifies the dimension to which the object variable applies.
Entities	Sets object references to the HsvEntities object, and also sets references to the IHsvTreeInfo interface for use with the Entity dimension.
ICPs	Sets object references to the HsvICPs object, and also sets references to the IHsvTreeInfo interface for use with the Intercompany Partner dimension.
Periods	Sets object references to the HsvPeriods object, and also sets references to the IHsvTreeInfo interface for use with the Period dimension.
Scenarios	Sets object references to the HsvScenarios object, and also sets references to the IHsvTreeInfo interface for use with the Scenario dimension.
Values	Sets object references to the HsvValues object, and also sets references to the IHsvTreeInfo interface for use with the Value dimension.
Views	Sets object references to the HsvViews object, and also sets references to the IHsvTreeInfo interface for use with the View dimension.
Years	Sets object references to the HsvYears object, and also sets references to the IHsvTreeInfo interface for use with the Year dimension.

For detailed descriptions of these properties, see HsvMetadata Object Properties.

The following table lists the HsvMetadata object’s methods:

Table 11. HsvMetadata Object Methods

Method	Description
ConsolidationMethodIDs	Returns IDs that identify an application’s consolidation methods.
EnumExtractOptions	Returns a two-dimensional array of the metadata extract options that can be passed to Extract. The array includes the options’ names and default values.
EnumLanguages	Returns the numeric IDs and labels of an application’s languages.
EnumLoadOptions	Returns a two-dimensional array of the metadata load options that can be passed to Load.
Extract	Extracts metadata into a text file. The file will be created on the application server.
GetApplicationAttribute	Returns the raw value of a given application setting attribute.
GetApplicationCurrency	Returns the label of the application’s default currency.
GetApplicationSettingsTimeStamp	Returns a timestamp that indicates when the application settings were last updated.
GetByIndexValidationAccount	Returns the member ID of a validation account, given the index of the account.
GetCellLevelAccountType	Returns the account type of a cell, given the member IDs of the cell’s Account and Custom dimension members.
GetConsolidationMethodDescription	Returns a consolidation method’s description for the specified language.
GetConsolidationMethodInfo	Returns the attributes of a consolidation method, given the method’s ID.
GetConsolidationMethodsTimeStamp	Returns a timestamp that indicates when the application’s consolidation methods were last updated.
GetCurrencyTimeStamp	Returns a timestamp that indicates when the application’s currencies were last updated.
GetCurrencyValueIDForEntityValueCombination	Returns the currency value dimension ID for the specified parent, entity, and value triplet.
GetCurrencyValueIDsForEntityValueCombinations	Returns the currency value dimension IDs for the specified parent, entity, and value triplet.
GetDefaultValueOfActiveStatusAccount	Returns the default value for an application’s active status account.
GetFdmAppName	Returns the value of the FDM Application Name setting for the application.
GetFrequencyID	The frequency (YTD, MTD, QTD, and so forth) for which to return an internal numeric ID.
GetICPEntitiesAggregationWeight	For internal use.
GetSupportSubmissionPhaseForAccountFlag	Indicates whether phased submissions are enabled for the Account dimension.
GetSupportSubmissionPhaseForCustom1Flag	Indicates whether phased submissions are enabled for the Custom1 dimension.
GetSupportSubmissionPhaseForCustom2Flag	Indicates whether phased submissions are enabled for the Custom2 dimension.
GetSupportSubmissionPhaseForCustom3Flag	Indicates whether phased submissions are enabled for the Custom3 dimension.
GetSupportSubmissionPhaseForCustom4Flag	Indicates whether phased submissions are enabled for the Custom4 dimension.
GetSupportSubmissionPhaseForICPFlag	Indicates whether phased submissions are enabled for the Intercompany Partner dimension.
GetUseSubmissionPhaseFlag	Indicates whether phased submissions are enabled for the application.
GetValidationAccount	Returns the member ID of an application’s Validation Account setting.
IsCustomMemberValidForAccount	Indicates whether a Custom dimension member is valid for an account.
IsOrgByPeriodApplication	Indicates whether the OrgByPeriodApplication application setting is on or off.
Load	Loads metadata into a Classic application, using a load file on the application server.
LoadWithAccessCode	For internal use.
TranslateApplicationAttributeForDisplay	Returns a user-readable string that represents the value of a given application setting attribute.

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