Menu Schließen

Automated Process Documentation in IBM Planning Analytics (TM1)

BI2run - Automated Process Documentation

A new developer takes over an established TM1 system. He opens a rule file containing 800 lines of code with no comments. His predecessor is no longer with the company.

The TM1 Dokutool automatically analyzes processes and rules and generates a visual dependency diagram, rather than leaving system knowledge locked away in a single person’s code.

Why is TM1 code often undocumented?

TM1 processes and rules are often created under time pressure; documentation comes “afterward” – and in practice, often not at all. Existing documentation tools require complex code tags that are rarely maintained.

This is particularly true for systems that have been further developed over the years by a succession of external service providers, where documentation standards have varied from project to project.

BI2run - SAP

What is the cost of missing process documentation?

When the person in charge leaves the company, a significant portion of the system’s knowledge disappears with them. Every new developer must painstakingly acquire this knowledge on their own.

Without the Dokutool, dependencies are only visible in the code itself; the onboarding process takes significantly longer, and knowledge transfer usually only works through a personal handoff. With the Dokutool, dependencies are visualized as a diagram, new developers get up to speed noticeably faster, and knowledge transfer succeeds even without a personal handoff.

In practice, the onboarding of new developers is shortened by about 2 days, and debugging dependencies takes about 50 percent less time.

Is your system knowledge only in the code?

We’ll check how well your TM1 processes are documented – honestly, even if the answer turns out to be “pretty good already.”

Schedule a call →

How does Dokutool generate documentation automatically?

The TM1 documentation tool automatically analyzes processes and rules – without requiring any special code tags – and generates a visual dependency diagram based on this analysis. This diagram shows which processes and cubes depend on one another.

Because the documentation is generated directly from the existing code, it is automatically kept up to date without anyone having to maintain it manually.

How can Dokutool be implemented?

In practice, the following order has proven effective:

  1. Select the relevant processes and rule files for the analysis.
  2. Run Dokutool on the existing system.
  3. Have experienced developers review the generated dependency diagram.
  4. Provide the diagram to new team members as a training aid.
  5. Repeat the analysis after major system changes.

The benefits are most evident when a new team member begins the onboarding process. That is precisely when the effort put into the analysis earlier pays off.

Fact BlockThe key figures at a glance:
MetricValue
Implementation Effort1 to 3 person-days
ROI in Year Onearound 380 percent (calculated at 1 person-day of effort)
Business Valueapprox. 4,800 euros per year (5 hrs/month × 80 euros × 12 months)
Area of ImpactDev & Integration, one of 5 areas of impact in our playbook “Small Tools. Big Impact.”
Average ROI Across Our 15 Modulesaround 200 percent in year one

Basis: our playbook “Small Tools. Big Impact.” (2026), internal ROI formula: ROI = (Business Value − Implementation Cost) ÷ Implementation Cost × 100%, based on 1 person-day = 1,000 euros.

BI2run - Application Managment
GlossaryA few terms from this article explained briefly:
TermDefinition
TM1 / IBM Planning AnalyticsCube-based software for integrated enterprise planning, budgeting, and forecasting
Rule FileA file containing calculation logic that controls the behavior of a TM1 cube
Dependency DiagramA visual representation showing which processes, cubes, and rules are linked to one another
Code TagA manually inserted marker in the code for documentation purposes
DokutoolBI2run module for automatically analyzing and documenting TM1 processes and rules

FAQ

How long does it take to use the Dokutool?

Typically 1 to 3 person-days, depending on the size and complexity of the system.

Do developers have to include code tags?

No. Dokutool automatically analyzes existing code without requiring any special tags.

Will the documentation remain up to date after system changes?

Only if the analysis is run again after major changes. It does not generate itself automatically on an ongoing basis.

What is the Dokutool generally not best suited for?

For very small, straightforward systems with few dependencies, the effort is usually not necessary.

Does the Dokutool replace in-person training?

No. It significantly speeds up the onboarding process, but it does not replace professional discussions with experienced colleagues.

How does the effort compare to the benefits?

The ROI in the first year is approximately 380 percent, with 1 to 3 person-days of setup effort.

Why BI2run

BI2run develops modules like Dokutool based on actual TM1 systems, not from scratch. If an assessment shows that your system is already well documented, we’ll let you know. Feel free to contact us to discuss your situation.

Free · TM1 / Planning Analytics

Small Tools. Big Impact.

15 ready-to-use modules for your TM1 / Planning Analytics – with an ROI calculation per tool.

Get the playbook now →

Share article:

LinkedIn
WhatsApp
Facebook
Email

More articles

Any questions? Our experts look forward to your call!