Virto Custom Mask and Unique Field Validator - Installation and … · 2016. 10. 17. · Virto Custom Mask and Unique Field for SharePoint setup program provides links to the various

Virto Custom Mask and Unique Field Validator

For Microsoft SharePoint

Release 2.1.0

User and Installation Guide

2

Copyright © 2015 All rights reserved. www.virtosoftware.com

Table of Contents

SYSTEM/DEVELOPER REQUIREMENTS ........................................................................................................................................ 3

OPERATING SYSTEM .............................................................................................................................................................................. 3 SERVER ................................................................................................................................................................................................ 3 BROWSER ............................................................................................................................................................................................. 3

INSTALLATION AND ACTIVATION ................................................................................................................................................ 4

INSTALLING VIRTO SHAREPOINT CUSTOM MASK AND UNIQUE FIELD ............................................................................................................. 4 LICENSE ACTIVATION .............................................................................................................................................................................. 8 UPGRADING VIRTO SHAREPOINT CUSTOM MASK AND UNIQUE FIELD ........................................................................................................... 8 UNINSTALLING VIRTO SHAREPOINT CUSTOM MASK AND UNIQUE FIELD ........................................................................................................ 8

ADMINISTRATION AND USAGE ................................................................................................................................................... 9

DEFINITION OF UNIQUE FIELDS ................................................................................................................................................................ 9 ADDING MASK FIELDS .......................................................................................................................................................................... 10

General Mask Settings .............................................................................................................................................................. 11 Creating a Mask ......................................................................................................................................................................... 12

USE CASES .......................................................................................................................................................................................... 17 Credit Card Custom Field for SharePoint ................................................................................................................................. 17 Custom Document Identifier ..................................................................................................................................................... 21 Text Column with Regular Expression Validation ................................................................................................................... 25

VERSION RELEASE HISTORY ....................................................................................................................................................... 29

http://www.virtosoftware.com/

3


Virto Custom Mask and Unique Field Validator for Microsoft SharePoint

Features List

Feature Version

Definition of unique fields for list, site or site collection v.1.0

Adding mask fields to SharePoint lists v.1.0

Using existing column value as a block of mask v.1.0

Ability to use hex color code for mask blocks v.1.0

Using different separators for mask blocks v.1.0

Simple ordering of mask blocks v.1.0

Preview of a mask v.1.0

System/Developer Requirements Operating System Microsoft Windows Server 2003 and 2008

Server SharePoint Release 2013: - Microsoft Windows SharePoint Foundation 2013 or Microsoft Office SharePoint Server 2013; - Microsoft .NET Framework 4.5;

SharePoint Release 2010: - Microsoft Windows SharePoint Foundation 2010 or Microsoft Office SharePoint Server 2010; - Microsoft .NET Framework 3.5;

SharePoint Release 3: - Microsoft Windows SharePoint Services v3 or Microsoft Office SharePoint Server 2007; - Microsoft .NET Framework 3.5; Note: This product is not compatible with SPS 2003 and WSS v2.

Browser Microsoft Internet Explorer 7 or higher is required.


4


Installation and Activation This section describes how to install, upgrade, uninstall, or contact Support for the Virto SharePoint Custom Mask and Unique Field.

Installing Virto SharePoint Custom Mask and Unique Field

Before you begin, you need to make sure you have access to the server and your account must have the appropriate administrative privileges to install applications. Virto Custom Mask and Unique Field for SharePoint setup program provides links to the various installation components for the calendar. To access Virto Custom Mask and Unique Field Setup program download Virto.SharePoint.20XX.CustomMask.zip file and unzip it. Run extracted Setup.exe file. The setup wizard window will appear.

Virto Custom Mask and Unique Field wizard performs a system check prior to the installation. All the system checks must be completed successfully in order to proceed with the installation. After the checks have completed, click “Next”.


5


Check “I accept the terms in the License Agreement” and click “Next”.


6


Select the web application(s) where you want to install the product. Warning: You must be logged in to the SharePoint server with a Site Collection Administrator account to automatically activate this feature.

Then click “Next”.


7


Click “Close” to complete the installation.


8


Note: installation procedure is similar for SharePoint 2007, 2010 and 2013 versions.

License Activation

To see full instruction for successful activation of your component, please download “Virto License Manager” PDF instruction from Downloads section of our site or read it in Wiki.

Upgrading Virto SharePoint Custom Mask and Unique Field

If you already use Virto SharePoint Custom Mask and Unique Field and need to upgrade it to the latest version, download the.zip file from http://www.virtosoftware.com. Unzip the file and run setup.exe as it is described in the Installing Virto SharePoint Custom Mask and Unique Field section. On the step 3 check the box “Upgrade” and click “Next”. Note: if you had activated the license while installing the previous Virto SharePoint Custom Mask and Unique Field version, you do not need to activate it now.

Uninstalling Virto SharePoint Custom Mask and Unique Field

To uninstall the component:

1. Double click the Setup.exe extracted from downloaded Virto.SharePoint.20XX.CustomMask.zip file.

2. The program performs the system checks again. Once that has successfully completed, the program prompts you to Repair or Remove the solution. Select Remove, and click “Next”.

http://www.virtosoftware.com/http://community.virtosoftware.com/media/g/web-part-userguides/default.aspxhttp://community.virtosoftware.com/wikis/http://www.virtosoftware.com/

9


Administration and Usage Virto SharePoint Custom Mask and Unique Field Validator allows you to define which fields in the list will be unique. With this validator you can create mask fields and use them in your SharePoint site lists.

Definition of Unique Fields

When you have installed Virto SharePoint Custom Mask and Unique Field Validator, you will see the

feature in the list settings of your current list. Go to “Settings – List Settings” and click “Unique field

settings”.

In case you need to define a field as a unique one, check the box opposite the required field and select

the scope (the level which it will be unique on - current list, site or site collection). For example, make

“Title” field unique. Then click “OK”.


10


Now if anyone enters a value that already exists in the current list (or other scope), the system will not

allow to save this entry – you will see “Duplicate values” message.

This way you can define settings of unique fields and apply them to your SharePoint lists.

Adding Mask Fields

With Virto SharePoint Custom Mask and Unique Field Validator you can create custom masks to be

used for user friendly input.

Masks can be added when you create columns in your SharePoint list. Go to your list and use “Create

column” button in the “Actions” menu.


11


Now enter column name (mask name) and select “Virto Custom Mask” as information type.

General Mask Settings

Enter the description for new mask, mark the mask as required or not.

Then define unique scope (current list, current site or current site collection).


12


Note: you can set unique scope later on as it is described in previous section.

Now define field case – the way text will be displayed: Capital, UPPER or lower.

Then select a separator you want to use.

Creating a Mask

Every mask can consist of several blocks. You can use one of the following field formats while mask

creating:

Text – a static value that will not change. For example, if you want to identify help desk tickets,

you might want to include “HD” text in the front of the identifier;

Date/Time – can be used to identify your list items with the date and time they were opened;

Existing Column Value – you can also use a secondary column value from the same items in the

ID;

Site Name – use this type to point when the item resides in the portal by using the Site Name

and List Name options in your ID;

List Name – add this type to point when the item resides in the portal by using the Site Name

and List Name options in your ID;


13


Number – Auto Incremented, Go beyond the single digit ID of 1, 10, 100 and set it to show the

same number of digits, say 4, all the time: 0001, 0010, 0100.

This means that mask can consist of blocks of different types. For example, you need to create a

Virtosoftware Identifier which will include a text part, number and a date.

Select “Text” type and click “Add”.

You can define text to be displayed and make it editable or not and set the color. Also, you can define

field width and set pattern if needed.

Click “Refresh” and see how the mask looks like in preview.


14


Now you need to add a number which will be automatically generated in the mask.

Select “Number” type and click “Add”.

Now define number format, for instance 0001, and check the box “Auto increment” to make this value

automatically generated. Click “Refresh” to see the result.


15


Now you need to add a date which will be automatically added (date of item adding).

Select “Date/Time” type and click “Add”.

For example, define M/d/yyyy format and do not allow editing. Click refresh to see the result.

You can delete some blocks if you need. Just click “Delete” button opposite the block.


16


In case you need to change the order of blocks use “Up” and “Down” buttons in order to do it.

Click “Refresh” to see new order.

When you have added all the required blocks to the mask, click “OK” to save the settings. And return to

the SharePoint list to see the result. Now when a user adds a new item to the list, he will see an

identifier generated automatically.


17


The same way you can create any masks which will suppose filling out fields with some information. For

example, make date editable for users.

And when adding a new item, date will be editable.

This way you can use masks for credit card numbers, help desk system and other situations.

Use Cases

Credit Card Custom Field for SharePoint

This part explains how to create a new field to input credit card numbers without the necessity to write

a code.


18


To start, create a new list entitled “Credit Card Storage”. You can also add new fields to any existing list

as well, if preferred.

When the new list is created, you can then create a column by going to Settings > Create Columns.

Title the column as “Credit Card Number”. If you have Virto Custom Mask and Unique Field Validation

installed, a list of column types will be available. Select “Virto Custom Mask”.

Once column type is selected, visual field editor will be available. It consists of several blocks.


19


Block 1 defines unique scope, automatic field case and separator between elements.

Block 2 contains mask preview which is refreshed automatically, but you can also refresh it manually by

clicking the “Refresh” button.

Block 3 allows adding, deleting and adjusting mask elements.

The format of credit card numbers depends on the type of credit card. Please see

http://en.wikipedia.org/wiki/Bank_card_number for reference. For this article, we have chosen Visa –

16-digit card number: 4 blocks with 4 numbers. Now let’s create a field for inputting the credit card

numbers.

Now, let’s add a text block. In order to do this, select “Text” in the “Select mask item type” section and

click “Add”. You will see the following picture as a result.

1

2

3

http://www.virtosoftware.com/http://en.wikipedia.org/wiki/Bank_card_number

20


This block is not editable by default. Check the “Editable” box to change this setting. More fields will be

displayed and you will then define the width to 40 and set a 4 symbols limit by using the

expression”\d{4}”. Now you’ve added one text block to the field. This block will be editable and will

require 4 numbers to enter.

Repeat the above actions three times and define it with a dash symbol, “-“, as a separator. The result is

as follows.

The field for inputting credit card numbers is ready to use. Click “OK” to add this field to the list.

You will now have the menu options to create, edit and view forms of the list containing the new form

for inputting credit card numbers. Here are several screenshots of the created mask:


21


Custom Document Identifier

With this example you can create unique identifiers of any complexity in any SharePoint objects. You

don’t need any special programming skills or code writing.

Custom Document Identifier provides you with the ability to tag documents with a unique identification

number.

To start, create a new list where you will be creating the new text field or go to an existing list. Then go

to Settings > Create Columns.

Title the name of your new field as “Document ID”. If you have Virto Custom Mask and Unique Field

Validation installed, a list of column types will be available. Select “Virto Custom Mask”.


22




1

2

3


23


You can define the unique scope. The following options are available:

[Not use] – fields are not validated whether or not they are unique;

Current List – field value must be unique within the current list;

Current Site – field value must be unique within the site and all columns with the same name;

Must Have Matching Field Name and Type – field value must be unique within the current site

collection and in all lists and all columns with the same name.



Block 3 allows adding, deleting and adjusting mask elements. You can add elements with the following

types:

Text – any text value;

Date/Time – current date/time in free form;

Existing Column Value – value from existing field;

Site Name – name of site;

List Name – name of list;

Number – numeric value, auto increment is also supported (depending on unique scope type).

Let’s now create a unique identifier which will contain prefix, current date, unique number and custom

string code.

First of all, define the basic settings as follows: Unique Scope to be “Current List”; Field Case to be

“Default”; and Separator to be “-“. It should look as below.

Now define the text prefix. Select “Text” in the mask item type field and click “Add”. Then enter

“MYPREFIX” as the prefix and click “Refresh”. Here’s how it should look like:


24


You will then need to add current date. In order to do this, select “Date/Time" in the mask item type

and click “Add”. Then define the required data format.

Note: you can select predefined date/time formats or use custom ones. Please use the following links

for reference on date and time formats:

http://msdn.microsoft.com/en-us/library/az4se3k1%28v=VS.90%29.aspx

http://msdn.microsoft.com/en-us/library/8kb3ddd4%28v=VS.90%29.aspx

You will get the fields structure as shown on the picture below:

You can now define the auto increment number. Select “Number” in the mask item type and click Add.

Check the box “Auto increment” in the new block. Then click “Refresh” to show all the changes in

preview.

http://www.virtosoftware.com/http://msdn.microsoft.com/en-us/library/az4se3k1%28v=VS.90%29.aspxhttp://msdn.microsoft.com/en-us/library/8kb3ddd4%28v=VS.90%29.aspx

25


Text Column with Regular Expression Validation

SharePoint does not support validating values, and it is not required in some cases. However, if you try

to build complex business processes based on entered data, it is critical to validate that users input

correct data in the fields.

This article describes how to create an Email text field that validates regular expressions without any

codes.

To start, create a new list where you will be creating the new text field or go to an existing list. Then go

to Settings > Create Columns.

Title the name of your new field as “Email”. If you have Virto SharePoint Custom Mask and Unique Field

Validation installed, a list of column types will be available. Select “Virto Custom Mask”.


26




1

2

3


27




Block 3 allows adding, deleting and adjusting mask elements.

Now, let’s add a text block. In order to do this, select “Text” in the “Select mask item type” section and

click “Add”. You will see the following picture as a result.

This block is not editable by default. Check the “Editable” box to change this setting.

You need to define the Pattern for this block. This can be done by using regular expressions that will

check if entered data is in the format of an email address.

You can use the following regular expressions (please see

http://www.regexlib.com/REDetails.aspx?regexp_id=711):

Pattern ^((?>[a-zA-Z\d!#$%&'*+\-/=?^_`{|}~]+\x20*|»((?=[\x01-

\x7f])[^"\\]|\\[\x01-

\x7f])*"\x20*)*(?\.?[a-zA-Z\d!#$%&'*+\-

/=?^_`{|}~]+)+|"((?=[\x01-\x7f])[^"\\]|\\[\x01-\x7f])*")@(((?!-

)[a-zA-Z\d\-]+(?

4]\d|[01]?\d?\d)){4}|[a-zA-Z\d\-]*[a-zA-Z\d]:((?=[\x01-

\x7f])[^\\\[\]]|\\[\x01-\x7f])+)\])(?(angle)>)$

Description This accepts RFC 2822 email addresses

Matches [email protected]

Name Surname [email protected]

"b. blah"@blah.co.nz

Non-Matches name [email protected]

name."surname"@blah.com

[email protected]

You can define the text color in addition to basic settings. The following is the result of the template:

http://www.virtosoftware.com/http://www.regexlib.com/REDetails.aspx?regexp_id=711mailto:[email protected]:[email protected]:[email protected]

28


The field for inputting email address with validation settings is ready to use. Click “OK” to add this field

to the list.

You will now have the menu options to create, edit and view forms of the list containing the new form

for inputting email addresses.

Here are several screenshots of the created mask:

A library of regular expressions for new masks can be found at: http://www.regexlib.com

http://www.virtosoftware.com/http://www.regexlib.com/

29


Version Release History

Release

Date Version Description

09/10/2013 v. 2.0.0 [+] New license manager

04/05/2011 v. 1.1.2 [-] Incorrect working with Document Library was fixed.

08/12/2010 v. 1.1.0 [+] Custom validation error message

05/23/2010 v. 1.0.0 First public release.

Documents

Virto Custom Mask and Unique Field Validator - Installation and … · 2016. 10. 17. · Virto Custom Mask and Unique Field for SharePoint setup program provides links to the various