Action Implementation

dotnetprog · dotnetprog · commit 1fa4d379347d · 2025-09-15T22:46:16.000-04:00
diff --git a/src/broadcast-typescript/app/modules/common/utility/context.ts b/src/broadcast-typescript/app/modules/common/utility/context.ts
@@ -1,9 +1,11 @@
+import { fdn_language } from "@app/modules/domain";
+
 export function getUserLangFromGlobalContext(){
     const userLang = Xrm.Utility.getGlobalContext().userSettings.languageId;
     switch(userLang){
         case 1036:
-            return 794560002;
+            return fdn_language.French;
         default:
-            return 794560001;
+            return fdn_language.English;
     }
 }
diff --git a/src/broadcast-typescript/app/modules/domain/entities/fdn_broadcastappnotification.ts b/src/broadcast-typescript/app/modules/domain/entities/fdn_broadcastappnotification.ts
@@ -1,4 +1,5 @@
 import { entity ,fdn_localizednotificationcontent} from ".";
+import { fdn_actiontype } from "../optionsets";
 
 export enum fdn_level {
     Success = 794560000,
@@ -8,9 +9,13 @@ export enum fdn_level {
 }
 export class fdn_broadcastappnotification extends entity {
     fdn_level?: fdn_level;
+    fdn_actiontype?: fdn_actiontype;
     fdn_message?: string;
     fdn_name?: string;
     fdn_appmoduleid?: string
     fdn_broadcastappnotificationid?: string;
+    fdn_buttondefaulttext?: string;
+    fdn_buttonactionurl?: string;
     fdn_localizednotificationcontent_AppNotificationConfigId_fdn_broadcastappnotification?:fdn_localizednotificationcontent[];
+
 }
diff --git a/src/broadcast-typescript/app/modules/domain/entities/fdn_localizednotificationcontent.ts b/src/broadcast-typescript/app/modules/domain/entities/fdn_localizednotificationcontent.ts
@@ -1,11 +1,12 @@
 import { entity } from ".";
 export enum fdn_language {
-    English = 794560000,
-    French = 794560001,
+    English = 794560001,
+    French = 794560002,
 }
 export type fdn_localizednotificationcontent = entity &{
     fdn_localizednotificationcontentid?:string;
     fdn_language?:fdn_language;
     fdn_name?:string;
     fdn_contentmessage?:string;
+    fdn_actionbuttondisplaytext?:string;
 }
diff --git a/src/broadcast-typescript/app/modules/domain/index.ts b/src/broadcast-typescript/app/modules/domain/index.ts
@@ -1,2 +1,3 @@
 export * from './entities';
-export * from './model';
+export * from './model';
+export * from './optionsets';
diff --git a/src/broadcast-typescript/app/modules/domain/optionsets/fdn_actiontype.ts b/src/broadcast-typescript/app/modules/domain/optionsets/fdn_actiontype.ts
@@ -0,0 +1,3 @@
+export enum fdn_actiontype {
+    WebLink = 794560000
+}
diff --git a/src/broadcast-typescript/app/modules/domain/optionsets/index.ts b/src/broadcast-typescript/app/modules/domain/optionsets/index.ts
@@ -0,0 +1 @@
+export * from './fdn_actiontype'
diff --git a/src/broadcast-typescript/app/modules/form/fdn_broadcastappnotification.ts b/src/broadcast-typescript/app/modules/form/fdn_broadcastappnotification.ts
@@ -0,0 +1,37 @@
+import * as utilities from "@app/modules/common/utility";
+import { fdn_actiontype } from "@app/modules/domain";
+const ActionTypeSectionMapping = {
+    [fdn_actiontype.WebLink.toString()]: {
+        name:"tab_action_section_url",
+        mandatoryFields:['fdn_buttondefaulttext','fdn_buttonactionurl']
+    }
+}
+export default class {
+    //broadcast.forms.fdn_broadcastappnotification.onLoad
+    async onLoad(executionContext: Xrm.Events.LoadEventContext) {
+        const formContext = executionContext.getFormContext();
+
+        utilities.registerOnChangeHandler(formContext, 'fdn_actiontype', this.onActionTypeChange, this);
+
+        displayActionSectionAccordingToType(formContext);
+    }
+    async onActionTypeChange(executionContext: Xrm.Events.EventContext) {
+        const formContext = executionContext.getFormContext();
+        displayActionSectionAccordingToType(formContext);
+    }
+}
+function displayActionSectionAccordingToType(formContext: Xrm.FormContext) {
+
+    const actionTypeAttribute = formContext.getAttribute<Xrm.Attributes.OptionSetAttribute>("fdn_actiontype")!;
+    const tab = formContext.ui.tabs.get("tab_action")!;
+    const currentActionType = actionTypeAttribute.getValue() ?? -1;
+    for(let key in ActionTypeSectionMapping) {
+        const config = ActionTypeSectionMapping[key as keyof typeof ActionTypeSectionMapping];
+        const isSectionVisible = currentActionType.toString() === key;
+        tab.sections.get(config.name)?.setVisible(isSectionVisible);
+        config.mandatoryFields.forEach(fieldName => {
+            formContext.getAttribute(fieldName)?.setRequiredLevel(isSectionVisible ? "required" : "none");
+        });
+    }
+
+}
diff --git a/src/broadcast-typescript/app/modules/form/index.ts b/src/broadcast-typescript/app/modules/form/index.ts
@@ -1,10 +1,15 @@
 import { lazy } from "@app/modules/common/system";
 import fdn_localizednotificationcontent from "./fdn_localizednotificationcontent";
+import fdn_broadcastappnotification from "./fdn_broadcastappnotification";
 
 class Forms{
     @lazy
     get fdn_localizednotificationcontent():fdn_localizednotificationcontent{
         return new fdn_localizednotificationcontent();
     } 
+    @lazy
+    get fdn_broadcastappnotification():fdn_broadcastappnotification{
+        return new fdn_broadcastappnotification();
+    }
 }
 export const forms = new Forms();
diff --git a/src/broadcast-typescript/app/modules/ribbon/application.ts b/src/broadcast-typescript/app/modules/ribbon/application.ts
@@ -1,6 +1,5 @@
-import { notificationStore,broadcastNotificationService } from "@app/modules/services";
-import { fdn_broadcastappnotification, fdn_level, NotificationUI } from "@app/modules/domain";
-import * as utilities from '@app/modules/common/utility';
+import { notificationStore,broadcastNotificationService,clientNotificationFactory } from "@app/modules/services";
+import { NotificationUI } from "@app/modules/domain";
 export default class {
     //broadcast.ribbon.application.renderNotifications
     async renderNotifications(targetpage?:string){
@@ -12,7 +11,6 @@ export default class {
                 return false;
             }
 
-            const userLang = utilities.getUserLangFromGlobalContext();
             console.log("broadcast renderNotifications");
             const appProps = await Xrm.Utility.getGlobalContext().getCurrentAppProperties();
             if(!appProps || !appProps.appId){
@@ -24,7 +22,7 @@ export default class {
             await Promise.all(clearTasks);
             const data:NotificationUI[] = [];
             for(const n of livenotifications){
-                const dataverseNotification = MapNotificationToDataverse(n,userLang);
+                const dataverseNotification =clientNotificationFactory.create(n);
                 const uid = await Xrm.App.addGlobalNotification(dataverseNotification);
                 data.push({
                     uid,
@@ -42,33 +40,3 @@ export default class {
     }
 
 }
-function MapNotificationToDataverse(n:fdn_broadcastappnotification,userLang:number):Xrm.App.Notification{
-    const level = MapToLevel(n.fdn_level!);
-    let msg = n.fdn_message;
-    const localizedMsgObjs = n.fdn_localizednotificationcontent_AppNotificationConfigId_fdn_broadcastappnotification;
-    if(localizedMsgObjs && localizedMsgObjs.length > 0){
-        msg = localizedMsgObjs.find((v)=> v.fdn_language === userLang)?.fdn_contentmessage ?? n.fdn_message;
-    }
-    return {
-        level: level,
-        message: msg!,
-        showCloseButton: false,
-        type: 2
-    };
-}
-function MapToLevel(level:number):number{
-    switch(level){
-        case fdn_level.Success:
-            return 1;
-        case fdn_level.Danger:
-            return 2;
-        case fdn_level.Warning:
-            return 3;
-        case fdn_level.Information:
-            return 4;
-        default:
-            return 4;
-    }
-   
-
-}
diff --git a/src/broadcast-typescript/app/modules/services/BroadcastNotificationService.ts b/src/broadcast-typescript/app/modules/services/BroadcastNotificationService.ts
@@ -36,9 +36,13 @@ export class BroadcastNotificationService implements IBroadcastNotificationServi
         const columns = ["fdn_appmoduleid",
             "fdn_message",
             "fdn_broadcastappnotificationid",
-            "fdn_level"
+            "fdn_level",
+            "fdn_buttondefaulttext",
+            "fdn_buttonactionurl",
+            "fdn_actiontype"
         ];
-        const expandOptions = `&$expand=fdn_localizednotificationcontent_AppNotificationConfigId_fdn_broadcastappnotification($select=fdn_contentmessage,fdn_language;$filter=statecode eq 0)`;
+        const expandColumns = ['fdn_language','fdn_contentmessage','fdn_actionbuttondisplaytext'];
+        const expandOptions = `&$expand=fdn_localizednotificationcontent_AppNotificationConfigId_fdn_broadcastappnotification($select=${expandColumns.join(',')};$filter=statecode eq 0)`;
         const queryOptions = `?$select=${columns.join(',')}`+expandOptions+filterOptions;
         const result = await this.webApi.retrieveMultipleRecords("fdn_broadcastappnotification", queryOptions);
         const notifications = result.entities as fdn_broadcastappnotification[];
@@ -63,13 +67,16 @@ function cleanNotification(e:fdn_broadcastappnotification){
         "fdn_message",
         "fdn_broadcastappnotificationid",
         "fdn_level",
-        "fdn_localizednotificationcontent_AppNotificationConfigId_fdn_broadcastappnotification"];
+        "fdn_localizednotificationcontent_AppNotificationConfigId_fdn_broadcastappnotification",
+        "fdn_buttondefaulttext",
+        "fdn_buttonactionurl",
+        "fdn_actiontype"];
     let n = removeODataGarbages(e,keysToKeep);
     const lmg = n.fdn_localizednotificationcontent_AppNotificationConfigId_fdn_broadcastappnotification;
     if(!lmg || lmg.length === 0){
         return n;
     }
-    lmg.map(l => removeODataGarbages(l,["fdn_contentmessage","fdn_language"]));
+    lmg.map(l => removeODataGarbages(l,["fdn_contentmessage","fdn_language","fdn_actionbuttondisplaytext"]));
     return n;
 }
 function removeODataGarbages<T>(e:T,keys:string[]){
diff --git a/src/broadcast-typescript/app/modules/services/XrmAppNotificationFactory.ts b/src/broadcast-typescript/app/modules/services/XrmAppNotificationFactory.ts
@@ -0,0 +1,42 @@
+import { fdn_actiontype, fdn_broadcastappnotification, fdn_level, fdn_localizednotificationcontent } from "@app/modules/domain";
+import * as utilities from '@app/modules/common/utility';
+const LevelMappings = {
+    [fdn_level.Success.toString()]: 1,
+    [fdn_level.Danger.toString()]: 2,
+    [fdn_level.Warning.toString()]: 3,
+    [fdn_level.Information.toString()]: 4
+};
+
+export interface IClientAppNotificationFactory{
+    create(n:fdn_broadcastappnotification):Xrm.App.Notification;
+}
+export class XrmAppNotificationFactory implements IClientAppNotificationFactory{
+    private _buildAction = (n:fdn_broadcastappnotification,localizedContent?:fdn_localizednotificationcontent) => {
+        if(n.fdn_actiontype == fdn_actiontype.WebLink){
+            return {
+                actionLabel:localizedContent?.fdn_actionbuttondisplaytext ?? n.fdn_buttondefaulttext!,
+                eventHandler:  () => {
+                    window.open(n.fdn_buttonactionurl!, "_blank");
+                }
+            }
+        }
+        return undefined;
+    };
+    create(n:fdn_broadcastappnotification):Xrm.App.Notification{
+        const userLang = utilities.getUserLangFromGlobalContext();
+        const level = LevelMappings[n.fdn_level!.toString()];
+            let msg = n.fdn_message;
+            const localizedMsgObjs = n.fdn_localizednotificationcontent_AppNotificationConfigId_fdn_broadcastappnotification;
+            const localizedObj = localizedMsgObjs && localizedMsgObjs.length > 0 ? localizedMsgObjs.find((v)=> v.fdn_language === userLang) : undefined;
+            if(localizedObj !== undefined && localizedObj !== null){
+                msg = localizedObj.fdn_contentmessage ?? n.fdn_message;
+            }
+            return {
+                level: level,
+                message: msg!,
+                showCloseButton: false,
+                type: 2,
+                action: this._buildAction(n,localizedObj)
+            };
+    }
+}
diff --git a/src/broadcast-typescript/app/modules/services/index.ts b/src/broadcast-typescript/app/modules/services/index.ts
@@ -2,8 +2,9 @@ import { BroadcastNotificationService, IBroadcastNotificationService } from "./B
 import {  INotificationStore,StorageNotificationStore} from "./notifications.store";
 export * from "./BroadcastNotificationService";
 export * from "./notifications.store";
+import { IClientAppNotificationFactory,XrmAppNotificationFactory} from "./XrmAppNotificationFactory";
 
 
-
+export const clientNotificationFactory:IClientAppNotificationFactory = new XrmAppNotificationFactory();
 export const notificationStore:INotificationStore = new StorageNotificationStore(window.localStorage);
 export const broadcastNotificationService:IBroadcastNotificationService = new BroadcastNotificationService(Xrm.WebApi,window.sessionStorage);
diff --git a/src/broadcast-typescript/tests/XrmTestDriver.ts b/src/broadcast-typescript/tests/XrmTestDriver.ts
@@ -0,0 +1,69 @@
+import { FormSelectorMock, UserSettingsMock, XrmMockGenerator, XrmStaticMock,ItemCollectionMock,FormItemMock, ContextMock, ClientContextMock, UiMock } from "xrm-mock";
+
+export class XrmTestDriver {
+    
+    private userSettingsBuilder:XrmUserSettingsBuilder = new XrmUserSettingsBuilder();
+    private formBuilder:XrmFormBuilder = new XrmFormBuilder();
+    private clientType:Xrm.Client = "Web";
+    ConfigureUserSettings(fn:(u:XrmUserSettingsBuilder) => void):XrmTestDriver{
+        fn(this.userSettingsBuilder);
+        return this;
+    }
+    ConfigureForm(fn:(f:XrmFormBuilder) => void):XrmTestDriver{
+        fn(this.formBuilder);
+        return this;
+    }
+    
+    public build():XrmStaticMock{
+        const xrmMock = XrmMockGenerator.initialise({
+            context: new ContextMock({
+                clientContext: new ClientContextMock(this.clientType,'Online'),
+                orgUniqueName: "",
+                userSettings: this.userSettingsBuilder.build()
+            }),
+            ui:new UiMock({
+                formSelector: this.formBuilder.build()
+            })
+        });
+        return xrmMock;
+    }
+}
+class XrmUserSettingsBuilder{
+    _userLcid:number = 1033
+    PreferFrench():XrmUserSettingsBuilder{
+        this._userLcid = 1036;
+        return this;
+    }
+    public build():UserSettingsMock{
+        return new UserSettingsMock(
+        {
+            isGuidedHelpEnabled: false,
+            isHighContrastEnabled: false,
+            isRTL: false,
+            securityRolePrivileges: [],
+            securityRoles: [],
+            userId: "{00000000-0000-0000-0000-000000000000}",
+            userName: "jdoe",
+            languageId: this._userLcid
+        });
+    }
+    
+}
+class XrmFormBuilder{
+    _formType:XrmEnum.FormType = XrmEnum.FormType.Update;
+    public AsCreateForm():XrmFormBuilder{
+        this._formType = XrmEnum.FormType.Create;
+        return this;
+    }
+    public build():FormSelectorMock{
+        const itemMocks:ItemCollectionMock<FormItemMock> = new ItemCollectionMock<FormItemMock>([
+            new FormItemMock({
+                id: "form1",
+                label: "Main Form",
+                formType:this._formType,
+                currentItem: true
+            }),
+        ]);
+        return new FormSelectorMock(itemMocks);
+    }
+}
diff --git a/src/broadcast-typescript/tests/fakers/fdn_broadcastappnotification.faker.ts b/src/broadcast-typescript/tests/fakers/fdn_broadcastappnotification.faker.ts
@@ -1,13 +1,26 @@
-import { fdn_broadcastappnotification, fdn_level } from '@app/modules/domain';
+import { fdn_actiontype, fdn_broadcastappnotification, fdn_level } from '@app/modules/domain';
 import { faker } from '@faker-js/faker';
-import { createRandomLocalizedContent } from './fdn_localizednotificationcontent.faker';
-export function createRandomAppNotification(appid:string):fdn_broadcastappnotification{
+import { createBilingualLocalizedContents } from './fdn_localizednotificationcontent.faker';
+export function createRandomAppNotificationWithNoAction(appid:string,localized:boolean = true):fdn_broadcastappnotification{
     return {
         fdn_appmoduleid: appid,
         fdn_broadcastappnotificationid: faker.string.uuid(),
         fdn_level: faker.helpers.enumValue(fdn_level),
         fdn_message: faker.string.alpha({length:10}),
         fdn_name:faker.string.alpha({length:10}),
-        fdn_localizednotificationcontent_AppNotificationConfigId_fdn_broadcastappnotification: faker.helpers.multiple(createRandomLocalizedContent,{count:2})
+        fdn_localizednotificationcontent_AppNotificationConfigId_fdn_broadcastappnotification: localized ?createBilingualLocalizedContents():[],
+    };
+}
+export function createRandomAppNotificationWithWebLinkAction(appid:string,localized:boolean = true):fdn_broadcastappnotification{
+    return {
+        fdn_appmoduleid: appid,
+        fdn_broadcastappnotificationid: faker.string.uuid(),
+        fdn_level: faker.helpers.enumValue(fdn_level),
+        fdn_message: faker.string.alpha({length:10}),
+        fdn_name:faker.string.alpha({length:10}),
+        fdn_localizednotificationcontent_AppNotificationConfigId_fdn_broadcastappnotification:localized? createBilingualLocalizedContents():[],
+        fdn_actiontype: fdn_actiontype.WebLink,
+        fdn_buttonactionurl: faker.internet.url(),
+        fdn_buttondefaulttext: faker.string.alpha({length:10})
     };
 }
diff --git a/src/broadcast-typescript/tests/fakers/fdn_localizednotificationcontent.faker.ts b/src/broadcast-typescript/tests/fakers/fdn_localizednotificationcontent.faker.ts
@@ -1,10 +1,17 @@
-import { fdn_localizednotificationcontent } from '@app/modules/domain';
+import { fdn_language, fdn_localizednotificationcontent } from '@app/modules/domain';
 import { faker } from '@faker-js/faker';
-export function createRandomLocalizedContent():fdn_localizednotificationcontent{
+export function createRandomLocalizedContent(lang:fdn_language = fdn_language.English):fdn_localizednotificationcontent{
     return {
        fdn_contentmessage:faker.string.alpha({length:10}),
-       fdn_language: faker.number.int({min:794560000,max:794560001}),
+       fdn_language: lang,
        fdn_localizednotificationcontentid:faker.string.uuid(),
-       fdn_name: faker.string.alpha({length:10})        
+       fdn_name: faker.string.alpha({length:10}),
+       fdn_actionbuttondisplaytext: faker.string.alpha({length:10})        
     };
+}
+export function createBilingualLocalizedContents():fdn_localizednotificationcontent[]{
+    return [
+        createRandomLocalizedContent(fdn_language.English),
+        createRandomLocalizedContent(fdn_language.French)
+    ];
 }
diff --git a/src/broadcast-typescript/tests/fakers/notificationui.faker.ts b/src/broadcast-typescript/tests/fakers/notificationui.faker.ts
diff --git a/src/broadcast-typescript/tests/form/fdn_broadcastappnotification.test.ts b/src/broadcast-typescript/tests/form/fdn_broadcastappnotification.test.ts
diff --git a/src/broadcast-typescript/tests/ribbon/application.test.ts b/src/broadcast-typescript/tests/ribbon/application.test.ts
diff --git a/src/broadcast-typescript/tests/services/BroadcastNotificationService.test.ts b/src/broadcast-typescript/tests/services/BroadcastNotificationService.test.ts
diff --git a/src/broadcast-typescript/tests/services/XrmAppNotificationFactory.test.ts b/src/broadcast-typescript/tests/services/XrmAppNotificationFactory.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,11 @@`
	`1`	`+import { fdn_language } from "@app/modules/domain";`
	`2`	`+`
`1`	`3`	`export function getUserLangFromGlobalContext(){`
`2`	`4`	`const userLang = Xrm.Utility.getGlobalContext().userSettings.languageId;`
`3`	`5`	`switch(userLang){`
`4`	`6`	`case 1036:`
`5`		`- return 794560002;`
	`7`	`+ return fdn_language.French;`
`6`	`8`	`default:`
`7`		`- return 794560001;`
	`9`	`+ return fdn_language.English;`
`8`	`10`	`}`
`9`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export enum fdn_actiontype {`
	`2`	`+ WebLink = 794560000`
	`3`	`+}`