SQL Server Sample Database
This section describes how to connect to SQL Server and import the sample database. SBM Configurator can only import the sample database into SQL Server locally. If your SQL Server instance is hosted on a remote server, consult your DBA and restore the sample.bak file manually using the SQL Server native tools.
installDir\Sample Database\sample_general_mssql.zip
If you restore the database manually, do not select the
Use sample database option in
SBM Configurator.
Instead, enter the connection information for the database in which you
restored the
sample.bak.Server Information
If the Use sample database option is selected, the Database Servers tab prompts you to enter the connection information for the server that will host the sample database. In the Server information section, provide the following:
| Field | Description |
|---|---|
| ODBC Data source | Displays the current data source that is used to connect to the Application Engine database. Click Change to create a new data source, rename the default data source, or select an existing data source. For more information, see About Data Sources. |
| Database type | Select SQL Server to host the sample database in your SQL Server DBMS. |
| Windows Authentication | Select this check box to use Windows Authentication instead of SQL Authentication. For more information, see About Windows Authentication. |
| Host | Enter the host name of your SQL Server machine. |
| Instance | Enter the name of your SQL Server instance. |
| Port | Enter the SQL Server database server port number. The default SQL Server port is 1433. |
SBM Configurator also collects the credentials that are used by each server component to connect to the sample database. If you select SQL Server as the Database type, you must provide a set of existing database credentials to connect to the sample database. SBM Configurator does not create the user account in SQL Server for you; therefore, create the user account beforehand (or use an existing privileged account like sa). After you have established the user in SQL Server, enter the following:
| Field | Description |
|---|---|
| Database name | Enter the name of a database space that will host the sample database in SQL Server. The default is sample. This database space is created in SQL Server once you perform the Import Sample Database operation. |
| User name | Enter the name of a user account that can connect to and alter the database. The sa account appears by default. |
| Password | Enter the user account password. |
| Confirm Password | Enter the password again to confirm it. |
Note that the password that you use has certain restrictions. For example: it can not contain prohibited terms or user names (like "Password" or "Admin"); it can not contain the name of the user currently logged on to the machine; it can not contain the machine name; it must have a combination of uppercase text, lowercase text, and numerals. For more information, review the SQL Server Express password guidelines at http://msdn.microsoft.com/en-us/library/ms143705(SQL.90).aspx.
Configuring SSL with SQL Server
Before you begin, you must configure SSL for SQL Server and install a certificate that meets certain requirements. You must also decide if SQL Server will force encryption or not. Refer to "Encrypting Connections to SQL Server" here for details on configuring SQL Server.
To encrypt connections, select Use SSL in SBM, and then select one of the following options:
- Authenticate – Selected by default
When this option is selected, SSL encryption is required and the server's certificate must be signed by a trusted certificate authority (CA). Data encryption must be enabled on the server in order to complete the SSL handshake and the client (SBM machine) must trust the root authority of the certificate that is used by the server. This means you must also import trusted root and intermediate certificates into the Windows trust store on all servers in your installation and into the appropriate Java key stores on each SBM Tomcat server to use this option.
- Request
When this option is selected, SSL encryption is requested; however, if the server does not support SSL, a plain connection is used. If data encryption is enabled on the server, an SSL handshake is performed; however, the server's certificate is not validated.
- Require
When this option is selected, SSL encryption is required; however, if the server does not support SSL, an exception is thrown. If data encryption is enabled on the server, an SSL handshake is performed; however, the server's certificate is not validated.
Importing the Sample Database
To import the sample database locally, click Import Sample Database, and then enter the User name and Password of a privileged database user account that has the ability to create a new database. A progress indicator appears while the import operation runs.
Click Test connection to confirm that you can connect to the database. If the sample database has not been imported yet, the test will fail. Do not test the connection until after the database has been imported.
Click Next to proceed to the next dialog when the restore operation is finished.
Oracle Sample Database
This section describes how to connect to Oracle and import the sample database. SBM Configurator can either import the sample database into an Oracle instance that is hosted locally or on a remote server. SBM Configurator creates the sample database schema for you.
Server Information
If the Use sample database option is selected, the Database Servers tab prompts you to enter the connection information for the server that will host the sample database. In the Server information section, provide the following:
| Field | Description |
|---|---|
| ODBC Data source | Displays the current data source that is used to connect to the Application Engine database. Click Change to create a new data source, rename the default data source, or select an existing data source. For more information, see About Data Sources. |
| Database type | Select Oracle to host the sample database in your Oracle DBMS. |
| Host | Enter the host name of your Oracle server. |
| SID | Enter the SID of your Oracle database. |
| Port | Enter the port number of your Oracle service. The default Oracle port is 1521. |
SBM Configurator also collects the credentials that are used by each server component to connect to the sample database. If you select Oracle as the Database type, you can choose to use either a set of default database credentials to connect to the sample database or enter your own custom credentials. SBM Configurator creates the user account in Oracle for you; therefore, you do not need to create it beforehand.
To create the sample database in Oracle using a default schema, select Use default credentials. This creates a default schema in Oracle named sample, which uses the tablespace named users. The password for this schema is sample.
If you want to create the sample schema with different credentials, select Use custom credentials and enter the following:
| Field | Description |
|---|---|
| Schema/user name | Enter a new schema or user name. |
| Password | Enter the user password. |
| Confirm password | Confirm the password. |
After you enter the credentials, click Test connection to confirm that your local server can connect to the server that hosts your DBMS.
Importing the Sample Database
To import the sample database, select Import Sample Database, and then enter the Schema/User name and Password of a privileged user account that has the ability to create a new database. A progress indicator appears while the import operation runs. Click Next to proceed to the next dialog box when the restore operation is finished.
PostgreSQL Sample Database
This section describes how to connect to PostgreSQL and import the sample database. SBM Configurator can import the sample database into PostgreSQL remotely using the pg_restore.exe database restore utility.
The sample.bak is packaged in a zip file located here:
installDir\Sample Database\sample_general_postgresql.zip
If you restore the database manually, do not select the Use sample database option in SBM Configurator. Instead, enter the connection information for the database in which you restored the sample.bak.
Server Information
If the Use sample database option is selected, the Database Servers tab prompts you to enter the connection information for the server that will host the sample database. In the Server information section, provide the following:
| Field | Description |
|---|---|
| ODBC Data source | Displays the current data source that is used to connect to the Application Engine database. Click Change to create a new data source, rename the default data source, or select an existing data source. For more information, see About Data Sources. |
| Database type | Select Oracle to host the sample database in your Oracle DBMS. |
| Host | Enter the host name of your Oracle server. |
| SID | Enter the SID of your Oracle database. |
| Port | Enter the port number of your Oracle service. The default Oracle port is 1521. |
SBM Configurator also collects the credentials that are used by each server component to connect to the sample database. If you select Oracle as the Database type, you can choose to use either a set of default database credentials to connect to the sample database or enter your own custom credentials. SBM Configurator creates the user account in Oracle for you; therefore, you do not need to create it beforehand.
To create the sample database in Oracle using a default schema, select Use default credentials. This creates a default schema in Oracle named sample, which uses the tablespace named users. The password for this schema is sample.
If you want to create the sample schema with different credentials, select Use custom credentials and enter the following:
| Field | Description |
|---|---|
| Schema/user name | Enter a new schema or user name. |
| Password | Enter the user password. |
| Confirm password | Confirm the password. |
After you enter the credentials, click Test connection to confirm that your local server can connect to the server that hosts your DBMS.
Configuring SSL with PostgreSQL
Before you begin, you must configure SSL for PostgreSQL and install a certificate that meets certain requirements. You must also decide if PostgreSQL will force encryption or not. Refer to "SSL Support" here for details on configuring PostgreSQL.
To connect to PostgreSQL using SSL, select Use a secure connection and select one of the following SSL modes:
- Verify Full – Selected by default
When this option is selected, SBM requires an SSL connection to PostgreSQL and verifies that the certificate obtained from the server matches the one in the server.crt file. In addition, the Verify full option checks that the hostname in certificate matches the hostname of the database server.
This is the most secure SSL option.
- Verify-CA
When this option is selected, SBM requires an SSL connection PostgreSQL and verifies that the certificate obtained from the server matches the one in the server.crt file.
- Require
When this option is selected, SBM requires an SSL connection to PostgreSQL and the connection fails if the PostgreSQL server does not support it.
- Prefer
When this option is selected, SBM requests an SSL connection to PostgreSQL, but if the server does not support it, a plain connection is used.
- Allow
When this option is selected, SBM can accept an SSL connection from PostgreSQL, but does not require it.
You can optionally enable two-way SSL authentication between SBM and PostgreSQL. This forces the client machine (SBM) to identify itself to PostgreSQL in order to complete a secure handshake. To configure this option, perform the following:
- Enable and configure SSL in PostgreSQL. In PostgreSQL, ensure that you specify a certificate file that contains all client certificates that will be trusted by the server.
- In SBM Configurator, select Use client certificate.
- Click Set Client Certificate and enter the location of your certificate file with a private key. The certificate is converted into the following files:
- Client certificate file
A PEM-encoded public certificate file.
- Client key (ODBC)
A PEM-encoded private key file. Used by IIS, Application Engine, and SBM Configurator.
- Client key (JDBC)
A PKCS8 DER-encoded private key. Used by the SBM Java applications.
The certificates are placed in the same folder as the selected certificate with private key, and then used by the ODBC and JDBC drivers when connecting to the PostgreSQL database server.
Importing the Sample Database
To import the sample database, select Import Sample Database, and then enter the Schema/User name and Password of a privileged user account that has the ability to create a new database. A progress indicator appears while the import operation runs. Click Next to proceed to the next dialog box when the restore operation is finished.
SQL Server Express Sample Database
If the suite installer does not detect that the Microsoft SQL Server Native Client is installed on your server, you are given the option to install Microsoft SQL Server Express. If you select the option to install Microsoft SQL Server Express, the Use sample database check box is selected by default during wizard mode. This section describes how to connect to Microsoft SQL Server Express and import the sample database.
Entering Database Connection Information
If the Use sample database option is selected, the Database Servers tab prompts you to enter the connection information for the server that will host the sample database. When you choose to install SQL Express, the database is hosted locally; therefore, your local server information is used.
The Server information section displays the following information:
| Field | Description |
|---|---|
| ODBC data source | Displays the current data source that is used to connect to the Application Engine database. Click Change to create a new data source, rename the default data source, or select an existing data source. For more information, see About Data Sources. |
| Database type | Defaults to SQL Server when you choose to install Microsoft SQL Server Express. |
| Windows Authentication | Select this check box to use Windows Authentication instead of SQL Authentication. (This field only appears when you select SQL Server as the database type.) For more information, see About Windows Authentication. |
| Host | Contains the host name of your SQL Express server machine. |
| Instance | Contains the name of your SQL Express instance. Defaults to SBMSQLEXPR. |
| Port | Contains the SQL Express database server port number. The default SQL Express port is 1433. |
SBM Configurator also collects the credentials that are used by each server component to connect to the sample database. If you chose to install Microsoft SQL Express during installation, a set of default credentials are created and used to connect the sample database. In wizard mode, the following default credentials are listed in read-only format:
| Field | Description |
|---|---|
| Database name | Defaults to sample when you choose to install Microsoft SQL Server Express. |
| User name | Defaults to sa when you choose to install Microsoft SQL Server Express. |
You can change these credentials after installation if you do not want to use the default credentials; however, note that the password that you create has certain restrictions. For example: it can not contain prohibited terms or user names (like "Password" or "Admin"); it can not contain the name of the user currently logged on to the machine; it can not contain the machine name; it must have a combination of uppercase text, lowercase text, and numerals. For more information, review the SQL Server Express password guidelines at http://msdn.microsoft.com/en-us/library/ms143705(SQL.90).aspx.
To connect to SQL Server Express using custom credentials:
- Launch SBM Configurator.
- Select the Database Servers tab.
- In the Database and connection credentials section, select the Use custom credentials option.
- Change the database credentials according to your new connection criteria.
Importing the Sample Database
SBM Configurator can only import the sample database into SQL Server Express locally. If your SQL Server Express instance is hosted on a remote server, you must restore the sample database manually using the SQL Server Express native tools.
To import the sample database locally, click Import Sample Database. A progress indicator appears while the import operation runs. Click Next to proceed to the next dialog box when the restore operation is finished.