- Add automated and manual workflow handling to BenevolenceRequestDetail

Author: SteindelSE

Rock.Blocks/Finance/BenevolenceRequestDetail.cs

@@ -125,8 +125,7 @@ public class BenevolenceRequestDetail : RockEntityDetailBlockType<BenevolenceReq
 
         #region Properties
 
-        #region Properties - Services
-
+        // Services
         private PersonAliasService PersonAliasService => new PersonAliasService( RockContext );
         private LocationService LocationService => new LocationService( RockContext );
         private CampusService CampusService => new CampusService( RockContext );
@@ -135,8 +134,6 @@ public class BenevolenceRequestDetail : RockEntityDetailBlockType<BenevolenceReq
         private BinaryFileService BinaryFileService => new BinaryFileService( RockContext );
         private BenevolenceRequestDocumentService BenevolenceRequestDocumentService => new BenevolenceRequestDocumentService( RockContext );
 
-        #endregion Properties - Services
-
         #endregion Properties
 
         #region Keys
@@ -158,8 +155,6 @@ private static class AttributeKey
             public const string EthnicityOption = "EthnicityOption";
         }
 
-        #region List Source
-
         /// <summary>
         /// Provides a source of predefined list values used for configuration or validation purposes.
         /// </summary>
@@ -170,8 +165,6 @@ private static class ListSource
             public const string HIDE_OPTIONAL_REQUIRED = "Hide,Optional,Required";
         }
 
-        #endregion
-
         /// <summary>
         /// Provides a collection of constant keys used for identifying page parameters.
         /// </summary>
@@ -493,10 +486,6 @@ protected override bool TryGetEntityForEditAction( string idKey, out Benevolence
             return true;
         }
 
-        #region Helper Methods
-
-        #region Helper Methods - Entity Update
-
         /// <summary>
         /// Updates the properties of the requester in the specified <see cref="BenevolenceRequest"/> entity based on
         /// the provided <see cref="ValidPropertiesBox{T}"/> and a list of active country codes.
@@ -710,10 +699,6 @@ private void UpdateDetailProperties( BenevolenceRequest entity, ValidPropertiesB
             box.IfValidProperty( nameof( box.Bag.ProvidedNextSteps ), () => entity.ProvidedNextSteps = box.Bag.ProvidedNextSteps );
         }
 
-        #endregion Helper Methods - Entity Update
-
-        #region Helper Methods - Bag Construction
-
         /// <summary>
         /// Gets the entity bag that is common between both view and edit modes.
         /// </summary>
@@ -732,6 +717,23 @@ private BenevolenceRequestBag GetCommonEntityBag( BenevolenceRequest entity )
                 var caseWorkerPersonBag = BuildPersonBag( entity, entity.CaseWorkerPersonAliasId ?? 0, "", isRequester: false );
                 var campus = BuildCampusBag( entity.CampusId ?? 0 );
 
+                // Add workflow info for frontend
+                var workflows = GetAuthorizedManualWorkflows( entity )
+                    .Select( w => new BenevolenceRequestWorkflowBag
+                    {
+                        TypeId = w.WorkflowTypeId,
+                        TypeGuid = w.WorkflowType.Guid,
+                        TypeName = w.WorkflowType.Name,
+                        TriggerType = w.TriggerType,
+                        LaunchUrl = this.GetLinkedPageUrl( AttributeKey.WorkflowEntryPage, new Dictionary<string, string>
+                        {
+                            { "WorkflowTypeId", w.WorkflowTypeId.ToString() },
+                            { "BenevolenceRequestId", entity.IdKey }
+                        }),
+                        iconCssClass = w.WorkflowType.IconCssClass,
+                    })
+                    .ToList();
+
                 return new BenevolenceRequestBag
                 {
                     IdKey = entity.IdKey,
@@ -763,7 +765,8 @@ private BenevolenceRequestBag GetCommonEntityBag( BenevolenceRequest entity )
                             FileName = document.BinaryFile.FileName,
                             IsMarkedForDeletion = false
                         } )
-                        .ToList()
+                        .ToList(),
+                    Workflows = workflows
                 };
             }
 
@@ -1269,10 +1272,6 @@ private LocationBag GetLocationBag( Location location )
             };
         }
 
-        #endregion Helper Methods - Bag Construction
-
-        #region Helper Methods - Person Creation
-
         /// <summary>
         /// Finds an existing person based on the provided information or creates a new person record if no match is
         /// found.
@@ -1504,9 +1503,35 @@ private bool ValidatePhoneNumbers( List<PhoneNumberBag> phoneNumberBags, out str
             return true;
         }
 
-        #endregion Helper Methods - Person Creation
+        /// <summary>
+        /// Gets the authorized manual workflows for the given benevolence request.
+        /// </summary>
+        /// <param name="benevolenceRequest">The benevolence request.</param>
+        /// <returns>A list of authorized manual workflows.</returns>
+        private List<BenevolenceWorkflow> GetAuthorizedManualWorkflows( BenevolenceRequest benevolenceRequest )
+        {
+            if ( benevolenceRequest?.BenevolenceType == null )
+            {
+                return new List<BenevolenceWorkflow>();
+            }
+
+            var benevolenceWorkflows = benevolenceRequest.BenevolenceType.BenevolenceWorkflows;
+            var manualWorkflows = benevolenceWorkflows
+                .Where( w => w.TriggerType == BenevolenceWorkflowTriggerType.Manual && w.WorkflowType != null )
+                .OrderBy( w => w.WorkflowType.Name )
+                .Distinct();
 
-        #endregion Helper Methods
+            var authorizedWorkflows = new List<BenevolenceWorkflow>();
+            foreach ( var manualWorkflow in manualWorkflows )
+            {
+                if ( ( manualWorkflow.WorkflowType.IsActive ?? true ) && manualWorkflow.WorkflowType.IsAuthorized( Authorization.VIEW, RequestContext.CurrentPerson ) )
+                {
+                    authorizedWorkflows.Add( manualWorkflow );
+                }
+            }
+
+            return authorizedWorkflows;
+        }
 
         #endregion Methods
 

Rock.JavaScript.Obsidian.Blocks/src/Finance/BenevolenceRequestDetail/viewPanel.partial.obs

@@ -42,12 +42,29 @@
                     </div>
                 </div>
 
-                <div v-if="hasRequestLavaTemplateDetails"
-                     class="row">
+                <div v-if="hasAuthorizedManualWorkflows" class="row">
                     <div class="col-md-12">
-                        {{ benevolenceRequestTypeLavaDetails }}
+                        <NotificationBox v-if="launchWorkflowError" alertType="danger" class="mt-2">
+                            <strong><i class="ti ti-exclamation-circle"></i> Error Launching Workflow</strong>
+                            <span>{{ launchWorkflowError }}</span>
+                        </NotificationBox>
+                        <dl>
+                            <dt>Available Workflows</dt>
+                            <dd>
+                                <RockButton v-for="workflow in authorizedManualWorkflows"
+                                            class="m-1"
+                                            :key="workflow.typeId"
+                                            :btnType="BtnType.Default"
+                                            :btnSize="BtnSize.ExtraSmall"
+                                            @click="onWorkflowButtonClick(workflow.typeName, workflow.launchUrl)">
+                                    <i :class="workflow.iconCssClass"></i> {{ workflow.typeName }}
+                                </RockButton>
+                            </dd>
+                        </dl>
                     </div>
                 </div>
+
+                <ValueDetailList :modelValue="contactInfoBottomValues" />
             </ContentStack>
         </ContentSection>
 
@@ -129,6 +146,7 @@
     import HighlightLabel from "@Obsidian/Controls/highlightLabel.obs";
     import RockButton from "@Obsidian/Controls/rockButton.obs";
     import ValueDetailList from "@Obsidian/Controls/valueDetailList.obs";
+    import NotificationBox from "@Obsidian/Controls/notificationBox.obs";
     import { BenevolenceRequestBag } from "@Obsidian/ViewModels/Blocks/Finance/BenevolenceRequestDetail/benevolenceRequestBag";
     import { PersonBag } from "@Obsidian/ViewModels/Blocks/Finance/BenevolenceRequestDetail/personBag";
     import { BenevolenceResultBag } from "@Obsidian/ViewModels/Blocks/Finance/BenevolenceRequestDetail/benevolenceResultBag";
@@ -140,6 +158,8 @@
     import { BtnSize } from "@Obsidian/Enums/Controls/btnSize";
     import { isNotNullish } from "@Obsidian/Utility/util";
     import { emptyGuid } from "@Obsidian/Utility/guid";
+    import { confirm } from "@Obsidian/Utility/dialogs";
+    import { BenevolenceRequestWorkflowBag } from "@Obsidian/ViewModels/Blocks/Finance/BenevolenceRequestDetail/benevolenceRequestWorkflowBag";
 
     const props = defineProps({
         modelValue: {
@@ -163,6 +183,8 @@
         (e: "update:requestResults", value: BenevolenceResultBag[]): void,
     }>();
 
+    const launchWorkflowError = ref("");
+
     // #region Value Builders
 
     /** The values to display full-width at the top of the block. */
@@ -260,6 +282,21 @@
         return valueBuilder.build();
     });
 
+
+    const contactInfoBottomValues = computed((): ValueDetailListItem[] => {
+        const valueBuilder = new ValueDetailListItemBuilder();
+
+        if (!props.modelValue) {
+            return valueBuilder.build();
+        }
+
+        if (hasRequestLavaTemplateDetails.value) {
+            valueBuilder.addHtmlValue("", benevolenceRequestTypeLavaDetails);
+        }
+
+        return valueBuilder.build();
+    });
+
     /** The values to display full-width at the top of the block. */
     const requestDetailsTopValues = computed((): ValueDetailListItem[] => {
         const valueBuilder = new ValueDetailListItemBuilder();
@@ -453,6 +490,15 @@
 
     const requestType = props.options.benevolenceRequestTypes?.find(requestType => requestType.id === entity.benevolenceTypeId);
 
+    const hasAuthorizedManualWorkflows = computed((): boolean => {
+        return props.modelValue?.workflows != null
+            && props.modelValue?.workflows !== undefined
+            && props.modelValue?.workflows.length > 0;
+    });
+    const authorizedManualWorkflows = computed((): BenevolenceRequestWorkflowBag[] => {
+        return props.modelValue?.workflows ?? [];
+    });
+
     const benevolenceRequestTypeLavaDetails = requestType?.lavaDetails ?? "";
     const hasRequestLavaTemplateDetails = computed((): boolean => {
         return benevolenceRequestTypeLavaDetails !== null
@@ -587,5 +633,18 @@
         emit("update:requestResults", newValue);
     }
 
+    /**
+     * Opens a workflow launch URL in a new tab.
+     * @param url The workflow launch URL.
+     */
+    async function onWorkflowButtonClick(workflowName: string | null | undefined, url: string | null | undefined): Promise<void> {
+        if (!workflowName || !url) {
+            return;
+        }
+
+        await confirm(`A '${workflowName}' workflow has been started.`);
+        window.open(url, "_blank");
+    }
+
     // #endregion
 </script>

Rock.JavaScript.Obsidian/Framework/ViewModels/Blocks/Finance/BenevolenceRequestDetail/benevolenceRequestBag.d.ts

@@ -22,6 +22,7 @@
 //
 
 import { BenevolenceDocumentBag } from "@Obsidian/ViewModels/Blocks/Finance/BenevolenceRequestDetail/benevolenceDocumentBag";
+import { BenevolenceRequestWorkflowBag } from "@Obsidian/ViewModels/Blocks/Finance/BenevolenceRequestDetail/benevolenceRequestWorkflowBag";
 import { BenevolenceResultBag } from "@Obsidian/ViewModels/Blocks/Finance/BenevolenceRequestDetail/benevolenceResultBag";
 import { CampusBag } from "@Obsidian/ViewModels/Blocks/Finance/BenevolenceRequestDetail/campusBag";
 import { PersonBag } from "@Obsidian/ViewModels/Blocks/Finance/BenevolenceRequestDetail/personBag";
@@ -73,4 +74,7 @@ export type BenevolenceRequestBag = {
 
     /** Gets or sets the summary of the request result. */
     resultSummary?: string | null;
+
+    /** Gets or sets the collection of workflow options available for this request. */
+    workflows?: BenevolenceRequestWorkflowBag[] | null;
 };

Rock.JavaScript.Obsidian/Framework/ViewModels/Blocks/Finance/BenevolenceRequestDetail/benevolenceRequestWorkflowBag.d.ts

@@ -0,0 +1,46 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { BenevolenceWorkflowTriggerType } from "@Obsidian/Enums/Finance/benevolenceWorkflowTriggerType";
+import { Guid } from "@Obsidian/Types";
+
+/** Represents a workflow option for a benevolence request. */
+export type BenevolenceRequestWorkflowBag = {
+    /** Gets or sets the CSS class for the workflow icon. */
+    iconCssClass?: string | null;
+
+    /** Gets or sets the URL to launch the workflow. */
+    launchUrl?: string | null;
+
+    /** Gets or sets the trigger type for the workflow. */
+    triggerType: BenevolenceWorkflowTriggerType;
+
+    /** Gets or sets the workflow type unique identifier. */
+    typeGuid: Guid;
+
+    /** Gets or sets the workflow type identifier. */
+    typeId: number;
+
+    /** Gets or sets the workflow type name. */
+    typeName?: string | null;
+};

Rock.ViewModels/Blocks/Finance/BenevolenceRequestDetail/BenevolenceRequestBag.cs

@@ -102,5 +102,10 @@ public class BenevolenceRequestBag : EntityBagBase
         /// represented as a list of <see cref="ListItemBag"/> objects.
         /// </summary>
         public List<BenevolenceDocumentBag> RequestDocuments { get; set; }
+
+        /// <summary>
+        /// Gets or sets the collection of workflow options available for this request.
+        /// </summary>
+        public List<BenevolenceRequestWorkflowBag> Workflows { get; set; }
     }
 }

Rock.ViewModels/Blocks/Finance/BenevolenceRequestDetail/BenevolenceRequestDetailOptionsBag.cs

@@ -109,7 +109,7 @@ public class BenevolenceRequestDetailOptionsBag
         /// <summary>
         /// Gets or sets the unique identifier for the binary file type associated with benevolence documents.
         /// </summary>
-        public System.Guid BenevolenceDocumentBinaryFileTypeGuid { get; set; }
+        public Guid BenevolenceDocumentBinaryFileTypeGuid { get; set; }
 
         /// <summary>
         /// Gets or sets a value indicating whether country codes are enabled.

Rock.ViewModels/Blocks/Finance/BenevolenceRequestDetail/BenevolenceRequestWorkflowBag.cs

@@ -0,0 +1,57 @@
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+using System;
+using Rock.Model;
+
+namespace Rock.ViewModels.Blocks.Finance.BenevolenceRequestDetail
+{
+    /// <summary>
+    /// Represents a workflow option for a benevolence request.
+    /// </summary>
+    public class BenevolenceRequestWorkflowBag
+    {
+        /// <summary>
+        /// Gets or sets the workflow type identifier.
+        /// </summary>
+        public int TypeId { get; set; }
+
+        /// <summary>
+        /// Gets or sets the workflow type unique identifier.
+        /// </summary>
+        public Guid TypeGuid { get; set; }
+
+        /// <summary>
+        /// Gets or sets the workflow type name.
+        /// </summary>
+        public string TypeName { get; set; }
+
+        /// <summary>
+        /// Gets or sets the trigger type for the workflow.
+        /// </summary>
+        public BenevolenceWorkflowTriggerType TriggerType { get; set; }
+
+        /// <summary>
+        /// Gets or sets the URL to launch the workflow.
+        /// </summary>
+        public string LaunchUrl { get; set; }
+
+        /// <summary>
+        /// Gets or sets the CSS class for the workflow icon.
+        /// </summary>
+        public string iconCssClass { get; set; }
+    }
+}