Differences

This shows you the differences between two versions of the page.

--- docs:1100_inst_guide:0350_db_integration [2022/08/21 12:09] – ↷ Page moved from start:1100_inst_guide:0350_db_integration to docs:1100_inst_guide:0350_db_integration administrator
+++ docs:1100_inst_guide:0350_db_integration [2025/06/12 02:31] (current) – aware_support3
@@ Line 2: / Line 2: @@
 ====== Database integration ======
-//**Aware IM**// requires database software to function correctly. At the moment //**Aware IM**// is compatible with the Apache Derby, MySQL, Microsoft SQL Server/Azure, Oracle, PostgreSQL and Maria DB databases<sup>(( Note that Aware IM can connect to any existing database through a JDBC driver. In this section we only refer to databases that Aware IM supports “natively”, i.e. it can create NEW applications using these databases.))</sup>. MySQL, Maria DB, Oracle, PostgreSQL and MS SQL Server databases are not included in the //**Aware IM**// installation.
+//**AwareIM**// requires database software to function correctly. At the moment //**AwareIM**// is compatible with the Apache Derby, MySQL, Microsoft SQL Server/Azure, Oracle, PostgreSQL and Maria DB databases<sup>(( Note that //**AwareIM**// can connect to any existing database through a JDBC driver. In this section we only refer to databases that //**AwareIM**// supports “natively”, i.e. it can create NEW applications using these databases.))</sup>. MySQL, Maria DB, Oracle, PostgreSQL and MS SQL Server databases are not included in the //**AwareIM**// installation.
-Apache Derby is included in //**Aware IM**// and does not require any additional integration.
+Apache Derby is included in //**AwareIM**// and does not require any additional integration.
-Integrating //Aware IM// with MySQL database
+{{simplenavi>docs:1100_inst_guide:0350_db_integration:}}
-If you do not have MySQL database software you can download one free of charge from the MySQL web site at [[https://dev.mysql.com/downloads]]. Run MySQL installation program and follow the instructions (see MySQL Installation Guide for details). We recommend that you install MySQL as a Windows service. Once the installation has been completed make sure that MySQL is running and perform the integration steps described below.
-  - Start the Aware IM Control Panel
-  - Select the Settings/Database menu item and select MySQL as the database engine
-  - Enter credentials of the MySQL account. Note that the account you specify here must have root user privileges, otherwise Aware IM will not work
-  - Specify MySQL server name and the port number where MySQL listens to requests (if these are different from the default values)
-  - Click OK and restart Aware IM
-If you installed Aware IM as Windows service you can perform database integration manually without using the Aware IM Control Panel. To do this:
-  - Delete the default ''AwareIM/bin/BASServer.props'' file which contains default database settings
-  - Rename the file ''BASServerMySQL.props'' to ''BASServer.props''
-  - Use any text editor to change server name, port and root user credentials to the following lines in the ''BASServer.props'' file:
-<code>
-DriverURL=jdbc:mysql://localhost/BASDB?user=root&password=blah
-DriverTestURL=jdbc:mysql://localhost/BASDBTEST?user=root&password=blah
-BootstrapURL=jdbc:mysql://localhost/?user=root&password=blah
-</code>
-===== Integrating Aware IM with MS SQL Server database =====
-If you do not have MS SQL Server database software you can download the free version (SQL Server Express) from the Microsoft web site. Make sure that MS SQL Server or SQL Server Express is running and perform the integration steps described below.
-<note important>Support for the full version of MS SQL Server database is optional in Aware IM. Before integrating this database with Aware IM make sure that this option is available in your Aware IM edition.</note>
-  - Make sure that your MS SQL Server database is configured to use TCP/IP protocol – please refer to the MS SQL Server manual for details.
-  - Start the Aware IM Control Panel
-  - Select the Settings/Database menu item and select SQL Server as the database engine
-  - Enter credentials of the SQL Server account.
-  - Specify SQL server name and the port number where SQL Server listens to requests (if these are different from the default values)
-  - Click OK and restart Aware IM
-If you installed Aware IM as Windows service you can perform database integration manually without using the Aware IM Control Panel. To do this:
-  - Delete the default ''AwareIM/bin/BASServer.props'' file which contains default database settings
-  - Rename the file ''BASServerMSDE.props'' to ''BASServer.props''
-  - Use any text editor to modify the following lines in the ''BASServer.props'' file located in the ''BIN'' directory of your //**Aware IM**// installation:
-<code>
-DriverURL=jdbc:sqlserver://localhost:1433;user=sa;password=password;databaseName=BASDB
-DriverTestURL=jdbc:sqlserver://localhost:1433;databaseName=BASDBTEST;user=sa;password=password;
-BootstrapURL=jdbc:sqlserver://localhost:1433;user=sa;password=password;
-DriverClassName=com.microsoft.sqlserver.jdbc.SQLServerDriver
-DatabaseComponent=com.bas.basserver.persistence.dbplugins.MSSQLServerInterface
-</code>
-Change values for ''user'' and ''password'' properties in the first three lines above to provide the credentials of your MS SQL Server account.
-If you are running a specific instance of the SQL Server configure this instance to listen on a particular TCP/IP port and specify this port in the URL above
-====  Troubleshooting MS SQL Server database integration. ====
-^Cause of failure   ^What to do  ^
-|Aware IM fails to authenticate with MS SQL Server.    |Check that you specified correct user name and password in the BASServer.props file|
-|Aware IM cannot connect to the MSQL Server through the default TCP/IP port|1. Check that SQL Server is configured to use TCP/IP. Restart the SQL Server service after you make the changes.\\ \\ 2. If SQL Server is listening for connections on a different port than the default port 1433, specify this port number in the BASServer.props‎ file‎ after‎ ''localhost''‎ in‎ the 3 lines mentioned in the previous sections, for example ''localhost:1450''\\ \\ 3. Check that the port on which SQL Server is listening for connections is not blocked by a firewall.|
-If //**Aware IM**// does not start it could be for reasons described in the following table (which also suggests what to do):
-==== Integrating Aware IM with Oracle database ====
-IMPORTANT: Support for Oracle database is optional in //**Aware IM**//. Before integrating this database with Aware IM make sure that this option is available in your Aware IM edition.
-You need to install Oracle database prior to using //**Aware IM**// as it is not included in the Aware IM installation. Before you can start using Aware IM with the Oracle database make sure you do the following:
-  - //**Aware IM**// manages two databases named ''BASDB'' and ''BASDBTES''. The databases must be created manually before using Oracle with //**Aware IM**//. //**Aware IM**// will NOT create the databases automatically. It is enough to create empty databases without creating any tables – //**Aware IM**// will create all the required tables automatically on the first startup.
-  - Perform the steps to setup Aware IM connection with the Oracle database using the Aware IM Control Panel in a similar way as for MySQL or SQL Server databases described above. Or if Aware IM is installed as a service, perform manual integration in a similar fashion as described for MySQL and SQL Server databases.
-==== Integrating Aware IM with Microsoft Azure, Maria DB and PostgreSQL databases ====
-Integration with these databases is very similar to the one described for MySQL or SQL Server databases. When integrating using the Aware IM Control Panel, make sure that you select the corresponding database engine and enter the required values for the database server. If integrating manually, make sure that you rename the appropriate ''BASServer.props'' file and change the lines in these files that control database connection.