Go to primary content
Oracle Agile Engineering Data Management Server Installation Guide on Windows and UNIX
Release e6.2.0.0
E52561-02
  Go To Table Of Contents
Contents

Previous
Previous
 
Next
Next
 

5 Batch Installation of the Agile e6 Server

This chapter describes the batch installation of the Agile e6 Server components.


Note:

The Agile e6.2.0.0 installer is fully batch enabled.

All installation tasks can be done in batch mode providing all necessary attributes in a property file.

5.1 Requirements

  • Deploying the J2EE application in batch modes requires a WebLogic Node Manager which has been configured and is running. WebLogic domains will be setup and started during the batch installation.

  • Database Client and Server, and WebLogic Server installation have to be available. The Database must be running before starting to install Agile e6 J2EE and EDM Server.

  • Please make sure that all prerequisites mentioned in the Prerequisite Guide for Agile are met before performing the batch installation.

5.2 Batch Modes

The batch installation scripts for UNIX (batchinstall.csh) and Windows (batchinstall.cmd) have two mandatory parameters.

  • First parameter:

    Property file with the installation attributes.

  • Second parameter:

    Defines the components which should be installed.

The following table describes the components which will be installed, based on the second parameter. There are also different example files for the required property attributes which can be used as a start for your own property file.


Note:

The parameter INIT has to be executed once before using the parameters WALLET and DFMWALLET. You can then use the other parameters listed below.

The WALLET option must also be executed while doing a J2EE component based installation. This will set up the wallets which are required when using the AdminClient.


  1. Call batchinstall with INIT, WALLET or DFMWALLET.

    Second Parameter Components Example properties file (located in <install-media-path>\installer\properties)
    INIT Initial task which has to be executed once for an installation. tpl_installation.properties
    WALLET Create the required server wallets. tpl_installation.properties
    DFMWALLET Create the required wallets for a DFM site. examples\batch_install_dfm.properties

  2. Call batchinstall with the component selection to be installed.

Second Parameter Components Example properties file (located in <install-media-path>\installer\properties)
ALL The native EDM Server, File Server and WebLogic domains with all deployments. tpl_installation.properties
E6S The native EDM Server. tpl_installation.properties
E6F The native EDM Server and the File Server. tpl_installation.properties
E6J The native EDM Server and WebLogic domains with all deployments. tpl_installation.properties
DFM The File Server, FMS Java Daemon, and the Tomcat server with the DFM deployments. examples\batch_install_dfm.properties
FMS The File Server. examples\batch_install_fms.properties
J2EE The WebLogic domains with all deployments. tpl_installation.properties

5.3 Preparation of a Properties File

  1. Copy the example property file from the table above to <install-media-path>\installer\properties\installation.properties.

    This file contains the default values for a Windows batch installation


    Note:

    On Windows you have to use double backslashes for plm.inst.root, plm.applicationserverdefinition.mw_home, and plm.applicationserverdefinition.domain_root:

    E.g. plm.inst.root=C:\\plm620



    Note:

    On Windows you have to use quadruple backslashes for plm.fileserver.destination:

    E.g. plm.fileserver.destination:C:\\\\fms


  2. Enter the values for all properties with value <CHANGETHIS>.


    Note:

    '$' character in property values should be replaced with '$$'.

    e.g. the property value 'pa$$word$' has to be changed to 'pa$$$$word$$'


    • plm.databasedefinition.dbhost:

      Host name of the Oracle 12cR1 Database server.

    • plm.j2eeappserver.jadehost:

      Host name where the Java Daemon is/will be running.

    • plm.j2eeappserver.fmsjadehost:

      Host name where the FMS Java Daemon is/will be running.

    • plm.j2eeappserver.adminserver_password:

      Password of the WebLogic administration user (weblogic) for the installation domain.

    • plm.application.j2eehost:

      Host name where WebLogic is running (the WebLogic Server host name).

    • plm.application.httphost:

      Host name where the Agile e6 Web Client can be reached over HTTP (the WebLogic server hostname).

    • plm.application.dbpassword:

      Password of the database user for the application.

    • plm.application.dbpassword.wlscrypt:

      Password of the database user for the Business Service application. For information about using a different property while (re)deploying the Business Service, please refer to the Administration guide for Agile e6.2.0.0.

    • plm.application.mailrelay:

      To send emails with the business services, define the name of your SMTP mail server. Otherwise use "nn".

    • plm.application.mail_auth_user:

      User name if the Mail Authentication for your SMTP mail server is activated. Leave it empty if the plm.application.mail_use_authentication property is set to false.

    • plm.application.mail_auth_password:

      Password if the Mail Authentication for your SMTP mail server is activated. If the plm.application.mail_use_authentication property is set to false, leave it empty.

    • plm.application.plm_auth_provider_password:

      Password of the WebLogic user PlmAuthenticatorDSUser, which secures the Data Source PlmAuthenticatorDS that is used by the PLM Authentication provider.

    • plm.application.adminserver_password:

      Password of the WebLogic administration user (weblogic) for the application domain.

    • plm.inst.wallets.private.archive

      Full path to the existing private wallets archive.

    • plm.inst.wallets.public.archive

      Full path to the existing public wallets archive.

    • plm.javadaemon.admpwd:

      Password for the administration interface of the Java Daemon.

    • Plm.userdefinition.priv_password:

      Password of the local Windows user which is used by the following service: File Server.

    • Plm.userdefinition.unpriv_password:

      Password of the local Windows user which is used by the following services: EDM Server, Java, FMS Java, and Portmapper.

    • plm.applicationserverdefinition.ora_inventory_unix_group

      Not used on Windows. Please see the UNIX section below. Please remove the <CHANGETHIS> from the entry on Windows.


    Note:

    The values for the following password properties have to be entered in clear text:

    plm.j2eeappserver.adminserver_password

    plm.application.dbpassword.wlscrypt

    plm.application.plm_auth_provider_password

    plm.application.adminserver_password



    Note:

    The values for the following password properties can be encrypted with epkeytool

    plm.application.dbpassword

    plm.application.mail_auth_password

    plm.userdefinition.priv_password

    plm.userdefinition.unpriv_password

    For further information about the epkeytool please refer to the Security Guide for Agile e6.2.0.0.


    Additionally, check if the remaining values match your environment and change the values if you do not want to use the default values.

    On a UNIX operating system, you need to change the following properties, which also contain a directory path:

    • plm.inst.root:

      The destination directory for the Agile e6 installation.

    • plm.databaseconnection.client_home:

      The path to the existing 32-bit Oracle 12cR1 Database client.

    • plm.fileserver.destination:

      The destination path for the File Server installation.

    • plm.applicationserverdefinition.ora_inventory_unix_home:

      Inventory root directory for the Oracle Universal Installer for WebLogic.

    • plm.applicationserverdefinition.ora_inventory_unix_group:

      Name of the group which has write permissions to create/update the Oracle Home Inventory directory for the WebLogic server.

    • plm.applicationserverdefinition.mw_home:

      The Oracle Home directory under which the Middleware software is installed.

    • plm.applicationserverdefinition.domain_root:

      The root directory where the Agile e6 WebLogic domains should be created.

    • plm.wls.installer:

      Full path to the WebLogic installer jar file.

    • plm.wls.java.executable.name:

      The Windows name is the default.

      The value for UNIX is commented out below it. Reverse the comments for the two lines.

5.4 Execution of the Batch Script

Windows

  1. Open an Administrative command shell and change to the installer directory:

    cd <installation-media-path>\installer.

  2. Set the JAVA_HOME environment variable to the installed Java Development Kit. This has to be a 32-bit Java 7 Development Kit.

    set JAVA_HOME=C:\Program Files (x86)\Java\jdk7

  3. Execute the following command in your previously opened command shell:

    batchinstall.cmd properties\installation.properties SECOND_PARAMETER

UNIX

  1. Open a csh shell and change to the installer directory:

    cd <install-media-path>/installer

  2. Set the JAVA_HOME environment variable to the installed Java Development Kit. This has to be a 32-bit Java 7 Development Kit.

    setenv JAVA_HOME /usr/local/java/jdk7

  3. 6. Execute the following command in your previously opened csh shell:

    ./batchinstall.csh properties/installation.properties SECOND_PARAMETER |& tee installation.log

The batch installation will take about 20 min. A log file, installation.log, is created and will be overwritten every time you will call batchinstall.cmd again.


Note:

Please make sure that the created installation.properties file is either highly secured, or will be deleted once the installation is done, because it contains passwords.

5.5 The Resulting Default Agile e6 Environments

Using the default values, the following Agile e6 environments are created:

5.5.1 Windows Services

Following Windows Services are available but not started:

  • AgilePLM_Fileservice

  • AgilePLM_JavaDaemon

  • AgilePLM_FMS_JavaDaemon

  • AgilePLM_Portmapper

5.5.2 WebLogic Domains

During the installation, 2 domains were created. Each domain consists of an AdminServer and an Agile eSeries-01 server.

  • The AdminServer is only for the administration of the domain.

  • The Agile eSeries-01 servers contain the Agile e6 deployments.

The domains directory, as defined in plm.applicationserverdefinition.domain_root, contains the domains eSeries_domain, and eSeries_domain_plmref.

5.5.3 Ports

E6 AdminClient 8030
Java Daemon 16087
Fileservice 804257548
"plmref" BusinessService ECI Port 19997
"plmref" WebServices ECI Port 19998
WebLogic eSeries_domain -> AdminServer 7101
WebLogic eSeries_domain -> AdminServer, SSL 7102
WebLogic eSeries_domain ->eSeries-01 7103
WebLogic eSeries_domain ->eSeries-01, SSL 7104
WebLogic eSeries_domain_plmref -> AdminServer 7105
WebLogic eSeries_domain_plmref -> AdminServer, SSL 7106
WebLogic eSeries_domain_plmref -> eSeries-01 7107
WebLogic eSeries_domain_plmref -> eSeries-01, SSL 7108
WebLogic Node Manager 5559
Oracle Database Listener 1521

5.5.4 Links

  • Java Client WebStart: https://<servername>:7104/Jacc/jacc.jnlp

  • Web Client: https://<servername>:7104/AgilePlmWps

  • DaemonAdminServlet: https://<servername>:7104/DaemonAdminServlet

  • HTTPSupport: https://<servername>:7104/plm-api-axis/services

  • AdminClient: http://<servername>:8030/AdminClient

  • WebLogic Admin Console:

    eSeries_domain: https://<servername>:7102/console

    eSeries_domain_plmref:https://<servername>:7106/console

5.6 DFM Batch Installation

A remote side for DFM (Distributed File Management) usually contains the following components:

  • File Server

  • FMS Java Daemon

  • Web Fileservice

  • Web File Server

  • AutoVue Components

    • If you are using the central AutoVue installation, it is possible to install the wrapper for the Agile e6 AutoVue Integration on the remote location (JVue.war) for performance reasons.

      If the AutoVue server is installed on the remote location, the complete Agile e6 AutoVue Integration (VueLink.war) has to be deployed.

  • Java Client WebStart

    • If the Java Client WebStart is used, it is possible to install the Java Client deployment on the remote location (Jacc.war) for performance reasons.

5.6.1 Requirements

  • The latest Tomcat version 7 with Java 7 has to be installed on the DFM site(s) server. The Tomcat 7 core binary distribution can be downloaded from http://tomcat.apache.org/


    Note:

    Only on Windows the Tomcat 7 32-bit version is supported by the batch installation

    • The Metro web service stack has to be installed too if File Web Services are used. The Metro web service stack zip archive can be downloaded from http://metro.java.net/


    Note:

    Tomcat 7 and the Metro web service stack can be installed with the batch installation for the FMS services.

  • A fully extracted Agile e6 package from the Oracle Software Delivery Cloud on the DFM site(s) server.

5.6.2 Installation Components

The batchinstall script with the DFM option will install the following components:

  • Tomcat with the Metro web service stack

    • On Windows it will create a service entry for starting the Tomcat

    • Deployments for:

      • Java Client WebStart

      • Wrapper for the AutoVue viewer

      • Agile e6 AutoVue Integration

      • Web Fileservice

      • Streaming Fileservice

  • FMS Java Daemon

  • File Server

5.6.3 Installation

To perform the DFM Batch Client installation, please execute the DFM properties file as mentioned in section Batch Modes.

5.7 Batch Installation Examples

This examples describe how you can install Agile e6 in batch mode.

5.7.1 Master Installation

This section shows the installation of the Agile e6 server.

5.7.1.1 Initialize Installation environment

Create the batch properties file at

<install-media-path>\installer\properties\installation.properties

You can use the tpl_installation.properties as template.

The necessary information in the installation.properties file is

plm.inst.name=AgileInstallation62

plm.inst.root=c:\\plm62

5.7.1.2 Execution of the Batch Script

  1. Open an Administrative command shell and change to the Installer directory:

    cd <installation-media-path>\installer

  2. Set the JAVA_HOME environment variable to the installed Java Development Kit.


    Note:

    This has to be a 32-bit Java 7 Development Kit. Set

    JAVA_OME=C:\Program Files (x86)\Java\jdk7


  3. Execute the following command in your command shell: batchinstall.cmd properties\installation.properties INIT

5.7.1.3 Create the Master Oracle Wallet Packages

Create the Master Oracle Wallet Packages

  1. Edit the installation.properties file and change the following properties

    1. plm.inst.wallets.private.archive

    2. plm.inst.wallets.public.archive

  2. Execute the following command in your command shell: batchinstall.cmd properties\installation.properties WALLET.

This command creates the master Oracle wallet packages which you must use for the other installation modes (Clone, J2EE, DFM).

  • The agile-edm-private-wallets.zip contains the master Oracle wallets (Including the private keys). This ZIP file must be protected against unauthorized access! Use secure transfer methods when you install other servers.

  • The agile-edm-public-wallets.zip contains the public key of the master server Oracle wallet.

5.7.1.4 Encrypt Passwords

Some of the properties which you have to change in the installation.properties file are passwords.

You have to enter them encrypted to secure your installation. The Agile e6 installer package provides the epkeytool to encrypt sensitive data.

To encrypt your passwords call the following command script:

tools\bin\epkeytool.bat -encryptpwd -keyStore file://%ALLUSERSPROFILE%\agile\installer\6.2.0\wallets\installation\AgileInstallation62\wallet\private\server\cwallet.sso -keyAlias orakey

The epkeytool prompts for the password to encrypt and prints the encrypted password in the command shell.

Copy the encrypted password to the correct place in the installation.properties file.

5.7.1.5 Finish the Installation

  • Execute the following command in your command shell: batchinstall.cmd properties\installation.properties ALL

Now the complete server installation is executed.

5.7.1.6 Clone Installation

To create another server installation based on the master installation you need three files from your master installation:

  • installation.properties

  • agile-edm-private-wallets.zip

  • agile-edm-public-wallets.zip

To deactivate the DUMP import, copy the installation.properties file to the <install-media-path>\installer\properties folder and change the following line:

plm.application.dumpimport=false

Also check the host names and ports in the installation.properties file and change them to meet your infrastructure.

For example the following host settings should point to the server where you execute the installation:

  • plm.j2eeappserver.jadehost

  • plm.j2eeappserver.fmsjadehost

  • plm.application.j2eehost

  • plm.application.httphost

There might be some additional host settings that need to be adapted.

Copy the ZIP files to the same location as in your master installation or change the paths in the installation.properties file to match the new location

5.7.1.7 Execution of the Batch Script

  1. Open an Administrative command shell and change to the installer directory:

    cd <installation-media-path>\installer

  2. Set the JAVA_HOME environment variable to the installed Java Development Kit. This has to be a 32-bit Java 7 Development Kit. Set

    JAVA_HOME=C:\Program Files (x86)\Java\jdk7

  3. Execute the following command in your command shell: batchinstall.

    cmd properties\installation.properties INIT

  4. Execute the following command in your command shell: batchinstall.

    cmd properties\installation.properties WALLET

  5. Execute the following command in your command shell:

    batchinstall.cmd properties\installation.properties ALL

5.7.1.8 J2EE Installation

To create an J2EE installation based on the master installation you need three files from your master installation:

  • installation.properties

  • agile-edm-private-wallets.zip

  • agile-edm-public-wallets.zip

Copy the installation.properties file to the <install-media-path>\installer\properties folder check the host names and ports in the installation.properties file and change them to meet your infrastructure.

Also check the host names and ports in the installation.properties file and change them to meet your infrastructure.

For example the following host settings should point to the server where you execute the installation:

  • plm.j2eeappserver.jadehost

  • plm.j2eeappserver.fmsjadehost

For example the following host settings should point to an Agile e6 native server which should be used from your J2EE installation:

  • plm.j2eeappserver.jadehost

  • plm.j2eeappserver.fmsjadehost

There might be some additional host settings that need to be adapted.

Copy the ZIP files to the same location as in your master installation or change the paths in the installation.properties file to match the new location

5.7.1.9 Execution of the Batch Script

  1. Open an Administrative command shell and change to the installer directory:

    cd <installation-media-path>\installer

  2. Set the JAVA_HOME environment variable to the installed Java Development Kit.This has to be a 32-bit Java 7 Development Kit. Set

    JAVA_HOME=C:\Program Files (x86)\Java\jdk7

  3. Execute the following command in your command shell:

    batchinstall.cmd properties\installation.properties INIT

  4. Execute the following command in yourcommand shell:

    batchinstall.cmd properties\installation.properties WALLET

  5. Execute the following command in your command shell:

    batchinstall.cmd properties\installation.properties J2EE

5.7.2 DFM Installation

5.7.2.1 Initialize Installation Environment

Create the batch properties file at

<install-media-path>\installer\properties\batch_install_dfm.properties

You can use the template from the examples folder.

The necessary information in the installation.properties file is

plm.inst.name=AgileInstallation62

plm.inst.root=c:\\plm62

5.7.2.2 Execution of the Batch Script

  1. Open an Administrative command shell and change to the installer directory:

    cd <installation-media-path>\installer

  2. Set the JAVA_HOME environment variable to the installed Java Development Kit.This has to be a 32-bit Java 7 Development Kit. Set

    JAVA_HOME=C:\Program Files (x86)\Java\jdk7

  3. Execute the following command in your command shell: batchinstall.

    cmd properties\batch_install_dfm.properties INIT

5.7.2.3 Create the DFM Oracle Wallet Package

  1. Edit the installation.properties file and change the following properties

    1. plm.inst.wallets.private.archive

    2. plm.inst.wallets.public.archive

  2. Copy the agile-edm-public-wallets.zip from your master installation to the location you have defined above

  3. Execute the following command in your previously opened command shell:

    batchinstall.cmd properties\batch_install_dfm.properties DFMWALLET

This command creates the DFM Oracle wallet package which is used to encrypt local passwords.

  • The agile-edm-private-wallets.zip contains the local DFM Oracle wallets (Including the private keys).

5.7.2.4 Encrypt Passwords

Some of the properties which you have to change in the installation.properties file are passwords.

You have to enter them encrypted to secure your installation. The Agile e6 installer package provides the epkeytool to encrypt sensitive data.

To encrypt your passwords call the following command script:

tools\bin\epkeytool.bat -encryptpwd -keyStore file://%ALLUSERSPROFILE%\agile\installer\6.2.0\wallets\installation\AgileInstallation62\wallet\private\server\cwallet.sso -keyAlias orakey

The epkeytool prompts for the password to encrypt and prints the encrypted password in the command shell.

Copy the encrypted password on the right place in the batch_install_dfm.properties file.

5.7.2.5 Finish the installation

  • Execute the following command in your previously opened command shell:

    batchinstall.cmd properties\batch_install_dfm.properties DFM

Now the complete DFM installation is executed.