Properties

The following properties are used by DB-to-JMS:

Table 1. Properties used by DB-to-JMS
Property Name	Type	Description
curam.batchlauncher.dbtojms.enabled	BOOLEAN	Default value is `false`. When this is set to `true`, batch programs can make use of deferred processing and workflow.
curam.batchlauncher.dbtojms.notification.host	STRING	Specifies the name of the host on which the application server is running. This is the same as the port on which the IBM Cúram Social Program Management client is listening. Batch programs require this information in order to trigger the DB-to-JMS conversion by calling `DBtoJMS`. `beginTransfer()`.
curam.batchlauncher.dbtojms.notification.port	INTEGER	Specifies the port number on which the application server is listening. This is the same as the port on which the client is listening. See property curam.batchlauncher.dbtojms.notification.host for more details.
curam.batchlauncher.dbtojms.notification.ssl	BOOLEAN	Default value is `true`. Specifies that the client application is listening on SSL (i.e. uses HTTPS). This determines whether the Batch Launcher uses HTTP or HTTPS to notify the application server to begin a transfer. Note that if a HTTPS notification fails, a HTTP notification is automatically attempted. This is to simplify switching between production mode which uses SSL and development mode which does not, without having to change the value of this property. See property curam.batchlauncher.dbtojms.notification.host for more details.
curam.batchlauncher.dbtojms.notification.encoding	STRING	Specifies the character encoding used on the application server. This is only required if the application server is using a different character encoding to that of the batch launcher, and the batch launcher or batch program triggers the DB-to-JMS conversion by calling `DBtoJMS`. `beginTransfer()`.
curam.batchlauncher.dbtojms.notification.batchlaunchermode	INTEGER	Default value is 0 (zero). Specifies the DB-to-JMS notification mode for the batch launcher. The following values are valid 0 No DB-to-JMS notification is performed by the batch launcher. 1 One DB-to-JMS notification is performed by the batch launcher after all batch programs have been run, or if a single standalone batch program has been run by specifying the batch.program property. 2 A DB-to-JMS notification is performed by the batch launcher after each batch program is run, or if a single standalone batch program has been run by specifying the batch.program property. Note that if this property is set to `1` or `2` then properties curam.batchlauncher.dbtojms.notification.host and curam.batchlauncher.dbtojms.notification.port must be set.
curam.batchlauncher.dbtojms.notification.disabled.in.standalone	BOOLEAN	Default value is `false`. Specifies that the batch launcher does not perform a DB-to-JMS notification when run in standalone mode i.e. when the batch launcher is used to launch a standalone operation by specifying property batch.program.
curam.batchlauncher.dbtojms.messagespertransaction	INTEGER	Default value is 512. Specifies the maximum number of messages to be processed per transaction when transferring pending messages from the database table to their JMS queues.
curam.batchlauncher.dbtojms.notification.test.stubtrigger	BOOLEAN	Default value is `false`. When this is set to `true`, calls by batch programs or the Batch Launcher to `DBtoJMS`. `beginTransfer()` are stubbed out and take no effect. i.e. this property prevents the method from attempting to contact an application server. This is to enable debugging of batch programs in the event of an application server being unavailable.
curam.custom.deferredprocessing.dpcallback	STRING	Mandatory. Specifies the name of a custom callback class which implements interface `curam.util.deferredprocessing.impl.DPCallback`. DB-to-JMS uses deferred processing, and this property must be set if deferred processing is used anywhere in the application. Method `dpHandleError` of this class will be called whenever the deferred process used by DB-to-JMS fails. The developers implementation of this method must take appropriate action in the event of the deferred process failing, such as sending an email or assigning a new task to a user.

Note: The property curam.test.stubdeferredprocessing¹, which is used internally by the SDEJ, can interfere with the operation of DB-to-JMS and must not be set.

Note: When switching the application between a production and deployment environment note that this may affect the host and port on which the application listens. For example WebSphere Application Server may use a different port to Apache Tomcat. Therefore it may be necessary to change properties curam.batchlauncher.dbtojms.notification.host and curam.batchlauncher.dbtojms.notification.port each time you change environment.

¹ Consult the Cúram Server Developer's Guide for more information on the Offline Unit-Testing of Deferred Processes.