When installing a CMS or gateway from a command line, you can use these variables to configure the database engine and the database account used by CA DataMinder. For key variables, you must supply a new value; for others, you only need to include the variable if you want to use a non-default value. Examples are shown at the end of this section.
Note: Note that these database details cannot not be validated during the installation; you must ensure that you have entered them correctly, otherwise the installation will fail.
Important! All database variables and their values must be in uppercase.
WGNDATABASETYPE=<type> WGNDATABASESERVER=<server> WGNDATABASEIPPORT=CA Portal WGNDATABASESERVICENAME=<service> WGNDATABASENAME=<dbname> WGNDATABASEUSERNAME=<username> WGNDATA=<path> WGNDATABASEPASSWORD=<password>
WGNDBPRIMARYUSERNAME=<username> WGNDBPRIMARYPASSWORD=<password> WGNDBPRIMARYCREATEACCOUNT=1 WGNDBPRIMARYTABLESPACENAME=<name>
WGNDBSEARCHUSERNAME=<username> WGNDBSEARCHPASSWORD=<password> WGNDBSEARCHCREATEACCOUNT=1 WGNDBSEARCHTABLESPACENAME=<name>
WGNDBOWNERUSERNAME=<username> WGNDBOWNERUSERPASSWORD=<password> WGNDBOWNERCREATEACCOUNT=1 WGNDBOWNERTABLESPACENAME=<name>
WGNDBADMINUSERNAME=<username> WGNDBADMINPASSWORD=<password>
WGNDBREPORTINGUSERNAME=<username> WGNDBREPORTINGPASSWORD=<password> WGNDBREPORTINGCREATEACCOUNT=1 WGNDBREPORTINGTABLESPACENAME=<name>
WGNDBUNRESTRICTEDUSERNAME=<username> WGNDBUNRESTRICTEDPASSWORD=<password> WGNDBUNRESTRICTEDCREATEACCOUNT=1 WGNDBUNRESTRICTEDTABLESPACENAME=<name>
WGNDWENABLE=1 WGNDWEVENTPARTICIPANTS=1
These variables are described below.
Identifies the database engine that you will use on the CMS. <type> is either MSSQL or ORACLE. If you omit this variable, the database engine defaults to MSSQL.
Identifies the host server for your database, where <server> is the name or IP address of the database server. If you specify a computer name, you must enclose the name in double quotes.
If you omit this variable, the database server defaults to localhost. This specifies a database on the local machine.
Specifies the TCP/IP port number used by the database host server. If you omit this variable, the default depends on the type of database engine (as specified by WGNDATABASETYPE). Note that you do not normally need to change these defaults, meaning you can normally omit this variable. The default port numbers are:
1433 for SQL Server.
1521 for Oracle.
For Oracle databases, this specifies a service name to identify the correct database tables, where <service> is the name of the Oracle service.
Important! Do not omit this variable; you must supply a service name.
Note: This is not required for SQL Server databases.
For SQL Server databases, this specifies the name of the database, where <dbname> is the database you want to create or (if already created) use on the database server.
If you omit this variable, the database name defaults to WGN_<machine name> where <machine name> is the name of the server on which you are installing the CMS or gateway.
Note: This is not required for Oracle databases.
Specifies the user name for a valid database account, where <username> is the user name. WGNDATABASEUSERNAME must be in upper case. CA DataMinder uses this account to access the CMS database. You must ensure that the account has appropriate roles and privileges.
Note: This value is still supported, but has been superseded by WGNDBPRIMARYUSERNAME.
Specifies the name and network location of the data folder. This folder contains all the configuration data and captured data used by the CA DataMinder installation. <path> is the full path to this folder.
To specify a remote location, you cannot specify a mapped network drive. Instead, you must enter a network file share, using the universal naming convention, for example:
\\MyMachine\share_name\target_folder
If you omit this variable, the folder defaults to CA’s \data\log subfolder of the Windows All Users profile.
Specifies the password for the database account used by CA DataMinder, that is, the account specified by WGNDATABASEUSERNAME. If you omit this variable, the password defaults to null (that is, no password is needed to access the database).
Note: This value is still supported, but has been superseded by WGNDBPRIMARYPASSWORD.
Specifies the user name for a valid CA DataMinder database user account, where <username> is the user name. CA DataMinder uses this account to access the CMS database. You must ensure that the account has appropriate roles and privileges, unless you intend to specify WGNDBPRIMARYCREATEACCOUNT which assigns the appropriate roles and privileges automatically.
Specifies the password for the database account used by CA DataMinder, that is, the account specified by WGNDBPRIMARYUSERNAME. If you omit this variable, the password defaults to null (that is, no password is needed to access the database).
Set this optional variable to 1 to specify that if no valid database account exists on the server, then CA DataMinder will automatically create one with the appropriate roles and privileges.
(Oracle only) This specifies a valid name name to identify the correct tablespace for the primary database account, where <name> is the name of the Oracle database tablespace.
Important! Do not omit this variable; you must supply a tablespace name.
Specifies the user name for the database search user account, where <username> is the user name. CA DataMinder uses this account when searching
the CMS database for events. You must ensure that the account has appropriate roles and privileges, unless you specify WGNDBSEARCHCREATEACCOUNT which assigns the appropriate roles and privileges automatically.
Note: This is a secure account that is subject to ‘row level security’ when searching the database for events. This ensures that reviewers cannot see events associated with users outside of their management groups.
Specifies the password for the database search user account used by CA DataMinder, that is, the account specified by WGNDBSEARCHUSERNAME. If you omit this variable, the password defaults to null (that is, no password is needed to search the database).
Set this optional variable to 1 to specify that if no valid search user account exists on the server, then CA DataMinder will automatically create one with the appropriate roles and privileges.
(Oracle only) This specifies a valid name to identify the correct tablespace for the search user account, where <name> is the name of the Oracle database tablespace.
Important! Do not omit this variable; you must supply a tablespace name.
(Oracle only) This optional variable specifies the user name for the database owner user account, where <username> is the user name. This account owns the database schema in preference to the primary user. You must ensure that the account has appropriate roles and privileges.
This optional variable specifies the password for the database owner account used by CA DataMinder, that is, the account specified by WGNDBOWNERUSERNAME. If you specify WGNDBOWNERUSERNAME but omit this variable, the password defaults to null (that is, no password is needed to access the database).
(Oracle only) Set this optional variable to 1 to specify that if no valid database owner account exists on the server, then CA DataMinder will automatically create one with the appropriate roles and privileges.
(Oracle only) This specifies a valid name to identify the correct tablespace for the database owner account, where <name> is the name of the Oracle database tablespace.
Important! Do not omit this variable; you must supply a tablespace name.
Specifies the user name for database administrator account, where <username> is the user name. CA DataMinder uses this account to create users. You must ensure that the account has appropriate roles and privileges.
This variable is only required if any of the following are set to 1:
Specifies the password for the database administrator account used by CA DataMinder. That is, the account specified by WGNDBADMINUSERNAME.
Important! Do not omit this variable; you must supply a password for this account.
This optional variable specifies the user name for the data warehouse user account, where <username> is the user name. External reporting applications (such as BusinessObjects Enterprise) use this database account to connect to the Data Warehouse and CMS database.
This optional variable specifies the password for the data warehouse user account used by CA DataMinder, that is, the account specified by WGNDBREPORTINGUSERNAME. If you specify WGNDBREPORTINGUSERNAME but omit this variable, the password defaults to null (that is, no password is needed to access the database).
Set this optional variable to 1 to specify that if no valid data warehouse user account exists on the server, then CA DataMinder will automatically create one with the appropriate roles and privileges.
This specifies a valid name to identify the correct tablespace for the data warehouse user account, where <name> is the name of the Oracle database tablespace.
Important! Do not omit this variable; you must supply a tablespace name.
This optional variable specifies the user name for the unrestricted search user account, where <username> is the user name.
This database account corresponds to the 'Unrestricted' security model. CA DataMinder consoles and external reporting tools can use this database account when searching the CA DataMinder data warehouse and CMS database for events. Unlike normal Search User database accounts, the Unrestricted Search User is not subject to row level security (RLS) when searching the database.
This optional variable specifies the password for the unrestricted search user account used by CA DataMinder, that is, the account specified by WGNDBUNRESTRICTEDUSERNAME. If you specify WGNDBUNRESTRICTEDUSERNAME but omit this variable, the password defaults to null (that is, no password is needed to access the database).
Set this optional variable to 1 to specify that if no valid unrestricted search user account exists on the server, then CA DataMinder will automatically create one with the appropriate roles and privileges.
This specifies a valid name to identify the correct tablespace for the unrestricted search user account, where <name> is the name of the Oracle database tablespace.
Important! Do not omit this variable; you must supply a tablespace name.
Set this optional variable to 1 to install a data warehouse.
Set this optional variable to 1 to collect event participant data in the data warehouse.
This option is essential if you want to run reports or dashboards that show results broken down by user group, or if you want to apply management group row level security.
Important! If you collect event participant data, the associated table in the data warehouse can grow very large. Our testing indicates that the table can increase the size of the database by 30-40%. The reason is because an individual event can have many participants. For further details, see the Reports Integration Guide.
|
Copyright © 2014 CA.
All rights reserved.
|
|