Copyright © Cloud Software Group, Inc. All Rights Reserved

JDBC Update

Activity

The JDBC Update activity performs the specified SQL INSERT, UPDATE, or DELETE statement.

If this activity is not part of a transaction group, the SQL statement is committed after the activity completes. If this activity is part of a transaction group, the SQL statement is committed or rolled back with the other JDBC activities in the group at the end of the transaction. See TIBCO ActiveMatrix BusinessWorks Process Design for more information about creating groups for transactions.

If you want to override the default behavior of transaction groups for certain JDBC activities in a transaction group, you can check the Override Transaction Behavior field on the Advanced tab. This specifies that the activity is outside of the transaction and the SQL statement is committed when the activity completes, even if the activity is in a transaction group.

Configuration

The Configuration tab has the following fields:

Field	Global Var?	Description
Name	No	The name to appear as the label for this field in the process definition.
Description	No	Short description of the activity.
JDBC Connection	Yes	Path to the shared configuration resource containing the JDBC connection information. See JDBC Connection for more information.
SQL Statement	Yes	The SQL INSERT, UPDATE, or DELETE statement to perform.
Timeout (sec)	Yes	The time to wait for the statement to complete.
Prepared Parameters	No	See Prepared Parameters for a description of this field.

Prepared Parameters

If you want to replace static names in the SQL statement with process variables, you must edit the SQL statement field and replace the variable items with a question mark (?). For example, you might specify the following statement:

 

UPDATE emp SET ename = ?, phone = ?
   WHERE id = ?

The ? replaces the value, and you can then provide input to the SQL statement from process data on the input tab.

When you add or remove question marks in SQL statements, a warning appears to the right of the Prepared Parameters field ("SQL/ Prepared Parameter Count Mismatch") to alert you to add or remove corresponding prepared parameters. Each prepared parameter corresponds to the question mark in the same position in the SQL statement. That is, the first prepared parameter in the list corresponds to the first question mark, the second prepared parameter in the list corresponds to the second question mark, and so on. The warning is for informational purposes only, you must make sure the parameters in this field correctly correspond to the SQL statement.

You can optionally specify names for each prepared parameter. By default, the prepared parameters are named Prepared_Param_1, Prepared_Param_2, and so on.

You must supply the datatype of each parameter to the SQL statement, and this datatype is used in the input schema for the statement. You can use the up or down arrow keys to move a specified datatype to the previous or next parameter. You can also select a contiguous set of parameters to move them up or down, or delete them with the delete button.

At run time, any parameters you place in the SQL statement are replaced with the mapped values for those parameters.

Any mappings or expressions you create on the Input tab are not updated when you move or delete prepared parameters. You must manually update the Input tab after changing the prepared parameter field.

For INSERT and DELETE statements, all prepared parameters appear as required items in the Input tab. For UPDATE statements, all prepared parameters appear as optional in the Input tab, but you must supply a value for at least one column in the statement or a runtime error occurs.

Advanced

The Advanced tab has the following fields:

Field	Global Var?	Description
Override Transaction Behavior	Yes	Overrides the default behavior of a transaction group. If this activity is in a transaction group, the activity is normally committed or rolled back with the other transactional activities. If this check box is selected, this activity is not part of the transaction group and is committed when it completes. Checking this option uses a separate database connection to perform the activity and commit the SQL statement.
Interpret Empty String as Null	No	Specifies how empty strings in the activity’s input elements should be handled. When the field is checked, nulls are sent to the database where empty strings are supplied. When the field is unchecked, empty strings are treated as zero-length strings. Whether you use this field or not, you can still use XPath to set input elements explicitly to null. Note: Many databases treat empty strings and nulls as the same, so this field will not affect how the database interprets empty strings.
Batch Update	No	Checking this field signifies you want to perform multiple statements by supplying an array of records as input to the activity where each record matches the prepared parameters for the statement. The statements are performed in one batch at the end of the activity’s execution. This field is only meaningful if there are prepared parameters in the SQL statement (see Prepared Parameters). If this field is not checked, the expected input is the list of prepared parameters for the statement (no array of records). Some database drivers may not support batch updates. A JDBCSQLException is thrown if the database driver does not support batch updates.

Input

The input for the activity is the following:

Input Item	Datatype	Description
Record	repeating	When batch updates are performed, the list of prepared parameters are contained in a repeating element. When only one update is performed, the list of prepared parameters appears as individual input elements. See the description of the Batch Update field on the Advanced tab for more information about batch updates.
Prepared_Param_* (name corresponds to name specified in the Prepared Parameters field on the Configuration tab)	varies	The list of the prepared parameters supplied in the SQL statement. Prepared parameters allow you to substitute process data for items in the SQL statement. See the description of the Prepared Parameters field on the Configuration tab.
ServerTimeZone	string	Specifies the time zone for the database server. See Time Zone Construction for more information about how time zones are constructed using this field. You can use the Constants tab in the XPath Formula Builder to supply a valid time zone name. The list of time zone names is generated from java.util.TimeZone.getAvailableIDs(). See Time Zone Names for the list of valid time zone names.
timeout	number	Time (in seconds) to wait for the statement to complete.

Output

The output for the activity is the following:

Output Item	Datatype	Description
noOfUpdates	integer	The number of updates performed by the statement specified on the Configuration tab. This element can also return -2 that indicates, in the event of a batch update, that the updates were successful, but it is unknown how many updates were performed.
Elapsed Time	long	This field displays the time taken for the execution of the activity in milliseconds. This is an optional element that appears only when the property java.property.bw.activity.output.stats.elapsedTime.JDBCUpdateActivity is set to true in designer.tra. For run-time, set the property to true in the bwengine.tra file. By default, the property is set to false. If set in the design-time, this property must be carried forward to the run-time; else it can cause run-time errors. Enabling this property causes additional performance overhead. Hence, it is recommended that you use this property only when this information is to be consumed by some other ActiveMatrix BusinessWorks activity. Also, it is recommended that this property be used only in a non-production environment as a diagnostic tool and the property be turned off at run-time. You can turn off the property and not calculate the elapsed time at run-time by setting the property java.property.bw.activity.output.stats.elapsedTime.turnoff in the bwengine.tra file. However, note that setting this property will turn off the calculation of elapsed time at run-time for all the JDBC activities.

Error Output

The Error Output tab lists the possible exceptions that can be thrown by this activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information about error codes and corrective action to take.

Exception	Thrown When...
JDBCDriverLoadingException	An error occurred when loading the specified JDBC driver.
InvalidSQLTypeException	A parameter’s datatype does not match the datatype of the table column.
JDBCConnectionNotFoundException	An error occurred when attempting to connect to the specified database.
InvalidTimeZoneException	An invalid timezone was specified. See Time Zone Names for a list of valid timezones.
JDBCSQLException	A SQL error occurred.
JDBCTimedOutException	The operation has timed out.
LoginTimedOutException	A timeout has occurred while attempting to connect to the database.

Copyright © Cloud Software Group, Inc. All Rights Reserved