Cognos TM1 TurboIntegrator Functions

TM1 TurboIntegrator lets you manipulate TM1 data and metadata when you define a process.
This is accomplished through the use of functions in the Prolog, Metadata, Data, and Epilog subtabs within the Advanced tab of the TurboIntegrator window. These sub-tabs include generated statements based on settings and options you select when defining a TurboIntegrator process. Any functions you create must appear after the generated statements.

The TI functions in this chapter are sorted by category:

ASCII and Text Turbointegrator Functions:
ASCIIDelete
ASCIIOutput
SetInputCharacterSet
SetOutputCharacterSet
TextOutput

Attribute Manipulation TurboIntegrator Functions:
AttrDelete
AttrInsert
AttrPutN
AttrPutS

Chore Management TurboIntegrator Functions:
ChoreQuit
SetChoreVerboseMessages

Cube Manipulation TurboIntegrator Functions:
CellGetN
CubeCreate
CellGetS
CubeDestroy
CellIsUpdateable
CubeExists
CellPutN
CubeGetLogChanges
CellPutProportionalSpread
CubeSetLogChanges
CellPutS
CubeUnload

Dimension Manipulation TurboIntegrator Functions:
DimensionCreate
DimensionElementDelete
DimensionDeleteAllElements
DimensionElementInsert
DimensionDestroy
DimensionElementPrincipalName
DimensionElementComponentAdd
DimensionExists
DimensionElementComponentDelete
DimensionSortOrder

ODBC TurboIntegrator Functions:
ODBCClose
ODBCOutput
ODBCOpen

Process Control TurboIntegrator Functions:

ExecuteCommand
ItemSkip
ExecuteProcess
ProcessBreak
GetProcessErrorFileDirectory
ProcessError
GetProcessErrorFilename
ProcessQuit
If
While
ItemReject

Rules Management TurboIntegrator Functions:
CubeProcessFeeders
RuleLoadFromFile

Security TurboIntegrator Functions:
AddClient
DeleteGroup
AddGroup
ElementSecurityGet
AssignClientToGroup
ElementSecurityPut
AssignClientPassword
RemoveClientFromGroup
DeleteClient
SecurityRefresh

Server Manipulation TurboIntegrator Functions:
BatchUpdateFinish
SaveDataAll
BatchUpdateFinishWait
ServerShutdown
BatchUpdateStart

Subset Manipulation TurboIntegrator Functions:
SubsetAliasSet
SubsetExists
SubsetCreate
SubsetExpandAboveSet
SubsetCreateByMDX
SubsetFormatStyleSet
SubsetDeleteAllElements
SubsetGetElementName
SubsetDestroy
SubsetGetSize
SubsetElementDelete
SubsetIsAllSet
SubsetElementInsert

View Manipulation TurboIntegrator Functions:
PublishView
ViewExtractSkipCalcsSet
ViewColumnDimensionSet
ViewExtractSkipRuleValuesSet
ViewColumnSuppressZeroesSet
ViewExtractSkipZeroesSet
ViewConstruct
ViewRowDimensionSet
ViewCreate
ViewRowSuppressZeroesSet
ViewDestroy
ViewTitleDimensionSet
ViewExists
ViewTitleElementSet
ViewExtractSkipCalcsSet
ViewZeroOut
ViewExtractSkipRuleValuesSet

Miscellaneous TurboIntegrator Functions:
Expand
StringToNumber
FileExists
StringToNumberEx
NumberToString
WildcardFileSearch
NumberToStringEx
TM1ProcessError.log file

There is no interface to assist in the creation of TurboIntegrator functions. You must enter functions by hand directly in the appropriate sub-tab within the Advanced tab. String arguments to TurboIntegrator functions must be enclosed in single quotation marks. A semi-colon (;) must be included to indicate the end of each function in the TurboIntegrator window.

In addition to these TurboIntegrator functions, you can also incorporate all standard TM1 Rules functions in a process definition, with the exception of the STET function. Important: Each argument to TurboIntegrator functions is limited to 256 bytes. A TurboIntegrator function can accept multiple arguments, and each argument is limited to 256 bytes.