Set up an entry mapping repository, a property extension repository, or a custom registry database repository using wsadmin commands

We can set up an entry mapping repository, a property extension repository, or a custom registry database repository using wsadmin commands.

If we are setting up an entry mapping repository, begin with the steps described in Configure an entry mapping repository in a federated repository configuration.

If we are setting up a property extension repository, begin with the steps described in Configure a property extension repository in a federated repository configuration.

When we create a repository, use the appropriate wsadmin commands to define the database schema and to populate the database property definitions.

Tasks

1. Create the database. Use any relational database product. The following examples give you tips for specific vendors.

   1. For DB2 , open a DB2 command window or command center and enter the following:

      db2 create database <name> using codeset UTF-8 territory US
      

      Enter the following database tuning commands:

      db2 update database configuration for <name> using applheapsz 1024
      db2 update database configuration for <name> using stmtheap 4096 
      db2 update database configuration for <name> using app_ctl_heap_sz 2048
      db2 update database configuration for <name> using locklist 1024
      db2 update database configuration for <name> using indexrec RESTART 
      db2 update database configuration for <name> using logfilsiz 1000 
      db2 update database configuration for <name> using logprimary 12 
      db2 update database configuration for <name> using logsecond 10 
      db2 update db cfg for <name> using sheapthres_shr MANUAL
      db2 update database configuration for <name> using sortheap 2048
      

   2. Optional: For Informix databases using dbaccess, enter:

      CREATE DATABASE <name> WITH BUFFERED LOG
      

   3. Optional: For Oracle databases, the database should already exist during Oracle installation (for example, orcl).

2. Run the setupIdMgrEntryMappingRepositoryTables command, the setupIdMgrPropertyExtensionRepositoryTables command, or the setupIdMgrDBTables command (for custom registry repositories) by doing the following:

   1. Start WebSphere Application Server.

   2. Open a command window and go to the <WAS>/Profiles/<PROFILE_NAME>bin directory.

   3. Start wsadmin.

   4. Type the necessary commands as described in the next section.

What to do next

Use these commands, we can:

• Specify the arguments on the command line.

• Specify the arguments in a file.

The -file option enables us to specify a file in which some or all of the parameters are specified. To use the -file argument on the command line, enter the full path to the file. Parameters in the file must be specified in key=value pairs and each must be on its own line. If a parameter is specified on both the command line and in the file, the value on the command line takes precedence.

Tips for diagnosing argument errors:

• If an argument is not properly specified on the command line or in the file, a message is returned which states that the argument was not properly specified. This might mean that the argument was not specified at all or was required for a given configuration but was not specified.

• If the argument was not specified at all, check that the parameter is specified on the command line or in the file, and that it is properly spelled and has matching case.

• If the argument was required for a given configuration but was not specified, it is possible that a value is not required solely by the command but is required for the type of database and configuration we are setting.

  For example, if we set the dn, wasAdminId, or wasAdminPassword parameters, we must also specify the dbDriver parameter.

  Additionally, if the dn, wasAdminId or wasAdminPassword parameters are specified, and the databaseType is not a Apache Derby v10.2 database, then the dbAdminId and dbAdminPassword parameters must also be specified.

(ZOS) Important: To use Apache Derby v10.2 for our repository, run the Apache Derby Network Server framework. This framework supports multiple concurrent JVM connections with the database, whereas the embedded framework works with only a single JVM, which cannot fulfill most workload-balancing requirements. Running the Network Server framework for Apache Derby v10.2 requires the Derby Client driver files and classes.

The setupIdMgrDBTables command:

The setupIdMgrDBTables command creates, and populates the tables in the database that we previously created. Arguments are case-sensitive, both through the command line and the file.

Parameters:

schemaLocation (String, Required)

The location of the <WAS>/etc/wim/setup directory.

dbPropXML (String)

The location of database repository property definition XML file.

databaseType (String, Required)

The type of database. Supported databases are db2, oracle, informix, derby, sqlserver, db2zos, and db2iseries.

dbURL (String, Required)

The database URL for direct access mode. For example: jdbc:db2:wim.

dbDriver (String)

The name of the database driver. For example: com.ibm.db2.jcc.DB2Driver.

dbAdminId (String)

The database administrator ID for direct access mode. For example: db2admin.

For a Apache Derby v10.2 embedded database, dbAdminId is not required.

dbAdminPassword (String)

The password associated with the dbAdminId.

For a Apache Derby v10.2 embedded database, dbAdminPassword is not required.

dn (String)

The default organization uniqueName to replace. For example: o=yourco. If it is not set, o=Default Organization is used.

wasAdminId (String)

The WebSphere Application Server admin user ID. The ID should be a short name, not a uniqueName. For example: wasadmin. After creation, the uniqueName is uid=wasadmin, <defaultOrg>.

wasAdminPassword (String)

The WebSphere Application Server admin user password. If wasAdminId is set, then this parameter is mandatory.

saltLength (Integer)

The salt length of the randomly generated salt for password hashing.

encryptionKey (String)

The password encryption key. Set the password encryption key to match the encryption key in the wimconfig.xml file for the repository. If the encryption key is not set, the default is used.

derbySystemHome (String)

The home location of the Apache Derby v10.2 system if we are setting up a Apache Derby v10.2 database.

reportSqlError (String)

Report SQL errors while setting up databases.

file (String)

The full path to a file containing the input parameters. Each input parameter must match a corresponding parameter as it would be typed on the command line, and it must be placed in a key=value pair. Each pair must be on a separate line.

(ZOS) tablesBufferPool (String)

(ZOS) The buffer pool variable of default tables in DB2 for z/OS. The default is BP0.

(ZOS) LOBtablesBufferPool (String)

(ZOS) The buffer pool variable of auxiliary LOB tables in DB2 for z/OS. The default is BP0.

(ZOS) indextablesBufferPool (String)

(ZOS) The buffer pool variable of unique index tables in DB2 for z/OS. The default is BP0.

dbSchema (String)

The database schema where we want to create the federated repository tables. The schema should exist in the database. The default is the default schema of the database according to the database type. Typically, the default schema is the namespace of the current database user.

(ZOS) dbSchema (String)

(ZOS) The database schema where we want to create the federated repository tables. The default is the default schema of the database according to the database type. Typically, the default schema is the namespace of the current database user.

(ZOS) tablespacePrefix (String)

(ZOS) The tablespace prefix. The maximum length allowed for this string is 3 characters. The value of tablespacePrefix parameter is required when using the dbSchema parameter. It is specific to DB2 for z/OS and will be ignored for any other database type.

If we specify the wasAdminId/wasAdminPassword parameters, a new user is created in the repository. Ensure that the value specified does not duplicate an existing user in another repository.

The deleteIdMgrDBTables command:

The deleteIdMgrDBTables command deletes the tables in the database.

Parameters:

schemaLocation (String, Required)

The location of the <WAS>/etc/wim/setup directory.

databaseType (String, Required)

The type of database. Supported databases are db2, oracle, informix, derby, sqlserver, db2zos, and db2iseries.

dbURL (String, Required)

The database URL for direct access mode. For example: jdbc:db2:wim.

dbDriver (String)

The name of the database driver. For example: com.ibm.db2.jcc.DB2Driver.

dbAdminId (String)

The database administrator ID for direct access mode. For example: db2admin.

For a Apache Derby v10.2 embedded database, dbAdminId is not required.

dbAdminPassword (String)

The password associated with the dbAdminId.

For a Apache Derby v10.2 embedded database, dbAdminPassword is not required.

derbySystemHome (String)

The home location of the Apache Derby v10.2 system if we are setting up a Apache Derby v10.2 database.

reportSqlError (String)

Report SQL errors while setting up databases.

file (String)

The full path to a file containing the input parameters. Each input parameter must match a corresponding parameter as it would be typed on the command line, and it must be placed in a key=value pair. Each pair must be on a separate line.

dbSchema (String)

The database schema from which we want to delete the federated repository tables. The schema should exist in the database. The default is the default schema of the database according to the database type. Typically, the default schema is the namespace of the current database user.

(ZOS) dbSchema (String)

(ZOS) The database schema from which we want to delete the federated repository tables. The default is the default schema of the database according to the database type. Typically, the default schema is the namespace of the current database user.

(ZOS) tablespacePrefix (String)

(ZOS) The tablespace prefix. The maximum length allowed for this string is 3 characters. The value of tablespacePrefix parameter is required when using the dbSchema parameter. It is specific to DB2 for z/OS and will be ignored for any other database type.

The setupIdMgrPropertyExtensionRepositoryTables command:

The setupIdMgrPropertyExtensionRepositoryTables command sets up the property extension repository. The default behavior includes creating and populating the tables in the database.

This command is available in connected or local mode.

Parameters:

schemaLocation (String, Required)

The location of the app_server_root/etc/wim/setup directory.

laPropXML (String)

The location of the property extension repository definition XML file.

databaseType (String, Required)

The type of database. Supported databases are db2, oracle, informix, derby, sqlserver, db2zos, and db2iseries.

dbURL (String, Required)

The database URL for direct access mode. For example: jdbc:db2:wim.

dbAdminId (String)

The database administrator ID for direct access mode. For example: db2admin.

For a Apache Derby v10.2 embedded database, dbAdminId is not required.

dbAdminPassword (String)

The password associated with the dbAdminId.

For a Apache Derby v10.2 embedded database, dbAdminPassword is not required.

derbySystemHome (String)

The home location of the Apache Derby v10.2 system if we are setting up a Apache Derby v10.2 database.

reportSqlError (String)

Report SQL errors while setting up databases.

skipDBCreation (Boolean)

Create the tables in the property extension repository.

If we set this parameter value to false or do not specify a value, then the command follows the default behavior of creating and populating the tables in the database.

If we set this parameter value to true, manually set up the property extension repository before running this command so that the tables get populated. For more information on this manual process, see the appropriate topic on manually setting up the property extension repository for our database.

file (String)

The full path to a file containing the input parameters. Each input parameter must match a corresponding parameter as it would be typed on the command line, and it must be placed in a key=value pair. Each pair must be on a separate line.

(ZOS) tablesBufferPool (String)

(ZOS) The buffer pool variable of default tables in DB2 for z/OS. The default is BP0.

(ZOS) LOBtablesBufferPool (String)

(ZOS) The buffer pool variable of auxiliary LOB tables in DB2 for z/OS. The default is BP0.

(ZOS) indextablesBufferPool (String)

(ZOS) The buffer pool variable of unique index tables in DB2 for z/OS. The default is BP0.

dbSchema (String)

The database schema where we want to create the federated repository tables. The schema should exist in the database. The default is the default schema of the database according to the database type. Typically, the default schema is the namespace of the current database user.

(ZOS) dbSchema (String)

(ZOS) The database schema where we want to create the federated repository tables. The default is the default schema of the database according to the database type. Typically, the default schema is the namespace of the current database user.

(ZOS) tablespacePrefix (String)

(ZOS) The tablespace prefix. The maximum length allowed for this string is 3 characters. The value of tablespacePrefix parameter is required when using the dbSchema parameter. It is specific to DB2 for z/OS and will be ignored for any other database type.

The deleteIdMgrPropertyExtensionRepositoryTables command:

The deleteIdMgrPropertyExtensionRepositoryTables command deletes the tables in the property extension database.

This command is available in the connected or local mode.

Parameters:

schemaLocation (String, Required)

The location of the <WAS>/etc/wim/setup directory.

databaseType (String, Required)

The type of database. Supported databases are db2, oracle, informix, derby, sqlserver, db2zos, and db2iseries.

dbURL (String, Required)

The database URL for direct access mode. For example: jdbc:db2:wim.

dbDriver (String)

The name of the database driver. For example: com.ibm.db2.jcc.DB2Driver.

dbAdminId (String)

The database administrator ID for direct access mode. For example: db2admin.

For a Apache Derby v10.2 embedded database, dbAdminId is not required.

dbAdminPassword (String)

The password associated with the dbAdminId.

For a Apache Derby v10.2 embedded database, dbAdminPassword is not required.

derbySystemHome (String)

The home location of the Apache Derby v10.2 system if we are setting up a Apache Derby v10.2 database.

reportSqlError (String)

Report SQL errors while setting up databases.

file (String)

The full path to a file containing the input parameters. Each input parameter must match a corresponding parameter as it would be typed on the command line, and it must be placed in a key=value pair. Each pair must be on a separate line.

dbSchema (String)

The database schema from which we want to delete the federated repository tables. The schema should exist in the database. The default is the default schema of the database according to the database type. Typically, the default schema is the namespace of the current database user.

(ZOS) dbSchema (String)

(ZOS) The database schema from which we want to delete the federated repository tables. The default is the default schema of the database according to the database type. Typically, the default schema is the namespace of the current database user.

(ZOS) tablespacePrefix (String)

(ZOS) The tablespace prefix. The maximum length allowed for this string is 3 characters. The value of tablespacePrefix parameter is required when using the dbSchema parameter. It is specific to DB2 for z/OS and will be ignored for any other database type.

The setupIdMgrEntryMappingRepositoryTables command:

The setupIdMgrEntryMappingRepositoryTables command sets up the entry mapping repository, which includes creating and populating the tables of the repository.

Parameters:

schemaLocation (String, Required)

The location of the <WAS>/etc/wim/setup directory.

databaseType (String, Required)

The type of database. Supported databases are db2, oracle, informix, derby, sqlserver, db2zos, and db2iseries.

dbURL (String, Required)

The database URL for direct access mode. For example: jdbc:db2:wim.

dbDriver (String)

The name of the database driver. For example: com.ibm.db2.jcc.DB2Driver.

dbAdminId (String)

The database administrator ID for direct access mode. For example: db2admin.

For a Apache Derby v10.2 embedded database, dbAdminId is not required.

dbAdminPassword (String)

The password associated with the dbAdminId.

For a Apache Derby v10.2 embedded database, dbAdminPassword is not required.

derbySystemHome (String)

The home location of the Apache Derby v10.2 system if we are setting up a Apache Derby v10.2 database.

reportSqlError (String)

Report SQL errors while setting up databases.

file (String)

The full path to a file containing the input parameters. Each input parameter must match a corresponding parameter as it would be typed on the command line, and it must be placed in a key=value pair. Each pair must be on a separate line.

(ZOS) tablesBufferPool (String)

(ZOS) The buffer pool variable of default tables in DB2 for z/OS. The default is BP0.

dbSchema (String)

The database schema where we want to create the federated repository tables. The schema should exist in the database. The default is the default schema of the database according to the database type. Typically, the default schema is the namespace of the current database user.

(ZOS) dbSchema (String)

(ZOS) The database schema where we want to create the federated repository tables. The default is the default schema of the database according to the database type. Typically, the default schema is the namespace of the current database user.

(ZOS) tablespacePrefix (String)

(ZOS) The tablespace prefix. The maximum length allowed for this string is 3 characters. The value of tablespacePrefix parameter is required when using the dbSchema parameter. It is specific to DB2 for z/OS and will be ignored for any other database type.

The deleteIdMgrEntryMappingRepositoryTables command:

The deleteIdMgrEntryMappingRepositoryTables command deletes the tables in the entry mapping repository.

Parameters:

schemaLocation (String, Required)

The location of the <WAS>/etc/wim/setup directory.

databaseType (String, Required)

The type of database. Supported databases are db2, oracle, informix, derby, sqlserver, db2zos, and db2iseries.

dbURL (String, Required)

The database URL for direct access mode. For example: jdbc:db2:wim.

dbDriver (String)

The name of the database driver. For example: com.ibm.db2.jcc.DB2Driver.

dbAdminId (String)

The database administrator ID for direct access mode. For example: db2admin.

For a Apache Derby v10.2 embedded database, dbAdminId is not required.

dbAdminPassword (String)

The password associated with the dbAdminId.

For a Apache Derby v10.2 embedded database, dbAdminPassword is not required.

derbySystemHome (String)

The home location of the Apache Derby v10.2 system if we are setting up a Apache Derby v10.2 database.

reportSqlError (String)

Report SQL errors while setting up databases.

file (String)

The full path to a file containing the input parameters. Each input parameter must match a corresponding parameter as it would be typed on the command line, and it must be placed in a key=value pair. Each pair must be on a separate line.

dbSchema (String)

The database schema from which we want to delete the federated repository tables. The schema should exist in the database. The default is the default schema of the database according to the database type. Typically, the default schema is the namespace of the current database user.

(ZOS) dbSchema (String)

(ZOS) The database schema from which we want to delete the federated repository tables. The default is the default schema of the database according to the database type. Typically, the default schema is the namespace of the current database user.

(ZOS) tablespacePrefix (String)

(ZOS) The tablespace prefix. The maximum length allowed for this string is 3 characters. The value of tablespacePrefix parameter is required when using the dbSchema parameter. It is specific to DB2 for z/OS and will be ignored for any other database type.

Sample command line usage:

To set up a database using the command line, enter the following:

$AdminTask setupIdMgrDBTables {-schemaLocation "C:/WAS/etc/wim/setup" -dbPropXML 
"C:/WAS/etc/wim/setup/wimdbproperties.xml" -databaseType db2
-dbURL jdbc:db2:wim -dbAdminId db2admin 
-dbDriver com.ibm.db2.jcc.DB2Driver -dbAdminPassword db2adminPwd 
-reportSqlError true}

To delete database tables using the command line, enter the following:

$AdminTask deleteIdMgrDBTables {-schemaLocation "C:/WAS/etc/wim/setup" 
-databaseType db2  -dbURL jdbc:db2:wim -dbAdminId db2admin 
-dbDriver com.ibm.db2.jcc.DB2Driver -dbAdminPassword db2adminPwd 
-reportSqlError true}

To set up a property extension repository using the command line, enter the following:

$AdminTask setupIdMgrPropertyExtensionRepositoryTables {-schemaLocation 
"C:/WAS/etc/wim/setup"
-laPropXML "C:/WAS/etc/wim/setup/wimlaproperties.xml" -databaseType db2 
-dbURL jdbc:db2:wim -dbAdminId db2admin -dbDriver com.ibm.db2.jcc.DB2Driver 
-dbAdminPassword db2adminPwd -reportSqlError true}

To delete a property extension repository using the command line, enter the following:

$AdminTask deleteIdMgrPropertyExtensionRepositoryTables {-schemaLocation "C:/WAS/etc/wim/setup " 
-databaseType db2 -dbURL jdbc:db2:wim -dbAdminId db2admin -dbDriver 
com.ibm.db2.jcc.DB2Driver -dbAdminPassword db2adminPwd -reportSqlError true}

To set up an entry mapping repository using the command line, enter the following:

$AdminTask setupIdMgrEntryMappingRepositoryTables {-schemaLocation "C:/WAS/etc/wim/setup" 
-databaseType db2 -dbURL jdbc:db2:wim -dbAdminId db2admin -dbDriver 
com.ibm.db2.jcc.DB2Driver -dbAdminPassword db2adminPwd -reportSqlError true}

To delete an entry mapping repository using the command line, enter the following:

$AdminTask deleteIdMgrEntryMappingRepositoryTables {-schemaLocation "C:/WAS/etc/wim/setup" 
-databaseType db2 -dbURL jdbc:db2:wim -dbAdminId db2admin -dbDriver 
com.ibm.db2.jcc.DB2Driver -dbAdminPassword db2adminPwd -reportSqlError true}

Sample CLI Usage using -file option:

To set up a database with the -file option using the following example params.txt file, enter the following lines:

$AdminTask setupIdMgrDBTables {-file C:/params.txt -dbPropXML 
"C:/OverrideDBPropParam/wimdbproperties.xml"}

Params.txt

schemaLocation=C:/WAS/etc/wim/setup
dbPropXML=C:/IBM/WebSphere/AppServer/profiles/default
/config/cells/mycell/wim/config/wimdbproperties.xml
laPropXML=C:/IBM/WebSphere/AppServer/profiles/default
/config/cells/mycell/wim/config/wimlaproperties.xml
databaseType=db2
dbURL=jdbc:db2:wim
dbDriver=com.ibm.db2.jcc.DB2Driver
reportSqlError=true
dn=o=db.com
dbAdminId=db2admin
dbAdminPassword=dbPassword
wasAdminId=wasadmin
wasAdminPassword=wasadmin1

To set up a database with the -file option using a file only, enter the following:

$AdminTask setupIdMgrDBTables {-file C:/params.txt}

The use of a file only works if -file is the only parameter specified on the command line. If other parameters are specified then the file is completely ignored, and only the parameters on the command line are used to execute the command.

Subtopics

• (iSeries) (ZOS) (Dist) Manually setting up the property extension repository for federated repositories
  Use the createIdMgrPropExtDbTables script to create tables in the property extension repository for federated repositories.

• (iSeries) (ZOS) (Dist) Manually setting up the property extension repository for DB2 for iSeries or DB2 for z/OS
  Use this task to set up the property extension repository for DB2 for iSeries or DB2 for z/OS .

Related tasks:

Configure the WebSphere Application Server data source

Configure an entry mapping repository in a federated repository configuration

Configure a property extension repository in a federated repository configuration

(ZOS) Use a DB2 database to hold custom user registry data

Related reference:

Entry mapping repository settings

Property extension repository settings