Table of Contents Previous Next Index

CHAPTER 1 Introduction : Installing the SDK

Installing the SDK

To install the SDK, identify a directory on your machine to use as the development directory: we refer to this as sdk_home.

Attention:

If you have an installation of an earlier version of the SDK on your machine, and want to install the current version, you must install the current version into a different directory. .

The SDK is delivered as a JAR file, sdkframework.jar. Simply unjar the JAR file in your sdk_home directory.

Attention:

You must use the SDK with JDK 1.4 (Releases 6.x and 7.x) or with JDK 1.5 (Releases 8.x and later). Ensure that your JAVA_HOME variables is set to point to the appropriate JDK home on your machine.

The SDK framework is updated regularly. Contact your Sterling Commerce representative to obtain updates. Releases of the SDK are managed on a separate timetable from releases of the Sterling Multi-Channel Selling Suite. Check whether your version of the SDK supports the Sterling Multi-Channel Selling Suite release that you are working with.

The Software Development Kit is designed to run a collection of Ant targets. Before you run these targets, make sure that you set the PATH and JAVA_HOME environment variables to point to the location of your installation of the Java Development Kit. For example:

set JAVA_HOME=C:/jdk-1.5
set PATH=%PATH%;%JAVA_HOME%\bin

(on a Windows platform)

setenv JAVA_HOME /usr/java1.5
setenv PATH=$PATH:$JAVA_HOME/bin

(on a UNIX platform)

UNIX Steps

You may need to change the permissions set on the SDK files as follows:

1. At the command line navigate to the sdk_home directory.

2. Enter:

chmod +x *sh

This makes all script files in the sdk_home directory executable by all users.

3. Note that the UNIX batch file is provided as sdk.sh. You can rename it to sdk (or create an alias called sdk: alias sdk=’./sdk.sh’) or run the targets below by substituting “sdk.sh” for “sdk”.

Test Installation

You can test that you have installed the SDK correctly as follows:

1. At the command line, navigate to sdk_home.

2. Enter:

sdk version

You should see output similar to the following:

 

Buildfile: C:\sdk_home\sdk.xml
displaySDKInfo:
   =======Configuration Info=======
   SDK Environment:
      Project Name: .............................. matrix80
      Default Comergent Version: ................. debs-8.0
      Environment:  .............................. dev
   Directory Information:
      Comergent SDK Home.......................... C:\sdk_home
      Default language............................ en
      Default Country............................. US
displayProjectInfo:
   ======= Project Info=======
   Project Environment:
      Application Name ........................... Comergent
      Comergent Version: ......................... debs-8.0
      Java Version: .............................. 1.5.0_08
   Directory Information:
      Project .................................... C:\sdk_home/projects/matrix80
      Build ...................................... C:\sdk_home/builds/matrix80
      Dist ....................................... C:\sdk_home/dist
container-chooser:
displayContainerInfo:
default-displayContainerInfo:
   ======= Container Info=======
      Container Name ............................. tomcat
      Container Version: ......................... 5.5
prepare:
init:
version:
        Comergent Technologies Inc. Software Development Kit 8
                SDK Framework version : 3.5(RTQA0a)-build624
BUILD SUCCESSFUL
Total time: 4 seconds

3. Enter:

sdk setup

This creates the my_sdk.properties file. Use this file to manage SDK properties that are specific to your installation of the SDK.