}bedrock.cube.data.export

Description

This TI is designed to export data in a given cube to a flat file for a given "slice" (any dimension/element combination).

Use Case: Intended for development/prototyping or in Production environment.

1. Export data for import into another TM1 model to eliminate possibility of locking.
2. Export data for import into ERP system.

Note:

• Naturally, a valid cube name (pCube) is mandatory otherwise the process will abort.
• All other parameters are optional, however, the filter (pFilter) should be specified to limit the size of the file.
• The default output path is the same as the error file path.
• As this TI has a view as a data source it requires the implicit variables NValue, SValue and Value_is_String
• To edit this TI in Architect a tmp cube with minimum 24 dims is needed as the preview data source or set the data source to ASCII and manually edit the TI in notepad after saving to add back the required implicit view variables
• If using the pFilterParallel parameter the single dimension used as the "parallelization slicer" cannot appear in the pFilter parameter
• When using parallelization via the RunProcess function the elements listed in pFilterParallel will be split one_at_a_time and passed to a recursive call of the process being added to pFilter. Each element name will also be appended to the filename Warning:
  As the RunProcess function currently has no mechanism to check for the state of the called process if more processes are released than available CPU cores on the server then this could lead to TM1 consuming all available server resources and a associated performance issue. Be careful that the number of slicer elements listed in pFilterParallel should not exceed the number of available cores.

Process Parameters

Parameter	Data Type	Default	Prompt Text
pLogoutput	Numeric	0	OPTIONAL: Write parameters and action summary to server message log (Boolean True = 1)
pCube	String		REQUIRED: Cube name
pView	String		OPTIONAL: Temporary view name
pFilter	String		OPTIONAL: Filter: Year¦ 2006 + 2007 & Scenario¦ Actual + Budget & Organization¦ North America Operations (Blank=whole cube)
pFilterParallel	String		OPTIONAL: Parallelization Filter: Month:Q1+Q2+Q3+Q4 (Blank=run single threaded). Single dimension parallel slices. Will be added to filter single element at a time. Dimension must not be part of filter
pParallelThreads	Numeric	0	OPTIONAL: Maximum number of threads to run when parallel processing is enabled ( if <2 will execute one thread, but parallel filter is still applied )
pDimDelim	String	&	OPTIONAL: Delimiter between dimensions (default value if blank = '&')
pEleStartDelim	String	¦	OPTIONAL: Delimiter for start of element list (default value if blank = '¦')
pEleDelim	String	+	OPTIONAL: Delimiter between elements (default value if blank = '+')
pSuppressZero	Numeric	1	OPTIONAL: Suppress Zero Values (1=Suppress)
pSuppressConsol	Numeric	1	OPTIONAL: Suppress Consolidated Values? (1=Suppress)
pSuppressRules	Numeric	1	OPTIONAL: Suppress Rule Values? (1=Suppress)
pSuppressConsolStrings	Numeric	0	OPTIONAL: Suppress Strings on Consolidations (Skip = 1) (Default = 0)
pZeroSource	Numeric	0	OPTIONAL: Zero Out view AFTER Copy? (Boolean 1=True)
pCubeLogging	Numeric	0	Required: Cube Logging (0 = No transaction logging, 1 = Logging of transactions, 2 = Ignore Cube Logging - No Action Taken)
pTemp	Numeric	1	OPTIONAL: Retain temporary view and Subset ( 0 = retain View and Subsets 1 = use temp objects)
pFilePath	String		OPTIONAL: Export Directory (will default to error file path)
pFileName	String		OPTIONAL: Export Filename (If Left Blank Defaults to cube_export.csv)
pDelim	String	,	OPTIONAL: AsciiOutput delimiter character (Default=comma, exactly 3 digits = ASCII code)
pQuote	String	"	OPTIONAL: AsciiOutput quote character (Accepts empty quote, exactly 3 digits = ASCII code)
pTitleRecord	Numeric	1	OPTIONAL: Include Title Record in Export File? (Boolean 0=false, 1=true, 2=title and filter line Default=1)
pSandbox	String		OPTIONAL: To use sandbox not base data enter the sandbox name (invalid name will result in process error)
pSubN	Numeric	0	OPTIONAL: Create N level subset for all dims not mentioned in pFilter

Full Process Dependencies

Process	ExecuteProcess	RunProcess
}bedrock.cube.view.create	Y	N
}bedrock.hier.sub.create	Y	N
}bedrock.hier.sub.exclude	Y	N
}bedrock.hier.sub.create.bymdx	Y	N