Sitecore Web Forms for Marketers Custom Sequential Number Field
I had a requirement to implement sequentially numbered WFFM form submissions to identify submissions, email address would not do as we anticipated multiple applications per email. Nothing out of the box supported this requirement so I created my own. Nikola’s blog post https://sitecorecorner.com/2015/06/30/wffm-session-aware-single-line-text-field/ pointed me in the right direction. My example was created using WFFM version 8.0 150625 and Sitecore version 8.0 (rev. 150621).
Here is what I did :-
Created a class with options to define how the field would look in Forms Designer, I have properties for which number sequence will be used, the size of padding to be applied and whether the field will be displayed.
using System.ComponentModel;
using System.ComponentModel.Design;
using Sitecore.Configuration;
using Sitecore.Data;
using Sitecore.Data.Items;
using Sitecore.Form.Core.Attributes;
using Sitecore.Form.Web.UI.Controls;
using Sitecore.SecurityModel;
namespace WesleyLomax.WFFM
{
[Designer("System.Windows.Forms.Design.ParentControlDesigner, System.Design", typeof(IDesigner))]
public class SequentialNumber : SingleLineText
{
private bool _isHidden = true;
private string _sequentialNumberId;
private int _numberPadding;
[VisualCategory("Sequence")]
[VisualFieldType(typeof(Fields.SequentialNumberField))]
[VisualProperty("Sequence:", 100)]
public string SequentialNumberId
{
get { return _sequentialNumberId; }
set { _sequentialNumberId = value; }
}
[VisualCategory("Sequence")]
[VisualProperty("Length:", 200), DefaultValue("6")]
public int NumberPadding
{
get { return _numberPadding; }
set { _numberPadding = value; }
}
[VisualCategory("Sequence")]
[VisualFieldType(typeof(Sitecore.Form.Core.Visual.BooleanField))]
[VisualProperty("Hidden:", 300), DefaultValue("Yes")]
public string IsHidden
{
get { return _isHidden ? "Yes" : "No"; }
set { _isHidden = value == "Yes"; }
}
}
}
Created a custom Field Type called SequentialNumberField this class will read the values of sequences being held in Sitecore, this is the type of the SequentialNumberId property from the SequentialNumber class.
using System;
using System.Web.UI;
using System.Web.UI.WebControls;
using Sitecore.Data;
using Sitecore.Data.Items;
using Sitecore.Form.Core.Configuration;
using Sitecore.Form.Core.Visual;
namespace WesleyLomax.WFFM.Fields
{
public class SequentialNumberField : ValidationField
{
private static readonly ID SequentialFormNumbers = new ID("{C7FB3754-A0B1-469C-9591-7CE3DC075272}");
public SequentialNumberField() : base(HtmlTextWriterTag.Select.ToString())
{
}
public override bool IsCacheable => false;
private static Item SequentialFormNumbersRoot => StaticSettings.ContextDatabase.GetItem(SequentialFormNumbers);
protected override void OnPreRender(object sender, EventArgs ev)
{
Controls.Clear();
base.OnPreRender(sender, ev);
Controls.Add(new Literal
{
Text = string.Format("<option {0} value='{1}'>{1}</option>", DefaultValue == EmptyValue ? "selected='selected'" : string.Empty, EmptyValue)
});
foreach (Item child in SequentialFormNumbersRoot.Children)
Controls.Add(new Literal
{
Text =
string.Format("<option {0} value='{1}'>{2}</option>",
DefaultValue == child.Fields[FieldIDs.MetaDataListItemValue].Value ? "selected='selected'" : string.Empty,
child.ID.ToShortID(),
child.DisplayName)
});
}
}
}
I have added a new folder in the WFFM Meta Data here /sitecore/system/Modules/Web Forms for Marketers/Settings/Meta data/Sequential Form Numbers that will hold a list of all the custom sequences in use for WFFM and their current values. The SequentialFormNumbers variable holds the folder ID located there so I can render the children in to Forms Designer for selection by the user, you’d need to update this GUID to you the value from your folder.
The final class is the SequentialNumberField this is the MVC Type WFFM will use to render the and populate the field.
using System;
using Sitecore.Configuration;
using Sitecore.Data;
using Sitecore.Data.Items;
using Sitecore.Forms.Mvc.Models.Fields;
using Sitecore.SecurityModel;
namespace WesleyLomax.WFFM.MVCModels
{
public class SequentialNumberField : SingleLineTextField
{
public SequentialNumberField(Item item) : base(item)
{
Initialize();
}
public override object Value { get; set; }
private void Initialize()
{
string isHidden = Sitecore.Forms.Mvc.Extensions.DictionaryExtensions.GetValue(ParametersDictionary, "isHidden");
if (!string.IsNullOrWhiteSpace(isHidden) && isHidden.ToUpper() == "YES")
{
if (!string.IsNullOrWhiteSpace(CssClass))
{
CssClass += " hidden";
}
else
{
CssClass = "hidden";
}
}
else
{
if (!string.IsNullOrWhiteSpace(CssClass))
{
CssClass += " disabled";
}
else
{
CssClass = "disabled";
}
}
string sequentialNumberId = Sitecore.Forms.Mvc.Extensions.DictionaryExtensions.GetValue(ParametersDictionary, "sequentialNumberId");
if (!string.IsNullOrWhiteSpace(sequentialNumberId) && ShortID.IsShortID(sequentialNumberId))
{
ID id = ShortID.DecodeID(sequentialNumberId);
if (!id.IsNull)
{
Database master = Factory.GetDatabase("master");
if (master != null)
{
Item sequenceItem = master.GetItem(id);
string number = sequenceItem.Fields[Sitecore.Form.Core.Configuration.FieldIDs.MetaDataListItemValue].Value;
int padding = Convert.ToInt32(Sitecore.Forms.Mvc.Extensions.DictionaryExtensions.GetValue(ParametersDictionary, "numberPadding"));
int currentNumber;
if (int.TryParse(number, out currentNumber))
{
currentNumber++;
string sequence = currentNumber.ToString().PadLeft(padding, '0');
Value = sequence;
using (new SecurityDisabler())
{
sequenceItem.Editing.BeginEdit();
sequenceItem.Fields[Sitecore.Form.Core.Configuration.FieldIDs.MetaDataListItemValue].Value = sequence;
sequenceItem.Editing.EndEdit();
}
}
}
}
}
}
}
}
Here I am reading the values from the ParametersDictionary set in Forms Designer and updating the field before it is rendered. The current sequential number is read from Sitecore incremented and wrote back to the Value field, with padding for the value read from the NumberPadding property.
After all the classes are built you will need to add the Custom Field definition here –** /sitecore/system/Modules/Web Forms for Marketers/Settings/Field Types/Custom** I called mine Sequential Number
With all that built and configured you can now add the new Sequential Number Field to your form.
Once added in Forms Designer you will see three options for configuration.
A Sequence to chose from which is maintained in Sitecore, having multiple sequences allows multiple forms submissions to be tracked with a sequential number.
The Length field allows you to set the number leading 0’s to add to the left of the number, so a length of 4 would produce 0001 if the sequence was at 1 and also a Hidden option** ** if you want the number to display on the form or not.
Finally some examples of the new Sequential Number field in action:-
Multiple fields with different sequences and padding values.
And the value being using in emails to the user who submitted the form.
And the team receiving it.
As the value is passed through to the Form Reports when viewed or exported the sequential number can be used to identify the form submitted.
The link to the Gist for this code is here with better formatting.