You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

Table of contents 

Description

The Comments SQL Store component adds the ability to connect your Runtime to a database for storing comments. It's an addition to the comment containers which are provided by the Dashboard component (see Container types), which use an in-memory DAO (for development purpose only) by default.

Requirements

This component persists data in a database, that must be provided. See platform support for the supported databases.

Installation

The Comments SQL Store component can be used together with the Dashboard component. In this case the comments from the dashboard will be saved using the CommentDao implementation from the Comments SQL Store component.

Add the artifact with groupId "com.blueriq" and artifactId "blueriq-component-comments-sql-store" as a dependency to your Blueriq runtime POM file.

In order to use this component, the comments-sql-store profile must be active. More information on how to configure the application using Spring Profiles can be found here : Application configuration with Spring Profiles.

In order to use this component, make sure to have the BlueriqComponentComments.dll in the /bin directory of your .NET webapp installation.

Configuration

Database

Scripts to create the required database content are provided for the following databases:

  • Microsoft SQL Server
  • Oracle
  • H2 (we do not recommend using a H2 database in production environments)

 

For customers that are upgrading an existing version of Blueriq, database upgrade scripts are provided in the Upgrade Instructions when applicable.

Use the following steps to configure the datasource:

  1. If necessary, create a new datasource. See Configuring JDBC database drivers for information on how to do this.
  2. Comments SQL Store component is using the comments-sql-store datasource to store data. The comments-sql-store datasource can be configured using JDBC or JNDI.
    1. Using JDBC datasource : this can be configured in the  application-externaldatasources.properties file. When configuring external datasources, the externaldatasources profile should be enabled.

      application-externaldatasources.properties
      blueriq.datasource.comments-sql-store.url=jdbc:sqlserver://<database_url>:<port>;databaseName=bq_comments;instance=SQL_EXPRESS
      blueriq.datasource.comments-sql-store.username=<username>
      blueriq.datasource.comments-sql-store.password=<password>
      blueriq.datasource.comments-sql-store.driverClassName=com.microsoft.sqlserver.jdbc.SQLServerDriver
      blueriq.hibernate.comments-sql-store.hbm2ddl.auto=validate
      blueriq.hibernate.comments-sql-store.dialect=org.hibernate.dialect.SQLServer2012Dialect
    2. Using JNDI datasource : this can be configured in the  application-jndidatasources.properties file When configuring JNDI datasources the jndidatasources profile should be enabled.

      application-jndidatasources.properties
      blueriq.datasource.comments-sql-store.jndiName=java:/comp/env/jdbc/main
      blueriq.hibernate.comments-sql-store.hbm2ddl.auto=validate
      blueriq.hibernate.comments-sql-store.dialect=org.hibernate.dialect.SQLServer2012Dialect
  3. Configuring the datasource from the Development Dashboard
    Go to Settings Widget → Datasources tab → On the left side menu : select comments-sql-store datasource. The same properties are available for configuration as from the properties file. Make sure the corresponding profile is enabled (externaldatasources or jndidatasources)
  4. Hibernate settings
    These settings are done for each datasource type in the corresponding properties file, as in the examples above.

Supported dialects:

  • org.hibernate.dialect.SQLServer2012Dialect (for SQL Server)
  • org.hibernate.dialect.Oracle10gDialect (for Oracle)
  • org.hibernate.dialect.H2Dialect (for H2) (we do not recommend using a H2 database in production environments)

Supported hbm2ddl.auto values:

  • none
  • validate

Configuring the database connection for the Comments SQL Store component in .Net is done by adding a connection configuration to the 

Unable to render {include} The included page could not be found.
 file.

.NET database configuration example
<hibernate-configuration>
  <session-factories>
    <session-factory name="CommentsDao">
      <properties>
        <property name="connection.provider" value="NHibernate.Connection.DriverConnectionProvider" />
        <property name="dialect" value="NHibernate.Dialect.MsSql2012Dialect" />
        <property name="connection.driver_class" value="NHibernate.Driver.SqlClientDriver" />
        <property name="connection.connection_string" value="Server=HOST\SQLEXPRESS;Database=test;User Id=USERNAME;Password=PASSWORD;" />
        <property name="show_sql" value="false" />
        <property name="current_session_context_class" value="Aquima.WebApplication.WebPersistenceUtility.Session.CurrentHibernateSessionContext, WebPersistenceUtility" />
      </properties>
    </session-factory>
  </session-factories>
</hibernate-configuration>

Supported dialects:

  • NHibernate.Dialect.MsSql2012Dialect

 

For more information about configuring database connections, see Configuring database connections in .Net webapp.

The Comments SQL Store component looks for a database connection named "comments-sql-store" so make sure that this name is used in order to configure the Comments SQL Store properly.

All necessary DLL files on which the Comments SQL Store component depends can be found in the /bin directory of the .NET webapp ZIP file.

 

 

  • No labels