SharePoint 2013/Online: Implement Client Caching for SharePoint Objects

Before started reading this article I would recommend that you should read my previous article SharePoint 2013/Online: Implement Client Caching for SharePoint Properties on Client Caching to get better understanding on topics like Caching Concepts, HTML5 Local Storage API and Modernizr.js.

In this demo we will discuss the caching mechanism for SharePoint Objects which are more complex in nature than the primitive data types.

I have selected “SharePoint List Items Collection” object for this demo since while working with SharePoint it is often that we need to query the SharePoint Lists using CSOM or REST API, which either ways returns a SharePoint List Items Collection Object that we can hold in the local cache and can boost Read/Write Operations in a more efficient manner.

So let’s starts with a new SharePoint App Project

• Choose “App for SharePoint” Project Template

• Specify SharePoint Site URL (On Premise or Online)
• Select hosting model as “SharePoint-Hosted”

Here I am using SharePoint Online Site to go with this demonstration

• Enter SharePoint Online Account Credentials

• Let Visual Studio configure the project for you

For the sake of this demo I have created a list called Products which has got few items added as shown below:

I have added HTML code to default.aspx page that will display following elements to the UI

• Result Panel: This is a div that will display the output of the operations performed
• Get List Button: This will retrieve the data from SharePoint and add it to the Cache
• Clear Cache: This will clear the local cache whenever needed

• Added little CSS to App.css to make UI elements more intuitive

With this our UI is a go.

Now let’s explore the code that that we have added to App.js

Step 1: Hooking up the event handlers to the click event for “Get List” & “Clear Cache” button

Step2: Verifying if the current browser supports the HTML5 Local Storage API

Step 3: Verifying if the current browser supports the HTML5 Local Storage API by utilizing Feature Detection capabilities of Modernizr.js Framework. For more details on Modernizr.js you can visit https://modernizr.com/

Step 4: This function first checks if Local Storage API is supported in the current browser and if it is supported then clear the specific key by specify the key name or all the keys from local cache by calling Clear() methods that you can see as commented in this function.

Step 5: This is the helper method that checks if current browser supports the HTML5 Local Storage API traditionally by querying JavaScript “window” object

Step 6: Same as Step 2 & 3

Step 7: Instantiate the local storage object

Step 8: Try to reading SharePoint Items Collection from Local Cache by specify Cache Key after converting it into string array

Step 9: If Items Collection is not present in Local Cache then we are calling getProductListItemsCollection(). This function will fetch the items from Products List and save it to the local cache for further use. We will see the implementation details of this function in Steps 12,13,14 & 15 down the line

Step 10: If the items collection is available in the local cache then it will be fetched from local cache based on the cache key

Step 11: Calling explodeJSONObject() which is a helper function that reads the item values out of the JSON Object that is passed as input parameter. We will see the implementation details of this function in Step 16.

Step 12: Getting Products List and query items using CAML Query

Step 13: Converting Lists Items Collection into a valid JSON Object by calling getJSONObject() method. We will see the implementation details of getJSONObject() method in Step 17 down below

Step 14: Once we received the valid JSON Object we can save it to Local Storage Cache by converting it back to String Array.

Step 15: Calling explodeJSONObject() which is a helper function that reads the item values out of the JSON Object that is passed as input parameter. We will see the implementation details in Step 16.

Step 16: explodeJSONObject() method takes JSON form of SharePoint List Items Collection and display it to the Result Panel by treating each row in the List Item Collection as Object with each column as its properties. Since we are fetching Item ID and Product Title Columns in the SharePoint List Items Collection so we can use it as [“RowObject”.ID] and [“RowObject”.Title] to display it in the result panel.

Step 17: getJSONObject() method takes SharePoint List Items Collection as input and transform it into JSON Object by reading values from List Items Collection

Step 18: getQueryStringParameter () is a helper method that helps you to extract Query String values based on the parameter name

With this we are done with the code.

Before we start execution we need to allow Read Permission to the App on Site Collection

• Launch AppManifest.xml
• Go to “Permissions” Tab
• Select “Site Collection” from Scope Dropdown
• Select “Read” from Permission Dropdown

Run the App

Enter the SharePoint Online Credential when prompted

Trust the App when prompted

When App lunches we can see the UI based on the HTML that we have added earlier to the default.aspx page

We can see Result Panel where we will see the results of the operations and “Get List”, “Clear Cache” buttons as well

First time when the “Get List” button clicked following tasks are being performed in a row:

• Verify Products Items are not present in local cache
• Products Items are then queried from SharePoint
• List Items Collection is then saved to the local cache to serve any upcoming request for the same data
• Display List Items in the Result Panel

Using Fiddler we can verify the request that is issued by App to SharePoint for getting Products List Items as shown below

Whenever “Get List” button clicked for the second time following tasks are being performed in a row:

• Verify Products Items are present in local cache
• Products Items are then fetched from local cache directly instead of sending request to SharePoint
• Display List Items in the Result Panel

Using Fiddler we can verify that there is no request issued by App to SharePoint for getting Products List Items as shown below

This is it for this demo.

Hope you find it helpful.

 

SharePoint 2013/Online: Implement Client Caching for SharePoint Properties

SharePoint Pages are intended to act as data presentation layer to the end Users for the data stored in SharePoint List. In the rich interactive Client Centric Applications it is expected to have quick response to different User Actions like Read Data from or Save Data to SharePoint List.

Any delays due to read/write operations to SharePoint can negatively impact the User experience and could lead to denial of acceptance on developed features.

Using HTML5 Local Storage API, Web Applications can store data locally in user’s browser. Local Storage is more secure and large data can be stored without impacting overall Web Application Performance.

This new API allows large amount of data (approx. 5 MB) to be cached locally which is far larger than cookies which were commonly used for caching data.

Local Storage is maintained per domain & protocol (Origin of Request) and all Web Pages of same origin can use the same Cache.

In this article we will see HTML5 Local Storage API in action and utilize it to cache SharePoint Properties of primitive data type like String, Integer, Boolean and in one of the upcoming articles in the same series I will explain the caching of some of the complex SharePoint Objects.

Let’s kick start this demo with a new SharePoint App Project in Visual Studio 2013

• Choose “App for SharePoint” Project Template

• Specify SharePoint Site URL (On Premise or Online). Here I am using SharePoint Online Site to go with this demonstration
• Select hosting model as “SharePoint-Hosted”

• Enter SharePoint Online Account Credentials

• Wait till Visual Studio configure the project for you

I have added HTML code to default.aspx page that will display following elements to the UI

• Result Panel: This is a div that will display the output of the operations performed
• Get Web Title: This HTML Button will retrieve the Title of the Host Web and add it to the Cache on click event
• Clear Cache: This HTML Button will clear the local cache whenever needed on click event

• Add little CSS to App.css to make UI elements more intuitive

With this our UI is a go.

Now let’s explore the code that that we have added to App.js

• Step 1: Hooking up the event handlers to the click event for “Get Web Title” & “Clear Cache” button
• Step2: This function first checks if Local Storage API is supported in the current browser and if it is supported then clear the specific key by specify the key name or all the keys from local cache by calling Clear() methods that you can see as commented in this function.
• Step 3: This is the helper method that checks if current browser supports the HTML5 Local Storage API traditionally by querying JavaScript “window” object

• Step 4: This method is a helper function that helps to retrieve Query String Parameters out of the requested URL

• Step 5: Verifying if the current browser supports the HTML5 Local Storage API
• Step 6: Verifying if the current browser supports the HTML5 Local Storage API by utilizing Feature Detection capabilities of Modernizr.js Framework. For more details on Modernizr.js you can visit https://modernizr.com/
• Step 7: Instantiate the local storage object
• Step 8: Reading Web Title value out of Local Storage Cache by specifying the key
• Step 9: If the Web Title exists in the Local Cache then the value is retrieve out of it without any need of issuing call to SharePoint else we call another helper method “getWebTitle()” that will issue the request to SharePoint and get the Web Title, display it to result Panel and add the value to the Local Cache and make it available to server any subsequent request.

• Step 10: In this method we are making CSOM call to SharePoint in usual way, once the call gets succeed the Web Title will get displayed in the Result Panel and also adding the value to local storage by calling setItem() method. This value will be available to serve from Cache in response to any future request for Web Title.

With this we are done with the code.

Before we start execution we need to allow Read Permission to the App on Site Collection

• Launch AppManifest.xml
• Go to “Permissions” Tab
• Select “Site Collection” from Scope Dropdown
• Select “Read” from Permission Dropdown

• Run the App
• Enter the SharePoint Online Credential when prompted

•  Trust the App when prompted

When App lunches we can see the UI based on the HTML we have added earlier to the default.aspx page

We can see Result Panel where we will see the results of the operations and “Get Web Title”, “Clear Cache” buttons as well

Now when we click on “Get Web Title” button we can see two actions performed & logged in the Result Panel as follows-

• Since the Web Title is not available in the Local Cache, it is retrieved from SharePoint and saved back to the local cache
• Displaying Web Title in the Result Panel

If we investigate the Client – Server Request cycle using Fiddler we can see that there is actually a request issued to SharePoint and the response received from the server in form of requested data.

When we click “Get Web Title” button again we will see following two actions performed & logged in the Result Panel

• Since the Web Title is available in the Local Cache this time , so no call has been issued to SharePoint for data and Web Title has been retrieved from the Local Cache
• Displaying Web Title in the Result Panel retrieved out of Local Cache.

If we look into Fiddler again we can see that no request has been issued to SharePoint since we got the requested data available in Local Cache.

That’s it for this article.

In the upcoming article on Client Caching I will explain the caching scenarios related to bit more complex SharePoint Object like “SPListItemCollection” which is quite common return type when we query data from SharePoint Lists and deserve special attention as long as the caching is concerned.

Hope you find it helpful.