Jump to a Section

Overview

When you add an Excel Online card to a Flow for the first time, you’ll be prompted to create a new connection.

Note: You can create multiple connections and manage them from your Settings page.

To create a new connection from an Event or Action card:

  1. Click New Connection.
  2. Add an Connection Nickname. This should be unique, so that if your teammates authorize multiple accounts, then you will be able to tell them apart.
  3. Click “Create” to launch a pop-up window to sign into your account and save this configuration.

    Events

    • Row Added or Updated

      Start the Flow when a new row is added or updated to the worksheet.

      Options

      • Workbook (dropdown): a list of workbooks available to the account. Workbook is another word for your Excel files.
      • Worksheet (dropdown): a list of worksheets available in the selected workbook. Worksheet is the individual spreadsheet within them, displayed as tabs in Excel files.

      Output Fields

      • Row
        • Row Number (number): Number of the row Added or Updated; this is the number displayed in Excel to the left of the first column.
      • Values (text) : a list that represent each column in the row that was added or updated.
      • context
        • Execution ID (text) : The context execution identification.
    • Updated Cell

      Start the Flow when data within a cell is updated.

      Options

      • Workbook (dropdown): a list of workbooks available to the account. Workbook is another word for your Excel files.
      • Worksheet (dropdown): a list of worksheets available in the selected workbook. Worksheet is the individual spreadsheet within them, displayed as tabs in Excel files.
      • Cell Reference (text) : forexample “A1, for the first cell in the spreadsheet.

      Output Fields

      Cell Explanation
      Cell Text (text) The text in the specified cell.
      Cell Value (text) The value of the cell.
      Type _(text) _type
      Format (text) number format
      Column Hidden _(T/F) _If the column is hidden
      Row Hidden _(T/F) _If the row is hidden
      Hidden _(T/F) _If the cell is hidden
      Formula _(text) _Excel online formula
      • context
        • Execution ID (text) : the execution context unique identifier.

    Actions

    • Add Row

      This card adds a row of data to the end of a worksheet. Microsoft’s Excel API takes time to propagate changes. When more than one row is being added to a Worksheet, we recommend you add a Wait Function Card set to 10 seconds. If you see rows being omitted, add more time.

      Options

      • Workbook (dropdown): a list of workbooks available to the account. Workbook is another word for your Excel files.
      • Worksheet (dropdown): a list of worksheets available in the selected workbook. Worksheet is the individual spreadsheet within them, displayed as tabs in Excel files.

      Input Fields

      • Values : This will be the list of values for the new row.
        • Column Letters (A - ZZ) (text) : Each of the field will represent the corresponding cell in the newly created row. For example if the worksheet is empty then the first three field will be 1A, 1B, 1C.

      Output Fields

      • Row
        • Row Number (number): The newly created row’s number. This is the number displayed in Excel to the left of the first column.
    • Clear Cells

      Clear formats and/or data from the designated cells.

      Options

      • Workbook (dropdown): a list of workbooks available to the account. Workbook is another word for your Excel files.
      • Worksheet (dropdown): a list of worksheets available in the selected workbook. Worksheet is the individual spreadsheet within them, displayed as tabs in Excel files.
      • Apply to (dropdown): select what should be cleared from the cells.
        • All - clear formats and content.
        • Formats - clear formats only.
        • Contents - clear contents only.

      Input Fields

      The cell reference cells are used to construct a grid of cells to apply the clear action.

      • Cells
        • Cell Reference Begin (text): a value representing a cell (e.g. A2) in the top left corner of the grid to be cleared.
        • Cell Reference End (text): a value representing a cell (e.g. D4) in the bottom right corner of the grid to be cleared.

      Output Fields

      • Response
        • Status Code (number)
    • Custom API Action

      Make a custom, authenticated HTTP call to the Excel Online API.

      NOTE: This action is unlike other Excel Online cards; refer to the Excel Online API documentation.

      Options

      • Request Type (drop-down): one of five supported HTTP request methods (sometimes called verbs) in custom API calls:
        • GET retrieves data from a web server based on your parameters. GET requests a representation of the specified resource. If successful, GET will receive a 200 OK response message with the requested content. Refer to additional documentation here.
        • POST sends data to a web server based on your parameters. POST requests include actions like uploading a file. Multiple POSTs may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POSTs. If a POST is successful, you will receive a 200 OK response message. Refer to additional documentation here.
        • PUT sends data to a location in the web server based on your parameters. PUT requests include actions like uploading a file. The difference between a PUT and POST is that PUT is idempotent, meaning that the result of a single successful PUT is the same as many identical PUT’s. If a PUT is successful, you will receive a 200 response message (usually 201 or 204). Refer to additional documentation here.
        • PATCH applies partial modifications to a resource on a web server based on your parameters. PATCH is not idempotent, meaning that multiple PATCHs could have unintended consequences. If a PUT is successful, you will receive a 200 response message (usually 204). Refer to additional documentation here.
        • DELETE deletes the specified resource from the web server based on your parameters (if the resource exists). If a DELETE is successful, you will receive a 200 OK response message. Refer to additional documentation here.

      Input

      • Relative URL (text): The address on the web server you are attempting to interact with. Relative URL means that you don’t have to explicitly specify the protocol at the beginning of the URL (such as “http://“). This suggests to the web server that the interaction is occurring on the server (in this instance).

        Example: https://graph.microsoft.com{{input.Request.Relative URL}}
      • Query (object or text): JSON object that determines the action taken at the URL

        Example: {"name":"something-urgent"}
      • Headers (object): JSON object that determines the content type of the request. This will usually be a replica of the example below.

        Example: {"Content-type":"application/json"}

      Output

      • Status Code (number): success or failure of your HTTP request. Here is a list of all status codes.
      • Headers (object): A detailed context for the status code, unrelated to the output body. Response headers are dependent on your selected HTTP request option. Note that not all headers are response headers.
      • Body (object): data returned from your selected HTTP request (for example, the data from a GET request)
    • Delete Cells

      Delete cells from an Excel Online sheet.

      Options

      • Workbook (dropdown): a list of workbooks available to the account. Workbook is another word for your Excel files.
      • Worksheet (dropdown): a list of worksheets available in the selected workbook. Worksheet is the individual spreadsheet within them, displayed as tabs in Excel files.
      • Shift (dropdown): select how to shift cells once the delete action is completed.
        • Left - shift cells left.
        • Up - shift cells up.

      Input Fields

      The cell reference cells are used to construct a grid of cells to apply the delete action.

      • Cells
        • Cell Reference Begin (text): a value representing a cell (e.g. A2) in the top left corner of the grid to be deleted.
        • Cell Reference End (text): a value representing a cell (e.g. D4) in the bottom right corner of the grid to be deleted.

      Output Fields

      • Response
        • Status Code (number)
    • Get Cell Value

      Gets information for a cell.

      Input Fields

      • Cell
        • Cell Reference (text): In format like “ A1”, for the first cell on the spreadsheet.

      Output Fields

      Cell Explanation
      Cell Text (text) The text in the specified cell.
      Cell Value (text) The value of the cell.
      Type _(text) _type
      Format (text) number format
      Column Hidden _(T/F) _If the column is hidden
      Row Hidden _(T/F) _If the row is hidden
      Hidden _(T/F) _If the cell is hidden
      Formula _(text) _Excel online formula
    • Read All Rows

      Read all rows in a worksheet (maximum of 300).

      Options

      • Workbook (dropdown): a list of workbooks available to the account. Workbook is another word for your Excel files.
      • Worksheet (dropdown): a list of worksheets available in the selected workbook. Worksheet is the individual spreadsheet within them, displayed as tabs in Excel files.

      Input Fields

      • Offset (number) : The amount of offset of the row to read. This is the numbers displayed in Excel to the left of the first column.

      Output Fields

      • Rows (list of object) : Dynamically generated rows object based on the worksheet.
    • Read Row

      Read a row of data from an Excel Online worksheet.

      Options

      • Workbook (dropdown): a list of workbooks available to the account. Workbook is another word for your Excel files.
      • Worksheet (dropdown): a list of worksheets available in the selected workbook. Worksheet is the individual spreadsheet within them, displayed as tabs in Excel files.

      Input Fields

      • Row
        • Row Number (number): number of the row you want to read; this is the number displayed in Excel to the left of the first column.

      Output Fields

      In the field selection window, select the column letters from which you want to retrieve values.

      • Values
        • Column letter (A-ZZ) (text): a letter that identifies the column from which to read the row data. Each of the fields will represent the corresponding cell of the read row.
    • Search Rows by Column

      Search for a row or rows that match a value in a certain column.

      Options

      • Workbook (dropdown): a list of workbooks available to the account. Workbook is another word for your Excel files.
      • Worksheet (dropdown): a list of worksheets available in the selected workbook. Worksheet is the individual spreadsheet within them, displayed as tabs in Excel files.
      • Column to Search (dropdown) : The column the search will be conducted on.
      • Result Set (dropdown) : either the first matching row or all matching rows.

      Input Fields

      • Column
        • Value (text) : The column value. This is the number displayed in Excel on the top of first row.

      Output Fields

      • Result : rows that are search for.
    • Update Cell

      Updates a value within a row on Excel Online.

      Options

      Choose a workbook and worksheet in order to update a cell.

      • Workbook (dropdown): a list of workbooks available to the account. Workbook is another word for your Excel files.
      • Worksheet (dropdown): a list of worksheets available in the selected workbook. Worksheet is the individual spreadsheet within them, displayed as tabs in Excel files.

      Input Fields

      • Cell
        • Cell Reference (text): In format like “ A1”, for the first cell on the spreadsheet.
        • Value (text): the new value.
        • Formula (text): Add an excel formula. e.g.: =SUM(A2:A10), = CONCAT(A1;B5),=MAX (number1, [number2], …) etc
        • Format (text): Number format. Excel Online uses special inner format. It can be read via Get Cell Value Format output Short list of formats: Number - 0 Currency - $#,##0 Date - m/d/yyyy Percentage - 0.00% Fraction - # ?/? Scientific - 0.00E+00 Text - @ Accounting - _($* #,##0.00_);_($* (#,##0.00);_($* "-"??_);_(@_)

      Output Fields

      • Response
        • Status Code (number)
    • Update Row

      Updates a row in an Excel Online Worksheet.

      Input Fields

      • Row
        • Row Number (number): the row number.
      • Values
        • Columns (A, B, C…) (text): the values to be inputted at the column location in the row.

      Output Fields

      • Response
        • Status Code (number)