Configuring the API server role for a .NET Web application

Configuring the API server role involves registering .NET Server Controls, configuring Profiling & Personalization, and setting up the Ambient Data Framework.

Procedure

  1. Follow the universal procedure for installing a server role describing how to install the files you need for each specific server role.
  2. Ensure that you have a Java Development Kit (JDK) 5 or 6 installed.
  3. Access the SDL Tridion installation media and from the folder Content Delivery\resources\web\, copy the file web.config from that location to the root location of your Web application.
  4. Add a page control to the web.config file, as follows:
    <configuration>
    	<system.web>
    		<pages>
    			<controls>
    				<add tagPrefix="tridion" 
             namespace="Tridion.ContentDelivery.Web.UI"
             assembly="Tridion.ContentDelivery" />
    			</controls>
    		</pages>
    	</system.web>
    </configuration>
  5. If you are running Windows 2003, also include the following inside your <system.web> section:
    <compilation defaultLanguage="c#" debug="true" />
  6. If you intend to use Profiling & Personalization functionality, also do one of the following:
    IIS 6, or IIS 7.x (Application Pool in Classic Mode)

    Add the following inside the <httpModules> inside the <system.web> section (create an <httpModules> element if it does not yet exist):

    <add type="Tridion.ContentDelivery.Web.WAI.WAIModule, Tridion.ContentDelivery" name="TridionWAIHttpModule" />
    IIS 7.x (Application Pool in Integrated Mode)
    • Add the following inside the <system.webServer> section:

      <directoryBrowse enabled="true">
    • Add the following inside the <modules> inside the <system.webServer> section (create a <modules> element if it does not yet exist):

      <add type="Tridion.ContentDelivery.Web.WAI.WAIModule, Tridion.ContentDelivery" name="TridionWAIHttpModule" />
  7. To enable the Ambient Data Framework, do one of the following:
    IIS 6, or IIS 7.x (Application Pool in Classic Mode)

    Add the following inside the <httpModules> inside the <system.web> section (create an <httpModules> element if it does not yet exist):

    <add type="Tridion.ContentDelivery.AmbientData.HttpModule" name="AmbientFrameworkModule" />
    IIS 7.x (Application Pool in Integrated Mode)

    Add the following inside the <modules> inside the <system.webServer> section (create a <modules> element if it does not yet exist):

    <add type="Tridion.ContentDelivery.AmbientData.HttpModule" name="AmbientFrameworkModule" preCondition="managedHandler" />
  8. Save and close web.config and restart the Web application.