Installing the API Server Role as a .NET Web application
Installing the API server role involves registering .NET Server Controls, configuring Profiling & Personalization, and setting up the Ambient Data Framework. The API Server Role is typically installed on the staging or live Web site, and takes care of resolving dynamic links between content items.
Procedure
- Ensure that all the prerequisites for a Content Delivery Server Role are met on your target system.
- If you use Windows 2012 or Windows 2012 R2, do the following:
- Start up the Server Manager and Add Roles and Features Wizard. Step through the wizard until you reach the Features screen.
- If you use .NET 4.5, expand the item .NET Framework 4.5 Features and the subitem WCF Services. If the option HTTP Activation is not listed as installed, select it.
- Alternatively, if you use .NET 3.5, expand the item .NET Framework 3.5 Features. If the option HTTP Activation is not listed as installed, select it.
- Click Next and Install to install the feature.
- If you use Windows 2008 R2 SP1, do the following:
- Start up the Server Manager and under Features Summary, select Add Features.
- In the Add Features dialog that opens, expand the item .NET Framework 3.5.1 Features and the subitem WCF Activation. If the option HTTP Activation is not listed as installed, select it.
- Click Next and Install to install the feature.
- If this is a 32-bit .NET Web application running in combination with Java 6, then in the advanced system properties of your machine, select Environment Variables to see and edit your environment variables, and ensure that your
PATHvariable contains the bin\ subfolder of the Java instance you are using. This location contains the file MSVCR71.DLL. - Create the following Web application directory structure:
- In the root folder, create a
bin\subfolder. - In the
bin\folder, create subfolders config\ and lib\.
- In the root folder, create a
- Access the SDL Tridion installation media.
- Navigate to the Content Delivery\roles\ folder.
- Access the api\DotNET subfolder.
- Copy all DLLs in this folder to the bin\ folder of your Web application.
- Do one of the following:
- To install a 32-bit .NET Web application, access the x86\ subfolder.
- To install a 64-bit .NET Web application, access the x86_64\ subfolder.
- Copy all DLLs in this folder to the bin\ folder of your Web application.
- On the installation media, navigate to the Content Delivery\roles\api\java\ folder.
- Copy all the JAR files from the lib\ subfolder, and all the JAR files from the third-party-lib\ subfolder, to the bin\lib\ folder of your Web application.
- If you store published content in a database, download the JDBC driver (JAR file) required for your specific database vendor and copy it into the bin\lib folder of your Web application:
Vendor JDBC Driver Required JAR Microsoft SQL Server Microsoft SQL Server JDBC Driver 4.0 sqljdbc42.jar for Java 8
sqljdbc4.jar for Java 6 or Java 7
Oracle Oracle JDBC driver 11.2.0.3 (deprecated) ojdbc6.jar for Java 6 or Java 7
Oracle Oracle JDBC driver 12.1.0.1 ojdbc7-12.1.0.1.jar for Java 8
ojdbc7.jar for Java 7
ojdbc6.jar for Java 6
IBM DB2 IBM Data Server Driver for JDBC and SQLJ (9.7 GA) (deprecated) Not supported with Java 8
db2jcc.jar for Java 6 or Java 7
You can download JDBC drivers from the following locations:- Oracle: download the JDBC Driver 12.1.0.1 from this location: http://www.oracle.com/technetwork/database/features/jdbc/index-091264.html
- SQL Server: download the JDBC Driver 4.0 from this location: http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=11774
- DB2: the JDBC driver is included with your DB2 installation.
- Navigate to \Content Delivery\resources\configurations\.
- Copy logback.xml from that folder to the bin\config folder of your Web application.
- Copy and rename the following configuration files to the bin\config folder of your Web application:
Corresponding configuration file Renamed configuration file cd_dynamic_conf_sample.xml cd_dynamic_conf.xml cd_storage_conf_sample.xml cd_storage_conf.xml cd_link_conf_sample.xml cd_link_conf.xml cd_wai_conf_sample.xml cd_wai_conf.xml - Copy cd_licenses.xml, your Content Delivery license file available from SDL Tridion Customer Support, to the bin\config directory of your Web application.
If you want to name the file differently or put it in a different location, you need to update the
Licenseelement in your configuration files. - Optional: Configure logging.
- Configure the Storage Layer and optionally encrypt sensitive strings.
- Disable recycling of the Application Pool of this Web application by doing the following:
- Open IIS Manager.
- From the tree on the left, select the current machine and navigate to the Web application you just created.
- Click Advanced settings to open a dialog with the application's properties, and note down the value of Application Pool.
- Close the dialog.
- From the tree on the left, under the current machine, now select the Application Pools node.
- From the list on the right, select the Application Pool you just noted down.
- Select Recycling in the Edit Application Pool area on the right.
- In the dialog that opes, deselect Regular time intervals, then click Next and Finish to commit your change.
- Restart IIS.
- 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, and open it for editing.
- Add a page control as follows:
<configuration> <system.web> <pages> <controls> <add tagPrefix="tridion" namespace="Tridion.ContentDelivery.Web.UI" assembly="Tridion.ContentDelivery" /> </controls> </pages> </system.web> </configuration> - If you intend to use Profiling & Personalization functionality, do one of the following:
- 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" /> - 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" />
- Save and close Web.config.
- Restart the Web application.