smart_retrieve_consolidation_breakdown

Instructions

Implementation Reference

• fccs_agent/tools/data.py:80-162 (handler)

  The main asynchronous handler function that implements the core logic of the smart_retrieve_consolidation_breakdown tool. It retrieves financial data for all consolidation dimension members (Entity Input, Consolidation, Total, Proportion, Elimination, Contribution) by making multiple data export calls.

  async def smart_retrieve_consolidation_breakdown(
      account: str,
      entity: str = "FCCS_Total Geography",
      period: str = "Jan",
      years: str = "FY24",
      scenario: str = "Actual"
  ) -> dict[str, Any]:
      """Retrieve all Consolidation dimension members for an entity / Recuperar todos os membros da dimensao Consolidation.
  
      This function retrieves FCCS_Entity Input, FCCS_Entity Consolidation, FCCS_Entity Total,
      FCCS_Proportion, FCCS_Elimination, and FCCS_Contribution for a given entity.
  
      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').
  
      Returns:
          dict: The retrieved data for all Consolidation members.
      """
      consolidation_members = [
          "FCCS_Entity Input",
          "FCCS_Entity Consolidation",
          "FCCS_Entity Total",
          "FCCS_Proportion",
          "FCCS_Elimination",
          "FCCS_Contribution"
      ]
      
      results = {}
      for consol_member in consolidation_members:
          try:
              grid_definition = {
                  "suppressMissingBlocks": True,
                  "pov": {
                      "members": [
                          [years], [scenario], ["FCCS_YTD"], [consol_member],
                          ["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)
              
              # Extract value from result
              value = 0.0
              if result and "rows" in result and len(result["rows"]) > 0:
                  row = result["rows"][0]
                  if "data" in row and len(row["data"]) > 0:
                      try:
                          value = float(row["data"][0])
                      except (ValueError, TypeError):
                          value = 0.0
              
              results[consol_member] = value
          except Exception as e:
              results[consol_member] = 0.0
      
      return {
          "status": "success",
          "data": {
              "entity": entity,
              "account": account,
              "period": period,
              "years": years,
              "scenario": scenario,
              "consolidation_breakdown": results,
              "summary": {
                  "entity_input": results.get("FCCS_Entity Input", 0.0),
                  "entity_consolidation": results.get("FCCS_Entity Consolidation", 0.0),
                  "entity_total": results.get("FCCS_Entity Total", 0.0),
                  "proportion": results.get("FCCS_Proportion", 0.0),
                  "elimination": results.get("FCCS_Elimination", 0.0),
                  "contribution": results.get("FCCS_Contribution", 0.0)
              }
          }
      }

• fccs_agent/tools/data.py:326-355 (schema)

  The input schema definition for the smart_retrieve_consolidation_breakdown tool, defining parameters like account (required), entity, period, years, scenario with descriptions and types.

  {
      "name": "smart_retrieve_consolidation_breakdown",
      "description": "Retrieve all Consolidation dimension members (Entity Input, Entity Consolidation, Entity Total, Proportion, Elimination, Contribution) for an entity / Recuperar todos os membros da dimensao Consolidation para uma entidade",
      "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')",
              },
          },
          "required": ["account"],
      },
  },

• fccs_agent/agent.py:161-161 (registration)

  Registration of the tool handler in the central TOOL_HANDLERS dictionary, mapping the tool name to the imported function from data module.

  "smart_retrieve_consolidation_breakdown": data.smart_retrieve_consolidation_breakdown,