A button beside the report

The user opens an IBM Planning Analytics Workspace (PAW) book, clicks “Update management report”, uploads a file and sets parameters. Data Bridge runs the prepared flow, while the button indicators show its status. After confirmed completion, the user refreshes the cube view and verifies the result.

The connection uses a URL in the Webpage widget. The widget displays the Data Bridge button. Its appearance and workflow are configured in Data Bridge; its position and size are configured in PAW.

The general mechanism is described in “A launch button on another website”. To execute TurboIntegrator, add the appropriate TI execution step.

Preparing the flow and access

  1. Test the flow with test data: file → parameters → validation → mapping → IBM destination.
  2. Configure the TM1 connection, target cube and mapping for every dimension. Publish the ready Production version.
  3. Give users permission to run the flow in Data Bridge. PAW book permissions and flow permissions are checked separately.
  4. Choose the IBM login method: saved credentials or the user's own session. The latter may require an additional IBM login.
  5. Prepare a Data Bridge HTTPS address reachable by users' browsers and the exact PAW environment address. The web content must permit display inside a frame.

Step 1. Enable the button in Data Bridge

  1. As an administrator, open the required flow's “Workspace button”.
  2. Enable the button. Set its label to “Update management report”.
  3. In “Allowed Workspace addresses”, enter, for example, https://planning.example.com. Include a nonstandard port if used. Do not add the book path, URL parameters or wildcards.
  4. Define who can run the flow from the button. For restricted access, select the required users.
  5. Configure its appearance, click “Save settings”, then “Copy address”.

Step 2. Add the link to a PAW book

  1. Open the book in Edit mode.
  2. In the side panel, click Widgets. In the Standard group, select Webpage.
  3. Paste the copied button URL into the webpage address field and confirm.
  4. Place the widget beside the cube view and resize it with the handles. Start at 280 × 44 px for the illustrated label, or 220 × 40 px for a shorter label.
  5. Save the book, switch to view mode and test the launch as a regular user.

Alternatively, paste the URL onto the canvas in edit mode with Ctrl+V or Cmd+V; Workspace recognizes web content. Labels depend on PAW language and version. The Widgets → Standard → Webpage path and HTTPS/iframe requirements are described in the official IBM instructions.

Step 3. Choose the appearance

Planning Analytics WorkspaceIllustrative book layout
Management reporting / Actual and planPeriod: October · Version: actual

Neutral

Blue accent

Soft green

MeasureActualPlanVariance
Revenue1 200 0001 150 000+50 000
Operating expenses840 000820 000+20 000
Operating result360 000330 000+30 000
Three styles of the same button beside a report. Choose one for the working book. Data is illustrative; this is a diagram, not a screenshot of your IBM environment.
VariantBackgroundFontBorderSize
Neutral#dcdcdc#1616161 px · #82828212 px
Blue accent#edf5ff#0043ce1 px · #0f62fe13 px
Soft green#defbe6#0e60271 px · #24a14813 px

Set these values in “Button appearance in the book”: background color, font color and size, border, border width and color. Supported font sizes are 8–48 px and border widths 1–8 px. The “Default Workspace appearance” command restores Data Bridge defaults.

Leave enough width for the label and status icon. Refresh the book after saving the appearance. Running, waiting and result indicator colors are determined by the component; these settings change the button's base appearance.

Reading button status in a book

Ready to run
Running
Waiting for action
Completed successfully
Needs attention
IndicatorExplanation
Label without an indicatorReady to run. Opening the book without clicking does not execute anything.
Spinner and blue barSigning in, starting, queued or processing. When available, the percentage appears in the tooltip and progress bar.
Yellow pauseAction is required in the wizard. Click to return to the current step.
Green ✓Success; the indicator disappears after approximately 8 seconds.
Red !Failure, a partial result or reconciliation required. The exact status appears in the tooltip and log.
Blue borderButton focus; the border alone does not confirm success.

The “Update management report” label usually stays in place. After stopping, the button becomes ready again, but already written data is not rolled back. See the complete status table, including partial and unconfirmed results.

Report-update wizard example

Updated file · Management reporting.xlsx
① Reporting file② Update parameters③ Data validation

Flow execution

Upload a new version of Management reporting.xlsx. This example uses the “ReportData” named range.

Drag a file here or select it on your computerExample format: .xlsx
No file selected yet. Continue becomes available after validation.
Stop processContinue
A training layout based on the supplied scenario, with renamed items. This illustration does not upload files or run a flow; the configured graph determines the actual steps.

For this scenario, configure the sequence:

  1. Reporting file. Create “Management reporting.xlsx” in File Manager and set its reading method, such as named range ReportData. Add a “File” block and enable “Ask the user for an updated file”.
  2. Update parameters. Add “Run parameters” displayed in the wizard: year, month, department and scenario. An “Element” field can obtain values from an accessible TM1 dimension/hierarchy.
  3. Data validation. Add a table preview marked “Show in execution wizard” before the destination so the user can see prepared rows before writing.
  4. Write to IBM. Map columns and parameters to cube dimensions, set the value field and the agreed write mode. Use object names from your own model.
  5. Result. Add a message or result file if needed. The complete log is available in Data Bridge.

After a file is selected, the system validates its format and reads the configured range. On success, it displays row and field counts and enables “Continue”. In a working run, the confirmed file is saved as a new version of the linked File Manager object under that object's name. Simulation or validation does not publish a version.

The steps across the top show the stages of this particular wizard: the flow and active route determine the list. For parameters, you can also choose a separate dialog and configure its title, dimensions and control-button labels.

The user's workflow

  1. Open the PAW book and click “Update management report”.
  2. Sign into Data Bridge when prompted and, for a session connection, into IBM as well.
  3. Select the file in the wizard, check the read confirmation and click “Continue”.
  4. Set the period, department and scenario; review the prepared table if that step is configured.
  5. Wait for confirmed completion, refresh the cube view in PAW and verify the required slice.

Book filters are not automatically passed to the flow. Required values are provided in the wizard or flow settings. Adding the button also does not configure automatic refresh of all book widgets after a write.

Wizard window, login and stopping

When PAW and Data Bridge use different domains, the wizard opens in a separate browser window centered on screen. Allow this window for the Data Bridge address. A dialog over the book, as illustrated, is possible when protocol, domain and port match. Simply inserting a URL does not let a frame access a page on another domain.

The web widget remains button-sized; the wizard has its own window. Clicking again returns to the open wizard. Closing the active window stops the run, and the next click starts a new one. Confirmed external actions are not rolled back.

A flow without forms runs without an additional wizard after any required login; its status is visible on the button.

Checking access

Test the book as its regular user. The user must satisfy the button rule, have flow execution permission and access to required resources. TM1 applies the permissions of its connection account.

Changing allowed addresses or access, or disabling the button, revokes its active grants and stops unfinished runs. Refresh the button and sign in again. Requests already sent to IBM are not rolled back; subsequent batches are not sent. Changing only the label or appearance does not require another login.

Common situations

SituationWhat to check
Empty web widgetThe button's HTTPS address, Data Bridge reachability, PAW's actual domain and port in allowed addresses, and embedded-content rules.
Truncated labelWidget width and font size. Increase width for a long label.
“Allow pop-up windows”The browser's permission for the Data Bridge launch window; then click again.
Repeated login or access deniedThe Data Bridge session, flow execution permission and button user list. PAW login does not replace these.
Disabled “Continue”The file has not been selected/read or does not match the settings. Check its format, sheet/range and the error message.
Success, but the report shows old dataRefresh the PAW view and check the slice, target cube and confirmed write in the log.
Partial result / reconciliation requiredCompare target cells and the log, and determine a safe scope for retrying.

Verification cycle before handing over the book: open → click → file and parameters → validation → write → refresh view. Merely opening the book must not start execution.