Setting Subset Properties

Subset properties are used to control the information that is returned from a dimension, including what members to return, whether to flatten hierarchies, sorting order, as well as member attributes.

 

Subset Properties

 

Setting Subset Properties

On the basic subset properties screen the following properties are available:

hmtoggle_arrow1        Dimension Name        

This field is automatically populated with the name of the dimension that the view is associated with.

This name is also the value that will be used as a parameter to the web service method for the view when changing the dimension member to use in the view at run time.   If you specify the dimension name as a parameter on the URL of a view, you can alter the members that are used when creating the results.   For example:

http://localhost/es/esweb.svc/json/MonthlyFinancials?Year=2012

hmtoggle_arrow1        Subset Name

Subset Name is the name of the subset in TM1 that was used as a basis for creating the published subset.  

hmtoggle_arrow1Publish Subset to Web Service

Saving a subset with the Publish Subset to Web Service option enabled makes it available for use in applications as a web service URL.  This creates a direct link to TM1 data that can be queried on-demand with changes in TM1 being reflected immediately.   No processing or data movement is required.

hmtoggle_arrow1        Web Service Method Name

Web Service Method Name is the name of the web method to be used in the URL for accessing the data from the dimension.   Normally this value is the same as the dimension name, but in cases where the name contains special characters, the subset name may be altered to conform to XML specifications.  

hmtoggle_arrow1        Member Selection Method

Member Selection Method allows you to choose from four different ways to determine how dimension members will be incorporated into a view.   These four methods are:

Member List        Individually select the members to be used in the view

Subset                Obtain members from a TM1 Subset

Library MDX        Use a centralized, pre-defined MDX statement

Custom MDX        Directly enter an MDX expression

 

Click on one of the above links for details on each of these member selection methods.

hmtoggle_arrow1        Break Hierarchy

Setting the Break Hierarchy option to true will force the structure of the dimension into a flat list of elements even if the hierarchy in TM1 is defined otherwise.   This allows for drop downs and other controls to list all of the available elements irrespective of dimensional structure.

hmtoggle_arrow1Sort Direction

Sort direction allows quick sorting by Ascending or Descending dimension members.   If sorting by attribute is required or more complex sorting capabilities, such as nested sorting, use the Attributes tab of the subset properties.

Previewing Subsets

Once you have made all the required property settings, you can preview the results by pressing the Preview button.   This will display the dimension in a grid layout similar to the one shown below:

Subset Preview

 

If you need to see how the dimension elements will be returned in a JSON or XML format, you can simply click on the appropriate radio button at the top of the screen.   The results will be similar to the following:

 

Subset Preview - JSON