After I’d written the tutorial for the Seadragon Web part, I hit upon the idea of making short introductory guides an additional part of the CodePlex Corner Series. In the course of my playing around with the goodies on offer, I’m typically taking notes for my own records. It’s not really a huge leap to tidy them up and make them available for publication.
I don’t really have a specific format in mind but I’d like to try and make these tutorials as inclusive as possible, especially as some of the projects might not have terribly detailed literature with them. Any part that’s not relevant for more experience readers can always be skipped.
With that in mind, let’s get you started with the SharePoint List Field Manager. This is an easy tool to use, so the tutorial will be brief. We will cover web part installation, then activation and will look at some best practice ideas around it.
Installing the SharePoint List Field Manager
- Create a folder on your root drive called Web Parts. This should be something like C:\Web Parts
- Download the ListFieldManager.wsp file into this folder
- Open the SharePoint 2010 Management Shell. Typically this is Start à All Programs à Microsoft SharePoint 2010 Products à SharePoint 2010 Management Shell. Run this as the administrator
- Use the following PowerShell Command to install the wsp file. Add-SPSolution “C:\Web Parts\ListFieldManager.wsp”. Please note that the double quotation marks are needed for the file path. Otherwise, you may generate the positional parameter error message below.
- As PowerShell will helpfully tell you the solution is deployed but not installed. Installing the solution is what will make it available for use.
- Use this PowerShell command, making sure to change the http://YourApp URL to your own Web Application. This should install with no issues
Once this command has completed the List Field Web Part will be available for use
Activating & using the SharePoint List Field Manager
The List Field Manager is a site collection feature and should be activated as such. It activates with no problems. This will be the same for both SharePoint 2007 & SharePoint 2010. The end product is a web part that you deploy and use to configure your lists: -
- Navigate to Site Actions à Site Settings à Site Collection Features and activate the web part. It is listed under SharePoint List Field Manger.
- Now that the web part is available it will be in the Web Part Gallery. It will appear under the SharePoint Management category
- Once the web part has been added to a web part zone you can feed it the URL of the site where you want to manage the lists. Please be aware that you cannot access lists in other sites if you are using the SharePoint 2010 SandBox deployment. Either way click on Display Lists
- The web part reloads with a List drop down, which is populated with all available lists for the site that was selected. Select a list and then click on Display Fields
- This will reload the web part again with a second drop down list from which you can select the field that you want to modify. Make the appropriate choice and then click Display Field Settings
- The web part reloads again with all available options for that field. The end configuration will look like this
Best Practice / Suggestions
These are some ideas and thoughts that struck me as I was using the SharePoint List Field Manager as things that I’d do when introducing the web part into any of my deployments. My current suggestions are: -
- Customising a View field to act as an List Admin Page
Best Practice #1: Setting up a List Admin Page
A useful trick I’ve found is to place the List View Manager within a page that’s associated with its usage. This simply consists clearing out the contents of a View Page and adding the web part in its place.
- Within your list or library enter the List Settings and scroll down to the Views Section
- Click on Create view. This loads a new page where you select the view format
- Click on Standard View
- This loads a new page where the view is configured. Forget about configuring anything here; just call the view something like List Field Admin Page. This can also be set up as a personal view. Click Ok. This loads a new page with the standard view
- On this page, get into the page editing mode via Site Actions à Edit Page
- Edit the web part from this view and set the hidden field under the Layout options
- Add the List Field Manager and move this to the top of the page
- You will now have an administration view with the List Field Manager present for future configuration