Defining and documenting applications

One useful viewing option in QUBEdocs is to view the model documentation by application. An application is a construct used to organise TM1 models logically, typically based on subject area, for example, a financial reporting application or a KPI application. It enables users to go to a single location and find only information relevant to a specific area of the model that they regularly use.  Applications are managed in the "Manage Applications" folder shown below or by views directly in the QUBEdocs Definitions cube. 

Adding Applications

The first step for setting up an application is to add the application name to the "Application" dimension. To do this:

1. Right click on the dimension shortcut called "Add Application to Dimension" and select Edit Dimension Structure.

Note: The element “ENTIRE MODEL” already exists – this is a required element for QUBEdocs and must not be deleted.

2. Add the new element.
3. Save the changes to the dimension.
4. Open up the "STEP 1 - Update Application Details view"
5. Give the application a description, an owner, and specify user, document and document hyperlink fields 

Note: The document fields are useful for linking in an external document such as a user guide or policy document. 

The second step is to assign the objects in the "QUBEdocs Definitions" cube to there relevant applications.  To do this:

1. Open the view "STEP 2 - Map Items to Applications" (or “A3. Map Items to Applications” view).
2. Select the appropriate application to define.
3. Set the “#IncludeInApplication” flag for any items that you would like to include in the application. Note that if you select consolidations for a collection of objects all of the items will be added automatically.

1. Decide whether you want the items to be grouped into the documentation based on default names or custom groups. If custom groupings are desired, enter a heading for the custom group against the “#CustomAppGroup” column.

Note that:

• By default objects will be added to the Related TM1 Objects area unless Custom groups are defined. Custom groups will be added to the Application Documentation
• Custom groups can have hyperlinks to other documents / resources or files whereas non custom groups cannot.