Chapter 3. Business application configuration

Procedure

1. Unzip the <business-application>.zip file and navigate to the <business-application>/<business-application>-service/src/main/resources folder.
2. Open the application.properties file in a text editor.

3. Configure the host, port, and path for the REST endpoints, for example:

   server.address=localhost
   server.port=8090
   
   cxf.path=/rest

4. Configure the Process Server (kieserver) so that it can be easily identified, for example:

   kieserver.serverId=<business-application>-service
   kieserver.serverName=<business-application>-service
   kieserver.location=http://localhost:8090/rest/server
   kieserver.controllers=http://localhost:8080/business-central/rest/controller

   The following table lists the Process Server parameters that you can configure in your business application:

   Table 3.1. kieserver parameters

   Parameter	Values	Description
   kieserver.serverId	string	The ID used to identify the business application when connecting to the Process Automation Manager controller.
   kieserver.serverName	string	The name used to identify the business application when connecting to the Process Automation Manager controller. Can be the same string used for the kieserver.serverId parameter.
   kieserver.location	URL	Used by other components that use the REST API to identify the location of this server. Do not use the location as defined by server.address and server.port.
   kieserver.controllers	URLs	A comma-separated list of controller URLs.

5. To enable asynchronous execution, set the value of the jbpm.executor.enabled parameter to true, uncomment the other jbpm.executor parameters, and change the values as required, for example:

   jbpm.executor.enabled=true
   jbpm.executor.retries=5
   jbpm.executor.interval=0
   jbpm.executor.threadPoolSize=1
   jbpm.executor.timeUnit=SECONDS

   The following table lists the executor parameters that you can configure in your business application:

   Table 3.2. Executor parameters

   Parameter	Values	Description
   jbpm.executor.enabled	true, false	Disables or enables the executor component.
   jbpm.executor.retries	integer	Specifies the number of retries if errors occur while a job is running.
   jbpm.executor.interval	integer	Specifies the length of time that the executor uses to synchronize with the database. The unit of time is specified by the jbpm.executor.timeUnit parameter. Disabled by default (value 0).
   jbpm.executor.threadPoolSize	integer	Specifies the thread pool size.
   jbpm.executor.timeUnit	string	Specifies the time unit used to calculate the interval that the executor uses to synchronize with the database. The value must be a valid constant of java.util.concurrent.TimeUnit. The default value is SECONDS.

6. If you selected Business Automation when you created your business application, specify which of the following components that you want to start at runtime:

   Table 3.3. kieserver capabilities parameters

   Parameter	Values	Description
   kieserver.drools.enabled	true, false	Enables or disables the Decision Manager component.
   kieserver.dmn.enabled	true, false	Enables or disables the Decision Model and Notation (DMN) component.
   kieserver.jbpm.enabled	true, false	Enables or disables the Red Hat Process Automation Manager component.
   kieserver.jbpmui.enabled	true, false	Enables or disables the Red Hat Process Automation Manager UI component.
   kieserver.casemgmt.enabled	true, false	Enables or disables the case management component.

Procedure

1. Download and install RH SSO. For instructions, see the Red Hat Single Sign-On Getting Started Guide.

2. Configure RH SSO:

   1. Either use the default master realm or create a new realm.
   2. Create the springboot-app client and set the AccessType to public.

   3. Set a valid redirect URI and web origin according to your local setup, for example:

      • Valid redirect URIs: http://localhost:8090/*
      • Web origin: http://localhost:8090
   4. Create realm roles that are used in the application.
   5. Create users that are used in the application and assign roles to them.

3. Add the following dependencies to the service project pom.xml file:

   <dependencyManagement>
     <dependencies>
       <dependency>
         <groupId>org.keycloak.bom</groupId>
         <artifactId>keycloak-adapter-bom</artifactId>
         <version>${version.org.keycloak}</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
     </dependencies>
   </dependencyManagement>
   
     ....
   
   <dependency>
     <groupId>org.keycloak</groupId>
     <artifactId>keycloak-spring-boot-starter</artifactId>
   </dependency>

4. Update the application.properties file:

   # keycloak security setup
   keycloak.auth-server-url=http://localhost:8100/auth
   keycloak.realm=master
   keycloak.resource=springboot-app
   keycloak.public-client=true
   keycloak.principal-attribute=preferred_username
   keycloak.enable-basic-auth=true

5. Modify the DefaultWebSecurityConfig.java file to ensure that Spring Security works correctly with RH SSO:

   import org.keycloak.adapters.KeycloakConfigResolver;
   import org.keycloak.adapters.springboot.KeycloakSpringBootConfigResolver;
   import org.keycloak.adapters.springsecurity.authentication.KeycloakAuthenticationProvider;
   import org.keycloak.adapters.springsecurity.config.KeycloakWebSecurityConfigurerAdapter;
   import org.springframework.beans.factory.annotation.Autowired;
   import org.springframework.context.annotation.Bean;
   import org.springframework.context.annotation.Configuration;
   import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
   import org.springframework.security.config.annotation.web.builders.HttpSecurity;
   import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
   import org.springframework.security.core.authority.mapping.SimpleAuthorityMapper;
   import org.springframework.security.core.session.SessionRegistryImpl;
   import org.springframework.security.web.authentication.session.RegisterSessionAuthenticationStrategy;
   import org.springframework.security.web.authentication.session.SessionAuthenticationStrategy;
   
   @Configuration("kieServerSecurity")
   @EnableWebSecurity
   public class DefaultWebSecurityConfig extends KeycloakWebSecurityConfigurerAdapter {
   
       @Override
       protected void configure(HttpSecurity http) throws Exception {
           super.configure(http);
           http
           .csrf().disable()
           .authorizeRequests()
               .anyRequest().authenticated()
               .and()
           .httpBasic();
       }
   
       @Autowired
       public void configureGlobal(AuthenticationManagerBuilder auth) throws Exception {
           KeycloakAuthenticationProvider keycloakAuthenticationProvider = keycloakAuthenticationProvider();
           SimpleAuthorityMapper mapper = new SimpleAuthorityMapper();
           mapper.setPrefix("");
           keycloakAuthenticationProvider.setGrantedAuthoritiesMapper(mapper);
           auth.authenticationProvider(keycloakAuthenticationProvider);
       }
   
       @Bean
       public KeycloakConfigResolver KeycloakConfigResolver() {
          return new KeycloakSpringBootConfigResolver();
       }
   
       @Override
       protected SessionAuthenticationStrategy sessionAuthenticationStrategy() {
           return new RegisterSessionAuthenticationStrategy(new SessionRegistryImpl());
       }
   }

Procedure

1. Create the quartz.properties file and add the following content:

   #============================================================================
   # Configure Main Scheduler Properties
   #============================================================================
   org.quartz.scheduler.instanceName = SpringBootScheduler
   org.quartz.scheduler.instanceId = AUTO
   org.quartz.scheduler.skipUpdateCheck=true
   org.quartz.scheduler.idleWaitTime=1000
   #============================================================================
   # Configure ThreadPool
   #============================================================================
   org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool
   org.quartz.threadPool.threadCount = 5
   org.quartz.threadPool.threadPriority = 5
   #============================================================================
   # Configure JobStore
   #============================================================================
   org.quartz.jobStore.misfireThreshold = 60000
   org.quartz.jobStore.class=org.quartz.impl.jdbcjobstore.JobStoreCMT
   org.quartz.jobStore.driverDelegateClass=org.jbpm.process.core.timer.impl.quartz.DeploymentsAwareStdJDBCDelegate
   org.quartz.jobStore.useProperties=false
   org.quartz.jobStore.dataSource=myDS
   org.quartz.jobStore.nonManagedTXDataSource=notManagedDS
   org.quartz.jobStore.tablePrefix=QRTZ_
   org.quartz.jobStore.isClustered=true
   org.quartz.jobStore.clusterCheckinInterval = 5000
   #============================================================================
   # Configure Datasources
   #============================================================================
   org.quartz.dataSource.myDS.connectionProvider.class=org.jbpm.springboot.quartz.SpringConnectionProvider
   org.quartz.dataSource.myDS.dataSourceName=quartzDataSource
   org.quartz.dataSource.notManagedDS.connectionProvider.class=org.jbpm.springboot.quartz.SpringConnectionProvider
   org.quartz.dataSource.notManagedDS.dataSourceName=quartzNotManagedDataSource

   Note

   Data source names in the Quartz configuration file refer to Spring beans. The connection provider must be set to org.jbpm.springboot.quartz.SpringConnectionProvider to enable integration with Spring-based data sources.

2. Include the following properties in the <business-application>/<business-application>-service/src/main/resourcesapplication.properties file to enable the Quartz clustered timers and set the path of the quartz.properties file that you created in the previous step:

   jbpm.quartz.enabled=true
   jbpm.quartz.configuration=quartz.properties

3. Create a managed and an unmanaged data source by adding the following content to the <business-application>/<business-application>-service/src/main/resources/application.properties file:

   # enable to use database as storage
   jbpm.quartz.db=true
   
   quartz.datasource.name=quartz
   quartz.datasource.username=sa
   quartz.datasource.password=sa
   quartz.datasource.url=jdbc:h2:./target/spring-boot-jbpm;MVCC=true
   quartz.datasource.driver-class-name=org.h2.Driver
   
   # used to configure connection pool
   quartz.datasource.dbcp2.maxTotal=15
   
   # used to initialize quartz schema
   quartz.datasource.initialization=true
   spring.datasource.schema=classpath*:<QUARTZ_TABLES_H2>.sql
   spring.datasource.initialization-mode=always

   In the preceding example, replace <QUARTZ_TABLES_H2> with the name of a Quartz H2 database schema script. The last three lines of the preceding configuration initialize the database schema.

Procedure

1. To provide an alternative implementation of UserGroupCallback, add the following code to the Application class or a separate class annotated with @Configuration:

   @Bean(name = "userGroupCallback")
   public UserGroupCallback userGroupCallback(IdentityProvider identityProvider) throws IOException {
       return new MyCustomUserGroupCallback(identityProvider);
   }

2. To provide an alternative implementation of UserInfo, add the following code to the Application class or a separate class annotated with @Configuration:

   @Bean(name = "userInfo")
   public UserInfo userInfo() throws IOException {
       return new MyCustomUserInfo();
   }

Procedure

1. Unzip the <business-application>.zip file and navigate to the <business-application>/business-application-service/src/main/resources folder.
2. Open the application.properties file in a text editor.

3. To configure your business application to use a MySQL database, find the following parameters in the application.properties file and change the values as shown:

   spring.datasource.username=jbpm
   spring.datasource.password=jbpm
   spring.datasource.url=jdbc:mysql://localhost:3306/jbpm
   spring.datasource.driver-class-name=com.mysql.jdbc.jdbc2.optional.MysqlXADataSource
   
   spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5InnoDBDialect

4. To configure your business application to use a PostgreSQL database, find the following parameters in the application.properties file and change the values as shown:

   spring.datasource.username=jbpm
   spring.datasource.password=jbpm
   spring.datasource.url=jdbc:postgresql://localhost:5432/jbpm
   spring.datasource.driver-class-name=org.postgresql.xa.PGXADataSource
   
   spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect

5. Save the application.properties file.

Procedure

1. Unzip the <business-application>.zip file and navigate to the <business-application>/<business-application>-service/src/main/resources folder.
2. Open the application.properties file in a text editor.

3. Find the following parameters in the application.properties file and verify that they have the values shown:

   spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.H2Dialect
   spring.jpa.properties.hibernate.show_sql=false
   spring.jpa.properties.hibernate.hbm2ddl.auto=update
   spring.jpa.hibernate.naming.physical-strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl

4. If your business application has business automation capabilities, you can add entities to the entity manager factory by adding a comma-separated list of packages:

   spring.jpa.properties.entity-scan-packages=org.jbpm.springboot.samples.entities

   Business applications with business automation capabilities create an entity manager factory based on the persistence.xml file that comes with Red Hat Process Automation Manager. All entities found in the org.jbpm.springboot.samples.entities package are automatically added to the entity manager factory and used the same as any other JPA entity in the application.

Procedure

1. Unzip the <business-application>.zip file and navigate to the <business-application>/<business-application>-service folder.
2. Open the service project pom.xml file in a text editor.

3. Add the following dependencies to the service project pom.xml file and save the file.

   <dependency>
     <groupId>org.apache.cxf</groupId>
     <artifactId>cxf-rt-rs-service-description-swagger</artifactId>
     <version>3.2.6</version>
   </dependency>
   <dependency>
     <groupId>io.swagger</groupId>
     <artifactId>swagger-jaxrs</artifactId>
     <version>1.5.15</version>
     <exclusions>
       <exclusion>
         <groupId>javax.ws.rs</groupId>
         <artifactId>jsr311-api</artifactId>
       </exclusion>
     </exclusions>
   </dependency>

4. To enable the Swagger UI (optional), add the following dependency to the pom.xml file and save the file.

   <dependency>
     <groupId>org.webjars</groupId>
     <artifactId>swagger-ui</artifactId>
     <version>2.2.10</version>
   </dependency>

5. Open the <business-application>/<business-application>-service/src/main/resources/application.properties file in a text editor.

6. Add the following line to the application.properties file to enable Swagger support:

   kieserver.swagger.enabled=true