Go to primary content
Oracle Agile Engineering Data Management Batch Client for Agile
Release e6.2.0.0
E52553-01
  Go To Table Of Contents
Contents

Previous
Previous
 
Next
Next
 

4 Batch Client Settings

This chapter describes the several settings related to the Java Wrapper framework of the Agile e6.2.0.0 Batch Client in the Scenario mode and ECI mode.

4.1 Batch Client Solution

The Agile e6.2.0.0 Batch Client uses the Java Wrapper as its run-time frame work.

4.1.1 Java Wrapper Settings

The Java Wrapper needs a configuration file:

<installdir>\axalant\ini\batch_simple_wrapper.conf

The Java Wrapper supports the following shutdown mode:

  • Simple type:

    The Java application, controlled by the Java Wrapper, will be configured and simply killed at shutdown. This mode is used for the Java Daemon

4.1.1.1 Configurations

Here is a short description of the settings which may be adapted to implement a custom batch solution.

4.1.1.2 Java Application Settings

This section in the configuration defines the controlled Java application and its command line parameters.

# Application parameters. Add parameters as needed starting from 1.
wrapper.app.parameter.1=com.agile.testclient.BatchClientApp
wrapper.app.parameter.2=-p%EP_ROOT%/examples/LgvLoop.properties
wrapper.app.parameter.3=-i%EP_ROOT%/examples/LgvLoop.groovy
wrapper.app.parameter.4=-T%EP_ROOT%/axalant/ini/testclient.properties

4.1.1.3 MS Windows Service Settings

This section within the configuration file defines the MS Windows Service settings. Here, the name of the server can be defined and some extended settings for services.

#****************************************************************
# Wrapper NT Service Properties
#****************************************************************
# WARNING - Do not modify any of these properties when an application using this configuration file has been installed as a service.
# Please uninstall the service before modifying this section. The service can then be reinstalled.
# Name of the service
wrapper.ntservice.name=AgilePLM_Batch_Service
# Display name of the service
wrapper.ntservice.displayname=AgilePLM_Batch_Service
# Description of the service
wrapper.ntservice.description=Batch Service for Agile PLM
# Service dependencies. Add dependencies as needed starting from 1
wrapper.ntservice.dependency.1=
# Mode in which the service is installed. AUTO_START or DEMAND_START
wrapper.ntservice.starttype=AUTO_START
# Allow the service to interact with the desktop.
wrapper.ntservice.interactive=false

4.1.2 Agile e6.2.0.0 Batch Client Properties

The used Agile e6.2.0.0 Batch Client scenario and the corresponding property file are defined as command line parameters in the Java Wrapper configuration file as you can see above.

This configuration file has to be adapted to your environment.


Note:

The Batch Client bundle provides an example (located in directory C:\Program Files\Agile_e6\batchclient\examples) which has to be adapted to your environment.

#
# ECI connection
#
host=<JAVA-DAEMON-HOSTNAME> 
port=<JAVA_DAEMON-PORT> 
env=<PLM-APPLICATION> 
scope=BATCH
#
# Client modes to define widget behaviors on client side.
# the valid values are: BATCH, TEST
#
# BATCH: No widgets will be opened on client side.
# TEST: widgets will be opened on client side virtually.
#
mode=BATCH

#
# Directories 
#
varenv.ep_root=<ROOT_DIRECTORY_OF_THE_BATCH_CLIENT> 
varenv.axalant_root=<AXALANT_ROOT_DIRECTORY_OF_THE_BATCH_CLIENT>

#
# Platform 
#
varenv.EP_MACH=<MACHINE_PLATFORM_NAME>

#
# Security settings
#
Security.KeyStoreFile=file://<installdir>/Agile_e6/BatchClient/init/wallet/private/batch/cwallet.sso 
Security.KeyAlias=orakey

#
# PLM Client 
#
client1=<USER_NAME>,<ENCRYPTED_PASSWORD>,<SCENARIO_CLASS_NAME>

The security setting needs to be adapted in the Batch Client properties. The SecurityKeyStoryFile has to point to the Oracle wallet of the Batch Client installation.

In the next section you can find instructions on how to create an Oracle wallet for your batch client installation.

Example:

Security.KeyStoreFile=file://C:/Program Files/Agile_e6/BatchClient/init/wallet/private/batch/cwallet.sso

Note:

The Batch mode can be set in the property files LGVCall.properties, LgvLoop.properties, OfsPdf.properties, and vuelink.properties.

When no mode is set in the property files, the default value is BATCH.


4.1.3 Secure User Credentials

The User credentials are stored in the Agile e6.2.0.0 Batch Client properties file.


Note:

The Batch Client installation needs to create a new installation specific Oracle wallet which needs to be protected against unauthorized file access.

4.1.3.1 Create Oracle Wallet

To encrypt a user password, the Batch Client needs an Oracle wallet. This Oracle wallet contains the private and public key for the encryption.

A Batch Client installation needs to create a new installation specific Oracle wallet which needs to be protected against unauthorized file access!

  1. Create a wallet root directory

    Default location: %BATCHCLIENT_ROOT%\init\wallet

  2. Protect the created wallet root directory against unauthorized file access!

  3. Open the script batchkeytool.cmd from directory %BATCHCLIENT_ROOT%\axalant\cmd.

  4. Configure the JAVA_HOME setting.

  5. Call the 'batchkeytool' to create the Oracle wallet.

    batchkeytool -c
    

    The following output should appear:

    Created private wallet with type BATCH at D:\dev\batchclient\axalant\cmd\..\..\init\wallet\private\batch
    --- Content of wallet at D:\dev\batchclient\axalant\cmd\..\..\init\wallet\private\batch:
    Requested Certificates:
    User Certificates:
    Subject:        C=US,ST=California,L=Redwood City,O=Oracle,OU=Agile PLM,CN=EDMBATCH
    Trusted Certificates:
    Subject:        C=US,ST=California,L=Redwood City,O=Oracle,OU=Agile PLM,CN=EDMBATCH
    

The Oracle wallet is used by the 'batchkeytool' to allow to encrypt user passwords. The Oracle wallet has to be used to store the password in the batch scenario properties file. The Batch Client then uses the Oracle wallet to decrypt the password to connect to the Agile EDM Server.


Note:

The password is encrypted during the login to the Agile EDM Server by using an automatically securely generated session key which is protected by Agile EDM Server certificates.

4.1.3.2 Encrypt User Credentials

The user credentials are stored in the Agile e6.2.0.0 Batch Client properties file.

  1. To protect the user password, it must be encrypted by 'batchkeytool'.

    Call the batchkeytool without any parameters to encrypt a password.

  2. Enter the password.

    The output is:

    {PLM-AES-128}RSA-PUBLIC-BASE64:QjFurSOpjlhQER+wZFF7L/XgD1+npwlEBcK0DDpNeYJ8gbxhIxuMZpZ4yEsuGuJQ5eZJiUHsHEW1X1pJddylUmrZm6rn+rx/BOfZlITnUvMpF93Ej11wdVu+DObmSazKD3v7rpAwpKXsFMeiKCVVVF7g5C2k033/UZTCnoPUAtE={PLM-AES-128}CVVOULGVgv06h2FJCMrAGrvyEgCeV9S0gZoTF4uCgL8=
    
  3. Copy the encrypted password into the scenario properties file for user password.

    Example:

    # PLM Client
    client1=USER_NAME,{PLM-AES-128}RSA-PUBLIC-BASE64:QjFurSOpjlhQER+wZFF7L/XgD1+npwlEBcK0DDpNeYJ8gbxhIxuMZpZ4yEsuGuJQ5eZJiUHsHEW1X1pJddylUmrZm6rn+rx/BOfZlITnUvMpF93Ej11wdVu+DObmSazKD3v7rpAwpKXsFMeiKCVVVF7g5C2k033/UZTCnoPUAtE={PLM-AES-128}CVVOULGVgv06h2FJCMrAGrvyEgCeV9S0gZoTF4uCgL8=,com.agile.LGVCall
    

    Note:

    Please make sure that the line above is a continuous line.

4.2 Enable the Old Batch Solution


Note:

The "old" batch solution of the EDM server is still available, but due to security risks this solution is not recommended.

To enable the EDB_BATCH mechanism, the security level has to be decreased to unrestricted.

The security level can be configured in the <environment>.xml file located in the <ep_root>/init directory.

Example:

<IPC
AbsEciUrl="eci://localhost:19997" SecurityLevel="unrestricted" TicketTimeout="600">
</IPC>

Note:

The security level setting also controls the security settings of the ECI connection. A client needs no authentication to connect to an unrestricted ECI server. Please ensure that this setting is not effective for EDM servers, which allow to be contacted via ECI.

4.3 Configuring the Batch Client for Executing a Simple LogiView Procedure

The standard Agile e6.2.0.0 Batch Client bundle is pre-configured for executing a LogiView Start/Stop scenario and cannot be used out of the box for a starting a simple LogiView scenario. Especially the wrapper configuration file needs a different wrapper Java MainClass and different wrapper application parameters.

The Agile e6.2.0.0 Batch Client requires the following configuration files / start scripts:


Note:

the following files / start scripts can all be renamed!

<ep_root>\axalant\ini\batch_wrapper.conf
<ep_root>\axalant\ini\testclient.properties
<ep_root>\examples\LGVCall.properties
<ep_root>\examples\LGVCall.groovy
<ep_root>\axalant\cmd\batchclient.cmd (Windows)
<ep_root>/axalant/scripts/batchclient (Unix)

To enable the Batch Client for executing a simple LogiView procedure, the Agile e6.2.0.0 Batch Client bundle is delivered with pre-configured examples which call a simple LogiView (LGV) procedure. The example files are located in the installation folder as follows:

Batch command script axalant/cmd/Simple.cmd
Wrapper configuration axalant/ini/batch_simple_wrapper.conf
Batch scenario axalant/examples/LGVCall.groovy
Batch configuration axalant/examples/LGVCall.properties