UNIX installation procedures

This section contains the Platform Services installation procedures for UNIX.

The UNIX version of the Platform Services software is distributed as a self-extracting bin file and install script.

The Platform Services package can be installed at any location. In these instructions, we assume /usr/local as the installation target directory.

To install Platform Services on UNIX:

  1. In your local environment, locate the Platform Services installation package that you downloaded from the Oracle Software Delivery Cloud. The name of the installation file is as follows:

  2. Determine where you will install the Platform Services. Verify that the target directory where you plan to install has enough available disk space and has write permissions (is not read-only). For example, in this procedure we assume that the target directory is /usr/local and that you have write permissions for it. If you do not set these permissions, the install script will not run.

  3. From the /downloads directory, start the installation with the following command: 

    ./OCplatformservices11.2.0-linux64.bin

  4. Select a locale.

  5. In the Introduction screen, press Enter to continue.

  6. Accept the terms of the license agreement.

  7. In the Choose Install Folder screen, enter /usr/local as the installation location.

  8. In the Choose Install Set screen, enter the number for the program features to be installed. The default is Typical.

    Install SetContents
    TypicalAll features except for Oracle Commerce Reference Implementation
    CompleteAll features
    PS & App Controller AgentApplication Controller Agent
    Reference Implementation Sample Guided Search applications, as well as JSP and .NET user interface applications.

  9. Enter the port on which the EAC service will listen. The default is 8888, but you must specifically enter that number in the prompt.

  10. Enter the shutdown port of the EAC service. The default is 8090, but you must specifically enter that number in the prompt.

  11. Enter the location (an absolute path) of the MDEX Engine root directory (for example, /usr/local/endeca/MDEX/<version> ).

    Note that the installer does not verify the existence of the directory; this allows you to install the Platform Services package before the MDEX Engine package.

  12. In the Pre-Installation Summary screen, review the settings you have selected and press Enter to continue.

  13. In the Ready to Install screen, press Enter to start the installation.

    The Installation Complete message displays at the completion of the installation.

  14. Press Enter to exit the installation.

At the completion of the installation, the installer prompts you to run the installer script that sets the Platform Services environment variables (such as ENDECA_ROOT), as well as some additional ones that are used internally.

Depending on your shell, run the following script:

For Bourne, Bash or Korn: 

source endeca/PlatformServices/workspace/setup/installer_sh.ini

or:

For csh or tcsh: 

source endeca/PlatformServices/workspace/setup/installer_csh.ini

Generally this command should be placed in a script run at the startup of the shell so the variables are set for future use.

To start the HTTP Service, change to the endeca/PlatformServices/<version>/tools/server/bin directory and run the startup.sh script. (You can also run the script from another directory by using the absolute path to the script). For information about how to control this service, see the Endeca Application Controller Guide.

Note

Platform Services must run using 64-bit java, using the -d64 argument in the startup script.

If you did not specify the MDEX Engine root directory (at Step 11), the com.endeca.mdexRoot setting (in the EAC eac.properties configuration file) will have a blank value. The file is located in the $ENDECA_CONF/conf directory. If you later install the MDEX Engine on your system, you must edit the file and add the absolute path of the MDEX Engine root directory in the setting, and then restart the EAC service. For more information on this file, see the Endeca Application Controller Guide.

The silent installer for UNIX reads the necessary input from a response file.

Silent installations are installations that use the -i silent flag to run without a user interface. The responses to the UNIX installer prompts are supplied in a response file and provide the same answers that an interactive user would provide. The silent installer is useful if you want to add the installation of Platform Services to your own install script, or push out the installation on multiple machines.

To launch the silent installer on UNIX:

  1. From a command prompt, navigate to the directory where you downloaded the installer.

  2. Create a response file with the appropriate properties. for example, ps_response.properties, and specify the response value for each prompt on its own line, in the order in which they appear in the interactive installer.

    Guided Search property NameDescription
    USER_INSTALL_DIR Required. Specifies the absolute path to the directory to install Platform Services (e.g., /usr/local/endeca/PlatformServices). Keep in mind that you cannot install the software in a directory with spaces in its name.

    Note

    If you do not use the default location, and you are installing more than one Guided Search product on the same machine, ensure that you install each product to a separate location.

    ETOOLS_HTTP_PORT Optional. The port on which the HTTP Service listens. The default is 8888.
    ETOOLS_SERVER_PORT Optional. The shutdown port for the HTTP Service. The default is 8090.
    EAC_MDEX_ROOT Optional. Specifies the MDEX Engine root directory if MDEX is already installed. If the MDEX Engine is not installed, use a newline or carriage-return to indicate that there is no MDEX Engine installed.

    Example: 

    USER_INSTALL_DIR=/usr/local/endeca/PlatformServices 
  ETOOLS_HTTP_PORT=8888 
  ETOOLS_SERVER_PORT=8090
  EAC_MDEX_ROOT=/usr/local/endeca/MDEX/6.5.2

    Note

    You must specify a value for each prompt. Even if you want to use the default, you must specify that value to the installer.

  3. Run the install script with the -i silent option (which indicates silent mode), and the response file as an input. For example: 

    ./OCplatformservices<version>-linux64.bin -i	silent -f ps_response.properties

  4. The installation is complete when the screen displays a reminder message about setting the environment variables.

After the installation is finished, you should run a script that sets the Platform Services environment variables (such as ENDECA_ROOT), as well as some additional ones that are used internally. The two environment variable scripts are located in the endeca/PlatformServices/workspace/setup directory and are named as follows:

The following example shows how to run the sh version: 

source /usr/local/endeca/workspace/setup/installer_sh.ini

Generally this command should be placed in a script run at the startup of the shell so the variables are set for future use.

To start the HTTP Service, change to the endeca/PlatformServices/<version>/tools/server/bin directory and run the startup.sh script. (You can also run the script from another directory by using the absolute path to the script). For information on controlling this service, see the Endeca Application Controller Guide.

If you did not specify the MDEX Engine root directory in the response file, the com.endeca.mdexRoot setting (in the EAC eac.properties configuration file) will have a blank value. The file is located in the $ENDECA_CONF/conf directory. If you later install the MDEX Engine on your system, you must edit the file and add the absolute path of the MDEX Engine root directory in the setting and restart the EAC service. For more information on this file, see the Endeca Application Controller Guide.

Copyright © Legal Notices