Installing a server role as a JSP Web application—universal procedure

To install a server role as a JSP Web application, you need to set up the correct Web application directory structure then copy over the necessary JAR files, configuration files and other resources. You then need to perform configuration and install a license.

Before you begin

Read the Content Delivery prerequisites before installing a server role.

Procedure

  1. Create a new Web application in your Java/JSP Web and Application Server.
  2. Create the Web application directory structure:
    1. Create a WEB-INF/ directory.
    2. In the WEB-INF/ directory create subdirectories:
      • classes/
      • lib/
    The Web application should have the following directory structure:
    WEB-INF/
          +--classes/
          +--lib/
  3. Access the SDL Tridion installation media.
  4. Navigate to the Content Delivery\ directory and access the java\ Java subfolder for the specific role you are installing:
    FolderServer role
    roles\api\java\API
    roles\deployer\java\Content Deployer
    roles\upload\java\HTTP Upload
    roles\webservice\java\Content Delivery Web service
  5. Access the lib\ subfolder and copy all the JAR files into the lib\ folder of your Web application.
  6. Access the third-party-lib\ subfolder and copy all the JAR files into the lib\ folder of your Web application.
  7. If you intend to use the Ambient Data Framework with this Server Role, and your WEB-INF/lib/ folder does not yet contain cd_ambient.jar, copy this file from Content Delivery\roles\api\java\lib\ to your WEB-INF/lib/ folder.
  8. If you store published content in a database, download the JDBC driver (JAR file) required for your specific database vendor and Java version, and copy it into the lib folder:
    Database vendorJDBC DriverFile to download when using Java 5File to download when using Java 6
    Microsoft SQL ServerMicrosoft SQL Server JDBC Driver 3.0sqljdbc.jarsqljdbc4.jar
    Oracle

    Oracle JDBC driver 11.2.0.2.0 or

    Oracle JDBC driver 11.2.0.1.0 (deprecated)

    ojdbc5.jarojdbc6.jar
    IBM DB2IBM Data Server Driver for JDBC and SQLJdb2jcc.jardb2jcc.jar
  9. Navigate to resources\configurations\.
  10. Copy logback.xml from that folder to the WEB_INF/classes/ subdirectory of your Web application.
  11. Check the JAR files in your Web application's lib subfolder that begin with cd_. You need to copy the corresponding configuration files to the config (.NET) or classes (Java) directory of your Web application and rename them as follows:
    JAR fileCorresponding configuration fileRenamed configuration file
    cd_ambient.jarcd_ambient_conf_sample.xmlcd_ambient_conf.xml
    cd_deployer.jarcd_deployer_conf_sample.xmlcd_deployer_conf.xml
    cd_datalayer.jarcd_storage_conf_sample.xmlcd_storage_conf.xml
    cd_dynamic.jarcd_dynamic_conf_sample.xmlcd_dynamic_conf.xml
    cd_linking.jarcd_link_conf_sample.xmlcd_link_conf.xml
    cd_monitor.jarcd_monitor_conf_sample.xmlcd_monitor_conf.xml
    cd_wai.jarcd_wai_conf_sample.xmlcd_wai_conf.xml
    cd_webservice.jarcd_webservice_conf_sample.xmlcd_webservice_conf.xml
  12. Open cd_ambient_conf.xml (if using) in a plain-text or XML editor.
  13. Find the <Security> section and enclose it in comments. This element is only needed if you intend to set up OAuth authentication.
  14. Save and close cd_ambient_conf.xml.
  15. Copy cd_licenses.xml, your Content Delivery license file available from SDL Tridion Customer Support, to the config (.NET) or classes (Java) 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 License element in your configuration files.
  16. Configure logging.
  17. If your configuration files include a cd_storage_conf.xml, configure the Storage Layer and optionally encrypt sensitive strings.
  18. If your Web application server is JBoss, locate the following files in the WEB_INF/lib/ subdirectory and remove them:
    • stax-api.jar
    • serializer.jar
    • xalan.jar
    • axis-jaxprc.jar
  19. If your Web application server is WebLogic, do the following:
    1. Remove the file stax-api.jar from your WEB_INF/lib/ subdirectory.
    2. Add a weblogic.xml file to the WEB-INF folder of your Web application that forces WebLogic to use the libraries contained in the Web application, rather than its own libraries. The contents of this weblogic.xml file must be as follows:
      <weblogic-web-app xmlns="http://xmlns.oracle.com/weblogic/weblogic-web-app">
            <container-descriptor>
                  <prefer-web-inf-classes>true</prefer-web-inf-classes>
            </container-descriptor>
      </weblogic-web-app>
  20. If you intend to use the Ambient Data Framework with this Server Role, also add the following to your web.xml:
    <filter>
      <filter-name>Ambient Data Framework</filter-name>
      <filter-class>com.tridion.ambientdata.web.AmbientDataServletFilter</filter-class>
    </filter>
    <filter-mapping>
      <filter-name>Ambient Data Framework</filter-name>
      <url-pattern>/*</url-pattern>
    </filter-mapping>
  21. Start the Web application.