Skip to main content

XrmToolBox: AutoNumberUpdater - new StateCode filter

Set Multi-OptionSet values with a custom workflow activity

As the relatively new multi-optionset field type arrived with v.9 of Dynamics 365 the need to set values via workflow is quite a common requirement.
So I searched within the community to find some ideas on how to solve and create such a workflow activity and so I stumbled upon Demian Raschkovan’s Workflow Tools with can be found on his github repository:

It gave me some basic ideas to reach my requirements which are:
  • Should be generic for any type of entity
  • Ability to specify the attribute name of the required multi-optionset for that entity
  • Provide a list of multi-optionset values (comma-separated)
  • Keep existing values (True/Yes => add provided values / False/No => replace all values with the provided values
  • Remove specific value(s) from an existing set of values

My code sample (without other dependencies):

using Microsoft.Xrm.Sdk;
using Microsoft.Xrm.Sdk.Workflow;
using System;
using System.Activities;
using Microsoft.Xrm.Sdk.Query;
using My.CRM.Code.Shared;

namespace My.CRM.Workflows
{
    public class SetMultiOptionSetValues : WorkFlowActivityBase
    {
        [Input("Record URL")]
        [RequiredArgument]
        public InArgument<string> RecordUrl { get; set; }

        [Input("Attribute Name")]
        [RequiredArgument]
        public InArgument<string> AttributeName { get; set; }

        [Input("Multi-OptionSet Values (,-separated)")]
        [RequiredArgument]
        public InArgument<string> MultiOptionSetValues { get; set; }

        [Input("Keep Existing Values")]
        [Default("false")]
        public InArgument<bool> KeepExistingValues { get; set; }

        [Input("Remove Specific Values")]
        [Default("false")]
        public InArgument<bool> RemoveSpecificValues { get; set; }

        protected override void ExecuteActivity()
        {
            string attributeName = this.AttributeName.Get<string>(this.ExecutionContext);

            OptionSetValueCollection optionSetValues = GetMultiOptionSetValues();

            EntityReference entityReference = GetEntityReference();

            UpdateEntity(entityReference, attributeName, optionSetValues);
        }

        private OptionSetValueCollection GetMultiOptionSetValues()
        {
            var optionSetValues = this.MultiOptionSetValues.Get<string>(this.ExecutionContext);

            string[] optionSetValuesArray = optionSetValues.Split(',');

            if (optionSetValuesArray == null || optionSetValuesArray.Length == 0)
            {
                this.TraceMessage("No optionset values could be found.");
                return null;
            }
            else
            {
                OptionSetValueCollection osvCol = new OptionSetValueCollection();

                foreach (string optionSetValueStr in optionSetValuesArray)
                {
                    int value = 0;
                    if (Int32.TryParse(optionSetValueStr, out value))
                    {
                        OptionSetValue optionSetValue = new OptionSetValue(value);
                        osvCol.Add(optionSetValue);
                    }
                    else
                        throw new InvalidWorkflowException("The provided optionset value is not a valid integer '" + optionSetValueStr + "'.");
                }

                return osvCol;
            };
        }

        private EntityReference GetEntityReference()
        {
            var recordUrl = this.RecordUrl.Get<string>(this.ExecutionContext);

            if (string.IsNullOrWhiteSpace(recordUrl))
                throw new ArgumentNullException("Record URL is empty.");

            return new DynamicUrlParser(recordUrl).GetEntityReference(this.OrganizationService);
        }

        private void UpdateEntity(EntityReference entityReference, string attributeName, OptionSetValueCollection newOptionSetValues)
        {
            if (entityReference == null || newOptionSetValues == null || string.IsNullOrWhiteSpace(attributeName))
                return;

            OptionSetValueCollection existingOptionSetValues = GetExistingOptionSetValues(entityReference, attributeName);

            Entity targetEntity = new Entity(entityReference.LogicalName, entityReference.Id);
            targetEntity.Attributes.Add(attributeName, MergeOptionSetCollections(newOptionSetValues, existingOptionSetValues));

            this.TraceMessage("Updating the entity record...");
            this.OrganizationService.Update(targetEntity);
            this.TraceMessage("Entity record updated successfully.");
        }

        private OptionSetValueCollection GetExistingOptionSetValues(EntityReference entityReference, string attributeName)
        {
            this.TraceMessage("Retrieving existing values...");

            bool removeValues = this.RemoveSpecificValues.Get<bool>(this.ExecutionContext);
            bool attributeValues = this.KeepExistingValues.Get<bool>(this.ExecutionContext);
            if (!attributeValues && !removeValues)
                return null;

            Entity record = this.OrganizationService.Retrieve(entityReference.LogicalName, entityReference.Id, new ColumnSet(new string[] { attributeName }));

            this.TraceMessage("Existing values have been retrieved correctly");

            if (record != null && record.Contains(attributeName))
                return record[attributeName] as OptionSetValueCollection;
            else
                return null;
        }

        private OptionSetValueCollection MergeOptionSetCollections(OptionSetValueCollection newValues, OptionSetValueCollection existingValues)
        {
            this.TraceMessage("Merging new and exiting multi-select optionset values...");

            if (existingValues == null && newValues == null)
                return new OptionSetValueCollection();

            if (existingValues == null)
                return newValues;

            if (newValues == null)
                return existingValues;

            bool removeValues = this.RemoveSpecificValues.Get<bool>(this.ExecutionContext);

            foreach (OptionSetValue newValue in newValues)
            {
                if (!existingValues.Contains(newValue) && !removeValues)
                    existingValues.Add(newValue);
                else if (existingValues.Contains(newValue) && removeValues)
                    existingValues.Remove(newValue);
            }

            this.TraceMessage("New and exiting multi-select optionset values have been merged correctly. Total options: {0} ", existingValues.Count);

            return existingValues;
        }
    }
}
  

Comments

Post a Comment

Popular posts from this blog

Yet Another Address Autocomplete PCF Control–powered by Bing

In this blog post I will not go into detail in how to install all the pre-requisites that are required to build and run PCF controls. My goal was to build a new PCF control and get into coding of PCF controls as fast as possible. Here are a few links to articles that will help you installing the pre-requisites (Microsoft PowerApps CLI)  https://docs.microsoft.com/en-us/powerapps/developer/component-framework/get-powerapps-cli Other good references to get into this topic: https://toddbaginski.com/blog/how-to-create-a-powerapps-pcf-control/ https://docs.microsoft.com/en-us/powerapps/developer/component-framework/create-custom-controls-using-pcf I looked through the Guido Preite’s https://pcf.gallery/ which will help you find appropriate use cases / examples for your own needs. It did not take very long to find a simple example to start with: Andrew Butenko's https://pcf.gallery/address-autocomplete/ A few moments later I had the idea to create yet another address autocomplete...

Power Automate: Avoid Apply to Each for List rows action (DataVerse)

If you do not want to use the Apply to Each loop after a Dataverse List rows action you can use the following in a Dynamic Content / Expression box to directly use a field's value in e.g. Compose action: first(outputs('List_rows')?['body/value'])?['apx_fullpath'] instead of apx_fullpath you can use whatever field name you need for the entity that's been queried before.

How to add your personal PowerBI Dashboard as a system dashboard

New Approach: Attention: Microsoft added this feature out of the box, so that the manual approach below is not required anymore. More to this can be found here: https://powerapps.microsoft.com/en-us/blog/power-bi-embedded-as-system-dashboard-in-model-driven-apps-preview/ Old Approach: The general guideline on how to create a personal dashboard is described in this article: https://docs.microsoft.com/en-us/powerapps/user/add-powerbi-dashboards But what if you want to rollout a global PowerBI dashboard for all users? With some tweaks you can manage it to make it work… 1. After you have created your personal dashboard you need to extract the formxml of that dashboard with this URL query in a browser tab: https://org.crm4.dynamics.com/api/data/v9.1/userforms?$select=name,formxml&$filter=type eq 103 and name eq 'Ticket Status' Replace… type = 103 => PowerBi Dashboard name = 'Your PowerBI Dashboard Name' In the result copy the XML part out of the "formxm...