Previous	Next		Contents	Index	Glossary

Note: These 'Outbound' and 'Inbound' queues are separate from the queues used for the Business Event System. See: Setting Up Background Workflow Engines and Workflow Queue APIs, Oracle Workflow API Reference.

After a Java function completes, you must run a background engine to process the 'Inbound' queue and complete the function activity. See: Setting Up Background Engines.

Some standard Workflow activities are external Java function activities and require the Java Function Activity Agent. You can also define your own external Java function activities. See: Standard Activities, Oracle Workflow Developer's Guide, To Create a Function Activity, Oracle Workflow Developer's Guide, and Standard API for Java Procedures Called by Function Activities, Oracle Workflow Developer's Guide.

To run the Java Function Activity Agent, you must have Java Development Kit (JDK) Version 1.4 installed.

Note: The Java Runtime Environment is available for download from: http://www.javasoft.com

Starting the Java Function Activity Agent

When you start the Java Function Activity Agent, you must specify the user name of your Oracle Workflow database account and the database connect string. You can also optionally specify the character set and the JDBC driver type that you want to use.

After starting, the Java Function Activity Agent prompts you to enter the password for your Oracle Workflow database account.

You use different commands to start the agent depending on whether you are running it from a script or manually, and which platform you are running it on.

Starting the Java Function Activity Agent From a Script

If you define your own external Java function activities, you must edit the scripts to include the path to the JAR files containing your custom Java classes. The custom class files should reside on the same platform where the Java Function Activity Agent is run. The Java Function Activity Agent does not need to reside on the same tier as the database, however.

Running the wfjvlsnr.csh Script on UNIX Use the following command to run the wfjvlsnr.csh script on UNIX:

wfjvlsnr.csh "<user_name> <connect_string> [<JDBC_driver>]" [<character_set>]

Replace the parameters in the command as follows:

• <user_name>--The user name of your Oracle Workflow database account.

• <connect_string>--The connect string for the database. The format of the connect string depends on the JDBC driver type.

• For a JDBC OCI8 driver, the connect string should be the database name as specified in its TNSNAMES entry, in the following format: <database_name>

• For a JDBC THIN driver, you can use two different types of connect string. For the first type, the connect string should include the host name, port number, and database system identifier (SID) in the following format: <host_name>:<port_number>:<database_SID>

For the second type, the connect string should include an Oracle Net name-value pair with the host name, protocol, port number, and SID in the following format: (description=(address=(host=<host_name>)(protocol= <protocol>)(port=<port_number>))(connect_data=(sid= <database_SID>)))

• <JDBC_driver>--The JDBC driver type you want to use to connect to the database. The JDBC driver type can be either oci8 or thin. If you do not specify a driver type, Oracle Workflow uses the JDBC OCI8 driver by default.

Note: The connection details, including the user name, connect string, and JDBC driver type, must be enclosed in double quotes to separate them from the character set parameter.

• <character_set>--The character set to use for the database session. If you do not specify a character set, Oracle Workflow uses UTF8 by default.

wfjvlsnr.bat "<user_name> <connect_string> [<JDBC_driver>]" [<character_set>]

Replace the parameters in the command as follows:

• <user_name>--The user name of your Oracle Workflow database account.

• <connect_string>--The connect string for the database. The format of the connect string depends on the JDBC driver type.

• For a JDBC OCI8 driver, the connect string should be the database name as specified in its TNSNAMES entry, in the following format: <database_name>

• For a JDBC THIN driver, you can use two different types of connect string. For the first type, the connect string should include the host name, port number, and database system identifier (SID) in the following format: <host_name>:<port_number>:<database_SID>

For the second type, the connect string should include an Oracle Net name-value pair with the host name, protocol, port number, and SID in the following format: (description=(address=(host=<host_name>)(protocol= <protocol>)(port=<port_number>))(connect_data=(sid= <database_SID>)))

• <JDBC_driver>--The JDBC driver type you want to use to connect to the database. The JDBC driver type can be either oci8 or thin. If you do not specify a driver type, Oracle Workflow uses the JDBC OCI8 driver by default.

Note: The connection details, including the user name, connect string, and JDBC driver type, must be enclosed in double quotes to separate them from the character set parameter.

• <character_set>--The character set to use for the database session. If you do not specify a character set, Oracle Workflow uses UTF8 by default.

Starting the Java Function Activity Agent Manually

The CLASSPATH must point to the Java Runtime Environment, the directory containing the Workflow JAR files, the Oracle XML parser, the Oracle JDBC implementation, and the following Workflow JAR files:

• wfjava.jar--The Java Function Activity Agent.

• wfapi.jar--Workflow Java APIs.

• The Share JAR file--Utilities referenced by the Workflow Java APIs. In standalone Oracle Workflow, this file is named share-<version>.jar, such as share-1_1_9.jar, or whichever version is current.

• The Ewt JAR file--Utilities referenced by the Workflow Java APIs. In standalone Oracle Workflow, this file is named ewt-<version>.jar, such as ewt-3_3_18.jar, or whichever version is current.

• The Swing JAR file--Optional additional utilities. In standalone Oracle Workflow, this file is named swingall-<version>.jar, such as swingall-1_1_1.jar, or whichever version is current.

• fndctx.jar--Utilities referenced by the Workflow Java APIs.

Note: In standalone Oracle Workflow, the Workflow JAR files are located in the <ORACLE_HOME>/jlib directory.

If you define your own external Java function activities, you must also include the JAR files containing your custom Java classes in the CLASSPATH. The custom class files should reside on the same platform where the Java Function Activity Agent is run. The Java Function Activity Agent does not need to reside on the same tier as the database, however.

Starting the Java Function Activity Agent on UNIX Use the following command to start the Java Function Activity Agent on UNIX:

jre -classpath "$<JREPATH>/rt.jar:$<Workflow_JAR_file_directory>:

$<Workflow_JAR_file_directory>/wfjava.jar:$<ORACLE_HOME>/wf/

xml/java/lib/xmlparserv2.jar:$<Workflow_JAR_file_directory>/wfapi.jar:$<ORACLE_HOME>/jdbc/lib/classes111.zip:

$<Workflow_JAR_file_directory>/<Share_JAR_file>:

$<Workflow_JAR_file_directory>/<Ewt_JAR_file>:

$<Workflow_JAR_file_directory>/<Swing_JAR_file>:

$<Workflow_JAR_file_directory>/fndctx.jar:" [-DCHARSET=<character_set>] oracle.apps.fnd.wf.WFFALsnr <user_name> <connect_string> [<JDBC_driver>]

In this command, you can optionally use the -DCHARSET option to specify the character set that you want to use. If you do not specify a character set, Oracle Workflow uses UTF8 by default.

Replace the parameters in the command as follows:

• <character_set>--The character set to use for the database session.

• <user_name>--The user name of your Oracle Workflow database account.

• <connect_string>--The connect string for the database. The format of the connect string depends on the JDBC driver type.

• For a JDBC OCI8 driver, the connect string should be the database name as specified in its TNSNAMES entry, in the following format: <database_name>

• For a JDBC THIN driver, you can use two different types of connect string. For the first type, the connect string should include the host name, port number, and database system identifier (SID) in the following format: <host_name>:<port_number>:<database_SID>

For the second type, the connect string should include an Oracle Net name-value pair with the host name, protocol, port number, and SID in the following format: (description=(address=(host=<host_name>)(protocol= <protocol>)(port=<port_number>))(connect_data=(sid= <database_SID>)))

• <JDBC_driver>--The JDBC driver type you want to use to connect to the database. The JDBC driver type can be either oci8 or thin. If you do not specify a driver type, Oracle Workflow uses the JDBC OCI8 driver by default.

jre -classpath ";<JREPATH>\rt.jar;<Workflow_JAR_file_directory>;

<Workflow_JAR_file_directory>\wfjava.jar;<ORACLE_HOME>\wf\

xml\java\lib\xmlparserv2.jar;<Workflow_JAR_file_directory>\

wfapi.jar;<ORACLE_HOME>\jdbc\lib\classes111.zip;

<Workflow_JAR_file_directory>\<Share_JAR_file>;

<Workflow_JAR_file_directory>\<Ewt_JAR_file>;

<Workflow_JAR_file_directory>\<Swing_JAR_file>;

<Workflow_JAR_file_directory>\fndctx.jar;" 

-nojit [-DCHARSET=<character_set>] 

oracle.apps.fnd.wf.WFFALsnr <user_name> <connect_string> [<JDBC_driver>]

In this command, you can optionally use the -DCHARSET option to specify the character set that you want to use. If you do not specify a character set, Oracle Workflow uses UTF8 by default.

Replace the parameters in the command as follows:

• <character_set>--The character set to use for the database session.

• <user_name>--The user name of your Oracle Workflow database account.

• <connect_string>--The connect string for the database. The format of the connect string depends on the JDBC driver type.

• For a JDBC OCI8 driver, the connect string should be the database name as specified in its TNSNAMES entry, in the following format: <database_name>

• For a JDBC THIN driver, you can use two different types of connect string. For the first type, the connect string should include the host name, port number, and database system identifier (SID) in the following format: <host_name>:<port_number>:<database_SID>

For the second type, the connect string should include an Oracle Net name-value pair with the host name, protocol, port number, and SID in the following format: (description=(address=(host=<host_name>)(protocol= <protocol>)(port=<port_number>))(connect_data=(sid= <database_SID>)))

• <JDBC_driver>--The JDBC driver type you want to use to connect to the database. The JDBC driver type can be either oci8 or thin. If you do not specify a driver type, Oracle Workflow uses the JDBC OCI8 driver by default.

Stopping the Java Function Activity Agent

Note: If you are running more than one Java Function Activity Agent simultaneously, you must run the wfjvstop.sql script once for each Java Function Activity Agent.