Find your way around TBM Studio

Toolbar

All products Navigate to another Apptio product
Date Range Switch between time periods
Environment

Switch between Development, Staging, and Production environments

Learn more about enviroments

Help
You can:
  • search the Help Center
  • send feedback
Application settings
You can:
  • go to application administration
  • create or import a new Project
  • Change your domain
  • Configure row-level security
  • view details of the application, such as the version and environment
Profile settings
You can:
  • manage your profile
  • impersonate another user
    Tip: Administrators may want to do this to check a user's permissions or to troubleshoot problems.
  • log out

Navigation

Projects pane

In the Projects pane, you can view a list of all Projects in your tenant and select the Project you want to work in.
  • To minimize the Projects pane, select . To maximize the pane again, select .

Project Explorer pane

The Project Explorer pane includes sections for each type of document:
  • Tables: Lists the tables that have been uploaded into the application.
  • Metrics: Lists the calculated and model metrics.
  • Perspectives: Lists the fields added from another section that are available for creating reports.
  • Reports: Lists the object reports generated by the application and the custom reports created by users. It also lists the model reports.
  • Time: List the values such as months, quarters, and halves that can be used to group data in charts and tables on reports.
When you select a section, it expands. Only one section can be expanded at a time.
  • To minimize the Project Explorer pane, click the Minimize arrow in the upper-right corner of the pane.
  • To adjust the width of the Project Explorer pane, drag the vertical divider.

There are also several icons that appear in the Project Explorer:

Icon Tooltip (displayed when hovered over) Details
“This document is checked out by you” You have it checked out from the staging project for editing.
“This document has been checked out to <insert username here>” Someone besides the current user has it checked out. Hover over the icon to learn the user name of who has it checked out.
“To share this document, click check in” A new item in your workspace. You created it and have not checked it in yet. It will not be visible to other users until checked in.

“This document is being calculated. It will be available when the calculations are complete.”

After calculating the tooltip changes:

“There is a newer version of this document available. To get the new version, click Update Workspace."

The item has just been checked in by you and is currently calculating. The icon will update when the check in calculation has completed.

After calculating:

The item has been checked in by you or another user since your workspace was last updated. Click Update Workspace to load the current version.

Environments

There are three environments in TBM Studio:
  • Development
  • Staging
  • Production

To change environments, use the Environment menu in the toolbar.

Note: In the R11.x versions of TBM Studio, the three environments each had a separate URL. Now, all three environments are aggregated under a single URL.

Development environment

When you check out a document to your workspace and edit it, you automatically are working in the Development environment. The edits you make are local to your workspace. If other users are editing objects in TBM Studio, you will see listings for their Development environments. When you have no documents checked out for editing, you will automatically be switched to the Staging environment.

If other users are working in TBM Studio and have one or more documents checked out, you will see their environments listed in the Environment menu. If you have the correct access privileges, you can switch to another user's development environment and edit documents they have checked out.

Staging environment

When you check in a document, it is checked in to the Staging environment. All edits made by all users are aggregated in the Staging environment.

Production environment

The Apptio Admin can promote a project from the Staging environment to the Production environment. Users that have view-only access to Apptio are always viewing the Production environment. If the Staging environment has not been promoted to the Production environment, Production will not be displayed in the Environment menu.

Documents and document tabs

A document is an object that can be edited. Documents include tables, metrics, perspectives, and reports. When you check out a document, a tab is displayed at the bottom of the Details/Data Preview pane. The tabs are like the worksheet tabs in Excel. You can switch between two views of a document using the commands on View menu on the Home tab:

  • Show Document: This is the standard edit view of a document.
  • Show Changes: Displays a list of the changes made to the document.

To delete a document, you must check it out, delete it using the Delete command on the Home tab, and then check it back in. To find a document in Project Explorer, use the search field at the top of a section. In the example below, the search is for all tables that have the word "data" in the title.

Check out and check in

To edit a document, you must check it out.
  • On the Home tab, in the Document group, click Check Out.
When you check out a document, it is locked so others cannot edit the document. You can save changes to the document without triggering a recalculation. When you are done editing a document, save it and check it back in.
  • On the Home tab, in the Document group, click Check In.

This triggers a recalculation and others will see the changes you have made to the document. The changes will be made available in the Staging environment. Learn more about checking out documents

Update with recent changes

As you work in TBM Studio, you can update documents and workspaces using the Updates options on the Home tab. The options include:

  • Update Document — Update your currently active document with any checked-in changes.
  • Update Workspace — Update your workspace with changes from all currently checked-out documents.
  • Auto Calculate — Update all the documents you have checked out each time you save a document.
  • To enable the Update Document or Update Workspace options, select Auto-Calculate first.

Auto-save

In TBM Studio, the following actions trigger an auto-save of all checked out documents:

  • Creating a new document.
  • Switching from one step in a transform to another step or creating a new transform step.
  • Switching from one document tab to another.