The Rename Utility map file defines the dimensions and members to be renamed in the repository. It is an XML file that defines the complete logical path to each dimension and member. Here is a sample map file (with line numbers) along with a description of each section:
[01] <map name="Rename Map 01"> [02] <server name="essbase9x" [03] <serverAlias>essbase9x.hyperion.comserverAlias>essbase9x.hyperion.com> [04] <application name="Sample"> [05] <database name="Basic"> [06] [07] <dim oldName="Year" newName="NewYear" /> [08] [09] <dim oldName="Market" newName="NewMarket" [10] oldAlias="Market" newAlias="My New Market"> [11] <member oldName="South" newName="NewSouth"/> [12] <member oldName="East" newName="NewEast"/> [13] oldAlias="Eastern" newAlias="New Eastern"> [14] </dim> [15] [16] <newDim name="NewDim" alias="NewDim Alias" /> [17] [18] <newDim name="Attr" alias="Attribute" parentDim="product"> [19] [20] <newDim name="Features" alias="Prod Features"> [21] <attrDim name="Attr1"/> [22] <attrDim name="Attr2"/> [23] <attrDim name="Attr3"/> [24] </newDim> [25] [26] </database> [27] </application> [28] </server> [29] [30] <server name="server2"> [31] <...> [xx] </server> [xy] [xz] </map>
The topmost element of the map file must be the <map> element shown on line [01]. It must have a name attribute, which can be any text enclosed in quotes. There can be only one <map> element in a map file. This element is used internally to contain the list of servers included in this map file. It can contain only one or more <server> elements.
This element identifies an Essbase server that has renamed dimensions or members. Examples are shown on lines [02] and [30]. As shown in the example, there can be multiple server elements in a map file. It has the single attribute name which is required. This name must match the server name in the Essbase database connection stored in the Web Analysis repository. No DNS or hosts lookup is performed, and no IP address translation is done. Thus, <server name=”127.0.0.1”> is not the same as <server name=”localhost”>. The server element can contain only one or more application elements.
This element enables the user to specify alternate names that identify the Essbase server. For example, the server, ess9x might also be known as ess9x.hyperion.com,172.27.31.126, or localhost. Using serverAlias elements in the map file allows the dimension and member mappings for a server to be applied to that server, regardless of how it is referenced in the repository. An example is shown on line [03]. This example associates all dimensions and members for the server essbase9x with the alternate name essbase9x.hyperion.com. The serverAlias element does not have attributes and its body specifies the server alias.
This element identifies a specific instance of an Essbase application. An example is shown on line [04]. The application element has one attribute, name, which is required. This name must match the application name in the Essbase database connection stored in the Web Analysis repository. The application element can contain only one or more database elements.
This element identifies a specific instance of an Essbase database. An example is shown on line [05]. The database element has one attribute, name, which is required. This name must match the database name in the Essbase database connection stored in the Web Analysis repository. The database element must contain one or more dim or newDim elements.
This element identifies a specific instance of an Essbase dimension within a unique database. Examples are shown on lines [07] and [09]. The dim element must contain the attribute oldName to identify the dimension. There are three optional attributes for each element:
newName—New name for this dimension
oldAlias—Current alias for this dimension
newAlias—New alias for this dimension
If there is no newName or newAlias attribute for the dim element, it is not renamed. An example of this could be the case when a dimension name did not change, but members within that dimension were renamed. The oldAlias attribute should be included if it is defined in the outline, so that top level member selections using the alias can be identified. This is necessary because in Essbase, the top level member of a dimension uses the dimension name and alias. Because members may be stored by name or alias in repository objects, oldName and oldAlias must be included for all dim elements. This element can contain zero or moremember elements only. This would be the case if only the dimension name or alias changed, but no members in that dimension were renamed.
This element identifies a specific instance of an Essbase member within a unique dimension. Examples are shown on lines [11] and [12]. The member element must contain the attribute oldName to identify the member. There are three optional attributes for each element:
newName—New name for this member
oldAlias—Current alias for this member
newAlias—New alias for this member
The oldAlias attribute should be included if it is defined in the outline, so that member selections using the alias can be identified. Because members may be stored by name or alias in repository objects, oldName and oldAlias must be included for all member elements. This element may not contain other elements.
This element identifies a specific instance of a new Essbase dimension within a unique database. The newDim element must contain the attribute name to uniquely name the dimension. An optional attribute alias may exist to define an alias for this dimension. An example of this is shown on line [16].
If the dimension is an attribute dimension, the required XML attribute parentDim must be included in the element to associate the attribute dimension with its parent dimension. An example of this is shown above on line [18].
Finally, if the dimension has associated attribute dimensions, they must be defined in attrDim elements. This is the only case when the newDim element may contain child elements, and there can be multiple attrDim elements in it.
This element identifies a specific instance of an Oracle Essbase attribute dimension to associate with a new dimension. Examples are shown on lines [21], [22], and [23]. The attrDim element must contain the attribute name to uniquely identify the attribute dimension. This element cannot contain other elements.