CustomView Object

The CustomView object represents a custom view.

Discussion

Use this object to provide basic security to the cubes generated from a model. Each custom view consists of security objects, such as users, groups and roles, who perform similar job functions, and therefore require similar information.

Each CustomView object automatically includes a collection of View objects: one for each dimension. The default view for each object in a collection is "All Categories". To change this view, you can use the DimensionInclude property to omit all categories or to create a custom view.

Custom views provide a specific subset of cube information to PowerPlay® users. For example, a custom view may summarize an entire level or individual categories within the level. If you specify a custom view (trViewTypeCustom), you must also use the DimensionView property to return the View object associated with a Dimension. You can then use the Apex property to create a new root category, or the SetViewStatus method to associate the View object with selected levels or categories.

To complete a view with a custom view, you must associate a custom view with a cube. Use the Add method to add a CustomView object to the CubeCustomViews collection of the cube.

CustomView objects are defined in the model and are returned by the CustomViews property. You can modify properties of the Transformer CustomView object, such as DimensionInclude, to direct the scope of the custom view within Transformer.

To control access to all or parts of a cube, define groups of users in a namespace and then, in your Transformer model, associate the custom views with that cube.

For example, open a model that contains global performance data by product line, vendor, and region. Create a cube group in which each cube contains detailed performance data for one region and summarized data for all other regions. Custom views are defined and applied so that each sales team has the detailed information for their own region.

To save changes to the properties of this object, use the Update method.

Related Topics

These tables list related collections, methods, and properties.

Method	Description
Delete Method	Deletes the CustomView object.
Update Method	Updates the CustomView object.

Property	Description
Application Property	Returns the Transformer Application object.
ChildCustomViews Property	Returns a collection of CustomView objects.
Description Property	Returns the description of the CustomView object.
DimensionInclude Property	Sets or returns the type of view for a custom view.
DimensionView Property	Returns the View object associated with a custom view.
MeasureInclude Property	Sets or returns a Boolean to determine if a measure applies to a CustomView object.
Name Property	Sets or returns the name of the object.
Parent Property	Returns the parent object.
SecurityObjects Property	Returns the collection of SecurityObjects associated with the custom view.
Type Property	Returns the object type.
Views Property	Returns a Views collection.

Examples

custom_view = model.CustomViews.Add()