Introduction

Overview

QUBEdocs integrates tightly with Planning Analytics / TM1 to automate the generation of documentation that can be used for analysis and to support decision making. It pulls out information required to generate the documentation from a vast number of underlying source files and delivers this information through the following services:

Documentation Services

Model Documentation

The model documentation organizes the models by object type, allowing the documentation to be navigated in a way that is familiar to Planning Analytics / TM1 users. Each object has overview, individual pages and a model summary is also included that provides a holistic view of the model complete with interactive diagrams and other analytical aids which help users understand the relationships and dependencies in their models. 

Application Documentation

Typically a single Planning Analytics model contains several applications.  For example, it may contain a sales forecasting application, a budgeting model, HR or KPIs application. The application documentation allows you to create focused documentation for these applications.  It automatically produces diagrams which explain a subsection of the overall model and allows you to associate these with other documents such as end user guides.

Environment Diagrams

Environment Diagrams provide a single, holistic view of all of the Planning Analytics / TM1 models in your Eco-system. They can be used to explore cross server relationships between models and applications. 

Knowledge Base

The knowledge base provides a central repository of documents and a glossary of both business and technical terms. 

Analytical Services

Cube and Dimension Analysis 

Cube and Dimensions matrices show the relationships between objects in a model and are very useful for assessing the overlap of objects while designing or performing an impact analysis before making changes to models. 

Change Analysis and Documentation

The Change Analysis service track changes to models over time and differences between environments. They are typically used to document changes for compliance reasons and provide root cause analysis when issues occur. 

User and Group Analysis

The User and Group Analysis service provides information on the security model and the solution’s users and groups. Users are automatically classified based on their roles and assess levels and user profiles can easily be reviewed and compared. 

Model Statistics

Model Statistics are provided for each key object type.  These include volume and memory information as well as information on latest run times for jobs (processes and chores). 

Planning Services

Deployment Planning 

The Version Control and Deployment Planning service can be used to review source files, track changes to files over time and plan deployments between environments. 

Search

QUBEdocs provides a powerful and comprehensive search service which can be used to search key words, structures, object names, scripts and various other areas of the QUBEdocs documentation.  Both simple and complex search can be performed to help answer the many questions that you have around your models.