Skip to main content

Microsoft Office Excel

Note: Users must procure and maintain valid licenses to integrate this commercial DE tool with the Istari Digital platform. Please contact your local IT administrator for assistance.

Supported Functions:​

extract
update

Getting Started​

The Microsoft Office Excel integration provides support for Microsoft Office 2019 and Office 2021, allowing users to read and modify Excel files.

Upload: Yes​

Files Supported​

The istari Digital Platform can extract from the following file types: .xlsx

All other Microsoft Office Excel file types not supported at this time. Please submit a feature request if an important file type is not supported.

Example Files​

Setup for Administrators​

Ensure that Microsoft Office Excel 2019 is installed on a Virtual Machine (VM) with Istari Digital Agent and appropriate Istari Digital Software. Verify that the installation is up to date with the latest updates from Microsoft Office 2019.

Version Compatibility​

This software was tested with Microsoft Office 2019 and Office 2021, and is intended to run in a Windows environment due to reliance on the Excel application.

Function Coverage and Outputs​

The Microsoft Office Excel software can produce a number of artifacts extracted from the Excel model. The table below describes each output artifact and its type.

RouteCoverageArtifact Content Example
Extract Charts - PNGYes
Extract Sheets - CSVYes
Named Cells - JSONYes
Chart Data - JSONYes
Worksheet Data - JSONYes
Extract workbook - PDFYes
Extract workbook - xlsxYes
Extract html_workbook - ZIPYes

Detailed SDK Reference​

Prerequisite: Install Istari Digital SDK and initialize Istari Digital Client per instructions here​

Step 1: Upload and Extract the File(s)​

Upload the file as a model​

model = client.add_model(
    path="example.xlsx",
    description="Excel example Model",
    display_name="Excel Model Name",
)
print(f"Uploaded base model with ID {model.id}")

Extract once you have the model ID​

extraction_job = client.add_job(
    model_id  = model.id,
    function  = "@istari:extract",
    tool_name = "microsoft_office_excel",
    tool_version = "2019",
    operating_system = "Windows 10",
)
print(f"Extraction started for model ID {model.id}, job ID: {extraction_job.id}")

Please choose appropriate tool_name, tool_version, and operating_system for your installation of this software.
Above is an example of how to call the function

Step 2: Check the Job Status​

extraction_job.poll_job()

Step 3: Retrieve Results​

Example​

for artifact in model.artifacts:
    output_file_path = f"c:\\extracts\\{artifact.name}"

    if artifact.extension in ["txt", "csv", "md", "json", "html"]:
        with open(output_file_path, "w") as f:
            f.write(artifact.read_text())
    else:
        with open(output_file_path, "wb") as f:
            f.write(artifact.read_bytes())

Troubleshooting​

  1. For general Agent and Software Troubleshooting Click Here
  2. Missing Artifacts:
    • 2.1 named_cells.json: Check source file, are there named cells in the file? If not, refer to the software's manual for defining appropriate requirements.
    • 2.2 charts (JSON & PNG): Check source file, does it contain any charts?
    • 2.3 embedded images: The tool doesn't extract any embedded images.

FAQ​

  • Is this usable for other versions of Microsoft Office Excel?
    • Backwards compatibility with older versions of Microsoft Office Excel is not guaranteed.