Customizing URLs for Siebel CRM Applications

This task is part of Customizing the Application Container for Siebel Application Interface.

You can perform various configuration steps to customize the URLs you use for Siebel CRM applications. The steps you perform for this task primarily involve editing files on the application container (Apache Tomcat) for Siebel Application Interface.

The keyword siebel is present in the Siebel CRM application URLs as a result of your deploying the siebel.war file on the application container, though it also exists in other configuration contexts. The particular customization you can make is to replace the keyword siebel in the Siebel URLs with a name suitable for your organization, such as myorg. Perform these steps after configuration and deployment tasks using Siebel Management Console. These steps do not involve renaming the siebel.war file.

You can specify a custom keyword when you install Siebel CRM in a new deployment. For more information, see Installing Siebel CRM in a New Installation.

The existing URL format is as follows:

https://host:port/siebel/app/application/lang

You can customize the Siebel Application Interface to use a different keyword, so the format would resemble the following:

https://host:port/myorg/app/application/lang

An example of a customized URL would be as follows:

https://server1:9000/myorg/app/callcenter/enu

To customize the URLs for Siebel CRM, use the steps in the procedure that follows.

To customize the URLs for Siebel CRM

  1. Log in to the computer where you installed Siebel Application Interface.

  2. Stop the application container, as described in Stopping and Starting the Siebel Application Container.

  3. Navigate to the directory SIEBEL_AI_ROOT\applicationcontainer_external\conf.

  4. Back up the server.xml file.

  5. Open server.xml for editing, using a suitable text editing tool. For example, on Microsoft Windows you might use Notepad.

  6. In server.xml, locate the <Host> tag, and modify this line to include the autoDeploy element, as follows:

    <Host name="localhost" appBase="webapps" unpackWARs="true" autoDeploy="true">
  7. Under this <Host> tag, insert <Context> tags in lines like the following, substituting your preferred keyword for myorg. Include lines for all applicable languages.

    <Context docBase="${catalina.base}/siebelwebroot/images" path="/myorg/images" /> 
    <Context docBase="${catalina.base}/siebelwebroot/scripts" path="/myorg/scripts" />
    <Context docBase="${catalina.base}/siebelwebroot/smc" path="/myorg/smc" />
    <Context docBase="${catalina.base}/siebelwebroot/files" path="/myorg/files" />
    <Context docBase="${catalina.base}/siebelwebroot/htmltemplates" path="/myorg/htmltemplates" />
    <Context docBase="${catalina.base}/siebelwebroot/fonts" path="/myorg/fonts" />
    <Context docBase="${catalina.base}/siebelwebroot/migration" path="/myorg/migration" />
    <Context docBase="${catalina.base}/siebelwebroot/enu" path="/enu" />
    <Context docBase="${catalina.base}/siebelwebroot/enu" path="/myorg/enu" />
    <Context docBase="${catalina.base}/webapps/siebel" path="/myorg" />
    <Context docBase="${catalina.base}/webapps/ROOT/" path="/" />
    <Context path="/manager" docBase="${catalina.base}/webapps/manager" privileged="true" />
    

    If the webapps directory on the Application Interface also contains the subdirectories host-manager, docs, or examples, then also add <Context> lines like the following:

    <Context docBase="${catalina.base}/webapps/host-manager/" path="/host-manager" />
    <Context docBase="${catalina.base}/webapps/docs/" path="/docs" />
    <Context docBase="${catalina.base}/webapps/examples/" path="/examples" />
  8. Save your updates to server.xml.

  9. Restart the application container, as described in Stopping and Starting the Siebel Application Container.

    Next, you will update any referring links to the affected URLs.

  10. Run Siebel Management Console. In the Siebel Application Interface profile, under the REST Inbound Defaults section, update the value for the REST Response Base URL to reflect the URL change. For example, change this URL:

    https://host:port/siebel/v1.0/

    as follows:

    https://host:port/myorg/v1.0/

    For more information, see Configuring the Siebel Application Interface.

  11. Stop the application container, as described in Stopping and Starting the Siebel Application Container.

  12. Modify the re-write.config file. Do the following:

    1. Navigate to the directory SIEBEL_AI_ROOT\applicationcontainer_external\webapps\ROOT\WEB-INF.

    2. Back up the re-write.config file.

    3. Open re-write.config for editing using a suitable text editor, such as Notepad in Windows.

    4. Modify the following line, substituting siebel with the new keyword myorg, as you did in server.xml. For example, change this line:

      RewriteRule ^/eai_enu/start.swe?(.*)$ /siebel/app/eai/enu/$1 [L]

      as follows:

      RewriteRule ^/eai_enu/start.swe?(.*)$ /myorg/app/eai/enu/$1 [L]
    5. Make the same change in the lines for all other Siebel languages.

    6. Save your updates to re-write.config.

  13. Modify the ResourceSequence.txt file, which is used by the Siebel Migration application. Do the following:

    1. Navigate to the directory SIEBEL_AI_ROOT\applicationcontainer_external\webapps\siebel\WEB-INF. Then back up the ResourceSequence.txt file, if it exists.

    2. If ResourceSequence.txt does not exist, then navigate to SIEBEL_AI_ROOT\applicationcontainer_external\webapps, back up the siebel.war file, and extract ResourceSequence.txt into a directory of your choice (for temporary use).

    3. Open ResourceSequence.txt for editing using a suitable text editor, such as Notepad in Windows.

    4. Modify the following lines, substituting siebel with the new keyword myorg, as you did in server.xml. For example, change these lines:

      AuthenticationURISuffix=/siebel/v1.0/service/Authentication%20Service%20For%20Migration/AuthenticateUser
      RepoUpgradeURISuffix=/siebel/v1.0/service/describe?searchspec=%5BName%5D%20LIKE%20%27Application%20Migration%20Utility%20Service%27
      

      as follows:

      AuthenticationURISuffix=/myorg/v1.0/service/Authentication%20Service%20For%20Migration/AuthenticateUser
      RepoUpgradeURISuffix=/myorg/v1.0/service/describe?searchspec=%5BName%5D%20LIKE%20%27Application%20Migration%20Utility%20Service%27
      
    5. Save your updates to ResourceSequence.txt. Then replace this file in siebel.war.

      When the application container is restarted, the updated version of ResourceSequence.txt is extracted into SIEBEL_AI_ROOT\applicationcontainer_external\webapps\siebel\WEB-INF.

  14. Restart the application container, as described in Stopping and Starting the Siebel Application Container.

  15. Perform the same steps for each instance of Siebel Application Interface in your deployment.