Bedrock.Cube.Data.Export

This Bedrock TM1 TI exports data based on a string based filter from the nominated cube to an ASCII file.

Note: If you wish to export a current view use Bedrock.Cube.Data.ViewExportToFile

The filter can be based on multiple dimensions and multiple views, here are some standard examples using the standard delimiters: 

Filter Tips

If there is no filter parameter provided, the entire cube will be exported.

Limited to a cube with a maximum of 27 dimensions.

Parameters

Parameter

Data Type

Default

Explanation

pCube

String


The name of the cube where the data exists.

pView

String


The name to use for the temporary view and subsets created by the process.  If omitted or blank, a view name consisting of a time stamp and random number is used.

pFilter

String


The filter to be used to create the view to export, see the examples above.

pDimensionDelim

String


The delimiter between dimensions.

pElementStartDelim

String


The delimiter at the end of the dimension name and the start of the list of elements.

pElementDelim

String


The delimiter between elements.

pSkipRules

Boolean

1

Use 0 to include rule calculated data in the copied data.

Use 1 to exclude rule calculated data from the copied data.

pSkipCons

Boolean

1

Use 0 to include consolidated data in the copied data.

Use 1 to exclude consolidated data from the copied data. 

pZeroSource

Boolean

0

Use 1 to zero out the source element data after it is copied to the target element.

pDeleteTempObj

Boolean

1

Use 0 to retain temporary views and subsets created by the process.

Use 1 to delete temporary views and subsets created by the process.

Use 2 to delete only the temporary views created by the process.

pFilePath

String


The directory where the file is to be saved. If no file path is provided, the ASCII file will be saved to the TM1 logging directory.

pFileName

String


The file name of the ASCII file. If no file name is provided, a combination of the cube, dimension and element suffixed by 'export.csv' will be used.

pDebug

Numeric

0

The debug mode.


Example

ExecuteProcess('Bedrock.Cube.Data.ExportToFile',

    'pCube','General Ledger',

    'pView','',

    'pFilter','Year : 2011 + 2012 & Version : Actual' ,

    'pDimensionDelim','&',

    'pElementStartDelim',':',

    'pElementDelim','+',

    'pSkipRules',1,

    'pSkipCons',1,

    'pZeroSource',0,

    'pDeleteTempObj',1,

    'pFilePath','C:\FinancialData',

    'pFileName','Actuals.txt',

    'pDebug',0

    );


Copyright 2011, bedrocktm1.org Tested on: TM1 Versions 9.1 to 10.2.1 / Cognos Express 9.0 to 10.2