Description
Use the tacmd configurePortalServer command
to configure a user-defined portal server data source. If the data
source already exists, use this command to change the configuration.
If the data source does not exist, it is created by this command.
You can also use this command to remove a data source. This command
can only be run from a Tivoli Enterprise Portal Server
installation.
When the tacmd configurePortalServer command
is run on a system that does not have a Tivoli Enterprise Portal Server
installed, a cq.ini file is created. When a Tivoli Enterprise Portal
Server is not installed, this command fails with an error message
indicating that this command should only be run on a Tivoli Enterprise
Portal Server or that a Tivoli Enterprise Portal Server configuration
file was not found. Determine whether this system has a Tivoli Enterprise
Portal Server installed and ensure that the path is specified correctly
with the -d <CANDLEHOME> option or CANDLEHOME variable correctly
exported in the CLI's environment before running this command.
Note: - System defined data sources cannot be edited with this command.
Only user-defined data sources can be edited with this command. Names
for these data sources are in the format "DSUSER1", "DSUSER2"...etc.
- You must recycle the portal server to get a newly created connection
to show up as a data source.
CLI syntax
tacmd configurePortalServer
{-s|--datasource} DATASOURCE
{-p|--property|--properties} NAME=VALUE ...
[{-d|--directory} CANDLEHOME] [ {-f|--force } ]
tacmd configurePortalServer
{-s|--datasource} DATASOURCE
{-r|--remove} [{-d|--directory} CANDLEHOME] [ {-f|--force } ]
tacmd configurePortalServer {-s|--datasource} DATASOURCE
{-v|--view} [{-d|--directory} CANDLEHOME]
where:
- -s|--datasource
- Specifies the name of a new or existing data source. If the data
source already exists and the remove option is not given, then an
edit operation occurs. If the data source does not already exist,
and the remove option is not specified, then an add operation occurs.
- -r|--remove
- Removes the named data source.
- -v|--view
- Display the properties of a datasource and their values. Password
properties have their values displayed in an encrypted form.
- -p|--property|--properties
- A list of property names and values required to configure the
data source. The list can be different for each data source type but
usually includes at least user ID (key name UID) and password
(key name PWD). Each property is stored as a key=value pair.
Property values are encrypted before being stored to the configuration
file or the Windows Registry.
The combined properties create your datasource connection string.
The following is a list of typical properties:
- CONNECTION_TYPE=
- Required if other than ODBC. Valid values are JDBC or DB2.
- CONNECTION_LIMIT=
- Optional. Controls the limit on how many simultaneous connections
for ODBC or DB2 can be opened by the portal server. This property
does not affect JDBC.
- KFWDSURL=
- If you are using JDBC, this is required.
- KFWJDBCDRIVER=
- If you are using JDBC, this is required.
Note: Your datasource connection string might require
other properties not documented here.
The following is an example
of datasource connection string for Oracle: DSUSER2 =DSN=myJDBC;UID=scott;PWD=tiger;CONNECTION_TYPE=JDBC;
KFWJDBCDRIVER=/somewhere/ojdbc14.jar;
KFWDSURL=jdbc:oracle:thin:@myhost:1521:orcl
- -d|--directory
- The server's home directory.
- -f|--force
- Performs actions without asking confirmation.
CLI example
The following example modifies
the
DSUSER1 data source with user ID
db2user and password
db2password.
The DSUSER1 data source is created if it does not already exist.
tacmd configurePortalServer -s DSUSER1 -p UID=db2user PWD=db2password
The
following example shows the configuration settings for the DSUSER1
data source:
tacmd configurePortalServer -s DSUSER1 -v
The
following output is displayed:
DSN=DSUSER1
UID=db2user
PWD={AES256:keyfile:a}HW0LxUxCJ5tj9biXUWhCIQ==
CONNECTION_LIMIT=32
Return values
See
Table 1.
Note: To
verify that the data source was correctly configured, log on to the
portal server, click Query in the main toolbar to open the
Query editor, and then click New Query to open the Create Query
window. The name of the ODBC data source you configured is displayed
in the Data Sources list.
Related commands
Return to Table 1.