LoadDrillableRegions

Loads the definition file for the drillable regions. LoadDrillableRegions enables drill through on data values from Financial Management to the source data in the Oracle General Ledger (OGL) application. The function allows caller to define drillable regions in the Scenario, Year, Period, Entity, and Account dimensions. The drillable region allows the definition of the slice of data that was loaded from a GL Source System using EPMI or Oracle Hyperion Financial Data Quality Management, Fusion Edition.

Syntax

<HsvData>.LoadDrillableRegions bstrRegionsFilename, bstrLogFileName, lLoadMode, pvbErrors, pvbWarnings

Argument	Description
bstrRegionsFilename	String (ByVal). The file path to the definition file on the Financial Management application server.
bstrLogFileName	String (ByVal). The name and path of the log file. The path must exist on the application server.
lLoadMode	Long (ByVal). The load mode. Must be set to one of the following values: REPLACE_ALL = 0, REPLACE_BY_URL_NAME = 1, MERGE = 2, SCAN_ONLY = 3.
pvbErrors	Boolean. Returns TRUE if errors occurred during the load task. See the log file for details.
pvbWarnings	Boolean. Returns TRUE if warnings occurred during the load task.

lLoadMode Parameter

Replace all — This mode will clear all existing URL definitions before loading the new definition from the load file. It is intended to be used by the system administrator or a user with a special role.
Replace by URL name — This mode will clear and reload a URL definition in Financial Management if a URL with the same name is in the load file. All other URL definitions will remain unchanged. This mode is intended to be used by products that manage data input, either manually or automatically.
Merge — This mode will add new region definitions to the existing URL. If a new XML block for URL is supplied for an existing URL, it will replace the prior XML block. If it is not provided, existing XML block will be kept for the specified URL. A new URL will still be created if there are no existing URLs with the same URL name. URLs currently existed in Financial Management but are not included in the load file will not be removed.
Scan Only — This mode will scan the input file for invalid format in the definition. The new definition will not be stored to the database. The existing definition will remain unchanged.

Note:

For the Merge mode, if a URL link is not supplied and the URL definition exists, the new region definitions will be merged in. However, if the URL does not exist in Financial Management, an error will be logged and that URL definition will be rejected. Similarly, in Replace mode the URL link must be provided.

Examples

This function is intended to be used by HFMAwbAgent. The following example loads the definition file from C:\\temp\\~RD8a13.tmp in Merge mode. Progress messages and errors are saved in the log file C:\\temp\\~RD9bc1.tmp. If any errors or warnings occur, vbError or vbWarnings will be set to VARIANT_TRUE.

LoadDrillableRegions(_T(“C:\\temp\\~RD8a13.tmp”), _T(“C:\\temp\\~RD9bc1.tmp”), 2, &vbError, &vbWarnings);
The content of the input file C:\\temp\\~RD8a13.tmp:
!URLName=ERPI_ew3qnio
!URL=<foldercontents path="/">
<resource name="Sales Report" description="" type="application/x-hyperion-applicationbuilder-report">
    <attribute name=”name” type=”string” xml:lang="fr" value=”Rapport de ventes” />
    <attribute name=”name” type=”string” xml:lang="es" value=”Informe de ventas” />
    <action name="Display Drill-Back" description="Launch Drill-Back" shortdesc="drill-back">
      <url>./HyperionFDM/AuthorizedPages/IntersectionSummaryByLocation.aspx?&amp;fdmAppName=CommaFDM&amp;fdmTargetAppName=Comma95&amp;sso_token=$SSO_TOKEN$&amp;sso_username=$SSO_USERNAME$&amp;sso_password=$SSO_PASSWORD$&amp;$ATTR(id)$&amp;RCP_VERSION=$RCP_VERSION$</url>
    </action>
    </resource>
</foldercontents>
!Regions
Actual;2008;January;Stamford;Payroll
Actual;2008;January;California;MEMBERALL
!URLName=FDM_adf120agj
!URL=<foldercontents path="/">
  <resource name="EU Sales Report" description="" type="application/x-hyperion-applicationbuilder-report">
    <attribute name=”name” type=”string” xml:lang="fr" value=”EU Rapport de ventes” />
    <attribute name=”name” type=”string” xml:lang="es" value=”EU Informe de ventas” />
    <action name="Display Drill-Back" description="Launch Drill-Back" shortdesc="drill-back">
      <url>./HyperionFDM/AuthorizedPages/IntersectionSummaryByLocation.aspx?&amp;fdmAppName=CommaFDM&amp;fdmTarge
tAppName=Comma95&amp;sso_token=$SSO_TOKEN$&amp;sso_username=$SSO_USERNAME$&amp;sso_password=$SSO_PASSWORD$&amp;$ATTR(id)$&amp;RCP_VERSION=$RCP_VERSION$</url>
    </action>
  </resource>
</foldercontents>
!Regions
Actual;2008;MEMBERALL;Germany; Sales
Actual;2008; MEMBERALL;England;Sales
Actual;2008; MEMBERALL;France;Sales