Naming the Object Full Paths

In XML streams such as a query specification or a universe description, the objects of the universe are identified by the following attributes:

  • id

    This is the object identifier as defined in the CMS repository.

  • path

    This is the full path of the object. This attribute is optional and is mainly used by client tools to implement universe change source. If the universe data source must be replaced with another one containing different object IDs, then only the object paths can be used to map the objects in the query and the objects in the new universe data source.

Remember Only objects of .unx universes have paths identified.

You build the full paths by following the rules below:

  • Each node in the path is made of the object name and type, separated by |: "<name>|<type>".
  • The escape character of | and ~ is ~.
  • The nodes of the path are concatenated with \: "Age Group|folder\Age Max|dimension".
  • The escape character of \ and § is §.

The following table shows the possible types of objects manipulated in each of the provided SDKs:

BI Semantic Layer RESTful Web Service SDK
  • attribute
  • dimension
  • filter
  • folder
  • measure
Web Intelligence RESTful Web Service SDK
  • analysisDimension
  • attribute
  • aggregationAttribute
  • calculatedMember
  • dimension
  • filter
  • folder
  • hierarchy
  • level
  • measure
  • namedSet

Example

The following examples illustrate the naming rules:

Path Object String
Root folder "CustomerName" dimension "CustomerName|dimension"
"Customer" folder "Name" dimension "Customer|folder\Name|dimension"
"Customer" dimension in "Contact" folder "Name" attribute "Contact|folder\Customer|dimension\Name|attribute"
"Customer\Large" dimension in "Country|US" folder "First~Name" attribute "Country~|US|folder\Customer§\Large|dimension\First~~Name|attribute"