GetTransactionData

Returns source and destination data for a transaction, given the index of the transaction within the HsvTransactionData object’s array of transactions. In addition to the data, the member IDs of the transaction’s dimension members are returned.

Syntax

<HsvTransactionData>.GetTransactionData lItem, plCurrentPeriod, plCurrentParent, plCurrentEntity, plDestEntity, plDestAccount, plDestValue, plDestICP, plDestCustom1, plDestCustom2, plDestCustom3, plDestCustom4, plSourceScenario, plSourceYear, plSourcePeriod, plSourceParent, plSourceEntity, plSourceValue, plSourceAccount, plSourceICP, plSourceView, plSourceCustom1, plSourceCustom2, plSourceCustom3, plSourceCustom4, pdDestData, pdSourceData, pdFactor, pbstrNature

Argument

Description

lItem

Long (ByVal). The index of the transaction in the HsvTransactionData object’s array. This is a zero-based index.

Tip:

BeginDataEnum returns a count of the items in the HsvTransactionData object. For more information, see BeginDataEnum.

plCurrentPeriod

Long. Returns the member ID of the transaction’s current period.

plCurrentParent

Long. Returns the member ID of the transaction’s current parent entity.

plCurrentEntity

Long. Returns the member ID of the transaction’s current child entity.

plDestEntity

Long. Returns the member ID of the transaction’s destination child entity.

plDestAccount

Long. Returns the member ID of the transaction’s destination account.

plDestValue

Long. Returns the member ID of the transaction’s destination Value dimension member.

plDestICP

Long. Returns the member ID of the transaction’s destination Intercompany Partner dimension member.

plDestCustom1

Long. Returns the member ID of the transaction’s destination Custom 1 dimension member.

plDestCustom2

Long. Returns the member ID of the transaction’s destination Custom 2 dimension member.

plDestCustom3

Long. Returns the member ID of the transaction’s destination Custom 3 dimension member.

plDestCustom4

Long. Returns the member ID of the transaction’s destination Custom 4 dimension member.

plSourceScenario

Long. Returns the member ID of the transaction’s source scenario.

plSourceYear

Long. Returns the member ID of the transaction’s source year.

plSourcePeriod

Long. Returns the member ID of the transaction’s source period.

plSourceParent

Long. Returns the member ID of the transaction’s source parent entity.

plSourceEntity

Long. Returns the member ID of the transaction’s source child entity.

plSourceValue

Long. Returns the member ID of the transaction’s source Value dimension member.

plSourceAccount

Long. Returns the member ID of the transaction’s source account.

plSourceICP

Long. Returns the member ID of the transaction’s source Intercompany Partner dimension member.

plSourceView

Long. Returns the member ID of the transaction’s source View dimension member.

plSourceCustom1

Long. Returns the member ID of the transaction’s source Custom 1 dimension member.

plSourceCustom2

Long. Returns the member ID of the transaction’s source Custom 2 dimension member.

plSourceCustom3

Long. Returns the member ID of the transaction’s source Custom 3 dimension member.

plSourceCustom4

Long. Returns the member ID of the transaction’s source Custom 4 dimension member.

pdDestData

Double. Returns the transaction’s destination data.

pdSourceData

Double. Returns the transaction’s source data.

pdFactor

Double. Returns the factor that was passed in the HS.Con rules function.

Note:

For details on rules functions, see the Oracle Hyperion Financial Management, Fusion Edition Administrator's Guide.

pbstrNature

String. Returns the nature string passed in the HS.Con rules function.

Example

The following example shows how to loop through transaction data using the current period, parent entity, and child entity as search criteria. The example illustrates the steps in HsvTransactionData Object Methods that show how to use the HsvTransactionData object.

Dim cHsvTransData As HsvTransactionData, cHsvData As HsvData
Dim lNumItems As Long, lIndex As Long, lCurPeriod As Long
Dim lCurParent As Long, lCurEnt As Long, lDestEnt As Long
Dim lDestAcct As Long, lDestVal As Long, lDestICP As Long
Dim lDestCust1 As Long, lDestCust2 As Long, lDestCust3 As Long
Dim lDestCust4 As Long, lSrcScen As Long, lSrcYear As Long
Dim lSrcPer As Long, lSrcParent As Long, lSrcEnt As Long
Dim lSrcVal As Long, lSrcAcct As Long, lSrcICP As Long
Dim lSrcView As Long, lSrcCust1 As Long, lSrcCust2 As Long
Dim lSrcCust3 As Long, lSrcCust4 As Long, dDestData As Double
Dim dSrcData As Double, dFactor As Double, sNature As String
Set cHsvData = m_cHsvSession.Data
Set cHsvTransData = New HSVMDARRAYSLib.HsvTransactionData
cHsvTransData.Initialize m_lScen, m_lYear
cHsvTransData.SetQueryItem TRANSACTION_DIMENSIONS_CUR_ENTITY, _ 
m_lEnt
cHsvTransData.SetQueryItem TRANSACTION_DIMENSIONS_CUR_PARENT, _ 
m_lPar
cHsvTransData.SetQueryItem TRANSACTION_DIMENSIONS_CUR_PERIOD, _ 
m_lPer
cHsvData.GetTransactionData cHsvTransData
cHsvTransData.BeginDataEnum lNumItems
For lIndex = 1 To lNumItems
  cHsvTransData.GetTransactionData lIndex, lCurPeriod, _ 
  lCurParent, lCurEnt, lDestEnt, lDestAcct, lDestVal, _ 
  lDestICP, lDestCust1, lDestCust2, lDestCust3, lDestCust4, _ 
  lSrcScen, lSrcYear, lSrcPer, lSrcParent, lSrcEnt, _ 
  lSrcVal, lSrcAcct, lSrcICP, lSrcView, lSrcCust1, _ 
  lSrcCust2, lSrcCust3, lSrcCust4, dDestData, dSrcData, _ 
  dFactor, sNature
    '… Insert code that uses the transactions’ data here
Next lIndex
cHsvTransData.EndDataEnum