Deploying Siebel Applications with the Provisioning Server


Options



Before You Begin

Purpose

This tutorial shows you how to deploy a complete Siebel CRM IP2016 application with a demo database environment and a base database environment containing seed data only using Siebel MidTier and an Oracle 12c database to two virtual machines in Oracle Compute Cloud Service (Dedicated).

In this tutorial, you will set up security rules to enable HTTP access to your Siebel instance using port 7780. You will choose from the Oracle Cloud Marketplace the Siebel CRM IP2016 Mid tier image to install the Siebel Gateway, Web and Siebel Application Servers and connect to an Oracle database server containing either demo data or a vanilla base data.

Note that the information presented here is based on Siebel CRM IP2016, which is general availability since 2016.

Time to Complete

50 minutes

Background

Oracle Compute Cloud Service enables you to rapidly provision virtual machines (VMs) on Oracle Cloud with the necessary storage and networking resources. After you’ve created your virtual machine instance, you can navigate and test out Siebel CRM IP2016 on the VM.

What Do You Need?

A subscription to Oracle Compute Cloud Service (Dedicated) is mandatory and you must be a user with the Compute_Operations and Storage Read Write Group roles.

For more details on creating Oracle Compute Cloud Service instances, see the following:

Process Overview

To create the required Oracle Compute Cloud Service instance to deploy the Siebel CRM application, you will:

  1. Prerequisites
  2. Starting a Note Document.
  3. Generating an SSH Key Pair.
  4. Creating Security Lists, Security Rules, and a Security Application.
  5. Creating a Provisioning Server.
  6. Executing the Provisioning Script.
  7. Logging into the Siebel Application.

Prerequisites

Before you begin, you must first retrieve the following images available on the Oracle Cloud Marketplace:

  1. Siebel Provisioning Server
  2. Siebel CRM IP2016 BaseDB
  3. Siebel CRM IP2016 DemoDB
  4. Siebel CRM IP2016 Mid Tier

To retrieve these images, follow these steps:

  1. Go to the Oracle Cloud Marketplace at https://cloud.oracle.com/marketplace.
  2. Click on the PRODUCTS drop-down menu and select INFRASTRUCTURE (IaaS) > Compute Cloud.
  3. Enter 'siebel' in the search field and click Go.
  4. Install each of the above images.

To check that these images are installed, follow these steps:

  1. Navigate to the Dashboard and in the Compute tile pull down the menu and then choose Open Service Console.
  2. On the Oracle Compute Cloud Service console, click the Images tab.
  3. Compare your images to the ones below. If you have all four images installed, you are ready to proceed. If not, create the needed images.
  4. Prerequisite Images

Starting a Note Document

As you progress through this tutorial you will create and receive information that you need in future steps. To capture this information, a good practice is to create a note document using any text application of your choosing.

In your note document, the following are suggestions for information you may wish to capture as you progress through these instructions:

  1. Your Oracle Cloud User Name
  2. Your Oracle Cloud Password
  3. Cloud Identity Domain
  4. Cloud Compute REST Endpoint
  5. DBAAS REST Endpoint
  6. Your SSH Public Key
  7. Public IP
  8. private IP
  9. siebelenvurl

You can start your note document by copying the above information into it.

Generating an SSH Key Pair

When you create your Oracle Compute Cloud Service instance, you must provide an SSH public key that will be used for authentication when you log in to the instance. Generate your SSH key pair and upload the SSH public key to the Oracle Compute Cloud Service before you start to create your instance.

Generating an SSH Key Pair on UNIX or UNIX-Like Systems Using ssh-keygen

  1. Run the ssh-keygen command.
    ssh-keygen -b 2048 -t rsa
  2. The command prompts you to enter the path to the file in which you want to save the key. A default path and file name are suggested in parentheses. For example: /home/user_name/.ssh/id_rsa. To accept the default path and file name, press Enter. Otherwise, enter the required path and file name, and then press Enter.
  3. The command prompts you for a passphrase. Enter a passphrase.
    Note that the passphrase isn't displayed when you type it in. Remember the passphrase. If you forget the passphrase, you can't recover it.
  4. When prompted, enter the passphrase again to confirm it.
    The command generates an SSH key pair consisting of a public key and a private key, and saves them in the specified path. The file name of the public key is created automatically by appending .pub to the name of the private key file. For example, if the file name of the SSH private key is id_rsa, then the file name of the public key would be id_rsa.pub.
  5. Make a note of the path where you've saved the SSH key pair.
    When you create instances, you must provide the SSH public key. When you log in to an instance, you must specify the corresponding SSH private key and enter the passphrase when prompted.

Generating an SSH Key Pair on Windows Using the PuTTY Key Generator

  1. Find puttygen.exe in the PuTTY folder on your computer and double-click it. (If you do not have PuTTY.exe on your computer you can find it on web here http://www.putty.org/)
  2. Accept the default key type, SSH-2 RSA, and set the Number of bits in a generated key to 2048, if it is not already set. Then click Generate.

    Generate SSH key pair on Windows, PuTTY Key Generator

  3. Move your mouse around the blank area to generate randomness. The SSH key pair is generated.

    Generate SSH key pair on Windows, generate randomness.

  4. Save your private key.
    1. The key comment is the name of the key. You can keep the generated key comment or create your own.
    2. Enter a passphrase in the Key passphrase and the Confirm passphrase fields.

      Note: Remember the passphrase. You can't recover a passphrase if you forget it.

    3. To save the private key in the PuTTY PPK format, click Save private key. Enter the same name as you used for the key comment so that you know which public key to use this private key with. The private key is saved in PuTTY's Private Key (PPK) format, which is a proprietary format that works only with the PuTTY toolset. You can use this key whenever you use PuTTY for SSH.

      Generate SSH key pair on Windows, save private key

    4. Copy the private key and paste it into your note document.
  5. Next, save your SSH public key.
    1. To save the public key, in the PuTTY Key Generator, select all of the characters in the Public key for pasting into OpenSSH authorized_keys file field.

      Note: Make sure you select all the characters, not just the ones you can see in the narrow window. If there is a scroll bar next to the characters, you aren't seeing all the characters.

    2. Right-click somewhere in the selected text and select Copy from the menu.

      Generate SSH key pair on Windows, copy public key

    3. Open a text editor and paste the characters. Ensure that you paste the text at the first character in the text editor, and don't insert any line breaks.
    4. Save the key using the same root name that you used for the private key. Add a .pub extension. You can give it any extension you want, but .pub is a useful convention to indicate that this is a public key.
    5. Copy the public key and paste it into your note document.
    6. Exit PuTTY Key Generator.
  6. Make a note of the public and private key names and where they are saved.
    When you create instances, you must specify the SSH public key. When you log in to an instance, you must provide the path to the corresponding SSH private key and enter the passphrase when prompted.

Creating Security Lists, Security Rules, and a Security Application

Security rules enable you to override the default access settings of security lists. Each security rule defines a specific communication path, which consists of a source, a destination, and a protocol-port combination over which communication is allowed.

To create these elements, you must first sign on to Oracle Cloud Services.

  1. Go to the Oracle Cloud at https://cloud.oracle.com/sign-in.
  2. In the Cloud Account drop-down menu, choose Traditional Cloud Account.
  3. In the Select Data Center drop-down menu, choose your assigned data center and then click My Services.
  4. Enter your Identity Domain and click Go.
  5. Copy the Identity Domain into your notes document.
  6. Enter your user name and password and then click Sign In. Also copy these values into your notes document.
  7. In the Compute tile, pull down the Menu icon and choose Open Service Console.

Creating the Web Server Security List

A security list is a set of instances that can communicate with each other across all protocols and ports. When you create a security rule, you specify a security list as a destination. This allows traffic from a specified source to access instances that are part of the destination security list over a specified protocol and port. To open port 7780 for a specific instance, you must first group those instances in a security list.

To create a security list:

  1. On the Oracle Compute Cloud Service console, click the Network tab.
  2. Click the Security Lists tile, and then click Create Security List.
  3. In the Create Security List dialog box, select or enter the following information:
    • Name: Enter a name for the new security list. For the purpose of this tutorial, enter sebl_webserver_seclist. Note this name. You'll use it later in this tutorial.
    • Inbound Policy: Accept the default option, Deny (Drop packets, no reply).
    • Outbound Policy: Select Permit (Allow packets).
    • Description: Enter a description for the new security list if desired.

      Create Security List

  4. Click Create.

Creating the Default Security List

We need a security list for all other connections. Create the Default security list with these parameters:

  • Name: For the purpose of this tutorial, enter default.
  • Inbound Policy: Accept the default option, Deny (Drop packets, no reply).
  • Outbound Policy: Select Permit (Allow packets).
  • Description: Enter a description for the new security list if desired.

    Create Security List

Creating the SSH Security Rule

We need to create a security rule to enable SSH access.

To create a security rule:

  1. On the Oracle Compute Cloud Service console, click the Network tab.
  2. Click Create Security Rule.
  3. In the Create Security Rule dialog box, select or enter the following information:
    • Name: Enter an appropriate name for the rule. For the purpose of this tutorial, enter ssh.
    • Status: Select Enabled.
    • Security Application: Choose ssh from the drop-down list.
    • Source: Select the Security IP List option button, then from the Security IP Lists drop-down list, choose public-internet.
    • Destination: Select the Security List option button and then from the Security List drop-down menu choose default.
    • Description: Enter a description for the rule.

      Create ssh Security Rule

  4. Click Create.

Creating the HTTPS Security Rule

We need to create a security rule to enable HTTPS access.

To create a security rule:

  1. On the Oracle Compute Cloud Service console, click the Network tab.
  2. Click Create Security Rule.
  3. In the Create Security Rule dialog box, select or enter the following information:
    • Name: Enter an appropriate name for the rule. For the purpose of this tutorial, enter https.
    • Status: Select Enabled.
    • Security Application: Choose https from the drop-down list.
    • Source: Select the Security IP List option button, then from the Security IP Lists drop-down list, choose public-internet.
    • Destination: Select the Security List option button and then from the Security List drop-down menu choose default.
    • Description: Enter a description for the rule.

      Create HTTPS Security Rule

  4. Click Create.

Creating a Security Application

Next, create a security application for port 7780. A security application is a mapping between a port number and port type (TCP, UDP, or ICMP). To open port 7780, you must create a security application for that port.

  1. Click the Network tab and then the Security Applications tile.
  2. Click Create Security Application.
  3. In the Create Security Application dialog box, select or enter the following information:
    • Name: Enter a name for the new security application. For the purpose of this tutorial, enter tcp_7780. Note this name. You'll use it later in this tutorial.
    • Port Type: Select tcp.
    • Port Range Start and Port Range End: In both of these fields, enter the port that you want to open, port 7780.
    • Description: Enter a description for the new security application (for example, Allow TCP traffic to SBL web server on port 7780).
  4. Create Security Application

  5. Click Create.

Creating a Provisioning Server

You need to create an image for the Provisioning Server.

  1. Navigate to the Dashboard.
  2. In the Compute tile, pull down the menu and choose View Details.
  3. Portion of Create Instance, General window

  4. In the Service Details screen, find the REST Endpoint field and copy its value into your note document as the DBAAS REST Endpoint.

    DBAAS REST Endpoint

  5. Return to the Dashboard. In the Compute tile, pull down the menu and choose Open Service Console.
  6. General window

  7. If you are not already on the Instances tab, click the Instances tab.
  8. Portion of Create Instance, General window

  9. At the top of the screen, pull down the Site menu to display the Site Selector dialog.
  10. Portion of Create Instance, General window

  11. Copy the Cloud Compute REST Endpoint value into your note document, then click Cancel to close the Site Selector dialog.
  12. Click Create Instance.The Compute screen appears with the Image node selected.
  13. On the left edge, click Private Images.
  14. Click Select to the right of your newly created image. The button text changes from Select to Selected to indicate your selection.
  15. Portion of Create Instance, General window

  16. Click the > button at the top right to continue creating the instance.
  17. Select a shape (number of CPUs and Memory). For the purpose of this tutorial, select oc3 (OCPUs: 1, Memory: 7.5 GB) and then click > to continue creating the instance.
    terms
  18. Complete the Instance fields as described below.
    terms
  19. In the Instance page, select or enter the following information, and then click >:
    • Name: Enter an appropriate name. If you don’t specify a name, the instance name will be generated automatically. For the purpose of this tutorial, enter SiebelProvisioningServer
    • Label: Enter a description to help identify the instance, which is SiebelProvisioningServer in this example. If you provide a label, the label is used to list the instance on the Overview page.
    • Description: Enter a description of this instance.
    • Tags: If required, specify a tag to help identify your instance.
    • SSH Keys: Click Add SSH Public Key to add the public key you created earlier.
    • The Add SSH Public Key page appears. Fill in the following fields:

      Add SSH PUblic Key dialog box

      Name: enter a name for this public key. For the purpose of this tutorial, enter SSH_PK_PS.

      Value: Enter the value of the SSH public key you generated.

      Note. Paste the key value exactly as it was generated. Don't append or insert any extra characters, line breaks, or spaces.

      Click Add. Your SSH public key is added to Oracle Compute Cloud Service and the Add SSH Public Key page closes.

    • Custom Attributes: If needed, add any custom attributes within the brackets ().
  20. When done configuring the Instance page, it should resemble this:
  21. Create Instance, Storage window

  22. Click > to continue configuring the instance.
  23. In the Network page, select or enter the following information, and then click >:
  24. Compute page, Network node, start

    • DNS Hostname Prefix: Enter a string that will be used as a prefix in the domain host name for your instance.
    • Network Options: Select the check box for Shared Network and clear the check box for IP Network.
    • Public IP Address: Select Auto Generated from the drop-down list.
    • IP Networks: Do not enter any information for this field.
    • Security Lists: Click in the field to display a drop-down menu and choose default.
    • Compute page, Network node filled out

  25. In the Storage page, use only the volume for your provisioning server and remove any other volumes using the Remove command (in the menu on the right side). Click > to continue configuring the instance.

    Create Instance, Storage window

  26. In the Review page, verify the information that you've entered and then click Create. Your instance is created.

    Create Instance, Review window

  27. Check the status of the instance using the Orchestrations tab. In this example the status is Starting initially and changes to Ready.

    Instance list, Preparing window

  28. Manually refresh the browser until the status changes to Ready.

    Instance list, Initializing window

  29. When the Status has changed to Ready, click the Instances tab to dsiplay the details of the instance.

    Instance list, View Running window

  30. Copy the Public IP and Private IP values into your note document.

Executing the Provisioning Script

The provisioning script must be executed on the Provisioning Server you just created. To connect to the command line on the remote Provisioning Server, you need a secure terminal application. For this purpose we use Putty.

  1. Start the Putty application.
  2. The PuTTY Configuration window appears, showing the Session panel.

  3. In the Host Name (or IP address) field, enter the public IP address of your instance from your note document.
  4. PuTTY Configuration window

  5. In the Connection type field, select SSH if it is not already selected.
  6. In the Category pane, expand Connection, and then click Data. The Data panel appears.
  7. In the Auto-login username field, enter opc. Confirm that the When username is not specified option is set to Prompt.

    PuTTY Configuration, Data window

  8. In the Category pane, click Connection. Enter 60 in the Seconds between keepalives (0 to turn off) text box.
    Ensure that the Enable TCP keepalives (SO_KEEPALIVE option) check box is selected.

    PuTTY Options controlling the connection page

  9. In the Category pane, expand SSH, and then click Auth. The Auth panel appears.
  10. In the Private key file for authentication field, click Browse and select the private key file that you saved earlier.

    PuTTY Configuration, SSH window

  11. In the Category tree, click Session.
    The Session panel appears.
  12. In the Saved Sessions field, enter a name for this connection configuration, and then click Save.
  13. Click Open to open the connection.
    The PuTTY Configuration window is closed and the PuTTY window appears.
  14. Enter the passphrase you had provided for your SSH key pair.
  15. The first time you connect to your instance, the PuTTY Security Alert window is displayed, prompting you to confirm the public key. Click Yes to continue.
  16. Click Open. A terminal window appears.
  17. In the terminal window, enter the following commands exactly as shown, note that the last command starts with a period (.):
    • sudo su
    • mount /dev/xvdb4 /data
    • exit
    • ./provision.sh

    If this is your first time using the Siebel Provisioning Server you may get the following message:

    Setting up Siebel Provisioning Server. This would take some time. Please wait...

    This is a normal message, and it will go away when the server set up is complete.

    The script presents the following actions:

    PuTTY Configuration, SSH window

    Note: Action 7, Delete Existing Environment, should be used if you provisioned either the Demo DB or Base DB, and the provisioning failed. You can delete the environment, resolve the problem, and re-provision the database.

  18. Select one of the server provisions.
  19. Using the information you collected in your note document, respond to the following prompts:
  20. PuTTY Configuration, SSH window

    After you enter the above information, the provisioning script contacts the Provisioning Server and validates your credentials.

  21. Select an available image from the list presented.
  22. PuTTY Configuration, SSH window

  23. Select one of the industries from the list presented.
  24. PuTTY Configuration, SSH window

  25. Create a username and password for the landing page of your application. You can add these values to your note document.
  26. PuTTY Configuration, SSH window

  27. Select a shape for the application tier, and then again for the database tier. Select the shape that uses the least memory.
  28. PuTTY Configuration, SSH window

  29. if you are provisioning DBAAS, enter a password that meets the following criteria:
    1. Length of 8 to 30 characters

      Contains at least one lowercase letter

      Contains at least one uppercase letter

      Contains at least one number

      Contains one of the following special characters: - (dash), - (underscore), or # (octothorpe).

      Does not contain any space characters.

    Re-enter the same password when prompted.

    PuTTY Configuration, SSH window

  30. Select a database image from the list presented.
  31. PuTTY Configuration, SSH window

  32. Create a unique name for your environment. You can add this name to your note document.
  33. Select an SSH key from the list presented.
  34. PuTTY Configuration, SSH window

  35. Review the summary and enter Y to accept the values.
  36. PuTTY Configuration, SSH window

    The provisioning script now starts to create the environment as you specified. This is not instantaneous. There will be many status messages as the script runs.

    The script is done when you get this message: "Your Setup is ready. Please find the environment details below".

    PuTTY Configuration, SSH window

    Copy the value of the siebelenvurl field and paste that into your note document. You will use this URL to log in to your environment later.

  37. Return to the Oracle Cloud Services interface and click the Network tab.

Logging In to the Siebel Application

After the Siebel Mid Tier configuration has completed, you can log in to the Siebel environment details page in a browser using the siebelenvurl value that you copied into your note document earlier. It has this format:

http://<public IP address>:<port number>/

Want to Learn More?

  • Search for Siebel Bookshelf in My Oracle Support