Table of Contents Previous Next Index

CHAPTER 1 Introduction : Directory Organization

Directory Organization

While you work with the SDK, you see under the sdk_home directory the following directories and files. Note that not all of these are created as part of the initial installation of the framework:

builds/: contains the deployment source for the customized Web application. This directory is created the first time the newproject target is run. The content of each project is moved here prior to running the build scripts. It can contain one or more target projects, for example: builds/matrix80/ and builds/anderel/.

dist/: contains the built image of the Web application used to deploy to the servlet container.

docs/: contains the product documentation and generated Javadoc for the Sterling Multi-Channel Selling Suite.

etc/: contains the project templates and development tools used by the SDK. This includes a sub-directory etc/lib/ that holds the various JAR files used by the tools.

projects/: used to manage the source for SDK projects. This directory is created the first time the newproject target is run. Each project directory must have a unique name (such as matrix2). Typically, project directories each contain source directories, customized JSP and HTML pages for each project, and the project’s WEB-INF directory and its configuration files. For example, to manage two projects, matrix80 and anderel, you will use two sub-directories: projects/matrix80/ and projects/anderel/ to manage the customized content for each.

Each project directory contains the following properties files: project.properties, project_local.properties, and project_env.properties. These files specify the values of properties used by the SDK targets. The values of env are: dev, prod, and qa. When you run an SDK target, the deploy.environment property of the sdk_home/sdk-settings.properties file determines which properties file is used to set the SDK properties. See Environments for more information.

releases/: contains the Java classes, Java libraries, JSP pages, and configuration files for the Sterling Multi-Channel Selling Suite. This directory is created the first time the install target is run. When you work with a particular release of the Sterling Multi-Channel Selling Suite, you run the install target in order to put the Sterling Multi-Channel Selling Suite release in a directory under the releases/ directory. For example, if you install Release 8.0 into the SDK, a directory is created called sdk_home/releases/debs-8.0/. The following sub‑directories are created in each release directory:

examine/: when you run the examine target, files are copied under this directory from the release WAR file or from the overlay/ directory if they are present there.

image/: this directory holds the WAR for the release.

overlay/: this directory holds files installed through patches. When you run the customize or examine targets, files under this directory take precedence over corresponding files in the release WAR file and when the merge target is run to build projects.

tmp/: a temporary workspace used by SDK targets. This directory is created the first time the merge target is run.

workspaces/: contains the SQL scripts and XML data files that will be used to generate the database schema and load data into the database for each project.

ComergentCopyrightNotice.txt

my_sdk.properties: use this file to set any SDK properties specific to your environment. Properties set in this file take precedence over properties set in sdk-settings.properties. The sdk-settings.properties file can be overwritten during an upgrade to the SDK framework, whereas properties set in my_sdk.properties will be preserved.

sdk-settings.properties: the main file used to configure the SDK when targets are run. It determines which project is current, which environment is current, and which release is to be used when a new project is created.

sdk.bat: the main script file for Windows.

sdk.sh: the main script file for UNIX.

sdk.xml: the SDK configuration file with target definitions.

sdk-6.x.xml: the SDK configuration file with target definitions for Release 6.x releases.

sdk-7.x.xml: the SDK configuration file with target definitions for Release 7.x releases.

sdk-8.x.xml: the SDK configuration file with target definitions for Release 8.x releases.