Data Grid Definition DTD

<!DOCTYPE GRIDDEF [
  <!ELEMENT GRIDDEF ANY >
  <!ATTLIST GRIDDEF maxColsPerPage CDATA #IMPLIED>
  <!ATTLIST GRIDDEF maxRowsPerPage CDATA #IMPLIED>
  <!ATTLIST GRIDDEF metaDisplayMode CDATA #IMPLIED>
  <!ATTLIST GRIDDEF dataDisplayMode CDATA #IMPLIED>
  <!ATTLIST GRIDDEF rowSuppressNoData CDATA #IMPLIED>	
  <!ATTLIST GRIDDEF rowSuppressZero CDATA #IMPLIED>	
  <!ATTLIST GRIDDEF scale CDATA #IMPLIED>
  <!ATTLIST GRIDDEF numDecPlaces CDATA #IMPLIED>
  <!ELEMENT RDIMS (DIM*)>
  <!ELEMENT CDIMS (DIM*)>
  <!ELEMENT DIM EMPTY>
  <!ATTLIST DIM idx CDATA #IMPLIED>
  <!ATTLIST DIM name CDATA #IMPLIED>
  <!ELEMENT POV (POVDIM*)>
  <!ATTLIST POV obpFilterEnabled CDATA \"0\">
  <!ATTLIST POV obpScenario CDATA \"\">
  <!ATTLIST POV obpYear CDATA \"\">
  <!ATTLIST POV obpPeriod CDATA \"\">
  <!ELEMENT POVDIM EMPTY>
  <!ATTLIST POVDIM name CDATA #IMPLIED>
  <!ATTLIST POVDIM memberList CDATA #IMPLIED>
  <!ATTLIST POVDIM topMember CDATA #IMPLIED>
  <!ATTLIST POVDIM value CDATA #IMPLIED>
  <!ATTLIST POVDIM fixedMember CDATA #IMPLIED>
  <!ATTLIST POVDIM useMemberList CDATA #IMPLIED>
  <!ELEMENT PROCOPTIONS (FILTER*)>
  <!ATTLIST PROCOPTIONS listStyle CDATA #IMPLIED>
  <!ATTLIST PROCOPTIONS periodDisplay CDATA #IMPLIED>
  <!ATTLIST PROCOPTIONS allPeriodsColumn CDATA #IMPLIED>
  <!ELEMENT FILTER EMPTY>
  <!ATTLIST FILTER reviewLevelFilter CDATA #IMPLIED>
  <!ATTLIST FILTER reviewLevelCond CDATA #IMPLIED>
  <!ATTLIST FILTER reviewLevelSort CDATA #IMPLIED>
  <!ATTLIST FILTER passFailFilter CDATA #IMPLIED>
  <!ATTLIST FILTER consolStatusFilter CDATA #IMPLIED>
  <!ELEMENT REXPS (EXPRC*)>
  <!ELEMENT CEXPS (EXPRC*)>
  <!ELEMENT EXPRC EXPDET*>
  <!ATTLIST EXPRC seq CDATA #IMPLIED>
  <!ELEMENT EXPDET EMPTY>
  <!ATTLIST EXPDET didx CDATA #IMPLIED>
  <!ATTLIST EXPDET mbr CDATA #IMPLIED>
  <!ATTLIST EXPDET dexp CDATA \"0\">
  <!ATTLIST EXPDET mexp CDATA \"0\">
  <!ELEMENT UISTATE HDRWIDTH*>
  <!ATTLIST UISTATE currRow CDATA #IMPLIED>
  <!ATTLIST UISTATE currCol CDATA #IMPLIED>
  <!ELEMENT HDRWIDTH EMPTY>
  <!ATTLIST HDRWIDTH type CDATA #IMPLIED>
  <!ATTLIST HDRWIDTH idx CDATA #IMPLIED>
  <!ATTLIST HDRWIDTH width CDATA #implied>
]>

Element

Description

GRIDDEF

Root element. <GRIDDEF> contains the following attributes:

  • maxColsPerPage = Maximum columns per page (corresponds to the maxColsPerPage property).

  • maxRowsPerPage = Maximum rows per page (corresponds to the maxRowsPerPage property).

  • metaDisplayMode = Metadata display mode (corresponds to the metadataDisplayMode property).

  • dataDisplayMode = Data display mode (corresponds to sDataDisplayMode argument of GetGridPageWithExpansionInfoAsXML).

  • rowSuppressNoData = For internal use.

  • rowSuppressZero = For internal use.

  • scale = Scale (corresponds to the scale specified in the Data Explorer Grid Settings dialog box).

  • numDecPlaces = Number of digits to the right of the decimal point.

RDIMS

Defines the row dimensions. An <RDIMS> tag contains one <DIM> tag for each row dimension.

CDIMS

Defines the column dimensions. A <CDIMS> tag contains one <DIM> tag for each column dimension.

DIM

Represents a row or column dimension. <DIM> tags are nested in <RDIMS> and <CDIMS> tags and contain the following attributes:

  • idx = Dimension index. The index is relative to the other row or column dimensions (corresponds to the lDimIndex argument used in “Expand” methods such as ExpandRowDimension).

  • name = Dimension name.

POV

Point of view information for the grid. A <POV> tag contains a <POVDIM> tag for each dimension and contains the following attributes:

  • obpFilterEnabled = Indicates whether active entity filtering is enabled for Organization by Period applications. 0 indicates that filtering is disabled; a non-zero value indicates that filtering is enabled.

  • obpScenario = The Scenario dimension member to use if filtering is enabled.

  • obpYear = The Year dimension member to use if filtering is enabled.

  • obpPeriod = The Period dimension member to use if filtering is enabled.

POVDIM

Represents a dimension in a Point of View. <POVDIM> tags are nested in <POV> tags and contain the following attributes:

  • name = Dimension name.

  • memberList = The label or internal ID of the member list for the dimension.

  • created before Release 4.0 of Financial Management

  • topMember = The name of the dimension’s top member.

  • value = The names of the dimension’s members for the Point of View. If there are multiple members, the members are delimited by semicolons.

  • fixedMember = The name of the fixed Point of View member, which is used for page dimensions.

  • useMemberList = Indicates whether the Point of View uses a member list to specify the dimension’s members. A non-zero value indicates that the dimension members are specified by memberlist, while 0 indicates that the dimension members are specified by value.

PROCOPTIONS

Represents the display options specified by the following attributes:

  • listStyle = A flag indicating whether the grid represents members as a tree or a flat list. 1 represents tree, 0 represents list.

  • periodDisplay = A flag indicating whether the grid displays one period or all periods. 0 represents one period, 1 represents all.

  • allPeriodsColumn = A flag indicating whether the grid displays process levels or calculation statuses. 0 represents process levels, 3 represents calculation statuses.

FILTER

Represents the filtering and sorting options specified by the following attributes:

  • reviewLevelFilter = A number that represents the review level by which to filter. Valid values are represented by the HFMConstants type library enumeration CEnumProcessFlowStates, which is described in Process Management Review Level Constants.

  • reviewLevelCond = A number that represents the condition by which to filter the review level in the reviewLevelFilter attribute. Valid values are represented by the following members of the HFMConstants enumeration CEnumProcessFlowFilters, which is described in Process Management Filters:

    • PROCESS_FLOW_FILTER_ABOVESTATE

    • PROCESS_FLOW_FILTER_BELOWSTATE

    • PROCESS_FLOW_FILTER_ONLYSTATE

  • reviewLevelSort = A number that represents the order in which to sort process units in the grid. Valid values are represented by the HFMConstants enumeration CEnumProcessFlowSortOrders, which is described in Process Management Sorting Constants.

  • passFailFilter = A number that represents the validation for promotion state by which to filter. Valid values are represented by the following members of the HFMConstants enumeration CEnumProcessFlowFilters, which is described in Process Management Filters:

    • PROCESS_FLOW_FILTER_PASSFAIL

    • PROCESS_FLOW_FILTER_PASSONLY

    • PROCESS_FLOW_FILTER_FAILONLY

  • consolStatusFilter = A number that represents the consolidation statuses by which to filter. Valid values are represented by the HFMConstants enumeration tagCALCSTATUSSTATISTICS, which is described in Calculation Status Statistic Constants.

REXPS

Represents the grid’s expanded rows, and contains one <EXPRC> tag for each expanded row.

CEXPS

Represents the grid’s expanded columns, and contains one <EXPRC> tag for each expanded column.

EXPRC

Represents an expanded row or column. This element contains one <EXPDET> tag for each dimension member in the row or column.

The <EXPRC> element also contains the seq attribute, which represents the row or column number.

EXPDET

Represents a dimension member in an expanded row or column, and contains the following attributes:

  • didx = The index of the dimension member within the set of members in the row or column.

  • mbr = This can be the member label, member description, or both, depending upon the value to which the metaDisplayMode attribute of <GRIDDEF> is set.

  • dexp = The dimension expansion mode. Valid values are represented by the HFMConstants type library constants listed in Data Grid Dimension Expansion Mode Constants.

  • mexp = The member expansion mode. Valid values are represented by the HFMConstants type library constants listed in Data Grid Member Expansion Mode Constants.

UISTATE

Represents the state of the user interface. This element contains one <HDRWIDTH> tag for each row and column header in the grid, as well as the following attributes:

  • currRow = The row coordinate of the cell that currently has the focus.

  • currCol = The column coordinate of the cell that currently has the focus.

HDRWIDTH

Represents a row’s or column’s header, and contains the following attributes:

  • type = Indicates whether the header is for a row or column. The letter “r” indicates a row, the letter “c” indicates a column.

  • idx = The index that identifies the header within the set of rows or column headers.

  • width = The width of the header, measured in pixels.