TDM Portal Tools container

To use TDM Portal in Docker, it is necessary to create a user for the gtrep repository, which the TDM Portal container creates on your Oracle database. The TDM Portal Tools container includes utilities to make this process and others easier.
tdm47
To use TDM Portal in Docker, it is necessary to create a user for the gtrep repository, which the TDM Portal container creates on your Oracle database. The TDM Portal Tools container includes utilities to make this process and others easier.
This container requires the use of the
docker run
command. The Docker network on which you wish to make changes must be active when you run this container.
Using the Tools container
You can run the Tools container in the following two modes:
  • Interactive mode
    To run the tool in Interactive mode, supply no environment variables to the
    docker run
    command. When you run this container in 
    Interactive
     mode, the
    Action selection
    menu displays, from which you can run the
    encryption utility
    (in 'encrypt password' and 'generate JWT shared secret' modes), the
    user creation tool
    and the
    sample database creation tool
    . The tool prompts you to input values for each parameter.
    Syntax:
    docker run --rm
    -it
     --name=
    TDMWeb_Tools
     --hostname=
    TDMWeb_Tools
     --network=
    tdm_default 
    tdm/tdmtools:
    <version> [--encryption-util -p]
    To go directly to the Tool you need, add
    --<tool-name>
    to the end of the command.
  • Batch mode
    To run the tool in Batch mode, pass all the values you want to define, to the container as command line parameters.
    To run each tool in Batch mode, you must supply all necessary environment variables to the
    docker run
    command. You can omit optional variables, in which case its value is that variable's default value.
Features
The TDM Portal Tools container includes the following features:
  • This utility functions the same as the Encryption Utility in a normal Windows installation. For more information, see Use the Encryption Utility to Encrypt Passwords.
    The Password encryption utility is not available in
    Batch
    mode.
  • If you have Administrator access to the Oracle database where your gtrep repository is installed, you can use this tool to create gtrep users on this database.
  • With this tool, you can create tables from the sample databases supplied with TDM.
Password encryption utility
The Password encryption utility is only available in
Interactive
mode.
Run the encryption utility in 'encrypt password' mode
docker run --rm -it --name=
TDMWeb_Tools
--
hostname=
TDMWeb_Tools
--network=tdm_default tdm/tdmtools:
<version>
--encryption-util -p
This tool prompts you to enter a password, and returns the encrypted value.
Run the encryption utility in 'generate JWT shared secret' mode
docker run --rm -it --name=
TDMWeb_Tools
--hostname=
TDMWeb_Tools
--network=
tdm_default 
tdm/tdmtools:
<version>
--encryption-util -s
When you run this tool, it generates a JWT shared secret. For more information, see TDM Portal Password Management.
Gtrep user and schema creation tool
Create a user and schema for your
gtrep
repository. Before you run this tool, the gtrep repository is an empty database.
Run the user and schema creation tool in Interactive mode
Syntax:
docker run --rm -it
--name=
TDMWeb_Tools
--hostname=
TDMWeb
--network=tdm_default 
tdm/tdmtools:
<version>
--create-db-user
This command prompts you to enter each parameter necessary to create a database user.
Run the user and schema creation tool in Batch mode
Syntax:
docker run --rm --name=
TDMWeb_Tools
--hostname=
TDMWeb
--network=
tdm_default 
\
-e SYS_DB_USER="
system
" \
-e SYS_DB_PASSWORD="
system_password
" \
-e DB_HOST="
ora11g
" \
-e DB_SERVICE_NAME="
orcl
" \
-e DB_USER="
gtrep
" \
-e DB_PASSWORD="
gtrep_password
" \
tdm/tdmtools:
<version>
--create-db-user
Where:
  • SYS_DB_USER
    Existing user with administrator access to your Oracle database
  • SYS_DB_PASSWORD
    Password for this existing user.
  • DB_HOST
    Hostname of database server.
  • DB_SERVICE_NAME
    Oracle service name.
  • DB_USER
    The username you want to create for the new gtrep user.
  • DB_PASSWORD
    The password you want to create for the new gtrep user.
    This password must be
    unencrypted
    .
Sample database creation tool
Create a database on your Oracle database, from the sample databases included with CA TDM.
Run the Sample database creation tool in Interactive mode
Syntax:
docker run --rm -it --name=
TDMWeb_Tools
--hostname=
TDMWeb
--network=
tdm_default 
tdm/tdmtools:
<version>
--create-sample-db
This command prompts you to enter each parameter necessary to create a database from the sample databases provided with CA TDM.
Run the Sample database creation tool in Batch mode
Syntax:
docker run --rm --name=
TDMWeb_Tools
--hostname=
TDMWeb
--network=
tdm_default 
\
-e SYS_DB_USER="
system
" \
-e SYS_DB_PASSWORD="
system_password
" \
-e DB_HOST="
ora11g
" \
-e DB_SERVICE_NAME="
orcl
" \
-e DB_NAME="
orders
" \
-e DB_PASSWORD="
gtrep_password
" \
-e DB_PORT="
1521
"
tdm/tdmtools:
<version>
--create-sample-db
Where:
  • SYS_DB_USER
    Existing user with administrator access to your Oracle database
  • SYS_DB_PASSWORD
    Password for this existing user.
  • DB_HOST
    Hostname of database server.
  • DB_SERVICE_NAME
    Oracle service name.
  • DB_NAME
    Name of the sample database to create. This is also the name of a new user for this database.
    The available sample databases are:
    creditcard, creditcard_e, orders, orders_e, scramble, travel, travel_e
    .
  • DB_PASSWORD
    Password to associate with the
    DB_NAME
    user.
  • (Optional)
    DB_PORT
    Oracle database port. Default value is
    1521.