Working with the Document Wiki

Overview

The wiki gives you a centralized repository to store and organize all of your TM1 documentation. 

Accessing the Wiki

The Document Wiki can be found by selecting Document Wiki in the side bar.

Note: If Document Wiki is not appearing in the main menu and instead is found under Knowledge Base, we recommend that you upgrade your version of QUBEdocs Local.

Creating documentation

Creating new documents is really easy to do. Click New on the document wiki homepage and then select Document.

This will bring you to the main editor 

Before you can save your new document you first need to give it a title. Once you have saved the document all the options in the top right become available. From left to right these are Preview, Share, Print, Save and Delete.

When editing documentation, you have several tools available to you to format it. These are all available in the bar at the top of the document. You can also select which models/connections you wish this document to appear in the wiki for. The default is set to all models

Embedded Searches

To embed a saved search, ensure your document is in edit mode. You can then click the embed search button in the formatting bar at the top of the document. 

This will open the Embed Search popup. Select the model or snapshot you wish to run it against and then insert it into the page. All the advanced searches you have created for your account are available, as well as the ones we have made for you. If you choose not to select a specific model or connection the queries will be run against the one you are currently viewing.

After clicking insert you will see some blue text show in the editor with the name of the search, if you wish to change this text (or remove the search), simply edit the text.

Selecting the preview mode will allow you to see the results of the search in your document.

Note: We only show the top 100 rows for each object type returned in a search. This is so your documents don't get too large.

Embedded Diagrams

You can also embed diagrams for models/objects in your document. To do so, click on the “Embed Diagram” option in the toolbar while editing a document.

The embed diagram popup will then let you embed five different types of diagram:

• For a model diagram you can select which model and version you want a diagram filter to be applied to. There is a “Current Connection” option which will render the diagram for the model version the viewer will be browsing. You can also specify a model but tell the diagram to always render for the “Latest Version” of the model.
• With an environment diagram you can choose which environment and the diagram filter you want to render in the document.
• Cube, Process and Dimension diagrams can also be embedded. A model and version must be specified so QUBEdocs can load a list of associated model objects.

Similar to embedding a search, on clicking insert, some blue text will be inserted into the editor with the name of the filter in it. You can change the text to whatever you want or remove it from the editor to remove the diagram from the document.

Click preview to view the diagram in your document

Embedded Checklists

Checklists are intended to be a form of health check for your model. Embedding a checklist in your document will result in the checklist’s searches being executed when the document is viewed, and a table will be rendered summarizing the results of the searches.

To embed a checklist, click on “Embed Checklist” to open the popup.

Choose which model and version you want the checklist to be ran on. You can choose which model and version you want the checklist to be run for.

You can choose the “Current Connection” option for the model to execute the checklist on the model version the viewer will be browsing. You can also choose the “Latest Version” option to have the checklist run on the most recent version of the selected model.

The searches are organized into groups. To expand a group click on the arrow in the top right of a search group. You can then select individual searches by clicking on the checkbox on the left of the search name and choose a priority for the search in the drop-down on the right.

If you want to select (or deselect) every search in a search group, click on the checkbox to the left of the search group name.

Note that the priority currently defaults to high. If you select a whole group but do not change any of the priorities on the searches, the searches will all be marked as a high priority.

On inserting the checklist, blue text will appear in the editor saying “Checklist:”. You can modify this to say whatever you want or delete it to remove the checklist from the document.

Click preview to view the checklist in your document

As you can see in the screenshot, an item will be marked as a pass in the checklist only if the search returns zero objects. You can also click on a checklist item name to view the offending objects.

Embedded Change Reports

You can embed reports showing the changes between versions of the same model over time, or between different models such as development vs. production.

Select the Embed Change button from the top menu

This will open a popup allowing you to select your baseline and revision models and times from a list of all of your available snapshots

Once you insert the change report, you will see the familiar line of blue text indicating a comparison chart is in this location. Once you enter preview mode, you will see the chart embedded in the document.

Versions

Every time you save your document we take a snapshot of it. These versions are available when editing a document. 

Publishing

Once a document has been published it is no longer editable (it can however be changed back to a draft and then published again). This is done through the save menu by clicking the option Publish.

Managing Document Categories

Every document has a category associated with it, you can filter on these categories by clicking the tab at the top of the document wiki or by selecting the filter icon on the right hand side of the page.

Creating and editing categories is handled through the New and Management button respectively. You have no limit on the number of categories that can be created, however you can't edit the default four (WORKING NOTES, PROVEN PRACTICES, USER GUIDES and, ADMIN PROCESSES).

Linking to External Documentation

The wiki can store references to any external documents or websites you want to track. To do this select New on the initial page and then Link. 

You will receive a popup where you can give this link a name, description, category, and which models this link should appear in as you would with any other document.

Sharing documents

Every document has a shareable link you can send to your users. Note: this will still require that user to have access to QUBEdocs. If they are not logged in, they will be prompted to log in before they are able to see the documentation.

Clicking on the share  icon will bring up the following popup where you can get your link.

Deleting a Document

Deleting documents can be done in edit mode by clicking on the trash  icon. Note: Deleting a document is permanent- there is no recovery option.