Install the Visual Modeler reference implementation

About this task

This section describes the steps to install Visual Modeler without using the SDK. This provides you with a relatively quick verification of the basic deployment of our reference Web application. Before you start the process of customizing the Visual Modeler, install the Visual Modeler into the SDK and work in that environment to create your customized deployment.

Note: To provide support for locales other than U.S. English, you must install a language pack using the SDK.

These instructions use three logically distinct machines: the developer machine, the servlet container machine, and the database server machine. Depending on your situation, these machines may actually all be the same physical machine or different ones: we identify what steps are performed on which logical machine.

The Java™ Development Kit (JDK) must be installed on all three machines. The servlet container machine and the database server machine should have the database client tools installed to connect to the database server. You will need to know the database connection information required to connect from the servlet container machine to the database server.

Procedure

  1. Identify the location on the development machine where you will unpack the installation files. The location is called cmgt_home.
  2. Copy the release JAR file into cmgt_home.
  3. Unjar the release JAR file by navigating to cmgt_home and at the command prompt, execute the following command:

    jar -xvf <release JAR file name>

    This command unpacks the release JAR file and creates several sub-directories under cmgt_home.

  4. Go to the install/tools/preferencesXMLGenerator/bin folder and at the command prompt, execute the following command:

    preferencesXmlGenerator.bat<databaseType> <databaseUserID> <databaseuserPassword> <databaseServerIPOrHostname> <databasePortNumber> <databaseName>

    Example: preferencesXmlGenerator.bat Oracle testUser passw0rd localhost 1521 orcl

    This step generates a prefs.xml in the current directory (<cmgt_home>/install/tools/preferencesXMLGenerator/bin) that is used for the installation.

  5. Set only the properties on the generated prefs.xml that are needed to get the reference deployment up and running.
  6. If the database server is inaccessible from your current network location, transfer the appropriate sql-data file, depending on DB_TYPE, to a temporary location, cmgt_data_home, on a machine that can access the database server machine:

    cmgt_home/sql/Oraclesql-data-<release JAR filename>

  7. On the machine, at the command line, navigate to cmgt_data_home and unpack the JAR file by executing the following command:

    jar -xvf DB_TYPEsql-data<release JAR file name>

  8. Set up the database users, privileges, and if you are using an Oracle database server, the Oracle database link.
  9. If you are using an Oracle database server, edit the following files:
    • cmgt_data_home/WEB-INF/sql/Oracle/setup/oracle_indexes.sql - Change the value of @ORACLE_INDEX_TABLESPACE@name, if necessary, to TABLESPACE <tablespace_name>. The TABLESPACE name specifies the location of the Oracle database server’s index files. For example, replace the following line:

      CREATE INDEX ACL_ACCESS ON CMGT_ACCESSLIST(ACL_KEY) ORACLE_INDEX_TABLESPACE@

      with this line:

      CREATE INDEX ACL_ACCESS On CMGT_ACCESSLIST(ACL_KEY) TABLESPACE USERS

      where USERS refers to the tablespace name.

    • cmgt_data_home/WEB-INF/sql/Oracle/setup/Oracle_privileges.sql - Replace @ORACLE_USERNAME@ with the name of the transactional database username.
  10. Add connection information to the following batch scripts, which reside in cmgt_data_home.
    • For Oracle database servers:
      • OracleCreateSchema.bat or OracleCreateSchema.sh
    For example,
    set uuu=<userName>/<password>@'
    (DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)
    HOST=<hostname>)(PORT=<portNumber>)))
    (CONNECT_DATA=(SID=<databaseName>)))'

  11. Run the following scripts:
    • For Oracle:

      OracleCreateSchema.bat or OracleCreateSchema.sh

  12. Copy the following files or folders to a temporary location, cmgt_app_home, on the servlet container machine:
    • cmgt_home/Sterling-10.0.war (Released Version)
    • user_home/cmgt/debs/conf/prefs.xml
    • cmgt_home/data/Sterling-xmldata-<release JAR file name>
    • "lib" folder from cmgt_home/install/
  13. On the servlet container machine, copy the <cmgt_home>/install/tools/preferencesXMLGenerator/bin/prefs.xml file to the user_home/cmgt/debs/conf/prefs.xml directory. You might need to create the directory. Also, user_home must correspond to the user that is used to run the servlet container.
  14. If you are running Oracle, install the appropriate JDBC JAR file into the servlet container. The JAR file is used by the Visual Modeler web application when the application is deployed. WebLogic application servers are deployed with an extensive collection of JDBC clients. For this reason, you might not need to perform this step on WebLogic application servers.
  15. Ensure that you are logged in as the user who is running the application server. At the command line, navigate to cmgt_app_home and unpack the Sterling-xmldata-<release JAR file name> file by executing:

    jar -xvf Sterling-xmldata-<release Jar file name>

  16. Load the data.
    1. On UNIX, run:
      
      loadDBFromXML.sh full <jdbc_jar_file.jar>
      

      where <jdbc_jar_file.jar> is the full path to your JDBC driver. If you get a permissions error, modify the permissions on the script to give yourself execution privileges.

      Note: On Linux®, if you see errors reporting that a network connection cannot be established to the database server, check that you do not have Secure Linux enabled. If need be, navigate to /etc/sysconfig/selinux and make sure that the following is set:
      
      SELINUX=disabled
      
    2. For Windows configurations using ODBC to connect to the Knowledgebase database server, run:
      
            loadDBFromXML full
      
    3. For Windows configurations with JDBC, run:

      loadDBFromXML full <jdbc_jar_file.jar>

      where <jdbc_jar_file.jar> is the full path to your JDBC driver.

      Note: You can load just the minimal data by specifying “minimal” rather than “full” when you run this command.
  17. Check the results by examining the log files in the directory in which you ran the data load command.
  18. Rename the cmgt_app_home/Sterling_<date>_dev.war file to Sterling.war and deploy it to the servlet container.
  19. Restart the application server.
  20. You should now be able to point your browser to the standard Visual Modeler URL and log in as the enterprise administrator user admin/admin.