Skip to main content

Microsoft 365 Excel - Download Data from Workbook to Shipyard

Overview​

This blueprint can be used to download data from an Excel Sheet to Shipyard. The Sheet Name must be specified, otherwise it will default to Sheet1. The downloaded file will be a CSV.

Variables​

NameReferenceTypeRequiredDefaultOptionsDescription
Client IDEXCEL_CLIENT_IDPasswordβœ…--The Client ID of the app created in Azure
Client SecretEXCEL_CLIENT_SECRETPasswordβœ…--The secret value of the app created in Azure
TenantEXCEL_TENANTPasswordβœ…--The ID of the tenant associated with the app
User EmailEXCEL_USER_EMAILAlphanumericβœ…--The email address of the user to impersonate
OneDrive FolderEXCEL_ONEDRIVE_FOLDERAlphanumericβž–--The optional folder name of where to save the Excel workbook in OneDrive. If omitted, the file will be saved in the root
OneDrive File NameEXCEL_ONEDRIVE_FILE_NAMEAlphanumericβœ…--The name of the file once loaded to OneDrive. If omitted, the original file name will be used
Sheet NameEXCEL_SHEET_NAMEAlphanumericβž–Sheet1-The name of the sheet containing the data
Shipyard Folder NameEXCEL_LOCAL_FOLDER_NAMEAlphanumericβž–--The optional directory in Shipyard where the file resides
Shipyard File NameEXCEL_SRC_FILE_NAMEAlphanumericβž–--The name of the file to load to Excel (must be either a csv or xlsx file)

YAML​

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
blueprint: Microsoft 365 Excel - Download Data from Workbook to Shipyard
inputs:
EXCEL_CLIENT_ID: null ## REQUIRED
EXCEL_CLIENT_SECRET: null ## REQUIRED
EXCEL_TENANT: null ## REQUIRED
EXCEL_USER_EMAIL: null ## REQUIRED
EXCEL_ONEDRIVE_FOLDER: null
EXCEL_ONEDRIVE_FILE_NAME: null ## REQUIRED
EXCEL_SHEET_NAME: Sheet1
EXCEL_LOCAL_FOLDER_NAME: null
EXCEL_SRC_FILE_NAME: null
type: BLUEPRINT
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- '180'
- '181'
- '182'
- '183'
- '184'
- '200'
- '202'
- '203'
- '249'