5 Advanced Administration Tasks

5.1 Deploying Customer Adapted Files

Customer adapted files which are part of a deployment, have to be adapted outside the WebLogic server. The same applies for the Tomcat application server for a DFM remote site installation. These adapted files will be available even after applying a hotfix.

Note: We do not support the changing of Agile e6 files directly in the Oracle WebLogic server deployment. The same applies for the Tomcat application server for a DFM remote site installation.

The deployment process in Agile e6 will create a "staging" directory in <ep_root> with four subdirectories and is active for all described batch deployment tasks.

All four subdirectories contain an "installation" directory for all application-independent deployments and an "application" directory containing an additional subdirectory for each Agile e6 application. This subdirectory contains the application specific deployments (e.g. the BusinessService).

• product:

  This directory contains a subdirectory for every deployed component. Under these subdirectories, the unzipped archives are available. If you want to modify any file in the archive, the file has to be copied to the same directory in the "custom" folder.

  
  

  Note: When redeploying, changes made in this directory and its subdirectories will be lost.

  
  

• custom:

  
  

  Note: This is the ONLY folder where you should make changes to files and add directories.

  
  

  This directory contains the same directory structure as the "product" folder without files (except one, see Adapting Business Service Notification Mail Templates). Copy the files you want to modify from the "product" folder to the corresponding directory in this folder.

  
  

  Note: Files cannot be deleted from the "product" folder by copying them to the "custom" folder, and deleting them there.

  
  

• merged:

  This directory contains the merged result of the "product" and "custom" folders. In this directory structure you can check if your adapted files are available in the unzipped archive.

  From this directory structure, the final archive will be created in the deploy directory.

  
  

  Note: When redeploying, changes made in this directory and its subdirectories will be lost.

  
  

• deploy:

  This directory contains the final archive before it will be deployed.

  
  

  Note: When redeploying, changes made in this directory and its subdirectories will be lost.

  
  

5.1.1 Keeping Customer Adapted Files When Deploying a Hotfix

If you are installing a hotfix, you might get updates for files you have adapted in the past.

To keep the adaptations, do the following:

1. Check for changes in the readme file of the hotfix package.

2. Backup your "product" folder.

3. Install the hotfix.

4. Compare the backup of the "product" folder with the new "product" folder to identify any files which have been changed.

5. If you have modified any of these files in the "custom" folder, then apply the changes to the files in the "product" folder manually.

6. Redeploy the application to activate the changes.

5.2 Administrating the Business Service

Business Services are always deployed if a new application is created with the Administration client. Therefore, the availability of the application server is mandatory.

If you want to perform additional changes to the Workflow module, you have to edit the configuration file for the Business Services.

Note: For further information about the Workflow module, please refer to the Workflow Online Help.

To modify the configuration file, you have to perform the steps described in the section Deploying Customer Adapted Files of this document.

Example: Adapt values in "ABS_<application_name>.ini" file of the Business Service.

To modify the configuration file, it can be copied from the "product" directory after the installation. The file is available under: "<ep_root>\staging\product\application\<application_name>\BusinessService\BusinessService.war\WEB-INF\classes".

Save the modified file to the folder:

"<ep_root>\staging\custom\application\<application_name>\BusinessService.war\WEB-INF\classes".

The file that you modified will be used with the next deployment of the Business Service.

The Business Services will connect to the defined database user/schema directly after they are started in the Oracle WebLogic server.

Note: Once this connection is lost, e.g. due to database reboot, due to dropping of the database schema, or due to loss of service, you must restart the Business Service inside the Oracle WebLogic server.

Note: It is also possible to restart the complete Oracle WebLogic server, but all the included services will not be available for that time.

5.2.1 Adapting Business Service Notification Mail Templates

After the first Business Service deployment of a new application, the notification mail templates are unpacked and available under:

<ep_root>\staging\custom\application\<application_name>\BusinessService.war\WEB-INF\lib\abs-notifier-templates\lay\notifier".

All adaptations made to files in this directory, also all new files, will be available after the next deployment of the Business Service. All files and directories below the "abs-notifier-templates" directory will be automatically packed to "abs-notifier-templates-1.0-SNAPSHOT.jar" file, which will be used for the deployment.

5.2.2 Connection Pool for Business Service

For WebLogic, default settings are available for the data source definition and can be customized. To customize them, the following template file has to be edited:

%EP_ROOT%\build\applicationServer\weblogic_121\tpl_app\ear\tpl_eSeriesDataSource-jdbc.xml

Note: For further information about WebLogic, please refer to the respective documentation: http://docs.oracle.com/middleware/1213/wls/JDBCP/ds_annotation.htm

Example for default values for the connection pool:

<jdbc-connection-pool-params>
<pinned-to-thread>true</pinned-to-thread>
<initial-capacity>5</initial-capacity>
<max-capacity>150</max-capacity>
<statement-cache-size>100</statement-cache-size>
<statement-cache-type>LRU</statement-cache-type>
<connection-reserve-timeout-seconds>120</connection-reserve-timeout-seconds>
<test-table-name>SQL SELECT 1 FROM DUAL</test-table-name>
</jdbc-connection-pool-params>

Note: When configuring the minimum/maximum number of connections (<initial-capacity>), every connection needs a database process. Thus, the database has to have enough processes. Please check the configuration values in file: tpl_eSeriesDataSource-jdbc.xml and refer to your database administrator for further details.

Note: Further information about how to increase the performance can be obtained in an Oracle WebLogic training session.

5.3 About PLM-API / HTTP(S) Support

Note: Only supported with the Java Client.

PLM-API allows the communication with the Agile e6.2.0.0 application server through firewalls (via HTTP).

For further information on the architecture, refer to the Architecture Guide for Agile e6.2.0.0.

The PLM-API is always deployed if a new Agile e6.2.0.0 server installation is created and can be used for all created applications of the installation. To be able to use the PLM-API, it has to be configured in the Java Client. To use the PLM-API, no changes are required in the configuration of the Oracle WebLogic server.

For further information on how to set up the HTTP(S) support in the Java Client, refer to the section Online Help > Getting Started > Preferences, and the Architecture Guide for Agile e6.2.0.0.

5.4 Special Batch Administration Tasks

5.4.1 Prerequisites

Note: Agile e6.2.0.0 has to be installed!

For all batch tasks set the JAVA_HOME environment variable to Java 7 32-bit JDK before you execute setup.cmd/setup.csh in a cmd/csh shell.

Use the installation user of the Agile e6.2.0.0 installation.

Windows	UNIX
Use an administrator cmd shell.	Use a csh shell.
Execute setup.cmd for all batch tasks in: %ALLUSERSPROFILE%\agile\installer\6.2.0	Execute setup.csh for all batch tasks in: ${HOME}/.agile/installer/6.2.0

A properties file ("batch.properties") has to be created in one of the following directories by making a copy of the tpl_installation.properties file and adapting the properties in it:

Windows	UNIX
%ALLUSERSPROFILE%\agile\installer\6.2.0\properties	${HOME}/.agile/installer/6.2.0/properties

Example:

Windows	UNIX
cd %ALLUSERSPROFILE%\agile\installer\6. 2.0 set JAVA_HOME=<java7_home> setup.cmd application.install setup.cmd application.install -propertyfile properties\batch.properties > batch_ install.log 2>&1	cd ${HOME}/.agile/installer/6.2.0 setenv JAVA_HOME <java7_home> ./setup.csh application.install -propertyfile properties/batch.properties >& batch_install.log

Note: On UNIX, use different redirector settings for stderr and stdout

Note: After each batch installation task, check the log file.

5.4.2 Create an Application

1. Copy the template properties file installer/properties/tpl_installation.properties to installer/properties/batch.properties.

2. Replace the text in brackets (<CHANGETHIS>) with the values of your application.

   You can use different batch properties files for each application.

   # Defines if the schema will be created (system password also has to be applied for creating a schema)
   plm.application.creschema=true
   # Defines if the content of an existing schema will be deleted (Attention: All objects of the defined schema will be lost)?
   plm.application.delschemaobj=false
   # Database to import as defined in installation_prop.xml (normally no need to change this)
   plm.application.databasedefinition=oradb
   plm.oracle.systempwd=<systempwd>
   

3. After defining the properties, execute (example):

   setup.cmd application.install -propertyfile properties/batch.properties > application_install.log 2>&1
   

   This will create the application directory and the configuration files in the <ep_root>/init directory. Additionally, if enabled, the schema will be created and the reference dump will be imported.

To deploy the J2EE applications for an Agile e6 application, the following additional steps need to be executed.

1. Create J2EE application domain (example):

   setup.cmd j2eeappserver.install.domain_app -propertyfile properties/batch.properties > install_domain_app.log 2>&1
   

2. Deploy J2EE applications (Business Service, Web Services) to domain (example):

   setup.cmd j2eeappserver.deploy.app -propertyfile properties/batch.properties > deploy_app.log 2>&1
   

5.4.3 Common Properties for the Redeployment

Each of the following redeployment tasks requires a property file with at least the following content.

1. Create a common Properties file (example):

   plm.inst.name=<installation_name>

   
   

   Note: Replace <installation_name> with your installation name (e.g. AgileInstallation62).

   
   
   
   

   Note: The following three deployment tasks require additional properties: Business Service Web Services Web Development Toolkit

   
   

5.4.4 (Re)Deploying Business Services for an Application

Redeploying a Business Service causes a recreation of the Business Service 'ear' file and the deployment with the configured values as defined in the installation_prop.xml file.

1. Add the following lines to the common properties file (example):

   plm.application.name=mytest
   j2eeappserver.encryptpwd.encrypted={AES}JoQb6W...
   

   
   

   Note: The encrypted password "j2eeappserver.encryptpwd.encrypted" is the database schema password for this application and has to be generated with the WLSencrypt script which is located in the folder: %EP_ROOT%\build\applicationServer\weblogic_121\scripts\<domain_name>_<application_name>. Replace <domain_name>_<application_name> to match your installation, e.g. with eSeries_domain_mytest. Please be aware that you have to encrypt the password with the correct domain because the password is encrypted with the shared secret of this domain and will not work with another WebLogic domain.

   
   

2. Redeploy BusinessService (example):

   setup.cmd j2eeappserver.deploy.businessservice -propertyfile properties/batch.properties > deploy_businessservice.log 2>&1
   

5.4.5 (Re)Deploying Web Services for an Application

1. Add the following line to the common properties file (example):

   plm.application.name=mytest
   

2. Redeploy the Web Service (example):

   setup.cmd j2eeappserver.deploy.webservices.core -propertyfile properties/batch.properties > deploy_webservices.log 2>&1
   

5.4.6 (Re)Deploying Web Development Toolkit

Web Development Toolkit is not deployed after default installation. If you want to use it, you have to deploy it first.

Note: This can also be used to redeploy the Web Development Toolkit.

1. Add the following line to the common properties file (example):

   j2eeappserver.deploy.webdevelopmenttoolkit=true
   

2. Redeploy (example):

   setup.cmd j2eeappserver.deploy.webdevelopmenttoolkit -propertyfile properties/batch.properties > deploy_wdt.log 2>&1
   

5.4.7 (Re)Deploying Java Client

1. Redeploy (example):

   setup.cmd j2eeappserver.deploy.javaclient -propertyfile properties/batch.properties > deploy_javaclient.log 2>&1
   

5.4.8 (Re)Deploying Web Presentation Service

1. Redeploy (example):

   setup.cmd j2eeappserver.deploy.webpresentationservice -propertyfile properties/batch.properties > deploy_wps.log 2>&1
   

5.4.9 (Re)Deploying HTTPSupport (plm-api)

1. Redeploy (example):

   setup.cmd j2eeappserver.deploy.httpsupport -propertyfile properties/batch.properties > deploy_httpsupport.log 2>&1
   

5.4.10 (Re)Deploying Web Fileservice

1. Redeploy (example):

   setup.cmd j2eeappserver.deploy.webfileservice -propertyfile properties/batch.properties > deploy_wfs.log 2>&1
   

5.4.11 (Re)Deploying StreamingFileservices

1. Redeploy (example):

   setup.cmd j2eeappserver.deploy.fileservices -propertyfile properties/batch.properties > deploy_sfs.log 2>&1
   

5.4.12 (Re)Deploying JVue (Agile e6 AutoVue Integration Client Component)

1. Redeploy (example):

   setup.cmd j2eeappserver.deploy.jvue -propertyfile properties/batch.properties > deploy_jvue.log 2>&1
   

5.4.13 (Re)Deploying Vuelink (Agile e6 AutoVue Integration Server Component)

1. Redeploy (example):

   setup.cmd j2eeappserver.deploy.vuelink -propertyfile properties/batch.properties > deploy_vuelink.log 2>&1
   

5.4.14 (Re)Deploying DaemonAdminServlet

1. Redeploy (example):

   setup.cmd j2eeappserver.deploy.daemonadminservlet -propertyfile properties/batch.properties > deploy_admsvlt.log 2>&1