Dynamic Web View Of A SharePoint List Item Using Excel Web Access Web Part

Sometimes, the customer would like to see the SharePoint list item with a specific design instead of the default view, for which the developers have to develop an app or web part.

But in this example, I will show you how to create a dynamic web view of a SharePoint list item using Excel Web Access Web part.

Imagine a customer requirement is as below

A State Government would like to start a "Develop my Village" program for which they would like to gather information of all the villages (from each department) and store it in a database. After that, they would like to view each village information in a village report card format and share it with the central government for review.

Let's follow the below steps to store the village information in a SharePoint list and view the SharePoint list item in a village report card format.

Step 1 - Create a Village list in SharePoint site with a set of columns.

SharePoint

Step 2

Add a New Item and fill in the village information.

SharePoint

Step 3

Once list item is created, click on Iiew item to see the default SharePoint list item view.

SharePoint

Step 4

Now, instead of seeing this default SharePoint item view, the Government would like to see the list item as in the below design (which they call a Village Report Card).

SharePoint

Design a similar design of Village Report Card Template in Microsoft Excel. Download the sourcecode.zip file to see the sample Excel template (VillageTemplate.xlsx).

  • Open Microsoft Excel.
  • Rename the 1st two sheets to Village Raw Data and Village Report Card and delete the last sheet (Sheet 3)
  • Open Village Raw Data sheet.

    • Select 26 columns - click Insert Tab - click on Table to create a table. In this example, 26 referred to store 26 columns information from the Village list.
    • This time, select the same 26 columns and 3 rows and then put a name to the table range. In this example name of table range is 'VillageRecords'. 
    • Now click on Formulas Tab - Click on Name Manager - Verify the name of table range is "VillageRecords".
    • Then just imagine, 2nd row of this table range will contain the village list column names and 3rd row will contain the respective column value. 

    • See below screenshot for your reference

      SharePoint

  • Now, open the Village Report Card sheet and design the sheet as per your requirement.

    • Map the value from Village Raw Data sheet. 
    • In this example, I have mapped all the column information from Village Raw Data sheet. 
    • See the below screenshot for your reference.

      SharePoint

Step 5

Once the Village Report Card Excel template design is ready, save the template file and upload it to a document library.

SharePoint

Step 6

Open the village list view item page (DispForm.aspx). 

Example of the view item page URL is shown below.

http://sam.shapoint.com/sites/testsite/Lists/Village/DispForm.aspx?ID=1

Add an Excel Web Access Web part to the page.

Screenshot for your reference

SharePoint

Edit the Excel Web Access web part and select the workbook (VillageTemplate Excel file from the document library).

Disable and enable the options as below in Excel Web Access web part.

Screenshot for your reference

SharePoint

Set the height, width and chrome state in Excel Web Access web part.

SharePoint

Click "Apply" to update the settings in Excel Web Access web part.

Step 7

Create a JavaScript file to read the list item column name and corresponding column value based on All Items list view. Download the sourcecode.zip file to see VillageReportView.js and jquery-1.11.1.min.js file.

Logic behind VillageReportView.js file

  • In this file, it will read list item based on item id from the browser. For example ID from the browser URL: http://sam.shapoint.com/sites/testsite/Lists/Village/DispForm.aspx?ID=1
  • The idea is to read the All Items list view is to read the column names and their positions. Means it will write the column names in the same order in the 2nd row of Village Raw Data sheet in VillageTemplate excel file.
  • Then it will write corresponding column values in the 3rd row of Village Raw Data sheet in VillageTemplate excel file.
  • Then it will show the Village Report Card sheet in Excel Web Access web part.

    Screenshot of all Items list view for your reference

    SharePoint

Upload VillageReportView.js file and jquery-1.11.1.min.js file to SharePoint document library.

Screenshot for your reference

SharePoint

Open VillageReportView.js file and change the below-marked values (if required) and save it.

  • Change the jquery-1.11.1.min.js file URL.
  • Change the Site URL.
  • Change the Village List name.
  • Change the Village List GUID (Get the List GUID from list settings page url)
  • Change the All Item list view GUID  from Village list (Get the list view GUID from list view page url)

Source Code for your reference

  1. <script type="text/javascript" src="/sites/testsite/Shared%20Documents/VillageTemplate/ViewScript/jquery-1.11.1.min.js"></script>  
  2. <script type="text/javascript">  
  3.     $(document).ready(function() {  
  4.         SP.SOD.executeFunc('sp.js''SP.ClientContext'function() {  
  5.             ViewVillageReport();  
  6.         });  
  7.     });  
  8.     var siteUrl = "https://sam.sharepoint.com/sites/testsite";  
  9.     var VillagelistName = "Village";  
  10.     var VillagelistGuid = "F30508DD-A524-4F7C-A53B-9B1AC9C95F94";  
  11.     var VillagelistViewGuid = "64FE8DC2-5462-4C85-9AF2-EE0D6938B0A7";  
  12.     var ExcelTemplateSheetReportName = "Village Report Card"// Optional  
  13.     var ExcelTemplateNameRangeName = "VillageRecords"// Optional  

Open the village list view item page (DispForm.aspx). 

Example of view item page URL

http://sam.shapoint.com/sites/testsite/Lists/Village/DispForm.aspx?ID=1

Edit the DispForm.aspx page and add a content editor web part.

Screenshot for your reference

SharePoint

Edit the content editor web part and type the URL of "VillageReportView.js" file and click Apply.

Screenshot for your reference

SharePoint

Then click Stop Editing the page which will redirect to Village List All Items Page. 

Step 8

Select the village list item and click on view item.

Screenshot for your reference

SharePoint

Now it will show list item in the design format in DispForm.aspx page.

Screenshot for your reference

SharePoint

Step 9

You can still see the default SharePoint view under this custom view. 

You can minimize the list item view web part.

Screenshot for your reference

SharePoint

Step 10

From time to time, if the customer would like to change the design of this view, then you just need to change the design in the excel template and upload it to document library.

In this example, we will map few more columns and add a Life Style chart based on raw data from Village Raw Data sheet.

Screenshot for your reference

SharePoint

Save the excel template file.

Upload this new file and replace the old excel template file in the document library.

Step 11

Open the list item to view the latest design.

Screenshot for your reference 

SharePoint

Additionally you can print the village card report and save it as PDF file.

Screenshot for your reference

SharePoint

Here is the PDF view.

Screenshot for your reference

SharePoint

Hope this article helps you to view the SharePoint list item based on the design template you need using Excel Web Access web part without writing code again and again.

X

Build smarter apps with Machine Learning, Bots, Cognitive Services - Start free.

Start Learning Now