Using Windows Installer Properties for SQL Login Settings

InstallShield 2015

Project: This information applies to the following project types:

•

Basic MSI

•

DIM

•

InstallScript MSI

When you use the SQL Scripts view to add a new SQL database connection to your project, InstallShield adds the following Windows Installer properties to the project by default.

Default SQL Login Properties

Property

Description

IS_SQLSERVER_AUTHENTICATION

This property identifies the type of authentication that you want to use to connect to the specified catalog. The default property is IS_SQLSERVER_AUTHENTICATION. The following numbers are valid property values:

•

0—Windows authentication credential of the current user

•

1—Server authentication

This property is the default value for the Authentic Type Property Name setting on the Advanced tab for the selected SQL connection.

IS_SQLSERVER_DATABASE

This property identifies the name of the SQL catalog to which you want to create a connection during the installation. This property is the default value for the Target Catalog Property Name setting on the Advanced tab for the selected SQL connection.

IS_SQLSERVER_PASSWORD

This property identifies the password that should be used for server authentication. This property is the default value for the Server Authentication Password Property Name setting on the Advanced tab for the selected SQL connection.

IS_SQLSERVER_SERVER

This property identifies the name of the target server instance (for Microsoft SQL Server and MySQL) or the connect URL string or local net service name (for Oracle). This property is the default value for the Target Server Property Name setting on the Advanced tab for the selected SQL connection.

IS_SQLSERVER_USERNAME

This property identifies the login ID that should be used for server authentication. This property is the default value for the Server Authentication Login ID Property Name setting on the Advanced tab for the selected SQL connection.

If you want to override one of these Windows Installer property for an existing connection, add a new property in the Property Manager. Then, in the SQL Scripts view, select the connection. On the Advanced tab, select the name of the new property in the appropriate list.

If you want to store the values of any of these properties on the target system for later use by your product, you can do so. Following are examples of ways you can use these properties:

•

In the Registry view, create a registry value whose data is [IS_SQLSERVER_SERVER]. At run time, when your installation creates the registry value, the data for that registry value is set to the name of the SQL catalog.

•

Use the Text File Changes view to configure text string replacements that you want to occur at run time. In this view, add a text file reference that describes a file that is installed with your product, and then specify the search-and-replace criteria. For the search-and-replace criteria, you can enter [IS_SQLSERVER_DATABASE] in place of the name of the SQL Server machine. At run time, when your installation edits the text file, the name of the SQL Server machine is written in the text file.

Tip: For a list of additional Windows Installer properties that you can define in your project to override default SQL run-time behavior, see Overriding the Default SQL Run-Time Behavior.

Project: In a Basic MSI installation, the built-in SQLLogin dialog lets end users configure the aforementioned properties. If you change any of the SQL properties on the Advanced tab of a SQL connection in a Basic MSI project, the corresponding properties are not automatically updated in the SQLLogin dialog in the Dialogs view. Therefore, you must manually change the properties in the dialog to match the properties that selected on the Advanced tab of the SQL connection.

Using Windows Installer Properties for SQL Login Settings

InstallShield 2015 Help Library

June 2015