You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.
Enabling multi-tenancy
blueriq.multi-tenancy.enabled=true blueriq.multi-tenancy.allowed-tenants=google,apple
For additional information, please refer to Multi-tenancy Properties
Configuration
The datasources for the components can be configured either in the application-externaldatasources.properties
file or the application-jndidatasources.properties
. When configuring external datasources, the externaldatasources
profile should be enabled. When configuration JNDI datasources the jndidatasources
profile should be enabled.
JDBC datasources
### Comments SQL Store ### blueriq.datasource.comments-sql-store.tenants.google.url=jdbc:oracle:thin:@localhost:1521:orcl blueriq.datasource.comments-sql-store.tenants.google.username=google blueriq.datasource.comments-sql-store.tenants.google.password=welcome blueriq.datasource.comments-sql-store.tenants.apple.url=jdbc:oracle:thin:@localhost:1521:orcl blueriq.datasource.comments-sql-store.tenants.apple.username=apple blueriq.datasource.comments-sql-store.tenants.apple.password=welcome blueriq.datasource.comments-sql-store.driverClassName=oracle.jdbc.driver.OracleDriver blueriq.hibernate.comments-sql-store.hbm2ddl.auto=validate blueriq.hibernate.comments-sql-store.dialect=org.hibernate.dialect.Oracle12cDialect ### Process SQL Store ### blueriq.datasource.process-sql-store.tenants.google.url=jdbc:oracle:thin:@localhost:1521:orcl blueriq.datasource.process-sql-store.tenants.google.username=google blueriq.datasource.process-sql-store.tenants.google.password=welcome blueriq.datasource.process-sql-store.tenants.apple.url=jdbc:oracle:thin:@localhost:1521:orcl blueriq.datasource.process-sql-store.tenants.apple.username=apple blueriq.datasource.process-sql-store.tenants.apple.password=welcome blueriq.datasource.process-sql-store.driverClassName=oracle.jdbc.driver.OracleDriver blueriq.hibernate.process-sql-store.hbm2ddl.auto=validate blueriq.hibernate.process-sql-store.dialect=org.hibernate.dialect.Oracle12cDialect ### Trace SQL Store ### blueriq.datasource.trace-sql-store.tenants.google.url=jdbc:oracle:thin:@localhost:1521:orcl blueriq.datasource.trace-sql-store.tenants.google.username=google blueriq.datasource.trace-sql-store.tenants.google.password=welcome blueriq.datasource.trace-sql-store.tenants.apple.url=jdbc:oracle:thin:@localhost:1521:orcl blueriq.datasource.trace-sql-store.tenants.apple.username=apple blueriq.datasource.trace-sql-store.tenants.apple.password=welcome blueriq.datasource.trace-sql-store.driverClassName=oracle.jdbc.driver.OracleDriver blueriq.hibernate.trace-sql-store.hbm2ddl.auto=validate blueriq.hibernate.trace-sql-store.dialect=org.hibernate.dialect.Oracle12cDialect
JNDI datasources
### Comments SQL Store ### blueriq.datasource.comments-sql-store.tenants.google.jndiName=java:/comp/env/jdbc/google blueriq.datasource.comments-sql-store.tenants.apple.jndiName=java:/comp/env/jdbc/apple blueriq.hibernate.comments-sql-store.hbm2ddl.auto=validate blueriq.hibernate.comments-sql-store.dialect=org.hibernate.dialect.Oracle12cDialect ### Process SQL Store ### blueriq.datasource.process-sql-store.tenants.google.jndiName=java:/comp/env/jdbc/google blueriq.datasource.process-sql-store.tenants.apple.jndiName=java:/comp/env/jdbc/apple blueriq.hibernate.process-sql-store.hbm2ddl.auto=validate blueriq.hibernate.process-sql-store.dialect=org.hibernate.dialect.Oracle12cDialect ### Trace SQL Store ### blueriq.datasource.trace-sql-store.tenants.google.jndiName=java:/comp/env/jdbc/google blueriq.datasource.trace-sql-store.tenants.apple.jndiName=java:/comp/env/jdbc/apple blueriq.hibernate.trace-sql-store.hbm2ddl.auto=validate blueriq.hibernate.trace-sql-store.dialect=org.hibernate.dialect.Oracle12cDialect
CMIS
To configure CMIS in a multi-tenant environment, Blueriq supports setting the following properties per tenant:
- user
- password
- servicesUrl
- repositoryId
The rest of the CMIS properties are the same for all tenants. See How to setup a CMIS connection for the further configuration.
Note that it is not necessary to override the above properties for each tenant. If they are not defined for a tenant, the normal (not tenant-specific) properties are used.
Below is a sample configuration for two tenants, where the 'google' tenant uses the standard servicesUrl, while the 'apple' tenant overrides this.
# common blueriq.cmis.services-url=http://host:8080/alfresco/api/-default-/public/cmis/versions/1.1/atom blueriq.cmis.object-type-id=D:my:objectType blueriq.cmis.binding-type=atompub # multi-tenant google blueriq.cmis.tenants.google.user=admin blueriq.cmis.tenants.google.password=adminpass blueriq.cmis.tenants.google.repository-id=google # multi-tenant apple blueriq.cmis.tenants.apple.services-url=http://apple.local:8080/alfresco/api/-default-/public/cmis/versions/1.1/atom blueriq.cmis.tenants.apple.user=apple blueriq.cmis.tenants.apple.password=applepassword blueriq.cmis.tenants.apple.repository-id=apple
Connections
The file system connection requires a different connection to the file system for each tenant. This way of storing data allows the data of different tenants to be stored on the same file system. For long term storage, a better way to store files is to use a DMS (Document Management System) instead. This can be achieved using the CMIS connection.
blueriq.connection.connectionName.filesystem.tenants.google.path=C:/google/files blueriq.connection.connectionName.filesystem.tenants.apple.path=C:/apple/files
Rest & soap
The rest and soap filesystem connections can also be configured for each tenant. Most properties will be the same for each tenant, except for url, username and password. These can be configured for each tenant. In a multi-tenancy setup, two additional (optional) properties are added for soap and rest connections. It is possible to pass the tenant with your rest call, for example when you want to call a BAARS or an external application that is multi-tenant as well. To do this the tenant header should be enabled with the property tenantIdEnabled and the header can be set in the property tenantHeaderName. An example setup will look as follows:
# rest blueriq.connection.RestCall.http.tenantIdEnabled=true blueriq.connection.RestCall.http.tenantHeaderName=Tenant-Id blueriq.connection.RestCall.http.tenants.blueriq.url=http://something blueriq.connection.RestCall.http.tenants.blueriq.username=username blueriq.connection.RestCall.http.tenants.blueriq.password=password # soap blueriq.connection.SoapService.soap.tenantIdEnabled=true blueriq.connection.SoapService.soap.tenantHeaderName=Tenant-Id blueriq.connection.SoapService.soap.tenants.blueriq.url=http://something blueriq.connection.SoapService.soap.tenants.blueriq.username=username blueriq.connection.SoapService.soap.tenants.blueriq.password=password
DCM Lists Client
When multi-tenancy is enabled, the runtime will send the X-TENANT-ID
HTTP header to the DCM lists service whenever an HTTP request is made. To use a separate RabbitMQ instance for each tenant, additional configuration is required in application-dcm-lists-client.properties
.
DCM / Case Engine
The DCM module provides the Service call type: DCM_CaseCreate service call type that you can use to start a case by publishing data on a queue. The Case Engine will consume messages from the queue and start the case asynchronously. Below are examples on how to configure the RabbitMQ instance for each tenant.
A default properties mechanism was added with Blueriq 16.74 because it can be tedious to configure all components of the Runtime with the same properties. The following example shows default rabbitmq properties in a multi-tenant setup. There you can see how you can configure rabbitmq properties per tenant which will then be used for each component that uses rabbitmq instead of specifying it per component. Because queue and exchange names are specific per component you still need to configure them as stated above. This configuration will be used for each component that has no specific properties configured (except the queue and/or exchange names). When neither specific nor default properties are configured for a tenant, the component will try to use the default rabbitmq properties for this tenant. Parameters can be configured at three levels for RabbitMQ or SQL-Datasources and MongoDB: The properties supersede each other from general to more specific. So any properties from the most general level (default properties) will be overwritten by the other more specific levels. Example configuration:Default Multi-tenant RabbitMQ, Datasource & Mongodb properties
blueriq.default.rabbitmq.tenants.google.host=localhost
blueriq.default.rabbitmq.tenants.google.port=5672
blueriq.default.rabbitmq.tenants.google.username=google
blueriq.default.rabbitmq.tenants.google.password=welcome
blueriq.default.rabbitmq.tenants.google.virtualHost=google
blueriq.default.rabbitmq.tenants.google.ssl.enabled=true
blueriq.default.mongodb.tenants.google.host=localhost
blueriq.default.mongodb.tenants.google.port=27017
blueriq.default.mongodb.tenants.google.username=google
blueriq.default.mongodb.tenants.google.password=welcome
blueriq.default.datasource.tenants.google.url=jdbc:oracle:thin:@localhost:1521:orcl
blueriq.default.datasource.tenants.google.username=google
blueriq.default.datasource.tenants.google.password=welcome
blueriq.default.rabbitmq.tenants.apple.host=localhost
blueriq.default.rabbitmq.tenants.apple.port=5672
blueriq.default.rabbitmq.tenants.apple.username=apple
blueriq.default.rabbitmq.tenants.apple.password=welcome
blueriq.default.rabbitmq.tenants.apple.virtualHost=DefaultEverest
blueriq.default.rabbitmq.tenants.apple.ssl.enabled=true
blueriq.default.mongodb.tenants.apple.host=localhost
blueriq.default.mongodb.tenants.apple.port=27017
blueriq.default.mongodb.tenants.apple.username=apple
blueriq.default.mongodb.tenants.apple.password=welcome
blueriq.default.datasource.tenants.apple.url=jdbc:oracle:thin:@localhost:1521:orcl
blueriq.default.datasource.tenants.apple.username=apple
blueriq.default.datasource.tenants.apple.password=welcome
blueriq.default.rabbitmq.*
blueriq.default.datasource.*
blueriq.default.mongodb.*
blueriq.default.rabbitmq.tenants.<tenant_name>.*
blueriq.default.datasource.tenants.<tenant_name>.*
blueriq.default.mongodb.tenants.<tenant_name>.*
blueriq.<component>.<path>.rabbitmq.tenants.<tenant_name>.*
blueriq.datasource.<component>.tenants.<tenant_name>.*
blueriq.<component>.mongodb.tenants.<tenant_name>.*
# Generic level, all sources share the same host and port
blueriq.default.rabbitmq.host=localhost
blueriq.default.rabbitmq.port=5672
blueriq.default.rabbitmq.ssl.enabled=true
# a different user and virtual host is used for each tenant (for all queue connections at this tenant)
blueriq.default.rabbitmq.tenants.google.username=google
blueriq.default.rabbitmq.tenants.google.password=welcome
blueriq.default.rabbitmq.tenants.google.virtualHost=google
blueriq.default.rabbitmq.tenants.apple.username=apple
blueriq.default.rabbitmq.tenants.apple.password=welcome
blueriq.default.rabbitmq.tenants.apple.virtualHost=apple
# different components use different queues, which is most the specific level
blueriq.trace.event.publisher.channel.amqp.rabbitmq.tenants.google.exchangeName=traceEvents
blueriq.trace.event.publisher.channel.amqp.rabbitmq.tenants.apple.exchangeName=traceEvents
# for one specific connection, all settings are overwritten
blueriq.audit.rabbitmq.tenants.google.host=host_x
blueriq.audit.rabbitmq.tenants.google.port=8080
blueriq.audit.rabbitmq.tenants.google.username=google
blueriq.audit.rabbitmq.tenants.google.password=welcome
blueriq.audit.rabbitmq.tenants.google.virtualHost=google
blueriq.audit.rabbitmq.tenants.google.exchangeName=auditEvents
# blueriq.audit.rabbitmq.tenants.google.exchangeName=auditEvents --> no need to specify exchange name because it's taken from blueriq.audit.rabbitmq.exchangeName
blueriq.audit.rabbitmq.tenants.google.host=host_x
blueriq.audit.rabbitmq.tenants.google.port=8080
blueriq.audit.rabbitmq.tenants.google.username=google
blueriq.audit.rabbitmq.tenants.google.password=welcome
blueriq.audit.rabbitmq.tenants.google.virtualHost=google
blueriq.audit.rabbitmq.tenants.google.virtualHost=google
blueriq.audit.rabbitmq.tenants.google.exchangeName=googleAuditEvents