11 Configuring Oracle Application Server ProcessConnect

This chapter describes Oracle Application Server OracleAS ProcessConnect configuration in the OPMN opmn.xml file.

It features the following topics:

OracleAS ProcessConnect Module Configuration
OracleAS ProcessConnect Minimum Configuration
OracleAS ProcessConnect Complete Configuration
OracleAS ProcessConnect Attribute Descriptions

11.1 OracleAS ProcessConnect Module Configuration

The following lines load and identify the OracleAS ProcessConnect process module. Management of OracleAS ProcessConnect processes by the process module are identified by the module id.

<module path="%ORACLE_HOME%/opmn/lib/libopmnip.so">
   <module-id id="integration-manager"/>
   <module-id id="adapter-framework"/>
</module>

11.2 OracleAS ProcessConnect Minimum Configuration

The following lines represent the minimum configuration for OracleAS ProcessConnect. Default values are assigned to all other configuration elements and attributes for OracleAS ProcessConnect.

<ias-component id="ProcessConnect">
   <environment>
      <variable id="LANG" value="en_US" append="false"/>
      <variable id="THREADS_FLAG" value="native" append="false"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/rdbms/jlib/xdb_g.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/rts2.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/j2ee/home/oc4j.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/j2ee/home/lib/http_client.jar"       append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/j2ee/home/lib/aqapi.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/ip/admin" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/ip/work" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/ip/config" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/ip/lib/ip.jar" append="true"/>
   </environment>
   <process-type id="IntegrationManager" module-id="integration-manager">
      <port id="dms" range="8301-8401"/>
      <process-set id="im_instance1" numprocs="1"/>
   </process-type>
   <process-type id="AdapterFramework" module-id="adapter-framework">
      <port id="dms" range="8301-8401"/>
      <process-set id="af_instance1" numprocs="1"/>
   </process-type>
</ias-component>

11.3 OracleAS ProcessConnect Complete Configuration

The following lines show a complete configuration for OracleAS ProcessConnect. It contains all possible configuration elements and attributes for OracleAS ProcessConnect.

<ias-component id="ProcessConnect" status="enabled">
   <module-data>
      <category id="start-parameters">
         <data id="java-bin" value="/my/path/to/java/exec"/>
         <data id="java-parameters" value="-ms8m -mx512m"/>
         <data id="class-name" value="MyJavaStartClass"/>
      </category>
      <category id="stop-parameters">
         <data id="java-bin" value="/my/path/to/java/exec"/>
         <data id="java-parameters" value="-ms8m -mx512m"/>
         <data id="class-name" value="MyJavaStopClass"/>
      </category>
      <category id="ip-parameters">
         <data id="dms-port-property-name" value="my.dms.port.property"/>
         <data id="log-dir" value="/my/path/to/ip/log/dir"/>
         <data id="start-command" value="-mystartstring"/>
         <data id="shutdown-command" value="-myshutdownstring"/>
         <data id="im-string" value="MyIntegrationManagerString"/>
         <data id="af-string" value="My Adapter Framework String"/>
         <data id="im-class-name" value="MyIMClass"/>
         <data id="af-class-name" value="MyAFClass"/>
      </category>
   </module-data>
   <environment>
      <variable id="LANG" value="en_US" append="false"/>
      <variable id="THREADS_FLAG" value="native" append="false"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/rdbms/jlib/xdb_g.jar"
      append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/rts2.jar" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/j2ee/home/oc4j.jar"       append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/j2ee/home/lib/http_client.jar"
      append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/j2ee/home/lib/aqapi.jar"
      append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/ip/admin" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/ip/work" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/ip/config" append="true"/>
      <variable id="CLASSPATH" value="$ORACLE_HOME/ip/lib/ip.jar" append="true"/>
   </environment>
   <process-type id="IntegrationManager" module-id="integration-manager">
      <port id="dms"range="8301-8401"/>
      <id="im_instance1"numprocs="1"/>
   </process-type>
   <process-type id="AdapterFramework" module-id="adapter-framework">
      <port id="dms" range="8301-8401"/>
      <process-set id="af_instance1"numprocs="1"/>
   </process-type>
</ias-component>

11.4 OracleAS ProcessConnect Attribute Descriptions

This section describes the attributes that are specific for OracleAS ProcessConnect. This section also provides attribute descriptions of the attributes.

The OracleAS ProcessConnect attributes are described with the following format:

Title: This is the attribute name and value being defined. For example, id="ProcessConnect".
Required: This field defines whether or not the attribute is required in the component definition.
Default: This defines the default value assigned to the attribute. The default value appears in the installed version of the opmn.xml file or is assigned internally if the attribute is not present.
Valid values: This field defines the valid values for the attribute. For example, ProcessConnect.
Path: This field defines in which elements the attribute can appear. For example, ias-component.

id="ProcessConnect"

Required: true
Default: none
Valid values: ProcessConnect
Path: ias-component

This id is required and cannot be changed. The name must match the targets.xml entry or elements and attributes will not work.

id="start-parameters"

Required: false
Default: none
Path: ias-component/module-data/category

This id indicates the configuration block for the start-parameters category. In this category, some start-related module data can be specified.

id="stop-parameters"

Required: false
Default: none
Path: ias-component/module-data/category

This id indicates the configuration block for stop-parameters category. In this category, some stop-related module data can be specified.

id="ip-parameters"

Required: false
Default: none
Path: ias-component/module-data/category

This id indicates the configuration block for the ip-parameters category. In this category, some ProcessConnect-related module data can be specified.

id="java-bin"

Required: false
Default: $ORACLE_HOME/jdk/bin/java
Valid values: Full path to java.exe
Path: ias-component/module-data/category

You can specify alternate paths to the Java executable. However, a valid version of Java will have to be used for the process to start up and work correctly.

id="java-parameters"

Required: false
Default: -ms8m -mx512m -D<IM|AF> -Doracle.dms.httpd.port.start=<dms_port>
-Doracle.opmn.uid=<opmn_uid> -Doracle.ons.oraclehome=<ORACLE_HOME>
Valid values: Any valid Java parameters
Path: ias-component/module-data/category/data

You can specify any valid Java parameters for the Java command line. If a parameter matches one in the default parameter list, it will override the default.

id="class-name"

Required: false
Default: oracle.tip.runtime.admin.ProcessManager
Valid values: A valid Java class name
Path: ias-component/module-data/category/data

You can specify any valid Java class name that will be used for starting or stopping OracleAS ProcessConnect processes. This attribute is for internal use only and must not be changed by the user.

id="dms-port-property-name"

Required: false
Default: oracle.dms.httpd.port.start
Valid values: A valid Java property name
Path: ias-component/module-data/category/data

You can specify a Java property name that will be used to pass an OPMN assigned DMS port value to OracleAS ProcessConnect processes. In turn, OracleAS ProcessConnect processes will read this property to get the DMS port. This name should match the property name used by OracleAS ProcessConnect processes for retrieving the DMS port.

id="log-dir"

Required: false
Default: $ORACLE_HOME/ip/log
Valid values: The file path where OracleAS ProcessConnect processes store log files
Path: ias-component/module-data/category/data

You can specify a directory where OracleAS ProcessConnect processes will store their log files.

id="start-command"

Required: false
Default: -start
Valid values: A valid OracleAS ProcessConnect command for starting OracleAS ProcessConnect processes
Path: ias-component/module-data/category/data

This is an OracleAS ProcessConnect process management specific command to be passed into OracleAS ProcessConnect process management class. It should not be changed.

id="shutdown-command"

Required: false
Default: -shutdown
Valid values: A valid OracleAS ProcessConnect specific command for stopping OracleAS ProcessConnect processes
Path: ias-component/module-data/category/data

This is an OracleAS ProcessConnect process management specific command to be passed into OracleAS ProcessConnect process management class. It should not be changed.

id="im-string"

Required: false
Default: IntegrationManager
Valid values: A valid OracleAS ProcessConnect specific process management parameter
Path: ias-component/module-data/category/data

This is an OracleAS ProcessConnect process management specific parameter to be passed into OracleAS ProcessConnect process management class for Integration Manager process. It should not be changed.

id="af-string"

Required: false
Default: "Adapter Framework"
Valid values: A valid OracleAS ProcessConnect specific process management parameter
Path: ias-component/module-data/category/data

This is an OracleAS ProcessConnect process management specific parameter to be passed into OracleAS ProcessConnect process management class for Adapter Framework process. It should not be changed.

id="im-class-name"

Required: false
Default: oracle.tip.runtime.im.IntegrationManager
Valid values: A valid Java class name
Path: ias-component/module-data/category/data

This parameter tells OracleAS ProcessConnect process management class which class name will be used to instantiate Integration Manager class. It should not be changed.

id="af-class-name"

Required: false
Default: oracle.tip.adapter.fw.bootstrap.AFInstantiator
Valid values: A valid Java class name
Path: ias-component/module-data/category/data

This parameter tells OracleAS ProcessConnect process management class which class name will be used to instantiate Adapter Framework class. It should not be changed.

module-id="integration-manager"

Required: true
Default: none
Valid values: integration-manager
Path: ias-component/process-type

This id defines the type of process and associates the configuration with a process module.

module-id="adapter-framework"

Required: true
Default: none
Valid values: adapter-framework
Path: ias-component/process-type

This id defines the type of process and associates the configuration with a process module.

id="dms"

Required: true
Default: none
Valid values: dms
Path: ias-component/process-type/port

This id specifies the range of ports for DMS inside each OracleAS ProcessConnect process.

range="8301-8401"

Required: true
Default:
Valid values: A valid port number or a range of ports
Path: ias-component/process-type/port

You should use this parameter to specify a port or a range of ports to be used by DMS inside each OracleAS ProcessConnect process.

id="im_instance1"

Required: true
Default: none
Valid values: An OracleAS ProcessConnect process instance name
Path: ias-component/process-type/process-set

This parameter lists the process instance name for the process-set. This instance name will be passed into the OracleAS ProcessConnect process management class for starting or stopping OracleAS ProcessConnect processes.

numprocs="1"

Required: true
Default: none
Valid values: 1
Path: ias-component/process-type/process-set

This attribute gives the number of OracleAS ProcessConnect instances started for the process-set. The OracleAS ProcessConnect module does not permit more than one instance with the same process-set. To start more than one processes for the same server type, put one process-set entry with one unique process-set instance id for each process.