XML String Schema

Following is the schema for the XML string passed to the bstrTmplContents argument and returned by GetTemplate.

<povTemplate>
  <povEA></povEA>
  <options>
    <tablePrefix></tablePrefix>
    <exportOption></exportOption>
    <selectedDSN></selectedDSN>
    <excludeDynAccts></excludeDynAccts>
  </options>
</povTemplate>

The following table describes the XML string’s schema:

Element

Description

povTemplate

The root element.

povEA

Specifies the dimension members for the template. Members for each dimension are preceded by the following characters:

  • A# = Account

  • I# = Intercompany Partner

  • C1# = Custom1

  • C2# = Custom2

  • C3# = Custom3

  • C4# = Custom4

  • S# = Scenario

  • Y# = Year

  • P# = Period

  • W# = View

  • E# = Entity

    Note:

    The Entity dimension must include both the parent and child members, delimited by a period.

  • V# = Value

Dimensions are delimited with periods. Multiple members for a dimension are delimited by semicolons. Member list labels are enclosed with braces ( { } ).

options

Contains the elements that define the template’s extract options.

tablePrefix

The Relational Table Prefix, which is the prefix that identifies the star schema’s tables.

exportOption

The aggregation to use. Valid values are listed below:

  • 0 = Standard

  • 1 = Metadata Only

  • 2 = Selected Metadata Only

  • 3 = For internal use

  • 4 = Essbase

  • 5 = Data Warehouse

selectedDSN

The Extended Analytics Data Source Name that points to the database for the star schema.

excludeDynAccts

A flag that specifies whether to exclude dynamic accounts. Zero (0) indicates to include dynamic accounts, a non-zero value indicates to exclude them.

Example

The following example creates a template for a Standard aggregation type with dynamic accounts included. The example specifies multiple members for the Entity dimension and a member list for the Period dimension.

Dim StarSchemaTemplates As IHsvStarSchemaTemplates
'cStarSchema is an HsvStarSchemaACM object reference
Set StarSchemaTemplates = cStarSchema
StarSchemaTemplates.SetTemplate "mytemplate", "<povTemplate>" _
  & "<povEA>S#Actual.Y#2004.P{Months}.w#&lt;Scenario View&gt;" _
  & ".E#UnitedStates.NewYork;  UnitedStates.Virginia." _
  & "V#&lt;Entity Currency&gt;.A#Sales.I#[ICP None].C1#[None]" _
  & ".C2#[None].C3#[None].C4#[None]</povEA><options>" _
  & " <tablePrefix>myPrefix</tablePrefix><exportOption>0" _
  & "</exportOption><selectedDSN>myDSN</selectedDSN><excludeDynAccts>0" _
  & "</excludeDynAccts></options></povTemplate>", True