IBM BPM, V8.0.1, All platforms > Reference > Commands and scripts > Business Process Choreographer administrative scripts

manageQueryTable.py administrative script

Use the manageQueryTable.py administrative script to deploy, undeploy, and update query tables in Business Process Choreographer. This script can also list query tables and to list the XML definition of a query table.

Prerequisites

The following conditions must be met:

• Run the script in the connected mode, that is, the application server must be running.

• Run the script on the dmgr node in a ND environment.

• If WebSphere administrative security is enabled, and your user ID does not have administrator or deployer authority, include the wsadmin -user and -password options to specify a user ID that has administrator or deployer authority.

Location

The manageQueryTable.py administrative script is in the Business Process Choreographer admin directory.

Syntax

 -f manageQueryTable.py
     [ ([-node  nodeName] -server  serverName) | (-cluster  clusterName) ]
     ( ( -deploy ( qtdFile |  jarFile)) |
     (-undeploy  queryTableName)  |
     (-update definition ( qtdFile |  jarFile)) |
     (-query names -kind (composite | predefined | supplemental)) |
     (-query definition -name  queryTableName))

Parameters

-node nodeName

The name of the node where Business Process Choreographer is configured. This is optional when specifying the server name. The default is the local node.

-server serverName

The name of the server where Business Process Choreographer is configured. This is required if a cluster is not specified.

-cluster clusterName

The name of the cluster where Business Process Choreographer is configured. This is required if Business Process Choreographer is configured on a cluster.

-deploy qtdFile | jarFile

The file name, including the fully qualified path, of either the query table definition XML file to be deployed or a JAR file that contains the definitions. Use this option to deploy a query table. On Windows, use either "/" or "\\\\" as the path separator.

For example, to specify the file c:\temp\myQueryTable.qtd you must specify it as c:/temp/myQueryTable.qtd or c:\\\\temp\\\\myQueryTable.qtd.

-undeploy queryTableName

The name of the query table. Use this option to undeploy a query table.

-update definition qtdFile | jarFile

The file name, including the fully qualified path, of either the query table definition XML file to be updated or a JAR file that contains the definitions. Use this option to update an existing query table. On Windows, use either "/" or "\\\\" as the path separator.

For example, to specify the file c:\temp\myQueryTable.qtd you must specify it as c:/temp/myQueryTable.qtd or c:\\\\temp\\\\myQueryTable.qtd.

If a JAR file is provided, it can contain multiple QTD files and property files for each QTD file, which contain display names and descriptions. Use the Query Table Builder to export query table definitions as a JAR file.

-query names –kind composite | predefined | supplemental

The type of query table: composite, predefined, or supplemental. Use this option to list the names of deployed query tables of a particular type.

-query definition –name queryTableName

The name of the query table, in upper case. Use this option to list the XML definition of a deployed supplemental or composite query table.

Examples

Deploy composite and supplemental query tables.

wsadmin.sh –f manageQueryTable.py –server server1 –deploy sample.qtd

wsadmin.sh –f manageQueryTable.py –server server1 –deploy sample.qtd

wsadmin –f manageQueryTable.py –server server1 –deploy sample.qtd

Undeploy composite and supplemental query tables.

wsadmin.sh –f manageQueryTable.py –server server1 –undeploy COMPANY.SAMPLE

wsadmin.sh –f manageQueryTable.py –server server1 –undeploy COMPANY.SAMPLE

wsadmin –f manageQueryTable.py –server server1 –undeploy COMPANY.SAMPLE

Update composite and supplemental query tables.

wsadmin.sh –f manageQueryTable.py –server server1 
           –update definition sample_v2.qtd

wsadmin.sh –f manageQueryTable.py –server server1 
           –update definition sample_v2.qtd

wsadmin –f manageQueryTable.py –server server1 
        –update definition sample_v2.qtd

Retrieve a list of query tables.

wsadmin.sh –f manageQueryTable.py –server server1 
           –query names –kind composite

wsadmin.sh –f manageQueryTable.py –server server1 
           –query names –kind composite

wsadmin –f manageQueryTable.py –server server1 
        –query names –kind composite

Retrieve the XML definitions of query tables.

wsadmin.sh –f manageQueryTable.py –server server1 
           –query definition –name COMPANY.SAMPLE

wsadmin.sh –f manageQueryTable.py –server server1 
           –query definition –name COMPANY.SAMPLE

wsadmin –f manageQueryTable.py –server server1 
        –query definition –name COMPANY.SAMPLE

Business Process Choreographer administrative scripts

Related tasks:
Update composite and supplemental query tables
Deploying composite and supplemental query tables
Undeploying composite and supplemental query tables
Retrieving a list of query tables
Retrieving the XML definitions of query tables