Configuration Parameters for JDBC Update Data Services

You can use a JDBC Update data service to create a connection to a database that allows an administrator to save changes to the database. You can use a business rule in conjunction with a JDBC Update data service, but you cannot create data sources in Label Design associated with this type of data service.

Tip: To create a read-only connection to a database or a spreadsheet that can be used in conjunction with Database data sources, use a JDBC data service A connection to a database or spreadsheet that is external to Loftware. A JDBC data service drives Database data sources used in label templates. instead.

The following panels and panes may be displayed when you configure a JDBC Update data service.

Note: A Data Service Administrator can add custom parameters by clicking the Add Parameter button when configuring a Data Service. An administrator can add custom parameters when editing a business rule. See the Advanced section of this topic for more information.

Note: Whether the Is Parameter check boxes in a JDBC Update data service are selected or cleared has no impact.

Ribbon

Ribbon Commands

Icon	Command	Description
	New	Create a new object of a specific type.
	Open	Open an existing object.
	Save	Save the displayed object.
	Delete	Delete the displayed object.
	Undo Edits	Reverse the most recent action on an object.
	Redo	Reapply the previously undone action to an object.

File Menu

Command	Description
Close	Close the current object.
Close All	Close all objects that you have open.
Save	Save the object.
Save As	Save a copy of the object under a different name.
Delete	Delete the displayed object.

Home

Start and Stop Data Service

The Start Data Service and Stop Data Service functions control the availability of the data service to Designers and Data Providers.

Button	Command	Description
	Start Data Service	Make a data service available.
	Stop Data Service	Make a data service unavailable.

View

Properties Pane

The Properties pane allows you to describe the data service. It also displays the type of the data service and status information about the data service.

Option	Description
Service Name	The name for this data service.
Description	A description for this data service.
Data Service Type	The type of data service. JDBC Data Service JDBC Update Data Service File Data Service HTTP Data Service Link Data Service SOAP Web Service Data Service Serial Number Data Service
Configured Status	This property is not displayed until the data service has been saved for the first time. Started Stopped
Status	This property is not displayed until the data service has been saved for the first time. Service Up: The service is online. Service Down: The service is unreachable and possibly offline.
Creation Information	Created By: The user name of the creator of the data service. Created On: The date the data service was created. Modified By: The last user to change the data service Modified On: The date the data service was last changed.

Tags Pane

The Tag Values dialog box is available when viewing an object that supports tags. Click View > Tags to open the dialog box.

You can categorize an application, business rule, data service, device group, facility, field data catalog, form, image, integration, label template, layer object, layout, process, Remote Site, reusable object, user, or workflow template by assigning tags to it. Each tag has a category and a value. For a version-controlled object, tags cannot be changed in a previously checked-in version.

Button	Command	Description
	Assign Tag	Assign a tag to an object. The tag category must already exist.
	Delete Tag	Remove a tag that was assigned to an object.
	Edit Tag	Edit the tag Category and Value.

For more information about using tags, see Categorize a Data Service.

Service Management

Connection

The following options may be displayed in the Connectionpanel for a JDBC Update data service. You can also add custom options.

Parameter	Description
JDBC Connection URL	The connection string for the database used for this data service. This option is displayed only if Is Data Link is not selected. For information about the format, see JDBC Connection URL Formats. Note: In most cases, the Data Service Administrator should clear the Is Parameter check box so that this parameter cannot be configured in Database data sources by Designers.
Database Username	The user name used when establishing a connection to the database. This option is displayed only if Is Data Link is not selected. Note: In most cases, the Data Service Administrator should clear the Is Parameter check box so that this parameter cannot be configured in Database data sources by Designers.
Database Password	The password associated with the user name used when establishing a connection to the database. This option is editable only if Is Data Link is not selected. Note: In most cases, the Data Service Administrator should clear the Is Parameter check box so that this parameter cannot be configured in Database data sources by Designers.
Test URL	A button used to check the connection parameters to a database.
Show Testing Dialog	Select to open a window that will allow you to change and test different connection parameters

General

The following options may be displayed in the General panel for a JDBC Update data service.

Parameter	Description
Is Data Link	Whether to obtain the JDBC Connection URL and credentials from a Link data service. This parameter cannot be displayed or configured in Database data sources. If cleared, the URL and credentials from this JDBC data service are used. If selected, the URL and credentials from the Link data service specified in the Data Link field are used.
Data Link	The Link data service from which to obtain the JDBC Connection URL and credentials. This option is displayed only if Is Data Link is selected. This parameter cannot be displayed or configured in Database data sources.
Read Only Session	If selected, prevents the user from using this connection to make changes to the database during this session. This functionality may vary with the JDBC driver and database software used. Note: In most cases, the Data Service Administrator should clear the Is Parameter check box so that this parameter cannot be configured in Database data sources by Designers.
Session Expiration	Time (specified in seconds) allowed for a Data Provider Person or process that enters data into a form or other data entry view for a label that was configured by a Designer. A user acting as a Data Provider requires the DOCUMENT_PRINTER role or equivalent permissions. to select a row. The default value is 300 seconds.

SQL

Parameter	Description
SQL Query	The SQL query that the data service runs on the database. The query can be entered as part of the data service or can be passed as a parameter from a Database data source used in the label template. Note: If the Data Service Administrator selects the Is Parameter check box so that this parameter can be configured in Database data sources by Designers, then the Data Service Administrator should also select Is Parameter for Result Map.

Advanced

The following options may be displayed in the Advancedpanel for a JDBC Update data service. You can also add custom options.

Parameter	Description
Connection Test Query	A database query to be used for verifying whether the JDBC connection is valid. This query is run automatically during attempts to reestablish a connection to the database after a connection error has occurred. Example For an Oracle database, the following query can be used to test whether the connection to the database is functioning. It does not test a specific table. select 1 from dual
Add Parameter	Allows you to configure custom parameters for the data service. For each parameter that you create, you can configure the following: Variable Name: Name displayed to Data Service Administrators in the Configurationpanel of a data service. For a JDBC data service, if you select Is Parameter after you create the parameter, the Variable Name is also displayed to a Designer who creates a Database data source associated with this data service. Data Type: Whether the variable must resolve to a String, Integer, Number, Boolean, Character Large Object (CLOB Character Large Object. A data type designed to store a large amount of character data.), or Binary Large Object (BLOB Binary Large Object. A data type designed to store a large amount of binary data, such as an image.) value. After you have added a parameter, it is displayed in the Configurationpanel. Regardless of the data type selected, a text box is displayed in the data service so that a Data Service Administrator or a Designer can enter a data source to connect to the parameter. A message indicating the required data type is displayed to the Data Service Administrator or Designer when that individual begins to type in the text box for that parameter. For a JDBC data service, selecting the Is Parameter check box for a parameter allows Designers who use the data service to customize that parameter for each Database data source. Clearing the Is Parameter check box hides the parameter from Designers. A Data Service Administrator can delete a parameter created as part of the data service. The parameter is removed from existing Database data sources even if Is Parameter is selected. The default parameters cannot be deleted. Note: While configuring a Database data source, a Designer can add a custom parameter by clicking the Add Parameter Field button. A Designer can also delete parameters added to the Database data source.
JDBC Update Results	Required. The name of the data map entry A name (key) and value pair in the data map for a job. to contain the data returned by the data service. The value cannot be empty. If deleted, it is reset to its default value, JDBC_RESULT.

Parameter

Description

Connection Test Query

A database query to be used for verifying whether the JDBC connection is valid. This query is run automatically during attempts to reestablish a connection to the database after a connection error has occurred.

Example

For an Oracle database, the following query can be used to test whether the connection to the database is functioning. It does not test a specific table.

select 1 from dual

Add Parameter

Allows you to configure custom parameters for the data service. For each parameter that you create, you can configure the following:

Variable Name: Name displayed to Data Service Administrators in the Configurationpanel of a data service. For a JDBC data service, if you select Is Parameter after you create the parameter, the Variable Name is also displayed to a Designer who creates a Database data source associated with this data service.
Data Type: Whether the variable must resolve to a String, Integer, Number, Boolean, Character Large Object (CLOB Character Large Object. A data type designed to store a large amount of character data.), or Binary Large Object (BLOB Binary Large Object. A data type designed to store a large amount of binary data, such as an image.) value.

After you have added a parameter, it is displayed in the Configurationpanel. Regardless of the data type selected, a text box is displayed in the data service so that a Data Service Administrator or a Designer can enter a data source to connect to the parameter. A message indicating the required data type is displayed to the Data Service Administrator or Designer when that individual begins to type in the text box for that parameter.

For a JDBC data service, selecting the Is Parameter check box for a parameter allows Designers who use the data service to customize that parameter for each Database data source. Clearing the Is Parameter check box hides the parameter from Designers.

A Data Service Administrator can delete a parameter created as part of the data service. The parameter is removed from existing Database data sources even if Is Parameter is selected. The default parameters cannot be deleted.

Note: While configuring a Database data source, a Designer can add a custom parameter by clicking the Add Parameter Field button. A Designer can also delete parameters added to the Database data source.

JDBC Update Results

Required. The name of the data map entry A name (key) and value pair in the data map for a job. to contain the data returned by the data service.

The value cannot be empty. If deleted, it is reset to its default value, JDBC_RESULT.