In-Sheet Actions

In-sheet actions enable you to quickly interact with your data directly in Excel and Spreadsheet. Creating a button streamlines the following actions: 

  • Refreshing a worksheet or workbook

  • Submitting a worksheet or workbook

  • Running a data management sequence

NOTE: We recommend disabling AutoSave in Excel, and saving manually, while using In-Sheet actions for the best experience.

Create In-Sheet Button

Build an In-Sheet Action button using these steps: 

  1. Navigate to the Excel worksheet you would like to place your In-Sheet Action.

  2. Select a cell.

    NOTE: Make any In-Sheet Action button larger by selecting multiple cells. If a button consists of more than one cell, when opened in Spreadsheet, the button will revert to a single cell.

  3. From the ribbon, select OneStream > General > In-Sheet Actions.

    General Settings show In-Sheet Actions in Excel Ribbon

  4. In the In-Sheet Actions dialog, click the Add button.

  5. In the next In-Sheet Actions dialog, populate any applicable fields: 

    1. Label: Button text to show in cell.

    2. Refers To: Cell or range where the button will appear.

    3. Submit: Submits the Worksheet or Workbook after clicking the button. Select Nothing from the drop-down menu if you do not want to make a submission.

    4. Data Management Sequence: Use your In-Sheet action button to run a data management job. Click the ellipsis to browse for and select a data management sequence.

    5. Workspace Name: Populates with the name of the Workspace after you select a data management sequence.

    6. Parameters: Designate explicit values for parameters needed for your data management sequence or leave blank to resolve parameters based on sheet selections. Enter the parameter name and the value it should be set to at run time, for example, myparam = value.

      IMPORTANT: Parameters can only be used if they have been resolved in an existing Cube View or Table View in the sheet or workbook. To use parameters that don't exist in your Cube View or Table View, add it anywhere in the Cube View in OneStream, for example in the page caption field or other unused field that does not impact Cube View rendering. For Table Views, add the parameter to the GetCustomSubsVars section of the Spreadsheet business rule.

      NOTE: In-sheet actions will not prompt for unresolved parameters.

    7. Do not wait for task to finish: Enable this setting to continue working while the data management sequence runs in the background.

    8. Refresh: Refreshes the Worksheet or Workbook after clicking the button. Select Nothing from the drop-down menu if you do not want to make a submission.

    9. Text Color: Choose a custom button text color and input an eight character hex code, or select a color from the drop-down menu.

    10. Background color: Choose a custom button background color and input an eight character hex code, or select a color from the drop-down menu.

  6. Click the OK button and then the Close button. Your button will appear in the cells you selected.

Format In-Sheet Actions

By default, In-Sheet Action buttons will display as black with white text. After initial creation, customize the display of your buttons by formatting them with custom colors and styles. Modify your button using the steps below: 

  1. From the ribbon, select OneStream > General > In-Sheet Actions.

  2. In the In-Sheet Actions dialog box, select the button to format and click the Edit button.

  3. Use the Button Theme drop-down menu to select a color.

  4. Click OK and then Close to save changes.