stsadm.webconfig

Source code checked in, #49966

_TFSSERVICE — Mon, 19 Jul 2010 20:19:27 GMT

Checked in by server upgrade

New Post: How to use on a cluster

mtbak313 — Wed, 09 Dec 2009 17:00:18 GMT

Is it possible to use stsadm.webconfig on a cluster?
You have to give stsadm.webconfig the url to the webapplication. So you don't know on which server you currently are.

Closed Issue: connection strings are getting removed [2228]

richfinn — Fri, 18 Sep 2009 23:13:34 GMT

While using webconfig_apply, the command is adding the connection strings to the web.config file. Where as the connection string entries are not getting removed while using webconfig_remove command. The following are entries in the xml file.

<ConfigEntry>
<Name>connectionStrings</Name>
<Path>configuration</Path>
<Value><![CDATA[<connectionStrings />]]></Value>
<ModType>EnsureSection</ModType>
</ConfigEntry>
<ConfigEntry>
<Name>add[@key='pubsConnectionString']</Name>
<Path>configuration/connectionStrings</Path>
<Value><![CDATA[<add name='pubsConnectionString' connectionString='Initial Catalog=pubs;User Id=sa;password=p@ssword;Data Source=.\SQLEXPRESS' providerName='System.Data.SqlClient' />]]></Value>
<ModType>EnsureChildNode</ModType>
</ConfigEntry>

Please look in to this.
Comments:

Commented Issue: connection strings are getting removed

richfinn — Fri, 31 Jul 2009 15:29:43 GMT

This is not due to a bug, but rather the order in which the items are being removed. Since you are removing the <connectionStrings/> section before you are removing the <add/> item, it doesn't know what to do. Try creating a second file used for the remove command that first removes the <add/> item, then removes the <connectionString/> section...

Commented Issue: connection strings are getting removed

subhashkotu — Tue, 14 Jul 2009 07:41:16 GMT

sorry. the title should be "connection strings are not getting removed".

Created Issue: connection strings are getting removed

subhashkotu — Tue, 14 Jul 2009 07:37:40 GMT

Updated Wiki: Home

richfinn — Mon, 06 Jul 2009 14:33:31 GMT

To apply: stsadm -o webconfig_apply -url http://webappurl -configfile config.sample.ajax35.xml
To remove: stsadm -o webconfig_remove -url http://webappurl -configfile config.sample.ajax35.xml

Another thing which can now be accomplished is that farm-specifc config values can be defined in a single solution by creating different xml config files like customapp.dev.xml, customapp.test.xml, customapp.prod.xml. If using WSPBuilder, for example, a developer can add those files to the wsp project in the /12/Config directory, and when the WSP is created and moved through the environments, the config settings will move with the solution.

One thing to point out: it's best to have a special sharepoint web application in development to test your web config changes. It is easy to mess up your web config file, and you don't want to ruin your environment. Start with a single simple config modification, test it, retract it, and then add the next one. Don't start developing your config changes and then test all of them at once.

The config file follows a simple pattern:
<ConfigEntries owner="[Title of config changes. example: ProdConfigChanges]">

</ConfigEntries>

example config file (from config.sample.ajax35.xml)
<ConfigEntries owner="AjaxifyMoss35">
<ConfigEntry>
<Name>add[@verb='GET,HEAD'][@path='ScriptResource.axd'][@validate='false'][@type='System.Web.Handlers.ScriptResourceHandler, System.Web.Extensions, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35']</Name>
<Path>configuration/system.web/httpHandlers</Path>
<Value><![CDATA[<add verb='GET,HEAD' path='ScriptResource.axd' validate='false' type='System.Web.Handlers.ScriptResourceHandler, System.Web.Extensions, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35'/>]]></Value>
<ModType>EnsureChildNode</ModType>
</ConfigEntry>
<ConfigEntry>
<Name>add[@name='ScriptModule'][@type='System.Web.Handlers.ScriptModule, System.Web.Extensions, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35']</Name>
<Path>configuration/system.web/httpModules</Path>
<Value><![CDATA[<add name='ScriptModule' type='System.Web.Handlers.ScriptModule, System.Web.Extensions, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35'/>]]></Value>
<ModType>EnsureChildNode</ModType>
</ConfigEntry>
<ConfigEntry>
<Name>SafeControl[@Assembly='System.Web.Extensions, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35'][@Namespace='System.Web.UI'][@TypeName='*'][@Safe='True']</Name>
<Path>configuration/SharePoint/SafeControls</Path>
<Value><![CDATA[<SafeControl Assembly='System.Web.Extensions, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35' Namespace='System.Web.UI' TypeName='*' Safe='True' />]]></Value>
<ModType>EnsureChildNode</ModType>
</ConfigEntry>
</ConfigEntries>

Reviewed: stsadm.webconfig 1.0.0.0 (Jul 06, 2009)

subhashkotu — Mon, 06 Jul 2009 09:25:48 GMT

Rated 4 Stars (out of 5) - Working fine..

Updated Release: stsadm.webconfig 1.0.0.0 (Jun 09, 2009)

richfinn — Thu, 25 Jun 2009 17:34:13 GMT

Make SharePoint web config modifications using a config file, rather than having to hard-code static strings in a class file.

To install:

download stsadm.webconfig.zip file.
extract on sharepoint server
run deploy.stsadmwebconfig.cmd

Released: stsadm.webconfig 1.0.0.0 (Jun 09, 2009)

Thu, 25 Jun 2009 17:34:13 GMT

Make SharePoint web config modifications using a config file, rather than having to hard-code static strings in a class file.

To install:

download stsadm.webconfig.zip file.
extract on sharepoint server
run deploy.stsadmwebconfig.cmd

Updated Release: stsadm.webconfig 1.0.0.0 (Jun 09, 2009)

richfinn — Thu, 25 Jun 2009 13:55:13 GMT

Make SharePoint web config modifications using a config file, rather than having to hard-code static strings in a class file.

To install:

download stsadm.webconfig.zip file.
extract on sharepoint server
run deploy.stsadmwebconfig.cmd

New Post: Unhandled exception while executing the command

subhashkotu — Thu, 25 Jun 2009 11:44:50 GMT

it was <Name>add[@key='eventName']</Name>.

New Post: Unhandled exception while executing the command

subhashkotu — Thu, 25 Jun 2009 11:42:56 GMT

Hi,

I am getting an unhandled exception (An unhandled exception ('Launch for user') occurred in STSADM.EXE [4384]). Here is my sample xml code which I have used to test the utility.

<ConfigEntries owner="Deloitte.Portal.Integration.ApplicationIntegration.FeatureReceiver">
  <ConfigEntry>
    <Name>add[@key='eventName']</Name>
    <Path>configuration/appSettings</Path>
    <Value><![CDATA[<add key='eventName' value='Testing Web.config XML feature' />]]></Value>
  </ConfigEntry>
</ConfigEntries>

The command I am executing is "stsadm -o webconfig_apply -url http://weburl -configfile sample.dev.xml" and the exception dialog occurs for both the options webconfig_apply and webconfig_remove.

If I cancel the exception dialog, the stscommand executes properly and gets the message "http://weburl web.config file configured successfully". Could you please help me in avoiding this unhandled exception.

~ Gangadhar Kotu

Commented Issue: stsadm copyappbincontent not working

richfinn — Wed, 24 Jun 2009 22:50:05 GMT

after deploying this utility, the above is not working, i think the xml file names should not follow webconfig.XXX.xml format as these files are being used by the above command
Comments: ** Comment from web user: richfinn **

file has been renamed, wiki has been updated, release has been updated, and code has been checked in. Again, thank you.

Updated Wiki: Home

richfinn — Wed, 24 Jun 2009 22:49:17 GMT

Project Description
Make SharePoint web config modifications using a config file, rather than having to hard-code static strings in a class file.

While SharePoint provides developers with an API to manage web.config modifications, those entries are commonly managed via custom, hard-coded Features or stsadm commands, which means packaging and deploying code to run and test changes. And, to top it off, SPWebConfigModification is not the easiest object to use, and takes a little bit of work to get right. That's why stsadm.webconfig was created.

While this custom stsadm command does not make creating the xpath needed to define the modification any easier, it does make managing your config entries extremely easier. Developers can now define web.config entries in an XML file deployed to the [12]/Config directory, run this stsadm command, and have those entries applied to the web.config file.

For example, there is a sample config file deployed with this command which will configure a web application for version 3.5 of ajax.asp.net [12]/Config/config.sample.ajax35.xml.

*To apply the config changes, run stsadm -o webconfig_apply -url http://webappurl -configfile config.sample.ajax35.xml
To remove: stsadm -o webconfig_remove -url http://webappurl -configfile config.sample.ajax35.xml*

Another thing which can now be accomplished is that farm-specifc config values can be defined in a single solution by creating different xml config files like customapp.dev.xml, customapp.test.xml, customapp.prod.xml. If using WSPBuilder, for example, a developer can just add those files to the wsp project in the /12/Config directory, and when the WSP is created and moved through the environments, the config settings will move with the solution.

One thing to point out: it's best to have a special sharepoint web application in development to test your web config changes. It is easy to mess up your web config file, and you don't want to ruin your environment. Start with a single simple config modification, test it, retract it, and then add the next one. Don't start developing your config changes and then test all of them at once.

The config file follows a simple pattern:
<ConfigEntries owner="[Title of config changes. example: ProdConfigChanges]">

</ConfigEntries>

example config file (from config.sample.ajax35.xml)
<ConfigEntries owner="AjaxifyMoss35">
<ConfigEntry>
<Name>add[@verb='GET,HEAD'][@path='ScriptResource.axd'][@validate='false'][@type='System.Web.Handlers.ScriptResourceHandler, System.Web.Extensions, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35']</Name>
<Path>configuration/system.web/httpHandlers</Path>
<Value><![CDATA[<add verb='GET,HEAD' path='ScriptResource.axd' validate='false' type='System.Web.Handlers.ScriptResourceHandler, System.Web.Extensions, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35'/>]]></Value>
<ModType>EnsureChildNode</ModType>
</ConfigEntry>
<ConfigEntry>
<Name>add[@name='ScriptModule'][@type='System.Web.Handlers.ScriptModule, System.Web.Extensions, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35']</Name>
<Path>configuration/system.web/httpModules</Path>
<Value><![CDATA[<add name='ScriptModule' type='System.Web.Handlers.ScriptModule, System.Web.Extensions, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35'/>]]></Value>
<ModType>EnsureChildNode</ModType>
</ConfigEntry>
<ConfigEntry>
<Name>SafeControl[@Assembly='System.Web.Extensions, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35'][@Namespace='System.Web.UI'][@TypeName='*'][@Safe='True']</Name>
<Path>configuration/SharePoint/SafeControls</Path>
<Value><![CDATA[<SafeControl Assembly='System.Web.Extensions, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35' Namespace='System.Web.UI' TypeName='*' Safe='True' />]]></Value>
<ModType>EnsureChildNode</ModType>
</ConfigEntry>
</ConfigEntries>

Updated Release: stsadm.webconfig 1.0.0.0 (Jun 09, 2009)

richfinn — Wed, 24 Jun 2009 22:48:00 GMT

Make SharePoint web config modifications using a config file, rather than having to hard-code static strings in a class file.

To install:

download stsadm.webconfig.zip file.
extract on sharepoint server
run deploy.stsadmwebconfig.cmd

Released: stsadm.webconfig 1.0.0.0 (Jun 09, 2009)

Wed, 24 Jun 2009 22:48:00 GMT

Make SharePoint web config modifications using a config file, rather than having to hard-code static strings in a class file.

To install:

download stsadm.webconfig.zip file.
extract on sharepoint server
run deploy.stsadmwebconfig.cmd

Source code checked in, #22232

richfinn — Wed, 24 Jun 2009 16:26:44 GMT

Commented Issue: stsadm copyappbincontent not working

richfinn — Wed, 24 Jun 2009 15:59:29 GMT

can name the files anything you'd like. I'll fix the ajax one. Thanks for the heads up.

Created Issue: stsadm copyappbincontent not working

englian — Tue, 23 Jun 2009 07:08:04 GMT

after deploying this utility, the above is not working, i think the xml file names should not follow webconfig.XXX.xml format as these files are being used by the above command