@sapui5/sap.fe.templates 1.149.0 → 1.150.0

package/src/sap/fe/templates/ListReport/ListReportController.controller.ts

@@ -22,12 +22,14 @@ import { getResourceModel } from "sap/fe/core/helpers/ResourceModelHelper";
 import * as StableIdHelper from "sap/fe/core/helpers/StableIdHelper";
 import CoreLibrary from "sap/fe/core/library";
 import type { TitleInformation } from "sap/fe/core/rootView/RootViewBaseController";
+import type { TelemetryVariantEvent } from "sap/fe/core/services/TelemetryServiceFactory";
 import type Breadcrumbs from "sap/fe/macros/Breadcrumbs";
 import type ChartType from "sap/fe/macros/Chart";
 import type FilterBarAPI from "sap/fe/macros/FilterBar";
 import type MacroAPI from "sap/fe/macros/MacroAPI";
 import type MessageButton from "sap/fe/macros/MessageButton";
 import type TableAPI from "sap/fe/macros/Table";
+import VariantManagementBB from "sap/fe/macros/VariantManagement";
 import type ChartDelegate from "sap/fe/macros/chart/ChartDelegate";
 import ChartUtils from "sap/fe/macros/chart/ChartUtils";
 import type ContentSwitcher from "sap/fe/macros/contentSwitcher/ContentSwitcher";
@@ -65,7 +67,7 @@ import IntentBasedNavigationOverride from "./overrides/IntentBasedNavigation";
 import MessageHandlerOverride from "./overrides/MessageHandler";
 import ShareOverrides from "./overrides/Share";
 import ViewStateOverrides from "./overrides/ViewState";
-
+const { VariantType } = VariantManagementBB;
 const TemplateContentView = CoreLibrary.TemplateContentView,
 	InitialLoadMode = CoreLibrary.InitialLoadMode;
 
@@ -925,11 +927,15 @@ class ListReportController extends PageController {
 				}
 			}, 0);
 		},
-		onVariantSaved(this: ListReportController): void {
+		onVariantSaved(this: ListReportController, event: UI5Event<Record<string, unknown>>): void {
 			//TODO: Should remove this setTimeOut once Variant Management provides an api to fetch the current variant key on save!!!
 			setTimeout(() => {
 				this.getExtensionAPI().updateAppState();
 			}, 1000);
+			this.trackVariantSavedTelemetry(event);
+		},
+		onVariantManaged(this: ListReportController, event: UI5Event<Record<string, unknown>>): void {
+			this.trackVariantManagedTelemetry(event);
 		},
 		onSearch(this: ListReportController): void {
 			const oFilterBar = this._getFilterBarControl() as FilterBar; // onsearch is called only if the filterbar exists
@@ -1116,6 +1122,72 @@ class ListReportController extends PageController {
 			this.setShowFooter(event.getParameter("visible"));
 		}
 	}
+
+	/**
+	 * Tracks telemetry when a new variant is saved.
+	 * @param event The save event.
+	 */
+	private async trackVariantSavedTelemetry(event: UI5Event<Record<string, unknown>>): Promise<void> {
+		if (event.getParameter("overwrite")) {
+			return;
+		}
+		if (!(await this.getAppComponent()?.getTelemetryService()?.isEnabled())) {
+			return;
+		}
+		const vmMode = this.getView().getViewData().variantManagement;
+		if (vmMode === "Page") {
+			const variantManagement = this.getView().byId("fe::PageVariantManagement") as VariantManagement | undefined;
+			if (variantManagement) {
+				this.fireTelemetry(variantManagement.getVariants().length, VariantType.PAGE);
+			}
+		} else {
+			const source = event.getSource();
+			const filterBarVM = this._getFilterBarVariantControl();
+			if (source === filterBarVM) {
+				this.fireTelemetry(filterBarVM?.getVariants().length ?? 0, VariantType.FILTER);
+			} else if (source.isA("sap.fe.macros.Table")) {
+				const tableAPI = source as unknown as TableAPI;
+				this.fireTelemetry(tableAPI?.getContent?.()?.getVariant?.()?.getVariants?.()?.length ?? 0, VariantType.TABLE);
+			}
+		}
+	}
+
+	/**
+	 * Tracks telemetry when variants are managed (e.g. deleted).
+	 * @param event The manage event.
+	 */
+	private async trackVariantManagedTelemetry(event: UI5Event<Record<string, unknown>>): Promise<void> {
+		const deletedCount: number = ((event.getParameter("deleted") as string[] | undefined) ?? []).length;
+		// The manage dialog can be closed without deleting any variants (e.g. rename or reorder only)
+		if (deletedCount === 0) {
+			return;
+		}
+		if (!(await this.getAppComponent()?.getTelemetryService()?.isEnabled())) {
+			return;
+		}
+		const vmMode = this.getView().getViewData().variantManagement;
+		if (vmMode === "Page") {
+			this.fireTelemetry(deletedCount, VariantType.PAGE);
+		} else {
+			const source = event.getSource();
+			const filterBarVM = this._getFilterBarVariantControl();
+			if (source === filterBarVM) {
+				this.fireTelemetry(deletedCount, VariantType.FILTER);
+			} else if (source.isA("sap.fe.macros.Table")) {
+				this.fireTelemetry(deletedCount, VariantType.TABLE);
+			}
+		}
+	}
+
+	/**
+	 * Stores a FE.Variant telemetry event.
+	 * @param countVariants Number of variants affected by the action.
+	 * @param variantType The variant type discriminator.
+	 */
+	private fireTelemetry(countVariants: number, variantType: TelemetryVariantEvent["parameters"]["variantType"]): void {
+		const telemetryEvent: TelemetryVariantEvent = { type: "FE.Variant", parameters: { countVariants, variantType } };
+		this.getAppComponent()?.getTelemetryService()?.storeAction(telemetryEvent);
+	}
 }
 
 export default ListReportController;

package/src/sap/fe/templates/ListReport/manifest.json

@@ -5,7 +5,7 @@
 		"type": "component",
 		"i18n": "../messagebundle.properties",
 		"applicationVersion": {
-			"version": "1.149.0"
+			"version": "1.150.0"
 		},
 		"title": "List Report",
 		"tags": {

package/src/sap/fe/templates/ListReport/view/fragments/Table.fragment.xml

@@ -20,6 +20,7 @@
 		busy="{ui>/busy}"
 		variantSelected=".handlers.onVariantSelected"
 		variantSaved=".handlers.onVariantSaved"
+		variantManaged=".handlers.onVariantManaged"
 		isAlp="{converterContext>hasMultiVisualizations}"
 		segmentedButtonPress="{= ${converterContext>hasMultiVisualizations} ? '.handlers.onSegmentedButtonPressed' : undefined }"
 		displaySegmentedButton="{converterContext>hasMultiVisualizations}"

package/src/sap/fe/templates/ListReport/view/fragments/VariantManagement.fragment.xml

@@ -18,6 +18,7 @@
 				showSetAsDefault="true"
 				select=".handlers.onVariantSelected"
 				save=".handlers.onVariantSaved"
+				manage=".handlers.onVariantManaged"
 				headerLevel="H2"
 				displayTextForExecuteOnSelectionForStandardVariant="{= ${viewData>/initialLoad} === 'Auto' ? ${sap.fe.i18n>T_LR_VARIANT_APPLY_AUTOMATICALLY_WHEN_FILTER_SET} : undefined }"
 				executeOnSelectionForStandardDefault="{= ${viewData>/initialLoad} === 'Enabled' || ${viewData>/initialLoad} === 'Auto'}"

package/src/sap/fe/templates/ObjectPage/ObjectPage.view.xml

@@ -52,8 +52,10 @@
 			>
 				<uxap:landmarkInfo>
 					<uxap:ObjectPageAccessibleLandmarkInfo
-						headerRole="{= ${internal>/hasUShell} ? 'None' : 'Banner'}"
-						headerLabel="{sap.fe.i18n>T_COMMON_OBJECT_PAGE_HEADER}"
+						rootRole="{= ${internal>/hasUShell} ? 'Region' : 'Main'}"
+						rootLabel="{= OP.getExpressionForTitle(${fullContextPath>@@UI.getDataModelObjectPath}, ${viewData>}, ${headerInfo>@@UI.getConverterContext})}"
+						headerRole="Banner"
+						headerLabel="{= OP.getExpressionForTitle(${fullContextPath>@@UI.getDataModelObjectPath}, ${viewData>}, ${headerInfo>@@UI.getConverterContext})}"
 						footerLabel="{sap.fe.i18n>T_COMMON_OBJECT_PAGE_FOOTER}"
 					/>
 				</uxap:landmarkInfo>