Downloading and configuring the Component SDK

You can download the Discovery Framework Component SDK from the Downloads section of the Endeca Developer Network (EDeN).

Before installing the Component SDK, download and unzip endeca-portal-<version>.zip, as described in the Discovery Framework Installation Guide. This is the base Discovery Framework code, which the Component SDK depends upon. You do not have to start the Discovery Framework.

Note: Do not install the Component SDK in a directory path that contains spaces.
Note: On Windows, for steps 3 and 5 below, backslashes in paths must be escaped. That is, use something like the following:
portal.base.dir=C:\\my_folder\\endeca-portal
instead of:
portal.base.dir=C:\my_folder\endeca-portal

To install the Component SDK:

  1. Download and unzip components-sdk-<version>.zip to a separate directory. This is the Component SDK itself. Perform the following steps within the Component SDK.
  2. Create a file components/build.<user>.properties, where <user> is the user name with which you logged on to this machine.
  3. Within that properties file, add a single property portal.base.dir=<absolute_path_to_portal>, where <absolute_path_to_portal> is the path to the unzipped endeca-portal-<version>.zip.
  4. Create a shared.properties file in the shared/ directory.
  5. Edit shared/shared.properties and set the single property portal.base.dir=<absolute_path_to_portal>, where <absolute_path_to_portal> is the path to the unzipped endeca-portal-<version>.zip.