ViewExtractSkipRuleValuesSet TM1 Function: Syntax and Use
This is one of a set of functions that define the behaviour of a Turbo Integrator AsciiOutput. The ViewExtractSkipRuleValuesSet function sets the output to either extract rule calculated values or not, depending if a flag is set (0 for export, 1 for skip). It is the equivalent of the Skip Rule Calculated Values option in the View Extract dialog box.
If you want to skip Consolidated (as distinct from Rule Calculated) values, please see this post.
Why would you use it? Two main reasons. The first one is to limit the size of a CSV extract. The second is to ensure that you only have non rule calculated values for reimport back into a TM1 cube with the same rules in play.
Syntax of View ExtractSkipRuleValuesSet
ViewExtractSkipRuleValuesSet (Cube, ViewName, Flag); where:
- cube, is the name of the cube that has the view you want to export
- viewname, is the view in the cue that is to be exported
- flag, is the setting, either 0 for export rule calculated values, or 1 for skip rule calculated values.
vCubeExport = 'Sales';
vViewExport = 'Sales Export'
ViewExtractSkipRuleValuesSet (vCubeExport , vViewExport , 1);
In this example we have defined variables for the cube and view to be exported, then used them in the ViewExtractSkipRuleValuesSet where we have set the flag to 1, so rule calculated values will not be exported.
If you are trying to set Rule calculated values to be either exported or skipped, please see this post.
This function is valid for use in Turbo Integrator processes only.