bea.com | products | dev2dev | support | askBEA
 Download Docs   Site Map   Glossary 
Search

Starting, Stopping, and Customizing

 Previous Next Contents Index View as PDF  

WebLogic Integration Commands

This section provides system administrators and developers with information about key WebLogic Integration commands. It is organized into the following topics:

 


Command List

The following table provides the name and a brief description of each command documented in this section.

Table B-1 WebLogic Integration Commands  

This command . . .

Allows you to . . .

bulkimporter

Import workflow objects from Java Archive (JAR) files

bulkloader

Import, export, or delete repository data

bulkmigrator

Migrate a repository data file

checkdomain

Validate a domain and set WLI_DOMAIN for the calling process

createdb

Create repository tables and load system data

createmssql createsybase

Create a Microsoft SQL or Sybase database, and execute a script in that database

domainname

Set or verify the current domain set by the setdomain command

fb

Start Format Builder

launchSamplesPage

Open the samples launcher page in the default Web browser

mdbgenerator

Generate a deployable JAR file to listen on a custom queue

migratedb

Migrate a database from WebLogic Integration 2.1 to 7.0

PIMigrator

Migrate a workflow template

RunSamples

Configure the samples domain and start WebLogic Server in the samples domain

setdbdata

Load the database-specific variables into the current process

setdbtype

Set the database type for the domain

setDBVars setDBVarsExt

Set the basic and extended database variables for the domain

setdomain

Set the current domain

setenv

Set common WebLogic Integration environment variables

SetDomainTypeData SetSampleData

Set domain-specific environment variables

setupAppView setupEDIAppView

Set up the sample adapter or EDI adapter application view

showdomain

Validate and display the current domain

startAiconsole startB2bconsole

Start the Application View Console or B2B Console

startpointbasecommander

Start the PointBase administrative tool

startWeblogic

Start WebLogic Server and deploy WebLogic Integration resources

stopWeblogic

Shut down WebLogic Server

studio

Start the WebLogic Integration Studio

switchdb

Update the database configured for the current domain

wliconfig

Launch the WebLogic Integration Database Wizard

worklist

Start the WebLogic Integration Worklist


 

 


Environment Variables

The following table provides the name and a brief description of each environment variable referenced by a WebLogic Integration command.

Note: The italicized string DOMAIN_NAME is used as a placeholder for a pathname in this document. Specifically, it represents the full pathname for the root of this domain. Unlike other terms shown in italic monospace font (such as WLI_HOME), DOMAIN_HOME is not an environment variable.

Table B-2 WebLogic Integration Environment Variables  

Variable

Description

CP

The classpath set by the SetDomainTypeData command and referenced by the setupAppView and setupEDIAppView commands. This variable is reset, but not exported, by the fb, worklist, and studio commands.

CMNCP

The common classpath set by the SetDomainTypeData command. For example, in the SetSampleData command, CMNCP is set as follows:

CMNCP=$WLI_SAMPLES_HOME/lib/samples.jar;$WLI_HOME/lib/wli-aux.jar

DB_CATALOG

Name of the database catalog.

See the description of the DB_PINGTABLE environment variable (in this table) and the setDBVarsExt and setupAppView commands.

DB_CODESET

The type of encoding used. This environment variable is not set if the encoding is US-ASCII or UTF-8. See the setDBVars commands.

DB_COMMAND

The command line required to invoke the client for the database. For example, if the current domain is configured to use an Oracle database, DB_COMMAND is set as follows:

DB_COMMAND="sqlplus username/password@oracle_sid @"

See the createdb, setdbdata, and setDBVars commands.

DB_CREATE

Invokes a database-specific command script. If the specified database does not exist, this command creates the database. See the createdb, setdbdata, and setDBVars commands.

DB_DIR

The location of the setDBVars and setDBVarsExt commands for the current domain. For example, if the current domain is configured to use an Oracle database, this variable is set as follows:

DB_DIR=$DBINFO/oracle

See the description of the DBINFO environment variable (in this table) and the setdbdata command.

DB_DRIVER

The JDBC driver required to connect to the configured database. For example, if the current domain is configured to use an Oracle database, then DB_DRIVER is set as follows:

DB_DRIVER="oracle.jdbc.driver.OracleDriver"

See the bulkloader, migratedb, and setDBVars commands.

DB_JVMARGS

When the domain is configured to use a PointBase database, this variable is set as follows:

DB_JVMARGS="-Dtransaction.isolationlevel=TRANSACTION_READ_COMMITTED -Ddatabase.pagesize=4096 -Dcache.size=2063 -Dsort.size=1024"

If a Microsoft SQL, Sybase, or Oracle database is configured, DB_JVMARGS is not set. See the bulkloader, createdb, migratedb, startWeblogic, stopWeblogic, setDBVars, startpointbasecommander, setupAppView, and setupEDIAppView commands.

DB_PASSWORD

The password required to connect to the database configured for the current domain. See the bulkloader, migratedb, and setDBVars commands.

DB_PINGTABLE

Specifies a table in the database. For example, if a Microsoft SQL database is configured for the samples domain on a Windows system, DB_PINGTABLE is set by the setDBVarsExt command as follows:

DB_CATALOG=WLIDB
DB_SCHEMA=dbo
DB_PINGTABLE=%DB_CATALOG%.%DB_SCHEMA%.EVENT

The DB_PINGTABLE variable is then invoked by the setupAppView command used to set up the sample application view as follows:

%JAVA_HOME%\bin\java . . . -cp %CP% examples.wlis.wlai.WLISAppViewDeployer . . . -pingTable %DB_PINGTABLE% . . .

(Only selected parts of the actual java command are shown.)

DB_PROPERTIES

Used with the switchdb command to update the JDBC connection pool properties for the current domain. For example, if the current domain is configured to use an Oracle database, then DB_PROPERTIES is set as follows:

On UNIX:
DB_PROPERTIES="user=$DB_USER;password=$DB_PASSWORD"

On Windows:
DB_PROPERTIES="user=%DB_USER%;password=%DB_PASSWORD%"

See the setdbdata command and the switchDB.xml file.

DB_SCHEMA

The database schema name. For Microsoft SQL and Sybase this is the database name; for Oracle it is the user name. For the default PointBase database the following setting is used:

DB_SCHEMA=PBPUBLIC

See the description of the DB_PINGTABLE environment variable (in this table) and the setDBVarsExt and setupAppView commands.

DB_SCRIPT_DIR

The location of the scripts for database configured for the current domain. For example, if the database for the current domain is an Oracle database, then DB_SCRIPT_DIR is set as follows:

On UNIX:
DB_SCRIPT_DIR="$WLI_HOME/dbscripts/oracle"

On Windows:
DB_SCRIPT_DIR="%WLI_HOME%/dbscripts/oracle"

See the createdb and setDBVars commands.

DB_SERVERNAME

The Microsoft SQL server name.

See the migratedb and setDBVars commands.

DB_TYPE

The type of database for the current domain. Valid values are: oracle, mssql, sybase, and pointbase.

See the createdb, migratedb, startpointbasecommander, startWeblogic, switchdb, setdbdata, setdbtype, and RunSamples commands.

DB_URL

The URL required by the database driver. The URL is constructed based on information provided during installation or during database configuration via the Database Wizard. For example, if DB_DRIVER="oracle.jdbc.driver.OracleDriver" then DB_URL="jdbc:oracle:thin:@(description=(address=
(host=
host)(protocol=tcp)(port=1521))(connect_data=
(sid=
oraclesid)))"

See the bulkloader, migratedb, and setDBVars commands.

DB_USER

The user name required to connect to the database configured for the current domain. See the bulkloader, migratedb, and setDBVars commands.

DBINFO

The location of the dbInfo directory for the current domain. This variable is set as follows:

On UNIX:

DBINFO=$WLI_DOMAIN/dbInfo

On Windows

DBINFO=%WLI_DOMAIN%\dbInfo

See the setdbdata and switchdb commands.

EVENTROUTER_URL

The URL for the event router for the domain. For example: EVENTROUTER_URL="http://$WLIS_HOST_AND_PORT/DbmsEventRouter/EventRouter"

See the SetDomainTypeData and setupAppView commands.

JAVA

The location of the java command. For example, if you install WebLogic Server in the default location on a Solaris system, JAVA is set as follows:

JAVA=$JAVA_BIN/java

See the PIMigrator command.

JAVA_HOME

The root directory of the Java Development Kit (JDK) installation. For example, if you install WebLogic Server in the default location on a Windows system, JAVA_HOME is set as follows:

JAVA_HOME=C:\bea\jdk131

See the bulkimporter, bulkloader, bulkmigrator, createdb, fb, mdbgenerator, migratedb, setenv, startpointbasecommander, studio, switchdb, wliconfig, worklist, startWeblogic, stopWeblogic, setupAppView, setupEDIAppView, and RunSamples commands.

JAVA_OPTIONS

The run-time options for the java command.

JAVACLASSPATH

The classpath variable invoked by the bulkmigrator command.

JDBC_DATASOURCE_JNDI_NAME

The JDBC data source JNDI name for the domain. For example:

JDBC_DATASOURCE_JNDI_NAME=WLAI_DataSource

See the SetDomainTypeData and setupAppView commands.

POINTBASE_HOME

For a domain configured to use a PointBase database, this variable sets the location of the PointBase database as follows: $WLI_DOMAIN/dbInfo/pointbase

See the setDBVars, startpointbasecommander, and creatdb commands.

SAMPLES_HOME

The WebLogic Platform samples directory. For example, if you install WebLogic Platform in the default location on a Windows system, SAMPLES_HOME is set as follows:
SAMPLES_HOME=C:\bea\weblogic700\samples

See the createdb, setenv, startWeblogic, stopWeblogic, SetDomainTypeData, setDBVars, and RunSamples commands.

SQLARGS

The set of options required by a Microsoft SQL or Sybase database. For example, if a Sybase database has been configured for the current domain, SQLARGS is set as follows:

SQLARGS="-b -e -n -S servername -U username -P \"password\""

See the setDBVars, createmssql, and createsybase commands.

SVRCP

Server classpath set by the SetDomainTypeData command. For example, when the SetSampleData command is run, SVRCP is set as follows:

SVRCP=$WLISERVERCP:$CMNCP

WL_HOME

The WebLogic Server installation directory. For example, if you install WebLogic Platform in the default location on a Windows system, WL_HOME is set as follows:
WL_HOME=C:\bea\weblogic700\server

See the bulkimporter, mdbgenerator, setenv, startWeblogic, stopWeblogic, and RunSamples commands.

WLI_DOMAIN

The currently set domain. See the checkdomain, createdb, migratedb, setdbdata, setdomain, domainname, showdomain, switchdb, SetDomainTypeData, and startWeblogic commands.

WLI_HOME

The WebLogic Integration installation directory. For example, if you install WebLogic Platform in the default location on a Windows system, WLI_HOME is set as follows:
WLI_HOME=C:\bea\weblogic700\integration.

See the bulkimporter, bulkloader, checkdomain, createdb, fb, mdbgenerator, migratedb, RunSamples, setdomain, setenv, SetDomainTypeData, setupAppView, setupEDIAppView, showdomain, startpointbasecommander, startWeblogic, stopWeblogic, studio, switchdb, and worklist commands.

WLI_SAMPLES_HOME

The root of the domain. For example:
WLI_SAMPLES_HOME=$SAMPLES_HOME/integration/config/samples

See the SetDomainTypeData command.

WLICOMMONCP

WebLogic Integration common classpath (for both client and server). See the setenv command.

WLICP

The WebLogic Integration client classpath. See the bulkloader, fb, migratedb, setenv, PIMigrator, studio, switchdb, worklist, SetDomainTypeData, setDBVars, and RunSamples commands.

WLIS_HOST_AND_PORT

The host and listen port for the domain administration server. For example:
WLIS_HOST_AND_PORT=localhost:7001

See the SetDomainTypeData, setupAppView, and setupEDIAppView commands.

WLIS_PASSWORD

The WebLogic Server password for the domain. For example:
WLIS_USER_NAME=system

See the SetDomainTypeData, setupAppView, and setupEDIAppView commands.

WLIS_USER_NAME

The WebLogic Server username for the domain. For example:
WLIS_PASSWORD=security

See the SetDomainTypeData, setupAppView, and setupEDIAppView commands.

WLISERVERCP

WebLogic Integration server classpath. See the setenv, SetDomainTypeData, and stopWeblogic commands.


 

 


Command Descriptions

This section presents descriptions of the WebLogic Integration commands, arranged in alphabetical order. The following figure summarizes the format of each command description.

Figure B-1 Command Description Format


 

 


bulkimporter

Name

bulkimporter—import workflow objects from Java Archive (JAR) files

Synopsis

bulkimporter -user bpm_user -password bpm_password -url
wls_server_url -orgid org_name {-file file_name |-dir
full_dir_path | -dir full_dir_path -file file_name}
[-activate] [-packagepwd
password] [-help] [-quiet]

Description

The bulkimporter command allows you to import workflow packages from the command line without using the WebLogic Integration Studio. A workflow package contains the following workflow objects:

Organizations, users, and roles cannot be imported.

At least one jar file must be specified on the command line but many jar files can be imported in one command as shown in the following supported combinations:

If the -quiet option is not specified, then a listing of all the objects imported into WebLogic Integration are displayed.

You can also import workflow objects using the WebLogic Integration Studio. For more information, see "Importing and Exporting Workflow Packages" in Using the WebLogic Integration Studio.

Options

The following table summarizes the options for the bulkimporter command.

Table B-3 bulkimporter Options

Option

Description

-user bpm_user

Specify the WebLogic Integration BPM user name. This is the same password that you use to login to the Studio. For a list of default BPM users, see BPM User Groups and Permissions. This option is required.

-password bpm_password

Specify the password for the BPM username specified by the -user option. This option is required.

-url wls_server_url

Specify the WebLogic Server URL. To connect to an instance of the WebLogic Server on a local machine with the default port number of 7001, set wls_server_url to t3//localhost:7001. This option is required.

-orgid org_name

Specify the BPM organization name. For a list of default BPM organizations, see option. This option is required.

-file file_name

Jar file which contains the workflow objects to import. File must end in the .jar extension. Either this option, the -dir full_dir_path option, or both the -file file_name and -dir full_dir_path options together must be specified.

-dir full_dir_path

The full directory path of the directory which contains the jar files to import. All the files that end in the .jar extension in this directory are imported. Either this option, the -file full_dir_path option, or both the -file file_name and -dir full_dir_path options together must be specified.

-activate

Activate the workflows after importing.

-packagepwd password

Specify the workflow password if the workflow package has been password protected.

-help

Display all the supported options.

-quiet

Run the command quietly, do display any messages while running the command.


 

UNIX Files

$WLI_HOME/bin/bulkimporter

Windows Files

%WLI_HOME%\bin\bulkimporter.cmd

Environment

This command references the following environment variables:

WL_HOME
WLI_HOME
JAVA_HOME

If WLI_HOME is not set, this command executes the setenv command.

 


bulkloader

Name

bulkloader—import, export, or delete repository data

Synopsis

bulkloader [-wlibc] cfg_file
bulkloader -load [-txAll] [-initDB][-wlibc] data_file

Description

The bulkloader command allows you to import, export, or delete B2B configuration data from the repository. The content of cfg_file specifies the action to be taken, provides database access information, and, if required for the action, supplies the name of the XML file to be used to update the repository.

If the -load option is used, the file specified (data_file) is the XML file to be imported to the repository. The database information is obtained from settings in the setDBVars command for the current domain. The current domain is set by the setdomain command. You can verify the current domain with the checkdomain command.

For detailed information about the Bulk Loader, and the contents of the cfg_file and data_file files, see Working with the Bulk Loader in Administering B2B Integration.

Note: By default, the Bulk Loader does not import, export, or delete data while the B2B engine is running. If, for some reason, the B2B engine does not shut down normally, the Bulk Loader fails with the following error:

ERROR: WLC is still running or was shut down abnormally.

To override this error and force the command to execute by modifying the Bulk Loader command file, see "Forcing the Bulkloader" in Working with the Bulk Loader in Administering B2B Integration.

Options

The following table summarizes the options for the bulkloader command.

Table B-4 bulkloader Options  

Option

Description

-wlibc

Use the -wlibc flag when you import an XML file created by a trading partner using the lightweight client, WebLogic Integration - Business Connect

-load

Import the data_file data into the database configured for the current domain.

-txAll

Import the data in a single transaction. When not specified, a transaction is initiated upon import or delete of each of the following entities: trading partners, conversation definitions, collaboration agreements, business protocol definitions, and logic plug-ins. If invalid data is detected during a transaction for any entity, the import is rolled back for the current transaction only; importing continues for the next transaction.

-initDB

Empties all tables in the repository before importing the data.

Warning: When you specify the -initDB option the existing data in the database is destroyed. If the data you are loading does not include the required system data, this option renders the system unusable. Because data created by a WebLogic  Integration  - Business  Connect trading partner does not include system data, never use this option in conjunction with the -wlibc option. Do not specify -initDB unless you intend to reinitialize the entire database.


 

UNIX Files

$WLI_HOME/bulkloader
$WLI_HOME/bin/setdbdata
$WLI_HOME/setenv.sh

Windows Files

%WLI_HOME%\bin\bulkloader.cmd
%WLI_HOME%\bin\setdbdata.cmd
%WLI_HOME%\setEnv.cmd

Environment

This command references the following environment variables:

DB_JVMARGS
JAVA_HOME
WLI_HOME
WLICP

When executed with the -load option, this command references:

DB_DRIVER
DB_URL
DB_USER
DB_PASSWORD

If WLI_HOME is not set, this command executes the setenv command.

 


bulkmigrator

Name

bulkmigrator—migrate a repository data file

Synopsis

bulkmigrator collaborate1.0_file wlintegration2.0_file

Description

The bulkmigrator command converts an XML data file exported from WebLogic Collaborate 1.0.x (collaborate1.0_file) to the format required for WebLogic Integration 2.0 (wlintegration2.0_file). Some additional steps must be taken to make the file compatible for import to WebLogic Integration 7.0.

For detailed instructions, see "Migrating from Releases Prior to WebLogic Integration 2.1" in Introduction to Migration in BEA WebLogic Integration Migration Guide.

Options

None.

UNIX Files

$WLI_HOME/bin/bulkmigrator

Windows Files

%WLI_HOME%\bin\bulkmigrator.cmd

Environment

This command references the following environment variables:

JAVA_HOME
JAVACLASSPATH

 


checkdomain

Name

checkdomain—validate a domain and set WLI_DOMAIN for the calling process

Synopsis

checkdomain

Description

The checkdomain command is used in conjunction with setdomain and other command scripts. The checkdomain command validates that a domain has the directories and files required for other commands to run, and, if the domain is valid, it executes the domainname command to set WLI_DOMAIN for the calling process.

Note: The domainname command is created when the setdomain command is executed. This command stores the current WLI_DOMAIN setting.

Options

None.

UNIX Files

$WLI_HOME/bin/checkdomain
DOMAIN_HOME/checkdomain
$WLI_HOME/bin/domainname
$WLI_HOME/setenv.sh

Windows Files

%WLI_HOME%\bin\checkdomain.cmd
DOMAIN_HOME\checkdomain.cmd
%WLI_HOME%\bin\domainname.cmd
%WLI_HOME%\setEnv.cmd

Environment

This command sets WLI_DOMAIN and references WLI_HOME.

If WLI_HOME is not set, this command executes the setenv command.

 


createdb

Name

createdb—create repository tables and load system data

Synopsis

createdb [-f] [-noinit]

Description

The createdb command creates the WebLogic Integration repository tables in the database configured for the current domain, and then, if required, loads the system data into that database. The command calls the setdbdata command to load the current database access information and the bulkloader command to load the data.

The tables created are dependent on the requirements of the current domain. (For a description of the required tables, see Table  1-3 in Domain Configuration Requirements.) For example, if the current domain does not support B2B functionality, then the B2B tables are not created, and the B2B system data is not loaded. If the current domain is the WebLogic Integration samples domain, additional, sample-specific tables are created.

Note: Because the osql client used to create tables in a Microsoft SQL database is not available on UNIX, you cannot use the createdb command to create tables in a Microsoft SQL database from a UNIX system.

Options

The following table summarizes the options for the createdb command.

Table B-5 createdb Options

Option

Description

-f

Do not prompt for confirmation. By default, the command prompts for confirmation before proceeding.

-noInit

Create tables only. Do not populate the repository with system data. By default, createdb loads system data into the repository.


 

UNIX Files

$WLI_HOME/bin/createdb
$WLI_HOME/bin/setdbdata
$WLI_HOME/bin/bulkloader
$WLI_HOME/dbscripts/$DB_TYPE/REPOSITORY_SCHEMA_BASE.sql
$WLI_HOME/dbscripts/$DB_TYPE/REPOSITORY_SCHEMA.sql
$WLI_HOME/dbscripts/$DB_TYPE/PERSISTENCE_SCHEMA.sql
$WLI_HOME/dbscripts/$DB_TYPE/BPM_SCHEMA.sql
$SAMPLES_HOME/integration/samples/wlis/dbscripts/$DB_TYPE/WLIS_SCHEMA.sql
$SAMPLES_HOME/integration/samples/e2e/dbscripts/$DB_TYPE/E2E_SCHEMA.sql
$WLI_HOME/adapters/dbms/src/sql/msql/cust.sql
$WLI_HOME/adapters/dbms/src/sql/msql/evnt.sql
$WLI_HOME/adapters/dbms/src/sql/oracle/cust.sql
$WLI_HOME/adapters/dbms/src/sql/oracle/evnt.sql
$WLI_HOME/adapters/dbms/src/sql/pointbase/cust.sql
$WLI_HOME/adapters/dbms/src/sql/pointbase/evnt.sql
$WLI_HOME/adapters/dbms/src/sql/sybase/cust.sql
$WLI_HOME/adapters/dbms/src/sql/sybase/evnt.sql
$WLI_HOME/dbscripts/SystemRepData.xml
$WLI_HOME/setenv.sh

Windows Files

%WLI_HOME%\bin\createDB.cmd
%WLI_HOME%\bin\setdbdata.cmd
%WLI_HOME%\bin\bulkloader.cmd
%WLI_HOME%\dbscripts\%DB_TYPE%\REPOSITORY_SCHEMA_BASE.sql
%WLI_HOME%\dbscripts\%DB_TYPE%\REPOSITORY_SCHEMA.sql
%WLI_HOME%\dbscripts\%DB_TYPE%\PERSISTENCE_SCHEMA.sql
%WLI_HOME%\dbscripts\%DB_TYPE%\BPM_SCHEMA.sql
%SAMPLES_HOME%\integration\samples\wlis\dbscripts\%DB_TYPE%\WLIS_SCHEMA.sql
%SAMPLES_HOME%\integration\samples\e2e\dbscripts\%DB_TYPE%\E2E_SCHEMA.sql
%WLI_HOME%\adapters\dbms\src\sql\msql\cust.sql
%WLI_HOME%\adapters\dbms\src\sql\msql\evnt.sql
%WLI_HOME%\adapters\dbms\src\sql\oracle\cust.sql
%WLI_HOME%\adapters\dbms\src\sql\oracle\evnt.sql
%WLI_HOME%\adapters\dbms\src\sql\pointbase\cust.sql
%WLI_HOME%\adapters\dbms\src\sql\pointbase\evnt.sql
%WLI_HOME%\adapters\dbms\src\sql\sybase\cust.sql
%WLI_HOME%\adapters\dbms\src\sql\sybase\evnt.sql
%WLI_HOME%\dbscripts\SystemRepData.xml\
%WLI_HOME%\setEnv.cmd

Environment

The createdb command references the following environment variables:

CLCP
DB_COMMAND
DB_CREATE
DB_JVMARGS
DB_PORT
DB_SCRIPT_DIR
DB_TYPE
JAVA_HOME
POINTBASE_HOME
SAMPLES_HOME
WLI_DOMAIN
WLI_HOME

If WLI_HOME is not set, this command executes the setenv command.

 


createmssql
createsybase

Name

createmssql—create Microsoft SQL database and execute a script in that database
createsybase—create Sybase database and execute a script in that database

Synopsis

createmssql database_name sql_script
createsybase database_name sql_script

Description

The createmssql and createsybase commands check for the existence of the specified database. If the database exists, the command then runs the specified SQL script. (This action is equivalent to invoking the DB_COMMAND environment variable, which also executes the specified sql_script.) If the database does not exist, it is created, and the specified script is executed in the newly created database.

For example, if a Microsoft SQL database named WLIDB is configured for the current domain, the DB_CREATE environment variable in the %WLI_DOMAIN%\dbInfo\mssql\setDBVars command file is set as follows:

DB_CREATE=call %WLI_HOME%\dbscripts\mssql\createmssql WLIDB

The DB_CREATE environment variable is invoked by the createdb command as follows:

%DB_CREATE%REPOSITORY_SCHEMA_BASE.sql

If the WLIDB database already exists, invoking the DB_CREATE environment variable is equivalent to invoking the DB_COMMAND environment variable. If the WLIDB database does not exist, it is created, and the specified script is executed in that database.

Note: Because the osql client is not available on UNIX, the createmssql command is not available on UNIX. You cannot use the createdb command on a UNIX system to create tables in a Microsoft SQL database.

Options

None.

UNIX Files

$WLI_HOME/dbscripts/sybase/createsybase

Windows Files

%WLI_HOME%\dbscripts\mssql\createmssql.cmd
%WLI_HOME%\dbscripts\sybase\createsybase.cmd

Environment

These commands reference the following environment variables:

SQLARGS
DB_COMMAND

 


domainname

Name

domainname—set or verify the current domain set by the setdomain command

Synopsis

domainname

Description

This machine-generated command stores the current domain setting. This file is generated when the setdomain command is executed. The checkdomain command uses the setting in this file to verify the domain and set WLI_DOMAIN for the calling process.

Options

None.

UNIX Files

$WLI_HOME/bin/domainname

Windows Files

%WLI_HOME%\bin\domainname.cmd

Environment

This command sets the WLI_DOMAIN environment variable.

 


fb

Name

fb—start Format Builder

Synopsis

fb

Description

This command starts the Format Builder client. A shortcut to the fb.cmd command is provided on the Windows Start menu.

Options

None.

UNIX Files

$WLI_HOME/bin/fb
$WLI_HOME/setenv.sh

Windows Files

%WLI_HOME%\bin\fb.cmd
%WLI_HOME%\setEnv.cmd

Environment

The fb command sets but does not export the CP environment variable:

The fb command references the following environment variables:

WLICP
WLI_HOME
JAVA_HOME

If WLI_HOME is not set, this command executes the setenv command.

 


launchSamplesPage

Name

launchSamplesPage—open the samples launcher page in the default Web browser

Synopsis

launchSamplesPage

Description

This command opens http://localhost:7001/index.html. If the administration server for the samples domain is running on the local machine, this command opens a page from which the samples can be run.

Note: On UNIX systems, the browser executable netscape must be included in the system path variable.

Options

None.

UNIX Files

$SAMPLES_HOME/integration/samples/bin/launchSamplesPage

Windows Files

%SAMPLES_HOME%\integration\samples\bin\launchSamplesPage.cmd

Environment

No environment variables are referenced or set.

 


mdbgenerator

Name

mdbgenerator—generate a deployable JAR file to listen on a custom queue

Synopsis

mdbgenerator -queue queue_name [-min number] [-max number] 
[-order number] [-transact] [-validate] [-timeout seconds] [-help]

Description

The message driven bean (MDB) generator utility (the mdbgenerator command) generates a deployable Java Archive (JAR) file that can be used to listen on a custom Java Message Service (JMS) queue.

Options

The following table summarizes the options for the mdbgenerator command.

Table B-6 mdbgenerator Options  

Option

Description

-queue queue_name

Name of the custom queue for which you want to generate the MDB. This option is required.

-min number

Minimum number of unordered listeners.

-max number

Maximum number of unordered listeners.

-order number

Number of ordered listeners. The number must be prime and less than or equal to 31.

-transact

Sets the transaction to required.

-validate

Turns on XML validation.

-timeout seconds

Sets the transaction timeout in seconds. This option defaults to 30 seconds.

This value is only used if the transact flag is not set. If the transact flag is set, the utility uses the WebLogic Server transaction timeout value, which can be set using the Administration Console and defaults to 30.

-help

Displays command usage syntax.


 

UNIX Files

$WLI_HOME/bin/mdbgenerator
$WLI_HOME/setenv.sh

Windows Files

%WLI_HOME%\bin\mdbgenerator
%WLI_HOME%\setEnv.cmd

Environment

This command references the following environment variables:

WLI_HOME
WL_HOME
JAVA_HOME

If WLI_HOME is not set, this command executes the setenv command.

 


migratedb

Name

migratedb—migrate a database from WebLogic Integration 2.1 or WebLogic Integration 2.1 Service Pack 1 (SP1) to WebLogic Integration 7.0

Synopsis

migratedb

Description

The migratedb command creates the scripts required to migrate the database configured for the current domain, and then executes those scripts against the database. The command updates WebLogic Integration 2.1 or WebLogic Integration 2.1 SP1 database tables and schema as required for compatibility with WebLogic Integration 7.0.

For additional information see BEA WebLogic Integration Migration Guide.

Options

None.

UNIX Files

$WLI_HOME/bin/migratedb
$WLI_HOME/bin/checkdomain
$WLI_HOME/bin/setdbdata
$WLI_HOME/bin/bulkloader
$WLI_HOME/setenv.sh
$WLI_HOME%/dbscripts/migrate/SystemRepData.xml

Windows Files

%WLI_HOME%\bin\migratedb.cmd
%WLI_HOME%\bin\checkdomain.cmd
%WLI_HOME%\bin\setdbdata.cmd
%WLI_HOME%\bin\bulkloader.cmd
%WLI_HOME%\setEnv.cmd
%WLI_HOME%\dbscripts\migrate\SystemRepData.xml

Environment

This command references the following environment variables:

DB_DRIVER
DB_NAME
DB_PASSWORD
DB_SERVERNAME
DB_TYPE
DB_URL
DB_USER
JAVA_HOME
WLI_DOMAIN
WLI_HOME
WLICP

If WLI_HOME is not set, this command executes the setenv command.

 


PIMigrator

Name

PIMigrator—migrate a workflow template

Synopsis

PIMigrator InputTemplate.xml OutputTemplate.xml

Description

The PIMigrator command updates a template created for use with Collaborate 1.0 to the format required by WebLogic Integration 2.0/2.1.

Options

None.

UNIX Files

$WLI_HOME/bin/PIMigrator
$WLI_HOME/lib/dtd/PITemplateMigration.xsl

Windows Files

%WLI_HOME%\bin\PIMigrator.cmd
%WLI_HOME%\lib\dtd\PITemplateMigration.xsl

Environment

This command references the following environment variables:

JAVA
WLC_HOME
WLICP

 


RunSamples

Name

RunSamples—configure the samples database and start WebLogic Server in the samples domain

Synopsis

RunSamples [option . . . ]

Description

The RunSamples command performs the following tasks for the samples domain:

When the RunSamples command is executed with the default option, all, or with no options, its behavior depends on whether it is being run for the first time against the database configured for the samples domain. For additional information see Configuring and Starting the Samples Domain.

Options

The following table summarizes the options for the RunSamples command.

Table B-7 RunSamples Options  

Option

Description

all

Perform all steps necessary to run the samples. This option is invoked by default.

BulkLoader

Run the Bulk Loader for the samples

CreateDB

Create the database for the samples

ImportPackages

Import BPM packages into the server

SampleDB

Create sample specific database tables

SetupAppView

Set up the application view for the sample adapter

StartServer

Start the sample server


 

UNIX Files

$SAMPLES_HOME/integration/samples/bin/RunSamples
$WLI_HOME/bin/setdomain
$SAMPLES_HOME/integration/samples/bin/SetSampleData

Windows Files

%SAMPLES_HOME%\integration\samples\bin\RunSamples.cmd
%WLI_HOME%\bin\setdomain.cmd
%SAMPLES_HOME%\integration\samples\bin\SetSampleData.cmd

Environment

This command references the following environment variables:

WLI_HOME
WLICP
WL_HOME
JAVA_HOME
DB_TYPE

If WLI_HOME is not set, this command executes the setenv command.

 


setdbdata

Name

setdbdata—load the database-specific variables into the current process

Synopsis

setdbdata

Description

The setdbdata command loads the database-specific variables into the current process by:

Options

None.

UNIX Files

$WLI_HOME/bin/setdbdata
$WLI_HOME/bin/checkdomain
DOMAIN_HOME/setdbdata
DOMAIN_HOME/checkdomain
DOMAIN_HOME/dbInfo/$DB_TYPE/setDBVars
DOMAIN_HOME/dbInfo/$DB_TYPE/setDBVarsExt
DOMAIN_HOME/dbInfo/setdbtype

Windows Files

%WLI_HOME%\bin\setdbdata.cmd
%WLI_HOME%\bin\checkdomain.cmd
DOMAIN_HOME\setdbdata.cmd
DOMAIN_HOMEn\checkdomain.cmd
DOMAIN_HOME\dbInfo\%DB_TYPE%\setDBVars
DOMAIN_HOME\dbInfo\%DB_TYPE%\setDBVarsExt
DOMAIN_HOME\dbInfo\setdbtype

Environment

In addition to the variables set by setdbtype and setDBVars, the setdbdata command sets the following:

DBINFO
DB_CREATE
DB_DIR
DB_PROPERTIES

Note: DB_CREATE is set to DB_COMMAND if it is not defined by setDBVars.

 


setdbtype

Name

setdbtype—set the database type for the domain

Synopsis

setdbtype

Description

This command is generated based on information provided when you use the Configuration Wizard to create a domain, execute the switchdb command, or use the WebLogic Integration Database Wizard (the wliconfig command) to update the database for a domain.

Options

None.

UNIX Files

DOMAIN_HOME/dbInfo/setdbtype

Windows Files

DOMAIN_HOME\dbInfo\setdbtype.cmd

Environment

This command sets the DB_TYPE environment variable.

 


setDBVars
setDBVarsExt

Name

setDBVars—set the basic database variables for the domain
setDBVarsExt—set the extended database variables for the domain

Synopsis

setDBVars
setDBVarsExt

Description

The setDBVars and setDBVarsExt commands for a domain are updated based on the information provided when you use the Configuration Wizard to create a domain, execute the switchdb command, or use the WebLogic Integration Database Wizard (the wliconfig command) to update the database for a domain.

Options

None.

UNIX Files

$WLI_DOMAIN/dbInfo/$DB_TYPE/setDBVars
$WLI_DOMAIN/dbInfo/$DB_TYPE/setDBVarsExt

Windows Files

%WLI_DOMAIN%\dbInfo\%DB_TYPE%\setDBVars
%WLI_DOMAIN%\dbInfo\%DB_TYPE%\setDBVarsExt

Environment

The setDBVars command sets the following environment variables:

DB_JVMARGS
DB_USER
DB_PASSWORD
DB_CODESET
DB_SERVERNAME
DB_NAME
DB_URL
DB_DRIVER
DB_SCRIPT_DIR
SQLARGS
DB_COMMAND
DB_CREATE
CLCP

The setDBVarsExt command sets the following environment variables:

DB_CATALOG
DB_SCHEMA
DB_PINGTABLE

Note: Some variables are specific to database type. For example, CLCP is set for PointBase only.

 


setdomain

Name

setdomain—set the current domain

Synopsis

setdomain domain_path

Here, domain_path is the path to the domain relative to the current directory. For example, if are on a UNIX system, and execute the command from the $BEA_HOME directory to set the current domain to $BEA_HOME/user_projects/mydomain, enter the following:

setdomain user_projects/mydomain

If you execute the command from the domain directory (for example, from the $BEA_HOME/user_projects/mydomain directory), you need not specify domain_path.

Note: You can execute the setdomain command from any directory if you first execute the setenv command.

Description

The setdomain command verifies that the specified directory is a valid domain. If the domain is valid, the command sets the WLI_DOMAIN environment variable to the specified domain and creates the domainname command to store the setting. The current domain must be set for the checkdomain, setdbdata, RunSamples, and switchdb commands.

Options

None.

UNIX Files

$WLI_HOME/bin/setdomain
$WLI_HOME/setenv.sh
$WLI_HOME/bin/domainname

Windows Files

%WLI_HOME%\bin\setdomain.cmd
%WLI_HOME%\setEnv.cmd
%WLI_HOME%\bin\domainname.cmd

Environment

The setdomain command sets the WLI_DOMAIN environment variable and references the WLI_HOME environment variable.

If WLI_HOME is not set, this command executes the setenv command.

 


setenv

Name

setenv—set common WebLogic Integration environment variables

Synopsis

setenv

Description

The setenv command sets the basic WebLogic Integration environment settings.

Options

None.

UNIX Files

$WLI_HOME/setenv.sh
$WLI_HOME/bin/setenv

Windows Files

%WLI_HOME%\setEnv.cmd
%WLI_HOME%\bin\setenv.cmd
%WLI_HOME%\samples\bpm_api\commandline\setEnv.cmd
%WLI_HOME%\samples\bpm_api\plugin\setEnv.cmd

Environment

The setenv command sets the following environment variables:

BEA_HOME
JAVA_HOME
SAMPLES_HOME
WL_HOME
WLI_HOME
WLICOMMONCP
WLICP
WLISERVERCP

The command also adds %JAVA_HOME%\bin to the existing PATH environment variable.

 


SetDomainTypeData
SetSampleData

Name

SetDomainTypeData—set environment variables for the DomainType domain
SetSampleData—set environment variables for the samples domain

Synopsis

SetDomainTypeData
SetSampleData

Description

The SetDomainTypeData command sets environment variables for a custom domain created with the Configuration Wizard.

Here the value of DomainType is determined by which Configuration Wizard template is used to create the custom domain. For example, if you used the WebLogic Integration template, the command is SetWliDomainData.

The SetSampleData command sets environment variables for the WebLogic Integration samples domain.

Options

None.

UNIX Files

DOMAIN_HOME/SetDomainTypeData
$SAMPLES_HOME/integration/samples/bin/SetSampleData
$WLI_HOME/setenv.sh
$WLI_HOME/bin/setdbdata

Windows Files

DOMAIN_HOME\SetDomainTypeData
%SAMPLES_HOME%\integration\samples\bin\SetSampleData.cmd
%WLI_HOME%\setEnv.cmd
%WLI_HOME%\setdbdata.cmd

Environment

Two commands, SetDomainTypeData and SetSampleData set the following environment variables for the custom domain and the WebLogic Integration sample domain, respectively.

WLI_SAMPLES_HOME (SetSampleData)
WLI_DOMAIN_HOME (SetDomainTypeData)
WLIS_HOST_AND_PORT
WLIS_USER_NAME
WLIS_PASSWORD
JDBC_DATASOURCE_JNDI_NAME
EVENTROUTER_URL
CMNCP
CP
SVRCP

The SetDomainTypeData command references the following environment variables:

WLICP
WLISERVERCP
WLI_HOME
CMNCP
SVRCP
WLI_DOMAIN_HOME
WLIS_HOST_AND_PORT

 


setupAppView
setupEDIAppView

Name

setupAppView—set up the application view for the sample adapter
setupEDIAppView—set up the application view for the EDI adapter

Synopsis

setupAppView
setupEDIAppView

Description

The setupAppView command sets up the application view for sample adapter (WLISAppView). The setupEDIAppView command sets up the application view for the EDI adapter (EDIAppView).

Both commands execute the SetSampleData command before issuing the java command that sets up the application view.

Options

None.

UNIX Files

$SAMPLES_HOME/integration/samples/bin/setupAppView
$SAMPLES_HOME/integration/samples/bin/setupEDIAppView
$SAMPLES_HOME/integration/samples/bin/SetSampleData
$WLI_HOME/setenv.sh

Windows Files

%SAMPLES_HOME%\integration\samples\bin\setupAppView.cmd
%SAMPLES_HOME%\integration\samples\bin\setupEDIAppView.cmd
%SAMPLES_HOME%\integration\samples\bin\SetSampleData.cmd
%WLI_HOME%\setEnv.cmd

Environment

The setupAppView and the setupEDIAppView commands reference the following environment variables:

CP
DB_JVMARGS
JAVA_HOME
WLI_HOME
WLIS_HOST_AND_PORT
WLIS_PASSWORD
WLIS_USER_NAME

In addition, the setupAppView command references the following environment variables:

DB_PINGTABLE
DB_CATALOG
DB_SCHEMA
EVENTROUTER_URL
JDBC_DATASOURCE_JNDI_NAME

 


showdomain

Name

showdomain—display the current domain

Synopsis

showdomain

Description

This command verifies that the current domain is valid, and it displays the current domain setting.

Options

None.

UNIX Files

$WLI_HOME/bin/showdomain
$WLI_HOME/bin/checkdomain
$WLI_HOME/setenv.sh

Windows Files

%WLI_HOME%\bin\showdomain.cmd
%WLI_HOME%\bin\checkdomain.cmd
%WLI_HOME%\setEnv.cmd

Environment

The showdomain command references the WLI_HOME environment variable.

If WLI_HOME is not set, this command executes the setenv command.

 


startAiconsole
startB2bconsole

Name

startAiconsole—start the Application View Console
startB2bconsole—start the B2B Console

Synopsis

startAiconsole
startB2bconsole

Description

The startAiconsole command launches your default browser and opens the URL for the Application View Console (http://localhost:7001/wlai). This command can only be used to access the Application View Console if the administration server for the domain is running on the local host.

The startB2bconsole command launches your default browser and opens the URL for the B2B Console (http://localhost:7001/b2bconsole). This command can only be used to access the B2B Console if the administration server for the domain is running on the local host.

Shortcuts to these commands are provided on the Windows Start menu.

Note: On UNIX systems, the browser executable netscape must be included in the system path variable.

Options

None.

UNIX Files

These command are not available on UNIX systems.

Windows Files

%WLI_HOME%\bin\startAiconsole.cmd
%WLI_HOME%\bin\startB2bconsole.cmd

Environment

This command references the $WLI_HOME environment variable.

 


startpointbasecommander

Name

startpointbasecommander—start the PointBase administrative tool

Synopsis

startpointbasecommander

Description

The startpointbasecommander command verifies the current database setting, and if the setting is PointBase, it launches PointBase commander, the PointBase administrative tool.

Options

None.

UNIX Files

$WLI_HOME/bin/startpointbasecommander
$WLI_HOME/bin/setdbdata

Windows Files

%WLI_HOME%\bin\startpointbasecommander.cmd
%WLI_HOME%\bin\setdbdata.cmd

Environment

This command references the following environment variables:

CLCP
DB_JVMARGS
DB_PORT
DB_TYPE
JAVA_HOME
POINTBASE_HOME

If WLI_HOME is not set, this command executes the setenv command.

 


startWeblogic

Name

startWeblogic—start WebLogic Server and deploy WebLogic Integration resources

Synopsis

startWeblogic

Description

The startWeblogic command:

Options

None.

UNIX Files

DOMAIN_HOME/startWeblogic
DOMAIN_HOME/SetDomainTypeData
DOMAIN_HOME/dbinfo/setdbdata
$SAMPLES_HOME/integration/samples/bin/SetSampleData
$WLI_HOME/setenv.sh

Windows Files

DOMAIN_HOME\startWeblogic.cmd
DOMAIN_HOME\SetDomainTypeData.cmd
DOMAIN_HOME\dbInfo\setdbdata.cmd
%SAMPLES_HOME%\integration\samples\bin\SetSampleData.cmd
%WLI_HOME%\setEnv.cmd

Environment

The startWeblogic command references the following environment variables:

CLCP
DB_JVMARGS
DB_PORT
DB_TYPE
JAVA_HOME
SVRCP
WL_HOME
WLI_DOMAIN_HOME
WLI_HOME

 


stopWeblogic

Name

stopWeblogic—shut down WebLogic Server

Synopsis

stopWeblogic

Description

The stopWeblogic command executes the setenv command, and then issues a shutdown request to the WebLogic Server running in the domain.

Options

None.

UNIX Files

DOMAIN_HOME/stopWeblogic
$WLI_HOME/setenv.sh

Windows Files

DOMAIN_HOME\stopWeblogic.cmd
%WLI_HOME%\setEnv.cmd

Environment

The stopWeblogic command references the following environment variables:

BEA_HOME
DB_JVMARGS
JAVA_HOME
WL_HOME
WLI_HOME
WLISERVERCP

 


studio

Name

studio—start the WebLogic Integration Studio

Synopsis

studio

Description

The studio command starts the WebLogic Integration Studio client.

Options

None.

UNIX Files

$WLI_HOME/bin/studio
$WLI_HOME/setenv.sh

Windows Files

%WLI_HOME%\bin\studio.cmd
%WLI_HOME%\setEnv.cmd

Environment

The studio command sets CP=$WLI_HOME/lib/wlpi-studio.jar:$WLICP (UNIX) or CP=%WLI_HOME%\lib\wlpi-studio.jar:%WLICP% (Windows), and references the following environment variables:

CP
JAVA_HOME
WLI_HOME
WLICP

If WLI_HOME is not set, this command executes the setenv command.

 


switchdb

Name

switchdb—update the database configured for the current domain

Synopsis

switchdb mssql|oracle|pointbase|sybase

Description

The switchdb command updates the database configuration for the current domain by:

The switchdb command does not update the setDBVars file. If the database configuration reflected in the setDBVars file requires modification, use the WebLogic Integration Database Wizard (the wliconfig command) to update the configuration.

Options

None.

UNIX Files

$WLI_HOME/bin/switchdb
$WLI_HOME/bin/checkdomain
$WLI_HOME/setenv.sh
$WLI_DOMAIN/dbInfo/setdbtype
$WLI_DOMAIN/dbInfo/$DB_TYPE/setDBVars
$WLI_DOMAIN/scripts/SwitchDB.xml
$WLI_HOME/lib/scripts/SwitchDB.xml

Windows Files

%WLI_HOME%\bin\switchdb.cmd
%WLI_HOME%\bin\checkdomain.cmd
%WLI_HOME%\setEnv.cmd
%WLI_DOMAIN%\dbInfo\setdbtype.cmd
%WLI_DOMAIN%\dbInfo\%DB_TYPE%\setDBVars.cmd
%WLI_DOMAIN%\scripts\SwitchDB.xml
%WLI_HOME%\lib\scripts\SwitchDB.xml

Environment

The switchdb command sets the DBINFO and DB_TYPE environment variables, and references the WLI_DOMAIN and JAVA_HOME environment variables.

If WLI_HOME is not set, this command executes the setenv command.

 


worklist

Name

worklist—start the WebLogic Integration Worklist

Synopsis

worklist

Description

The worklist command starts the WebLogic Integration Worklist client.

Options

None.

UNIX Files

$WLI_HOME/bin/worklist
$WLI_HOME/setenv.sh

Windows Files

%WLI_HOME%\bin\worklist.cmd
%WLI_HOME%\setEnv.cmd

Environment

The worklist command sets CP=$WLI_HOME/lib/wlpi-worklist.jar:$WLICP (UNIX) or CP=%WLI_HOME%\lib\wlpi-worklist.jar:%WLICP% (Windows), and references the following environment variables:

CP
JAVA_HOME
WLI_HOME
WLICP

If WLI_HOME is not set, this command executes the setenv command.

 


wliconfig

Name

wliconfig—launch the WebLogic Integration Database Wizard

Synopsis

wliconfig 

Description

This command launches the WebLogic Integration Database Wizard. For additional information, see Using the Database Wizard.

Options

No options are currently supported. The wizard prompts for the required information.

UNIX Files

DOMAIN_HOME/wliconfig
$WLI_HOME/setenv.sh

Windows Files

DOMAIN_HOME\wliconfig.cmd
%WLI_HOME%\setEnv.cmd

Environment

The wliconfig command references the following environment variables:

$JAVA_HOME
$WLI_HOME

If WLI_HOME is not set, this command executes the setenv command.

 

Back to Top Previous Next