fetch_dashboard_framework_summary
Retrieve a compliance dashboard summary for a specified period and common control framework, providing control statuses, assignments, due dates, and scores for audit and tracking.
Instructions
Function Overview: CCF Dashboard Summary Retrieval
This function returns a summary dashboard for a specified compliance period and Common Control Framework (CCF). It is designed to provide a high-level view of control statuses within a given framework and period, making it useful for compliance tracking, reporting, and audits.
Args:
period:
The compliance quarter for which the dashboard data is requested.
Format:"Q1 2024"framework_name:
The name of the Common Control Framework whose data is to be retrieved.
Dashboard Overview
The dashboard provides a consolidated view of all controls under the specified framework and period. It includes key information such as assignment status, compliance progress, due dates, and risk scoring to help stakeholders monitor and manage compliance posture.
Returns: - controls (List[FramworkControlVO]): A list of framework controls. - name (str): Name of the control. - assignedTo (str): Email ID of the user the control is assigned to. - assignmentStatus (str): Status of the control assignment. - complianceStatus (str): Compliance status of the control. - dueDate (str): Due date for completing the control. - score (float): Score assigned to the control. - priority (str): Priority level of the control. - page (int): Current page number in the overall result set. - totalPage (int): Total number of pages. - totalItems (int): Total number of items. - error (Optional[str]): An error message if any issues occurred during retrieval.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| period | Yes | ||
| framework_name | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| controls | No | ||
| page | No | ||
| totalPage | No | ||
| totalItems | No | ||
| error | No |