Turn Dashboards into a dropdown and automatically populate it with the dashboards you have added to the app. Dashboard names and files are also now prefixed with the name of the app, making them easier to search for.

Author: pyth0n1c

contentctl/objects/constants.py

@@ -123,6 +123,8 @@
 CONTENTCTL_DETECTION_STANZA_NAME_FORMAT_TEMPLATE = (
     "{app_label} - {detection_name} - Rule"
 )
+
+CONTENTCTL_DASHBOARD_LABEL_TEMPLATE = "{app_label} - {dashboard_name}"
 CONTENTCTL_BASELINE_STANZA_NAME_FORMAT_TEMPLATE = "{app_label} - {detection_name}"
 CONTENTCTL_RESPONSE_TASK_NAME_FORMAT_TEMPLATE = (
     "{app_label} - {detection_name} - Response Task"

contentctl/objects/dashboard.py

@@ -1,12 +1,14 @@
+import json
+import pathlib
+from enum import StrEnum
 from typing import Any
-from pydantic import Field, Json, model_validator
 
-import pathlib
 from jinja2 import Environment
-import json
-from contentctl.objects.security_content_object import SecurityContentObject
+from pydantic import Field, Json, model_validator
+
 from contentctl.objects.config import build
-from enum import StrEnum
+from contentctl.objects.constants import CONTENTCTL_DASHBOARD_LABEL_TEMPLATE
+from contentctl.objects.security_content_object import SecurityContentObject
 
 DEFAULT_DASHBAORD_JINJA2_TEMPLATE = """<dashboard version="2" theme="{{ dashboard.theme }}">
     <label>{{ dashboard.label(config) }}</label>
@@ -49,7 +51,9 @@ class Dashboard(SecurityContentObject):
     )
 
     def label(self, config: build) -> str:
-        return f"{config.app.label} - {self.name}"
+        return CONTENTCTL_DASHBOARD_LABEL_TEMPLATE.format(
+            app_label=config.app.label, dashboard_name=self.name
+        )
 
     @model_validator(mode="before")
     @classmethod
@@ -98,7 +102,9 @@ def pretty_print_json_obj(self):
         return json.dumps(self.json_obj, indent=4)
 
     def getOutputFilepathRelativeToAppRoot(self, config: build) -> pathlib.Path:
-        filename = f"{self.file_path.stem}.xml".lower()
+        # for clarity, the name of the dashboard file will follow the same convention
+        # as we use for detections, prefixing it with app_name -
+        filename = f"{self.label(config)}.xml"
         return pathlib.Path("default/data/ui/views") / filename
 
     def writeDashboardFile(self, j2_env: Environment, config: build):