configdatabase - Configure Named Database Access

configdatabase [--gui|--noui] [--copy=NAME] name [NAME=value ...]

configdatabase --drop name

configdatabase --print name

configdatabase --list

Use configdatabase to create named database access configurations. These are then available for the configdadb utility as templates to configure database access for data areas.

When you create a named database access configuration, the utility prompt you for the necessary information for a database access configuration and will validate your specifications.

Program Option Description
-g or --gui Prompt for interactive database access configuration specifications through an input form.
-n or --noui Use configdatabase in non-interactive mode. In this mode, the utility will create a new database access configuration based on the last database access configuration that was created, using the new name you provide.
--copy=NAME Create a new database access configuration by copying from the configuration identified through your value for NAME.
name The name of the database access configuration.
--drop name Delete the specified database access configuration.
--print name Print the values for specified database access configuration.
--list List all of the defined database access configurations.
NAME=value ... Provide a value for a database parameter, where NAME is the name of the parameter and value is the value you want it to have. You can enter multiple parameter/value pairs.
Database Access Option Description
Automatically create schemas for data areas? Select TRUE or FALSE. If you select TRUE, you will later provide a prefix to use to build the schema names.
The database to use for this data area. Choose the number from the list presented by the interview that represents the database you will use, or if in GUI mode, select the database from the drop-down list.
Are you connecting to an availability group listener of a SQL Server availability group or a SQL Server Failover Cluster Instance? This applies only to SQL Server 2012 and higher. If yes, do not specify an InstanceName, but rather the availability group listener of the availability group as the SQL Server.
The name of the SQL Server server to use.
The port number of the remote SQL Server database. If the SQL instance is configured to use dynamic ports, use 0 for the port. Otherwise specify the correct static port.
The name of the database on the server.
Do you want to use unicode support?
The name of the full text index for the database on the server.
The user ID to use when connecting to SQL Server. A user defined in the SQL Server database.
The password for the user. The password for the SQL Server user.
Do you want to specify filegroups for tables and indexes? If you choose to use filegroups, you will need to provide the names of the filegroups to use for tables, indexes, and large objects.
The prefix to use to build schema names

The schema name will be created by concatenating the prefix with an underscore and then the data area name. The resulting schema name cannot exceed 18 characters in length and must start with a letter.

You are only prompted for the prefix if you selected TRUE when asked if you want to automatically create schemas.