TI Syntax not found on the manual

[appleglaze28]

I was reviewing the TI process I got from the forum and I tried to understand what they do, I couldn't find the syntax on the manual TM1 References VIEWSETSKIPCALCS & VIEWSETSKIPRULEVALUE.

Since no error is found it seems to work. But what does it exactly do?

[Steve Rowe]

They are like the tick boxes when you use extract as ascii. Skip calcs suppresses consolidations, skip rules suppresses rule driven values.

As shown below in the documentation.

TM1 Reference Guide > TM1 TurboIntegrator Functions > View Manipulation TurboIntegrator Functions > ViewExtractSkipCalcsSet

--------------------------------------------------------------------------------

ViewExtractSkipCalcsSet
This is a TM1 TurboIntegrator function, valid only in TurboIntegrator processes.
This function sets an option to include/exclude consolidated values in a view extract. A view extract is a TM1 view exported as an ASCII comma-delimited (.cma) file.
ViewExtractSkipCalcsSet is the equivalent of the Skip Consolidated Values option in the View Extract dialog box.
Syntax
ViewExtractSkipCalcsSet (Cube, ViewName, Flag);
Arguments
Cube The parent cube of the view for which you are setting the option.
ViewName The view for which you are setting the option.
Flag A binary value that turns the option on or off. Specify 1 to exclude consolidated values from the view extract. Specify 0 to include consolidated values.

Example
ViewExtractSkipCalcsSet ('99sales', '1st Quarter Actuals', 1);
This example turns on the Skip Consolidated Values option for the 1st Quarter Actuals view. The view extract will not include any consolidated values.

[appleglaze28]

Thanks Steve, can't figure out why I couldn't search it though.I'll try to search through the manuals again if I encounter this stuff.

[Alan Kirk]

Thanks Steve, can't figure out why I couldn't search it though.I'll try to search through the manuals again if I encounter this stuff.

To be fair, it's because you won't find the functions under those names in the manuals. Not aside from one or two obscure one-line references anyway. You'll notice that one of the functions that you were asking about was ViewSetSkipCalcs. The one that Steve cited is ViewExtractSkipCalcsSet. For all intents and purposes they work the same way, but one is fully documented (or as fully as it gets) and the other only appears in, for example, lists of key words buried in obscure locations in some of the manuals.

I'm afraid that this one is down to cruddy documentation (and a previously discussed lack of nomenclature discipline) on Applix's part.

[Steve Rowe]

I never noticed that.

So there are two sets of TI calls doing exactly the same thing but with a slightly different name....
Strange

[Alan Kirk]

I never noticed that.

So there are two sets of TI calls doing exactly the same thing but with a slightly different name....
Strange

Yup. Historically I've always used the ViewSetSkipCalcs one, but that's just out of habit and because I put it in my standard templates. The funny thing is I can't recall where I got it from initially unless it was in one of the .chm style help files, because I can't find it referred to (as I said, aside from a couple of "reserved words" and similar lists) in any of the .pdfs. And I've got 'em all (plus release notes, etc) from version 6 onwards within a central directory for Acrobat to be able to do a full search on them. When it did, it didn't find a single instance of ViewSetSkipCalcs having been properly documented, nor any reference to ViewExtractSkipCalcsSet replacing it.

My first thought would have been that ViewSetSkipCalcs was intended for user views and ViewExtractSkipCalcsSet was intended for AsciiOutput views but (a) ViewSetSkipCalcs has no context inside a user view since that's driven only by subset selection and (b) as we know, to oft-expressed considerable annoyance, Iboglix doesn't treat export views as being a distinct and different kind of object and instead mixes them all in to the main view list. ("Oooh, what's this view?" {Click-click} "Out of memory"}

[lotsaram]

Historically I've always used the ViewSetSkipCalcs one, but that's just out of habit and because I put it in my standard templates. The funny thing is I can't recall where I got it from initially unless it was in one of the .chm style help files.

Back when I cut my teeth in v7 & v8 I used ViewSetSkipCalcs (also probably because I copied & pasted from a help reference) but I have long since swapped to using ViewExtractSkipCalcsSet. TM1 doesn't have a history of ceasing to support undocumented functions but who knows what might happen ...

My first thought would have been that ViewSetSkipCalcs was intended for user views and ViewExtractSkipCalcsSet was intended for AsciiOutput views but (a) ViewSetSkipCalcs has no context inside a user view since that's driven only by subset selection and (b) as we know, to oft-expressed considerable annoyance, Iboglix doesn't treat export views as being a distinct and different kind of object and instead mixes them all in to the main view list. ("Oooh, what's this view?" {Click-click} "Out of memory"}

Yes. The "processing view" zero skips are not to be confused with ViewSuppressZeroesSet (& ViewRowSuppressZeroesSet, & ViewColumnSuppressZeroesSet) which are used to set zero suppression in TI when building "user views."