Archive for category WSP Builder

Deploy and Re-deploy a web part solution package (.wsp) using STSADM command.

Deploying a web part solution to the SharePoint using STSADM is an easy task, everyone knows about it. But while developing a web part, sometimes we need to re-deploy the solution again and again. In this case we cannot simply re-deploy the solutions and we have to follow some additional steps to redeploy again.

There are several ways to create the solution file, but I have used the WSPBuilder to create this web part solution. You can see this in my previous post.

Deploy :

There are 2 steps to deploy a solution using stsadm.

  1. Add solution – Add a solution file to the solution store. See more details here.
    • Syntax: stsadm -o addsolution   -filename <solution file name>
  2. Deploy solution – Deploys files related to a solution from the configuration database to individual front-end Web servers in the farm. See more details here.
    • Syntax: stsadm -o deploysolution   -name <solution name>   -immediate  -allowgacdeployment   -force –allcontenturls
  3. We need one more command to Executes all administrative timer jobs immediately instead of waiting for the timer job to run. See more details here.
    • Syntax:stsadm -o execadmsvcjobs

Ok, we will see the steps here:

Step 1: Open the cmd prompt and change the directory (cd) to stsadm.exe location, I am using SharePoint 2007 so this is the path:  “cd c:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\bin”

Step 2: Adding the solution, my solution file is in the C:\Temp\

stsadm -o addsolution -filename C:\Temp\WSPBuilderStepBiStep.wsp

Step 3: Deploying the solution

stsadm -o deploysolution -name WSPBuilderStepBiStep.wsp -immediate -allowGacDeployment -force -allcontenturls

Step 4: Executing the timer jobs

stsadm -o execadmsvcjobs

Please note: The name and filename in the above commands, if it is filename we have to use full file path.

Re-Deploy:

When we deploy the solution package without retract and delete then we will get the following error message:

There are many ways to do this (Using UI, WSPBuilder and so…) but here are the steps which I normally used (Specially in the production servers):

  1. Retract solution: Retracts the specified solution’s deployment which removes files from the front-end Web server. This is actually reversing the deployment. See more details here.
    • Syntax: stsadm -o retractsolution   -name <solution name>  [-immediate]  [-allcontenturls]
  2. Delete solution:Removes a solution file (package) from the solution store. See more details here.
    • Syntax: stsadm -o deletesolution    -name <name>    [-override]

Here are the steps:

Step 1: Retracting the solution

stsadm -o retractsolution -name WSPBuilderStepBiStep.wsp -immediate –allcontenturls

Step 2: Executing the timer jobs

stsadm -o execadmsvcjobs

Step 3: Deleting the solution

stsadm -o deletesolution -name WSPBuilderStepBiStep.wsp –override

Step 4: Re-deploy the solution again, for this follow the steps 1 to 3 in the Deploy!

That’s all, Happy deploying..! 🙂

Advertisements

, , , , ,

2 Comments

Developing a simple web part (.wsp) using WSPBuilder

Before we started the development, we have to install the WSPBuilder (SharePoint WSP tool), an extensions for Visual Studio. Just download the latest version here and install it. It is pretty easy steps.

Step 1: Create a new project on visual studio and then select the project type WSPBuilder  under C# programming language (I am using Visual Studio 2008).

Step 2: This is will create the following structure in the solution explorer.

Step 3: Right click on the project (WSPBuilderStepBiStep) and then add a new Item.

Step 4: This will give the following dialog box and then select WSPbuilder and Web Part Feature template. Enter the name and click Add button (I have given WebPartStepBiStep here)

Step 5: We will get the following dialog box and asking for the scope for this Web Part. I just modified the description and select the scope and then click OK.

Step 6: The solution explorer will look like this. Under the 12 hive folder you can see the Template and Features sub folders.

Step 7: Double click  on the WebPartStepBiStep.cs file and add your custom code on the right place. I just modifed the property like this:

public string MyProperty
        {
            get
            {
                if (_myProperty == null)
                {
                    _myProperty = "Hello Step Bi Step!";
                }
                return _myProperty;
            }
            set { _myProperty = value; }
        }

If you wanna to add a label rather than using this LiteralControl just replace the following code

this.Controls.Add(new LiteralControl(this.MyProperty));

with this

System.Web.UI.WebControls.Label label=new System.Web.UI.WebControls.Label();
label.Text = "Hello StepBiStep!";
this.Controls.Add(label);

Step 8: After replacing the code, the CreateChildControls() method will look like this:

        protected override void CreateChildControls()
        {
            if (!_error)
            {
                try
                {
                    base.CreateChildControls();
                    // Your code here...
                    System.Web.UI.WebControls.Label label=new System.Web.UI.WebControls.Label();
                    label.Text = "Hello StepBiStep!";
                    this.Controls.Add(label);
                }
                catch (Exception ex)
                {
                    HandleException(ex);
                }
            }
        }

Step 9: To build the project, just right click on the project name (WSPBuilderStepBiStep –> Build) and click Build.

Step 10: To build the WSP, Right click on the project name(WSPBuilderStepBiStep) –> WSPBuilder –> Build WSP

Step 11: This will create the .dll and .wsp files.


Step 12: To deploy the web part (.wsp file), right click on the project name(WSPBuilderStepBiStep) –> WSPBuilder –> Deploy


Step 13: You will get the following output, saying the .wsp file deployed successfully (done!).


Step 14: Go to the Web Part gallery and  populate the deployed Web Part on the New web part page.

Step 15: To use this Web Part in to your page, just follow these steps from my previous post. That’s all! Happy WSPBuilding..! 🙂

Please note: You have to run the Visual Studio as Administrator, otherwise you will get this error when you deploy the web part.

References:

1. http://rasor.wordpress.com/2008/10/12/wss-dev-quickstart/

, , , , , , , , , ,

2 Comments

How to add a custom web part to SharePoint 2007

Everyone knows about this, but I wanted to re-use this for my next series of custom web part posts. 🙂
I have already developed and deployed  the web part (WebpartStepBiStep.wsp) using STSADM command, you can see my previous post here. Now we will see the steps:

Step 1: On the SharePoint site, click Site Actions –> Site Settings –>Modify all site settings

Step 2: Site Settings page, click Web Parts under Galleries

Step 3: On the Web Part Gallery page, click New

Step 4:On the New Web Parts page, select the check box next to the Web Part that you want to add, and then click Populate Gallery

Step 5: Web part will be showing on the web part gallery.

Step 6: Click Site Actions, and then click Edit Page

Step 7: Click Add a Web Part

Step 8: In the Add Web Parts dialog box,  select the check box next to the Web Part that you want to add, and then click Add button

Step 9: The web part will be shown on your page.

Step 10: If you want modify the appearance and layout then Click Publish.

Step 11: That’s all, we are done.

Reference:
http://support.microsoft.com/kb/939306

, ,

2 Comments

WSP Builder Error 1 – Microsoft SharePoint Services Timer is not running on ”Server Name”

I was developing a Webpart using WSPBuilder (SharePoint WSP tool) in my new development server (SharePoint 2007, Visual Studio 2008 and Windows 2008 R2) and was trying to deploy the solution then I have got the following error message!

I have checked the “Windows SharePoint Services Timer” on the Windows Services and it was running! I tried to re-build and re-deploy the solution again and I have got the same error message again. 😦

Start –> Administrative Tools –> Services

After spending several minutes and I have found the solution here!

If we want to deploy a solution using WSPBuilder, it needs the Administrative privileges, so we need to run the Visual Studio as Administrator.

That’s it, I was able to deploy the Webpart successfully!

References: 

1. http://social.msdn.microsoft.com/Forums/ar/sharepoint2010general/thread/74aff7aa-ea97-4317-a4ba-41566cbe020a

2. http://pbodev.wordpress.com/2010/01/05/microsoft-sharepoint-services-timer-is-not-running/#comment-57

3. http://madtechnology.wordpress.com/2008/06/24/wsp-builder-for-sharepoint-microsoft-sharepoint-services-timer-is-not-running-error/

, , , , ,

1 Comment