Skip to main content

Yet Another Address Autocomplete PCF Control–powered by Bing

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")]
        public InArgument<string> RecordUrl { get; set; }

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

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

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

        [Input("Remove Specific Values")]
        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;
                OptionSetValueCollection osvCol = new OptionSetValueCollection();

                foreach (string optionSetValueStr in optionSetValuesArray)
                    int value = 0;
                    if (Int32.TryParse(optionSetValueStr, out value))
                        OptionSetValue optionSetValue = new OptionSetValue(value);
                        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))

            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.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;
                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)
                else if (existingValues.Contains(newValue) && removeValues)

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

            return existingValues;


Post a Comment

Popular posts from this blog

Regarding SPFieldMultiLineText (Add HTML/URL content to a field) programmatically

I recently tried so set some HTML content in a SharePoint list column of type SPFieldMultiLineText.

My first approach was this piece of code:

SPFieldMultiLineText field = item.Fields.GetFieldByInternalName("Associated Documents") as SPFieldMultiLineText; StringBuilder docList = new StringBuilder(); docList.Append(""); foreach (DataRow docRow in addDocs) { DataRow[] parent = dr.Table.DataSet.Tables[0].Select("DOK_ID=" + docRow["DOK_MGD_ID"].ToString()); if (parent != null && parent.Length > 0) { docList.AppendFormat("{1}", parent[0]["FilePath"].ToString(), parent[0]["Title"].ToString()); } } if (docList.Length > 0) { // remove trailing tag docList.Remove(docList.Length-5, 5); } docList.Append(" "); string newValue = docList.ToString(); item[field.Title] = newValue;
What this code does is to get all associated documents to the main document and to add these document uri links to the "Assoc…

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)
Other good references to get into this topic:
I looked through the Guido Preite’s 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
A few moments later I had the idea to create yet another address autocomplete control b…

CRM 2016 SP1: Solution import failed with Solution With Id = 12ac16ec-41d5-1685-a230-0b1c31499250 Does Not Exist

Importing Solutions with the upgrade solution (holding solution) option is still not stable with CRM 2016 SP1 On-Premise.

Ronald Lemmon already posted the same issue on his blog:

I expected it to be fixed with SP1 but it is still happening every now and then.

With this query and the solution id (guid) of the error message you are able to find records in the ProcessTriggerBase table that reference the guid of a failed import from a holding solution that is not existing in the system anymore.

select * from ProcessTriggerBase where solutionid = 'YOUR_SOLUTION_GUID'
Due to this reference to a solution id not existing in the system you will not be able to import a new version of the target solution to be updated.

What I did and this is probably not a supported solution is to update the guid to the actual target solution that is currently deployed in the system.

To find out the id of the target solution y…