English

Before we continue, I suggest you read the first part here ; it gives basic idea of how it works. The purpose of part-2 is to make real implementation of Custom Web Service , but it is not the only way to do it. There are some key points that I want to show here:

1. We will put our custom Web Services in a Custom folder under _vti_bin. In this case we will create new folder WSCustom under (12hive/ISAPI for SharePoint 2007 or 14hive/ISAPI for SharePoint 2010)
2. We will need a helper to read SharePoint context (SPVirtualPath) before passing the request to the real ASMX. In this case we will copy WSDISCO.ASPX  and WSWSDL.ASPX from original _VTI_BIN to _VTI_BIN/WSCustom folder
3. We will need custom SPDisco.aspx for our web services, in this case I will name it WSCustomSPDisco.aspx. This is the file, where we will register our web service. (Note the registration is optional, but it is required for truly SharePoint integration)
4. We need an interceptor so that request to SPDisco.aspx will return combination between original SPDisco.aspx and WSCustomSPDisco.aspx. In this case, we will create WSCustomHttpHandler that combine XML from the two files.
5. We need rules to add rules to redirect request to _vti_bin/spdisco.aspx to our WSCustomHttphandler.

In the diagram, the scenario will look like this

1. Create ASPNET Web Services using Visual Studio. 
   You can follow instruction in MSDN here (http://msdn.microsoft.com/en-us/library/dd583131(v=office.11).aspx) and stop until “To copy the Web service files to the _vti_bin virtual directory”).

2. Create custom folder for your project under _vti_bin (for example 12hive/ISAPI/CustomWS for SharePoint 2007 or 14hive/ISAPI/CustomWS for SharePoint 2010). In this custom folder, we will put 3 files for every web service (*.asmx) which are:
   • <service>.asmx , where <service> is your web service file.
   • <serviceDISCO>.aspx , where <serviceDISCO> is corresponding DISCO file of your web service.
   • <serviceWSDL>.aspx , where <serviceWSDL> is corresponding WSDL file of your web service.
     
3. Copy ISAPI\spdisco.aspx to ISAPI\spdisco.disco.aspx . We need copy of original spdisco.aspx, since we don’t want to have infinite loop in our HttpHandler later.
4. Create ISAPI\customws.spdisco.aspx. In this file, we will register our custom web service. This is important to avoid modifying SharePoint built-in file.
5. Create HttpHandler to combine content of spdisco.aspx and *.spdisco.aspx.
6. Register HttpHandler in web.config. We will intercept all _vti_bin/spdisco.aspx with our HttpHandler.

More Information

1. Tutorial video, Writing Custom Web Services for SharePoint in Supported Mode.
   [See post to watch Flash video]
    
2. Download source code for this article Visual Studio 2010 + SharePoint 2010 (http://code.msdn.microsoft.com/Writing-SharePoint-Web-in-cb9de1be)

English

If you have read my comments on the Writing Custom Web Service for SharePont, Is it supported here (http://blog.libinuko.com/2011/02/16/sharepoint-writing-custom-web-service-for-sharepoint-is-it-supported/) ; you may have already created standard ASPNET web services. It is working, but with some limitation:

1. You can not have path virtualization

   Virtualization is one of SharePoint’s technique provided by SPVirtualPath provider, that enable virtualization of your web service path. For example, list.asmx will be available for http://mysite.com/_vti_bin/lists.asmx , or http://mysite.com/sites/myothersitecollection/_vti_bin/lists.asmx. The site collection has been virtualized by SharePoint.

   Without virtualization any web service consumer will have to access to the same path, usually in the root; for example /_services/mywebservice.asmx">/_services/mywebservice.asmx">http://<webapps>/_services/mywebservice.asmx

2. You can not have SPContext

   SPContext is very powerful object in SharePoint development. Using this context, we can retrieve current SharePoint context without having to instantiate it. For example, you can get current SPWeb by calling SPContext.Current.Web – and you don’t need to dispose it (in fact you’re not suppose to dispose it). Still using SPContext you can have direct access to list and everything under SharePoint.

   Without having direct access to SPContext, you have to instantiate SPWeb or SPSite using normal constructor with URL as parameter. It means new SPSite/SPWeb thread in the server memory, and you have to dispose it once you’ve done working with it.

So, how can we write custom web service for SharePoint in supported mode?

Before we start, we have to understand SharePoint architecture and how does the processing works for web services. I take following picture from SharePoint Architecture in MSDN. It describe how SharePoint process our request. There is SPHttpApplication which has SPRequestModule and any additional ASP.NET Module; and before the request returned back to the user SPHttpHandler is doint the job.

How SharePoint process web services?

If we dig into into the process on how SharePoint process request to web services in _vti_bin.

There are 3 scenarios of http request to the web services,

1. Disco request, identified by suffix ?DISCO in the web service address. For example, */_vti_bin/list.asmx?Disco
2. WSDL request, identified by suffix ?WSDL in the web service address. For example, */_vti_bin/list.asmx?Wsdl
3. Web service post request. For example, */_vti_bin/list.asmx?op=GetListItems

Every request will be processed by SPHttpHandler (SharePoint) and ScriptHandlerFactory (system.web.extension), but the SPHttpHandler will be selective only for Disco and Wsdl request.

On disco/wsdl request, SPHttpHandler will transfer the request to wsdisco.aspx or wswsdl.aspx using Server.Execute operation. This operation ensure that wsdisco.aspx/wswsdl.aspx is receiving same request object. wsDISCO.aspx or wsWSDL.aspx will then instantiate SharePoint Context object. Any *.aspx will be successfully instantiate SharePoint context object because they are managed by SPHttpApplication and hence it also impacted by SPVirtualPath provider from SharePoint which will activate path virtualization.

Next, wsDISCO.aspx will transfer the request to the <service>DISCO.aspx and wsWSDL.aspx will transfer to the <service>WSDL.aspx – using Server.Execute operation. So here we have seen 2 transfer operation. At the end, the result is correct WSDL/DISCO request. The correct WSDL/DISCO will point to the correct virtual path of the request. (Remember how do you create <service>disco.aspx / <service>wsdl.aspx)

When a consumer use the contract and tries to consume it. The SPHttpHandler will no longer intercept the request, but the normal ScriptHandlerFactory from System.Web.Extensions. However with the correct path in disco/wsdl, now the asmx now have the ability to look into current context from SharePoint. And hence you will be able to use SPContext.Current.Web in custom web services.

Part-2 is how to start create custom web services. I will need help from my buddy Denni , he will code for me. –

References

1. Writing Custom Web Services for SharePoint Products and Technology (http://msdn.microsoft.com/en-us/library/dd583131(v=office.11).aspx)

2. SharePoint Architecture (http://msdn.microsoft.com/en-us/library/bb892189(v=office.12).aspx )

3. Architectural Overview of Windows SharePoint Services (http://msdn.microsoft.com/en-us/library/dd583133(v=office.11).aspx)

4. Modifying Built-In SharePoint Files (http://msdn.microsoft.com/en-us/library/bb803457(v=office.12).aspx)

English

When I am looking for a way to compress file(s) into Zip, I find a blog from David Aiken here (Compress Files with Windows PowerShell then package a Windows Vista Sidebar Gadget) . I will just focus on Add-Zip function and nothing more.

Here is the original code:

function Add-Zip
{
    param([string]$zipfilename) 

    if(-not (test-path($zipfilename)))
    {
           set-content $zipfilename ("PK" + [char]5 + [char]6 + ("$([char]0)" * 18))
           (dir $zipfilename).IsReadOnly = $false
     } 

     $shellApplication = new-object -com shell.application
     $zipPackage = $shellApplication.NameSpace($zipfilename) 

     foreach($file in $input)
     {
            $zipPackage.CopyHere($file.FullName)
            Start-sleep -milliseconds 500
     }
}

usage: dir c:\demo\files\*.* -Recurse | add-Zip c:\demo\myzip.zip

I am raising two problems with the code:

1. Looking at the usage example, it is clear that the function accept only fully path filename. The reason, on line-12 , the $shellApplication.NameSpace parameter is $zipfilename; and this is not possible without giving fully path filename.

2. On line-16, the operation expect that $input array will contains object with FullName properties, that why the usage example uses DIR. What about if you just want to specify a filename?

With the 2 problem above, I am ready to improve that function. In the new improved version, Get-ChildItem will help us to convert any string representation of a file to a fully path filename. It won’t break DIR piping functionality, since actually Get-ChildItem is dir (and extra) functionality.

Here is the improved version:

function Add-Zip
{
	param([string]$zipfilename)

    $currFile = $zipfilename | get-childitem
	if(-not (test-path($zipfilename)))
	{
		set-content $currFile.FullName ("PK" + [char]5 + [char]6 + ("$([char]0)" * 18))
		(dir $currFile.FullName).IsReadOnly = $false
	}

	$shellApplication = new-object -com shell.application
	$zipPackage = $shellApplication.NameSpace($currFile.Fullname)

	$input | % {
            $file = $_ | get-childitem
            $zipPackage.CopyHere($file.FullName)
            Start-sleep -milliseconds 500
	}
}

usage: "FileInThisFolder.txt" -Recurse | add-Zip "ZipInThisFolder.zip"
        dir c:\demo\files\*.* -Recurse | add-Zip c:\demo\myzip.zip

So, I hope you enjoy the improved version.

English:

Conditional formatting now becomes easier using SharePoint Designer 2010. We can create intelligent view which able to highlight some important pointer in the display. There are 3 types of conditional formatting:

1. Show content , show content based on the pre-specified conditions
2. Hide content , hide content based on the pre-specified conditions
3. Apply formatting , apply formatting based on the pre-specified conditions.

Visual Touch for Easy Reading

Imagine, that you have developed a workflow that uses task list to assign task to the users. The standard task list, may look like this:

Actually there is nothing wrong with the task list web-part. However, since there isn’t any pointer on important information in the task list – then the message may not be conveyed efficiently to the reader.

Using conditional formatting, we will be able highlight overdue tasks, so that the task will get more attention from the user. In the picture below, we add red hand icon, if the task is overdue.

So, how would we do that?

Following step-by-step will show how to create conditional formatting using SharePoint Designer 2010. I will demonstrate how to add red-hand icon to the overdue task.

1. Open original task list view in SharePoint Designer 2010.

2. Select Title column tag and then create conditional formatting by selecting Apply formatting….

3. Define formatting condition as follows:

Due Date  <  [Current Date]     And

Status      <>  ‘Completed’

and then click Set Style.

4. I have uploaded the icon in Site Assets gallery, so that I can use it as background-image.

And finally I have configure my style to:

background-image: url(‘../../SiteAssets/Pointer_red_22x17.gif’); background-repeat: no-repeat; background-position: left bottom; text-indent: 20px

5. Save the changes, and you’ve done with the conditional formatting.

Finally, adding visual touch using conditional formatting is also adding more value to the user. It will make the information more knowledgeable than plain presentation.

English:

Sometimes you may received a request to change rating icons, from a normal star to a love icon. So, how would you do it?

Figure 1. Original rating icons

Figure 2. Modified love rating icons

1. Find and prepare rating icons.  In this case I will need to prepare 4 styles rating icons

Title	Sample	Size
a. Empty Rating		16×16
b. Selected Rating		16×16
c. Rating Overlay		448×16
d. Rating Overlay RightToLeft		448×16

2. Save the new icons under 14 hive\Images.

3. Create script to modify SPWeb property bag. To ease our job, I will use PowerShell script as follows,

[System.Reflection.Assembly]::LoadWithPartialName(“Microsoft.SharePoint”) > $null

$spSite = new-object Microsoft.SharePoint.SPSite(“http://win2k8″);
$spWeb = $spSite.OpenWeb();

$spWeb.Properties["Ratings_NewRatingIconUrl"] = “/_layouts/Images/love_RatingsNew.png”;
$spWeb.Properties["Ratings_EmptyIconUrl"] = “/_layouts/Images/love_RatingsEmpty.png”;
$spWeb.Properties["Ratings_ImageStripUrl"] = “/_layouts/Images/love_Ratings.png”;
$spWeb.Properties["Ratings_ImageStripRtlUrl"] = “/_layouts/Images/love_Ratingsrtl.png”;

$spWeb.Properties.Update();
$spWeb.Dispose();
$spSite.Dispose();

iisreset

4. Voila ! And you can refresh your browser to see the changes.

5. Finally you can distribute your solution into a solutions package with feature activation events to register/un-register custom rating images.

English:

This is graphical guidelines to disable My Site or My Profile link in a portal.

1. Open Central Administration , and click on “Manage service applications”.

2. Open Central Administration , and click on “Manage service applications”.

3. Click on “Manage User Permissions”

4. Remove “Use Personal Features” permission for the Groups/Users.

5. If you can’t see the new rules being reflected in the site. You can restart “User Profile Service”

6. And now, the users will not be able to see My Site / My Profiles link.

English

Imagine a business scenario where we have a lookup field in our list. The reference list contains items Title and their status.  Previously it always difficult to create filtered lookup field with minimal development task. But now, we can use InfoPath 2010 to achieve that functionality.

Part III , InfoPath 2010 and SharePoint 2010 Productivity series webcast shows how to create filtered lookup field.  There are two lists in the scenario “Books” and “Members” list.  The Books list contains list of books Title, Author and Status. There are 2 status of books, “Available” , “In-Used” and “Missing”.

“Members” list has Books  , lookup field – which should show only the “Available” books.

English:

Imagine that user wants to build Book lending application using SharePoint 2010. Initially they must register the book description , and sub-sequently they will update book lending status.  On the registration, the status should not be available in the form – however on lending event , they have to modify the status of the book.
Following webcast shows how to use InfoPath Designer 2010 to customize New/Edit/View form in SharePoint List to build that application.

English

You may encounter “Access denied by Business Data Connectivity” error when trying to access External List. The reason is because External List requires External Content type ; and External Content type is using Business Data Connectivity services proxy to access external Data Source. With the same principle of BDC in MOSS 2007 – users are required to have BDC Object permission before they can use it.  There are several set of permission available for the BDC object:

- Edit                                  
- Execute                            
- Selectable in Clients
- Set Permissions

How to configure the BDC access rights?

1. Open Central Administration page, and click on Manage service application.

2. Click on Business Data Connectivity Service

3. Open the context menu of the External Content type (ie. External CT in this example). Click on Set permissions.

4. Add account (Group, or User) and assign the permissions.

5. Set appropriate permission to the BDC object. Remember that BDC object permission rules the interaction between user and external data source through BDC object. It doesn’t rules his/her permission accessing Forms in the list (New / Edit / Delete  form).

English:

External Content type allows you to make seamless interface between SharePoint 2010 and external data storage (ie. SQL server). Using External Content type, you can create an External List which stores the data to predefined storage. You can imagine of having a table with SharePoint list interface.

To create an External Content type, you need SharePoint Designer 2010. If you curious enough, the External Content type is enhancement of Business Data Connector (BDC) in previous version. It will now depend on Business Connectivity Services (BCS) – which more or less same as BDC.

Imagine that you have a table in SQL Database and you want to create SharePoint list which directly stores the data in that table.

1. Open SharePoint Designer and click on External Content Types

2. Define the new External Content Type name. Then click on “External System” to start to connect to external Data Storage.

3. Define connection to external data storage. (ie. DB name,  and security)

In my case, I use SQL server as my data storage.

There are 3 security connection options in SQL Server Data Source:
– Connect with User’s Identity   => it will use running user’s credential to access to DB server. This implies that you need to manage user’s access rights in DB server.
– Connect with Impersonated Windows Identity => it will use impersonated Windows Identity ; usually the Application Pool identity.
– Connect with Impersonated Custom Identity => it will use specified user/password combination ; you need to define the Custom Identity separately.

Now, we already have the External List with the tables and views.

4. Select any table for the External Content types. In this scenario, I select RequestTbl for my data storage. Right click on the selected table, and SPD2010 will show you the available operations.
The External Content Types requires at least “Read Item” and “Read List” operation.  In every operation you will need at least 1 identifier.

Follow the wizard to create an operation.

Don’t forget that every operation requires at least 1 identifier. You can choose ID field from the table.

You can also define the default view filter, for example, by default this external content type will show only the first 100 items.

5. Publish the new content type by click “Save” button.

Now you already have new External Content Type. You can also create external content type to call .NET CLR and WCF Service. Next , how to use the external content type in a list.