Tasks
What Are Tasks
Tasks enable one-click automations for various Google Sheets and IBM Planning Analytics routines — such as recalculating sheets, running TI processes, uploading data, comparing results, and more.
You can define tasks either using the TeamOne Configuration section or directly on the .TEAMONE sheet.
Alternatively, you can define tasks directly on the .TEAMONE sheet.
For each task, enter the ::tasktype
in column A and the task name in column B.
TIP
Start creating tasks using the configuration menu, then use the Move to .TEAMONE sheet
option to transfer it to the .TEAMONE
sheet.
When defining tasks in the .TEAMONE
sheet, you can use formulas to make them dynamic. For example, use =YEAR(TODAY())
to pass the current year as a parameter to a TM1 process task.
To execute a task, simply click on it from the TeamOne sidebar:
::sheet.recalculate
The ::sheet.recalculate
task is used to recalculate one or more Google Sheets within the workbook. This is useful when you want to trigger a recalculation of dynamic formulas, refresh dependent cells, or run on-sheet logic manually.
Option / Parameter | Description |
---|---|
-info | A task hint, shown when hovering over the info icon next to the task name in the sidebar. |
Sheet1-SheetN | Enter one or more sheet names in column A. Each row should contain a single sheet name to be recalculated. |
TIP
To recalculate sheets named Summary
, Input
, and Forecast
, enter them in separate rows under column A. You can combine this task with other tasks in a sequence to refresh sheet data before or after importing/exporting TM1 data.
::sheet.truncate
The ::sheet.truncate
task is used to clean up one or more sheets by removing rows from the bottom. This is especially useful when resetting upload templates or clearing leftover data.
Option / Parameter | Description |
---|---|
-info | A task hint, shown when hovering over the info icon next to the task name in the sidebar. |
-keepRows | If specified, only the given number of rows at the top will be retained. All rows below will be deleted, even if they contain data. |
-addRows | If specified, the task will add the given number of empty rows at the bottom after truncation. |
Sheet1-SheetN | Enter one or more sheet names in column A. Each row should contain a single sheet name to truncate. |
TIP
Use this task to reset upload sheets before reloading data, especially in conjunction with ::tm1import
.
- If
-keepRows
is not specified, only empty rows at the bottom of the sheet will be deleted. - If
-keepRows
is specified, the sheet will be reduced to that number of rows, regardless of whether they are empty. - If
-addRows
is used, empty rows will be added at the bottom after deletion to maintain a consistent template size.
Example:
To truncate and reset sheets named Upload_Actuals
and Upload_Forecast
, list them in column A and optionally specify -keepRows
and -addRows
as needed.
::tm1process
The ::tm1process
task runs TM1 TurboIntegrator (TI) processes. Use the table below to define the process name and its parameters:
Option / Parameter | Description |
---|---|
-name | TI process name. If omitted, the task name is used. |
-tm1env | TM1 environment to run the process in. Must match a defined ::tm1env . Defaults to the selected environment in the TeamOne sidebar. |
-info | Tooltip text shown on hover. |
parameter 1–N | Enter parameter name in column A and its value in column B. If a parameter is omitted, its default value will be used. |
After running the task via the sidebar, the result will be shown in the log panel.
TIP
You can generate a ::tm1process
task using the sidebar process menu, which will auto-populate the process name and parameters.
View ::tm1process example
::tm1data
The ::tm1data
task queries TM1 data using a view, MDX, or dimension element definitions. The result is printed to the specified sheet.
Option / Parameter | Description |
---|---|
-tm1env | TM1 environment to use. Defaults to the selected one. |
-info | Tooltip text shown on hover. |
-sheet | Output sheet name. |
-activate | If set, switches to the output sheet after data is printed. |
-cube | Cube name. Required when using -view or dimension definitions. |
-view | Existing cube view to fetch data from. Requires -cube . |
-mdx | MDX query. Used only if -view is not provided. |
Dimension 1–N | Enter dimension name in column A and subset/elements/MDX in column B. Requires -cube . |
Accepted formats for dimension values in column B:
- Semicolon-separated list:
Actual;Budget;Forecast
- Subset name:
$SubsetName
- System subsets:
$ALL
,$LEAVES
,$ROOTS
- MDX:
{[Calendar].[FY2026].Children}
- Pattern matching:
/FY2026 Q?/
,/*Revenue*/
- Mixed list:
FY2025;FY2026;{[Calendar].[FY2026].Children};/FY2027 Q?/
If column B is left blank, the default member is used.
The result is printed to the sheet defined in -sheet
:
View ::tm1data example
::tm1import
The ::tm1import
task uploads data from a Google Sheet into a TM1 cube.
Option / Parameter | Description |
---|---|
-tm1env | TM1 environment to use. Defaults to the selected one. |
-info | Tooltip text shown on hover. |
-cube | Cube name to import into. |
-sheet | Sheet name containing data. |
-startRow | Starting data row (default: 1). |
-startColumn | Starting data column (default: 1). |
-skipBlank | Skips empty cells if enabled. |
-checkIfUpdatable | Skips rule-calculated cells if enabled. |
You can use of the 2 possible data formats:
Option 1: One value column
- Each column represents a cube dimension.
- Last column is labeled
Value
.
Option 2: One column per measure
- Final columns represent each measure element.
TeamOne automatically detects the format and supports both principal names and aliases.
TIP
You can use Option 1 directly with data fetched via a ::tm1data
task, enabling two-way sync between ::tm1data
and ::tm1import
.
View ::tm1import example
::tm1fileoutput
The ::tm1fileoutput
task exports sheet data to a delimited file on the TM1 server. Useful when TI processes use flat files for validation or transformation logic.
Option / Parameter | Description |
---|---|
-tm1env | TM1 environment to use. Defaults to the selected one. |
-info | Tooltip text shown on hover. |
-sheet | Sheet name containing data. |
-startRow | Starting data row (default: 1). |
-startColumn | Starting data column (default: 1). |
-rows | Number of rows to export (0 = all). |
-columns | Number of columns to export (0 = all). |
-file | Output file path (relative to TM1 data directory). |
-delimiter | Field delimiter (default: tab). |
::tm1datacompare
The ::tm1datacompare
task compares results from an existing ::tm1data
task between two time points or environments.
Option / Parameter | Description |
---|---|
-tm1env | TM1 environment to compare against. Defaults to current. |
-tm1data | Name of the ::tm1data task used for comparison. |
-activate | If set, switches to the -sheet from the ::tm1data task. |
First, run the related ::tm1data
task to store baseline results. Then run ::tm1datacompare
to re-run the query and show differences:
Compare TM1 data before and after deployments
Run ::tm1data
before making changes, then run ::tm1datacompare
after deployment to review changes on the original output sheet.
Compare TM1 data between environments
Use the -tm1env
option to define a second environment for comparison.