HsvTransactionData Object Methods

The HsvTransactionData object returns the transaction data generated by statutory consolidations. To return transaction data, you specify dimension members as selection criteria, then obtain the data for the specified members.

  The following steps provide an overview of how to return transaction data:

  1. Set an HsvTransactionData object reference using the Set and New keywords as shown below:

    Dim cHsvTransData As HsvTransactionData
    Set cHsvTransData = New HSVMDARRAYSLib.HsvTransactionData
  2. Call Initialize to set the current Scenario and Year dimension members of the transaction data to be returned.

  3. Specify the dimension members to be used as selection criteria by calling SetQueryItem once per dimension member. For each call, pass one of the HFMConstants type library constants listed in Transaction Dimension Constants along with the applicable member ID. For example, the following lines specify the current entity, parent, and period as selection criteria:

    cHsvTransData.SetQueryItem _ 
    TRANSACTION_DIMENSIONS_CUR_ENTITY, lEnt
    cHsvTransData.SetQueryItem _ 
    TRANSACTION_DIMENSIONS_CUR_PARENT, lPar
    cHsvTransData.SetQueryItem _ 
    TRANSACTION_DIMENSIONS_CUR_PERIOD, lPer
  4. To have the HsvTransactionData object populated with an array of the transaction data, pass the HsvTransactionData object to the HsvData object’s GetTransactionData method.

  5. Begin the enumeration of the array with which HsvData.GetTransactionData has populated the HsvTransactionData object by calling BeginDataEnum, which returns the number of items in the array.

  6. To get the data, call the HsvTransactionData object’s GetTransactionData method. You can use the count of items returned by BeginDataEnum to loop through the object’s array.

    Caution!

    Do not confuse this method with the HsvData object’s GetTransactionData method.

  7. After finishing with the data, end the enumeration by calling EndDataEnum.

    Tip:

    For an example that illustrates these steps, see Example.

The HsvTransactionData object’s methods are summarized in HsvTransactionData Object Overview, and are described in detail in the following topics.