Product Documentation
Abstract
As of TM1 10.2.2 Fix Pack 4, the SubsetCreate, SubsetCreateByMDX, and ViewCreate TurboIntegrator functions can all create temporary objects. There is no locking associated with a temporary subset or view, as these objects are never saved. This can result in improved performance, because there is no need for TurboIntegrator to wait for locks to be released before operating upon a temporary object.
Content
All three of these TurboIntegrator functions that can create temporary objects do so by use of an optional AsTemporary argument. When this argument is set to 1, the resulting object is temporary. When the argument is set to 0, or is omitted, the resulting object is permanent.
The following descriptions apply to the functions as of the TM1 10.2.2 Fix Pack 4 release. Prior to the 10.2.2 Fix Pack 4 release, these functions did not support the optional AsTemporary argument. Any existing SubsetCreate, SubsetCreateByMDX, or ViewCreate functions in processes that were created prior to 10.2.2 Fix Pack 4 will continue to function as expected, by creating a permanent object.
SubsetCreate
This function creates an empty public subset of a specified dimension.
This is a TM1 TurboIntegrator function, valid only in TurboIntegrator processes.
When the optional AsTemporary argument is set to 1, the subset is temporary and
persists only for the duration of the TurboIntegrator process or chore in which the
subset is created. While a temporary subset exists, the temporary subset takes
precedence over any same-named public subset. If another TurboIntegrator
function references a subset that exists in both a temporary and permanent state,
the function operates upon the temporary subset.
There is no locking associated with a temporary subset, as a temporary subset is
never saved. This can result in improved performance, because there is no need for
TurboIntegrator to wait for locks to be released before operating upon a temporary
subset.
Note: After creating a temporary subset, any attempt to use ViewSubsetAssign to assign a temporary subset to a permanent view will fail with error notification.
Syntax
SubsetCreate(DimName, SubName, <AsTemporary>);
Argument Description
DimName | The parent dimension of the subset you are creating. |
SubName | The name you want to assign to the subset. |
AsTemporary | This is an optional argument that specifies whether the subset being created is temporary. 1 indicates a temporary subset, 0 indicates a permanent subset. If this argument is omitted, the subset is permanent. |
Example
SubsetCreate(’Region’, ’Northern Europe’, 1);
This example creates the temporary Northern Europe subset of the Region
dimension.
SubsetCreateByMDX
This function creates a public subset based on a passed MDX expression.
This is a TM1 TurboIntegrator function, valid only in TurboIntegrator processes.
When the optional AsTemporary argument is set to 1, the subset is temporary and
persists only for the duration of the TurboIntegrator process or chore in which the
subset is created. While a temporary subset exists, the temporary subset takes
precedence over any same-named public subset. If another TurboIntegrator
function references a subset that exists in both a temporary and permanent state,
the function operates upon the temporary subset.
There is no locking associated with a temporary subset, as a temporary subset is
never saved. This can result in improved performance, because there is no need for
TurboIntegrator to wait for locks to be released before operating upon a temporary
subset.
Note: After creating a temporary subset, any attempt to use ViewSubsetAssign to assign a temporary subset to a permanent view will fail with error notification.
Syntax
SubsetCreatebyMDX(SubName, MDX_Expression, <AsTemporary>);
Argument Description
SubName | The name you want to assign to the subset. |
MDX_Expression | An MDX expression that returns a subset. |
AsTemporary | This is an optional argument that specifies whether the subset being created is temporary. 1 indicates a temporary subset, 0 indicates a permanent subset. If this argument is omitted, the subset is permanent. |
Example
SubsetCreatebyMDX(’0-level months’, ’{TM1SORT( {TM1FILTERBYLEVEL(
{TM1SUBSETALL([month] )}, 0)}, ASC)} ’, 1 );
This example creates a temporary subset named '0-level months' based on an MDX
expression that returns a subset consisting of all 0-level elements in the Month
dimension, sorted in ascending alphabetical order.
ViewCreate
This function creates an empty view of a specified cube.
This is a TM1 TurboIntegrator function, valid only in TurboIntegrator processes.
When the optional AsTemporary argument is set to 1, the view is temporary and
persists only for the duration of the TurboIntegrator process or chore in which the
view is created. While a temporary view exists, the temporary view takes
precedence over any same-named public view. If another TurboIntegrator function
references a view that exists in both a temporary and permanent state, the function
operates upon the temporary view.
There is no locking associated with a temporary view, as a temporary view is
never saved. This can result in improved performance, because there is no need for
TurboIntegrator to wait for locks to be released before operating upon a temporary
view.
Note: If you want to perform a replication or synchronization operation after using
the ViewCreate function in a TI process, call the SaveDataAllfunction from the
Epilog procedure of the process to make sure the newly created view is available
for the replication. These steps apply only when you use the ViewCreate function
before a replication or synchronization operation.
Syntax
ViewCreate(Cube, ViewName, <AsTemporary>);
Argument Description
Cube | The parent cube of the view you are creating. |
ViewName | The name you want to assign to the view. |
AsTemporary | This is an optional argument that specifies whether the view being created is temporary. 1 indicates a temporary view, 0 indicates a permanent view. If this argument is omitted, the view is permanent. |
Example
ViewCreate(’Sales’, ’1st Quarter Actuals’, 1);
This example creates a temporary view named 1st Quarter Actuals from the Sales
cube.
Was this topic helpful?
Document Information
Modified date:
17 June 2018
UID
swg27046436