Workbook Export (Preview)

oracle_analytics-export_workbook

Input Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "canvasIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "format": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "screenHeight": {
      "type": "integer"
    },
    "screenWidth": {
      "type": "integer"
    },
    "workbookId": {
      "type": "string"
    }
  }
}

Exports a workbook to PNG or PDF. The tool creates an export request, polls the work request, and fetches the resulting artifact.

Import Parameters

Parameter	Type	Notes
workbookId	string	Base64url workbook catalog ID. Required.
format	string	png or pdf. Required.
name	string	Optional export name.
canvasIds	string[]	Optional list of canvas IDs. If omitted, canvases are auto-resolved
screenWidth	integer	Optional viewport width. Default is typically 1920.
screenHeight	integer	Optional viewport height. Default is typically 1080.

Example - Export All Canvases to PDF

{
  "jsonrpc": "2.0",
  "id": 60,
  "method": "tools/call",
  "params": {
    "name": "oracle_analytics-export_workbook",
    "arguments": {
      "workbookId": "base64url-workbook-id",
      "format": "pdf",
      "name": "Revenue Overview Export",
      "screenWidth": 1920,
      "screenHeight": 1080
    }
  }
}

Example - Export Selected Canvases to PNG

{
  "jsonrpc": "2.0",
  "id": 61,
  "method": "tools/call",
  "params": {
    "name": "oracle_analytics-export_workbook",
    "arguments": {
      "workbookId": "base64url-workbook-id",
      "format": "png",
      "canvasIds": ["canvas-1", "canvas-2"],
      "screenWidth": 1440,
      "screenHeight": 900
    }
  }
}

Typical Outputs

• PNG exports return image content.
• PDF exports return an embedded or blob resource.
• Long-running export failures usually indicate workbook rendering issues, invalid canvas IDs, permissions, or server-side export limits.