Create Workbook Session
ms_excel.create_session
ActionFiles & storageconnection required
Calls the Microsoft Excel API with the connection's credentials.
Open a workbook session and return its id, so a run of several reads and writes shares one Excel transaction instead of one per call.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Microsoft Excel
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"} with the Files.ReadWrite delegated scope
- Config it needs
- tenant, drive_id, site_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
drive_id The drive holding the workbook. Leave blank for the connected user's own OneDrive (/me/drive). Ignored when site_id is set. | string | No | — | — | — |
site_id A SharePoint site id when the workbook lives in that site's document library, as 'hostname,siteCollectionId,siteId'. Takes precedence over drive_id. | string | No | — | — | — |
item_id The workbook file's driveItem id, addressing it as /items/{item-id}. Takes precedence over item_path when both are set. | string | No | — | — | — |
item_path The workbook's path inside the drive, e.g. 'Reports/Q3.xlsx', addressing it as /root:/Reports/Q3.xlsx:. Used when item_id is blank. | string | No | — | — | — |
persist_changes Save changes made in the session to the file. Turn this off for a read-only session that must not modify the workbook. | boolean | No | true | — | — |
- At least one of item_id, item_path must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"persist_changes": true
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
session_id Pass this as session_id on later Excel steps. | string | — |
persist_changes Whether the session saves its changes. | boolean | — |
{
"persist_changes": false,
"session_id": ""
}Related Microsoft Excel nodes
See Create Workbook Session run in a workflow.
In a technical demo we add the Microsoft Excel connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.