Deploying and initializing an application

The deploy script in the deployment_template\bin directory creates, configures, and distributes the EAC application files into the deployment directory structure.

To deploy an EAC application on Windows:

  1. Start a command prompt (on Windows) or a shell (on UNIX).

  2. Navigate to ToolsAndFrameworks\<version>\deployment_template\bin.

  3. Run the deploy script.

    For example, on Windows: 

    C:\Endeca\ToolsAndFrameworks\<version>\deployment_template\bin>deploy.bat

  4. If the path to the Platform Services installation is correct, press Enter.

    The template identifies the location and version of your Platform Services installation based on the ENDECA_ROOT environment variable. If the information presented by the installer does not match the version or location of the software that you plan to use for the deployment, stop the installation, reset your ENDECA_ROOT environment variable, and start again.

    Note

    The installer may not be able to parse the Platform Services version from the ENDECA_ROOT path if it is installed in a non-standard directory structure. It is not necessary for the installer to parse the version number, so if you are certain that the ENDECA_ROOT path points to the correct location, proceed with the installation.

  5. Specify a short name for the application.

    The name can contain any combination of alphabetic characters (uppercase and lowercase) and digits from zero through nine.

  6. Specify the full path into which your application should be deployed.

    This directory must already exist. The deploy script creates a folder inside of the deployment directory with the name of your application and the application directory structure.

    For example, if your application name is MyApp, and you specify the deployment directory as C:\Endeca\apps, the deploy script installs the template for your application into C:\Endeca\apps\MyApp.

  7. Specify the port number of the EAC Central Server, or press Enter to accept the default of 8888.

  8. Specify the port number of Oracle Commerce Workbench, or press Enter to accept the default of 8006.

  9. Specify the port number of the Live Dgraph, or press Enter to accept the default of 15000.

  10. Specify the port number of the Authoring Dgraph, or press Enter to accept the default of 15002.

  11. Specify the port number of the Log Server, or press Enter to accept the default of 15010.

    If the application directory already exists, the deploy script time stamps and archives the existing directory to avoid accidental loss of data.

  12. Specify the path to the Oracle Wallet configuration file, jps-config.xml, or press Enter to accept the default path of ../../server/workspace/credential_store/jps-config.xml.

  13. Press Enter to accept the default path to jps-config.xml, the Oracle Wallet configuration file: ../../server/workspace/state/repository.

  14. Navigate to the control directory of the newly deployed application.

    This is located under your EAC application directory. For example: C:\Endeca\apps\<app dir>\control.

  15. From the control directory, run the initialize_services script.

    The script initializes each server in the deployment environment with the directories and configuration required to host your application. This script stops all application components and removes any existing provisioning associated with this application in the EAC, then adds the hosts and components in your application configuration file to the EAC and restarts them. Use caution when running this script, as it may lead to service interruption if executed on a live environment.

When an EAC application has been deployed, it includes all of the scripts and configuration files required to create an index and start an MDEX Engine.

If no script customization is required, the application is ready to use. You can proceed with running a baseline update as well as any necessary CAS crawls.

However, if you need to configure an EAC application to reflect unique environment and data processing requirements, proceed to Configuring an EAC Application before indexing and starting the MDEX Engine.

The Deployment Template creates the directory structure described below.

The Deployment Template is designed to support operations with the MDEX Engine in the production environment. This means it must support a variety of possible configurations and their modifications. The AppConfig.xml file contains all possible configuration and directories required on a production server.

The Deployment Template has separate directories to ensure that the MDEX Engine operations access the information they need. It creates additional directories for any added Dgraphs.

Directory

Contents

config/lib

Subdirectories to store custom scripts or code for your Deployment Template project.

config/pipeline

The Developer Studio pipeline file and XML configuration files.

config/report_templates

Templates used to generate application reports.

config/script

The AppConfig.xml file and related Deployment Template scripts responsible for defining the baseline update workflow and communication from application components to the EAC Central Server.

control

Shell (UNIX) or batch (Windows) scripts responsible for running different operations defined within AppConfig.xml.

data/incoming

The premodified incoming data files that are ready acquisition by the Endeca pipeline and should be processed.

data/processing

Temporary data and configuration files created and stored during the baseline update process.

data/forge_output

The data and configuration files that are output from the Forge process to the Dgidx process.

data/dgidx_output

The index files that are output from the Dgidx process.

data/dgraphs

The copy of the index files used by an instance of the MDEX Engine.

data/state

Autogenerated dimensions files.

logs

Various log files within subdirectories, such as Dgidx logs.

reports

Generated reports.

Copyright © Legal Notices