smart_retrieve
Retrieve financial consolidation data from Oracle EPM Cloud FCCS by specifying account, entity, period, years, scenario, and consolidation dimensions for analysis.
Instructions
Smart data retrieval with automatic 14-dimension handling / Recuperacao inteligente
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| account | Yes | The Account member (e.g., 'FCCS_Net Income') | |
| entity | No | The Entity member (default: 'FCCS_Total Geography') | |
| period | No | The Period member (default: 'Jan') | |
| years | No | The Years member (default: 'FY24') | |
| scenario | No | The Scenario member (default: 'Actual') | |
| consolidation | No | The Consolidation member (default: 'FCCS_Entity Total'). Valid values: 'FCCS_Entity Input', 'FCCS_Entity Consolidation', 'FCCS_Entity Total', 'FCCS_Proportion', 'FCCS_Elimination', 'FCCS_Contribution'. |
Implementation Reference
- fccs_agent/tools/data.py:38-77 (handler)The main handler function for smart_retrieve tool. Builds a 14-dimension grid definition with defaults and exports data slice from Consol cube.async def smart_retrieve( account: str, entity: str = "FCCS_Total Geography", period: str = "Jan", years: str = "FY24", scenario: str = "Actual", consolidation: str = "FCCS_Entity Total" ) -> dict[str, Any]: """Smart data retrieval with automatic 14-dimension handling / Recuperacao inteligente de dados. Args: account: The Account member (e.g., 'FCCS_Net Income'). entity: The Entity member (default: 'FCCS_Total Geography'). period: The Period member (default: 'Jan'). years: The Years member (default: 'FY24'). scenario: The Scenario member (default: 'Actual'). consolidation: The Consolidation member (default: 'FCCS_Entity Total'). Valid values: 'FCCS_Entity Input', 'FCCS_Entity Consolidation', 'FCCS_Entity Total', 'FCCS_Proportion', 'FCCS_Elimination', 'FCCS_Contribution'. Returns: dict: The retrieved data for the specified dimensions. """ # Build grid definition with hardcoded defaults for 14 dimensions grid_definition = { "suppressMissingBlocks": True, "pov": { "members": [ [years], [scenario], ["FCCS_YTD"], [consolidation], ["FCCS_Intercompany Top"], ["FCCS_Total Data Source"], ["FCCS_Mvmts_Total"], [entity], ["Entity Currency"], ["Total Custom 3"], ["Total Region"], ["Total Venturi Entity"], ["Total Custom 4"] ] }, "columns": [{"members": [[period]]}], "rows": [{"members": [[account]]}] } result = await _client.export_data_slice(_app_name, "Consol", grid_definition) return {"status": "success", "data": result}
- fccs_agent/tools/data.py:292-324 (schema)Input schema definition for the smart_retrieve tool within the TOOL_DEFINITIONS list.{ "name": "smart_retrieve", "description": "Smart data retrieval with automatic 14-dimension handling / Recuperacao inteligente", "inputSchema": { "type": "object", "properties": { "account": { "type": "string", "description": "The Account member (e.g., 'FCCS_Net Income')", }, "entity": { "type": "string", "description": "The Entity member (default: 'FCCS_Total Geography')", }, "period": { "type": "string", "description": "The Period member (default: 'Jan')", }, "years": { "type": "string", "description": "The Years member (default: 'FY24')", }, "scenario": { "type": "string", "description": "The Scenario member (default: 'Actual')", }, "consolidation": { "type": "string", "description": "The Consolidation member (default: 'FCCS_Entity Total'). Valid values: 'FCCS_Entity Input', 'FCCS_Entity Consolidation', 'FCCS_Entity Total', 'FCCS_Proportion', 'FCCS_Elimination', 'FCCS_Contribution'.", }, }, "required": ["account"], },
- fccs_agent/agent.py:160-160 (registration)Registration of the smart_retrieve handler in the TOOL_HANDLERS dictionary."smart_retrieve": data.smart_retrieve,