Build a Smart View workbook
build_smart_view_reportmode is required: functions for shared-connection HsGetValue report sheets that refresh, or members for plain member grids with no formulas. A call without mode fails with a message naming both choices. Functions mode includes cached numbers, two-column variances and companion Grid sheets. Shared POV arguments apply to up to ten tabs, each with a title, row and column dimensions and local member overrides. Two or more function tabs share a Control sheet whose members apply to every Report tab on Refresh All. All tabs together must fit the policy's cell limit. Notes explains the selected connection. Functions mode can use a named private connection. Demo data stays plain numbers. Returns a download link for one hour. Use it to take numbers into Excel.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"mode": "<mode>"
},
"name": "build_smart_view_report"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pov | No | Members for any other dimension, for example { Version: "NSP_Base", Currency: "USD" }; dimensions you leave out use their top member | |
| mode | Yes | Required user choice: functions for Refresh All, or members for ad hoc analysis. Required. | |
| rows | No | Dimension names to put on rows, e.g. ["Account", "Department"]. Defaults to the account dimension. | |
| tabs | No | Up to ten report tabs. Shared POV is given at the top level. A tab may override members with pov or scenario/year/entity/period/account. Rows and columns name axis dimensions. | |
| year | No | Year member, e.g. FY26 or FY24 | |
| fresh | No | Set true to ignore the scenario, year, entity, cube and pov remembered from the user's previous request, start from scratch and read Oracle again even inside the policy's cache window. | |
| title | No | Workbook title and file name | |
| entity | No | Entity member, e.g. North America. Goes to the cube's entity-like dimension (Entity, Subsidiary, Company). | |
| period | No | Period member or comma-separated list, e.g. Jan, Q1 or TP1,TP2,TP3. Member functions such as ILvl0Descendants(YearTotal) work. Defaults to level 0 members under YearTotal. | |
| account | No | Account member or comma-separated list, e.g. Revenue or Descendants(Net Income). Defaults to all level 0 accounts. | |
| appName | No | Application name. Defaults to the connection's application. | |
| columns | No | Dimension names to put on columns, e.g. ["Period"] or ["Period", "Scenario"]. Defaults to the period dimension. | |
| planType | No | Cube (plan type) to export from, e.g. Plan1 or NSP_NFS. When the application has one cube it is used; with several, pass one. Otherwise Plan1. | |
| scenario | No | Scenario member, e.g. Actual, Plan, NSP_Actual | |
| connection | No | Connection id or label from list_connections. Defaults to the user's default connection. | |
| includeData | No | false omits cached numbers and leaves member grids empty; default true | |
| planningData | No | Set true to read through the application's form engine (Smart List labels, form-level security) instead of the plain cube export. The cube export is the default because the form engine returns nothing when a parent member is in the point of view. | |
| privateConnection | No | Exact Smart View private connection name for functions mode. Keep its spaces and case; no # or |. Members mode ignores it. |