TM1 Bedrock for Python

tm1_bedrock_py is a high-level integration toolkit for IBM Planning Analytics (TM1). It builds on TM1py and pandas to move data between TM1, SQL, and CSV sources, reshape coordinates with mapping pipelines, and manage dimension structures from tabular input.

The main public interface lives in TM1_bedrock_py.bedrock.

Start with Getting Started for workflow selection and first examples. Use Bedrock API Reference when you need the exact current signatures and defaults.

Getting started

• Getting Started
  • Installation
  • Create a TM1 connection
  • Choose a workflow
  • The standard data pipeline
  • Common transformation parameters
  • TM1 redimensionalization shortcuts
  • Missing-element checks
  • Logging
  • Where to go next
• TM1-to-TM1 Data Workflows
  • Choose the function
  • Primary example: intercube redimensionalization
  • Source extraction
  • Mapping steps
  • Example based on the project examples
  • Same-cube convenience
  • Mapping data sources
  • Callbacks
  • Missing elements and cell types
  • Writing and duplicates
  • Return value
• Cube, Dimension, and Hierarchy Management
  • Choose the wrapper
  • Primary workflow: dimension_builder
  • Build a cube
  • Build a dimension from parent-child data
  • Common data sources
  • Output without building
  • Export a dimension
  • Modify with a callable
  • Related wrappers
• Calculation Input Handler
  • Build the domain
  • Pipeline stages
  • Writing and dry runs
  • When to choose input_handler
• SQL Integration
  • SQL to TM1
  • TM1 to SQL
  • SQL safety
  • Backend notes
• CSV Integration
  • CSV to TM1
  • TM1 to CSV
  • Source clearing
  • Locale and data integrity
• Reliability and Error Handling
  • Public exception boundary
  • Parallel failure behavior
  • Transaction and cleanup behavior
  • Clear ordering
  • Trusted executable input
  • Validation status

Advanced workflows

• Parallel Execution
  • General rules
  • TM1 parameter slicing
  • Target clearing
  • Performance
• Parallel SQL Workflows
  • TM1 to SQL
  • SQL to TM1
  • Correct pagination
  • Connection capacity
• Parallel CSV Workflows
  • CSV directory to TM1
  • TM1 slices to CSV
  • Operational guidance
• Airflow Integration
  • Task groups
  • Example

Reference

• Bedrock API Reference
  • Calculation and cube structure
  • Dimension and hierarchy management
  • TM1 data movement
  • SQL integration
  • CSV integration
  • Parallel executors

Project links

• Source repository

• Issue tracker