Skip navigation FileNet logo
Glossary  |  Help Directory  
  Help for vwtool
  Search
Process Reference  
vwtool
Getting Started
Commands
  !<shell_cmd>
  =
  assertbehavior
  attachtran
  config
  convert
  count
  createDBviews
  dbconfig
  deletewob
  dispatchwob
  dump
  echo
  emptyqueue
  environment
  hardcopy
  help
  listdbconfig
  listobjects
  listobjects
  loadstatus
  lockwob
  logconfig
  logquery
  memory
  pagebreak
  queueconfig
  readcdl
  recover
  region
  regions
  resetloadstatus
  rosterconfig
  schemastatus
  statistics
  stepprocessors
  storedquery
  terminatewob
  trace
  unlockwob
  version
  views
  wobquery
  workstation
  writetrace

 

   

dbconfig

This command configures an external database so that you can execute a stored procedure in a specified database. You execute a stored procedure using using the DBExecute system function in Process Designer.

TIP You can view the configured connections using the listdbconfig command.

Overview

  1. Define a stored procedure in a database.
  2. Use the dbconfig command to define a connection to the database that holds the stored procedure. Note that you must define a connection from each Process Engine in a multi-server configuration.
  3. In Process Designer, when defining a DBExecute function as part of a system step, reference the connection defined in vwtool, specify the name of the stored procedure you want to call, and specify the parameters and their types to be passed to the stored procedure.

NOTE If the Process Engine is deployed on a Windows-based server, you can define the stored procedure in either a SQL Server database or an Oracle database. If the Process Engine is running on a Unix-based system, you must define the stored procedure in an Oracle database. A Unix-based Process Engine cannot call a stored procedure in a SQL Server database.

TIP The stored procedure can be located in a database other that the workflow database.

Syntax

The syntax varies depending on the type of database.

Database Syntax

SQL Server

dbconfig <alias> <dbtype> <groupname> <dbname> <authentication> [<dbuser> <dbpassword]

Oracle

dbconfig <alias> <dbtype> <dbname> <dbuser> <dbpassword>

Parameters

alias A name, unique within the VWService, to identify the Process Engine Database Connection. This is the database name to be entered in the DBExecute function in Process Designer.
dbtype Enter O for Oracle or S for SQL Server.
groupname (SQL Server only) The SQL Server Group name.

dbname

For SQL Server, the database name; for Oracle, the Global Database Name.

authentication

(SQL Server only) Enter Y to use Windows authentication, or N to specify a dbuser and dbpassword.

When using Windows Authentication, the connection to the remote database is performed using the Windows logon credentials of the user logged onto the Process Engine.

If you don't use Windows Authentication, you must enter a user name and password to be used to log onto the SQL Server. This information is sent across the network in clear text from the Process Engine to the server hosting the remote SQL Server database.

dbuser

The user that the Process Engine will use to log on to the specified database.

dbpassword The password associated with the dbuser.
   

TIP In vwtool, you can enter parameters on the command line (following the command name) or let vwtool prompt you for the information by entering just the command name. Generally, we recommend prompt mode for all but the simplest commands. Entering the parameters on the command line is intended primarily for script-driven input.

NOTE If necessary, change to the desired isolated region prior to executing this command.