SQL Data Source builder Input - Portlet Factory v6.1.2

Portlet Factory, Version 6.1.2

SQL Data Source builder Input

This topic describes the SQL Data Source builder inputs.
This builder has the following input groups:

Required

A builder name and JNDI Data Source name are the only required inputs.

Verify Connectivity

(optional) When enabled this input instructs the builder to verify that the named DataSource is accessible from the application server on which the model is to be run.

Remote JNDI Server Definition

(optional) These settings allow you to connect and, if necessary, authenticate to a remote JNDI server. You might need to do this if you are developing a model that will run on a server that does not have a local JNDI server as part of its implementation; in most cases, you will never need to specify these settings.

DataSource Authentication And Timeouts

(optional) These settings allow you to override the default authentication of the DataSource and specify timeouts for acquiring connections; in most cases, you will never need to specify these settings.

Events, Statistics and Logging

These settings enable you to collect database-related server statistics and work with database-related events.

Table 1. SQL Data Source builder Input
Input Name Description
Name Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Fetch DataSource Names Press this button to fetch a list of JDBC DataSources defined on the application server supporting IBM® WebSphere Portlet Factory Designer. The list will be inserted as choices for the DataSource Name input. If no DataSource names are listed in the DataSource Name input, then WebSphere Portlet Factory Designer may not be properly configured to query an application server, the server might not be running, or there are no DataSources defined by the application server.
Note: Any valid datasource name can be typed into the DataSource Name builder input. The Fetch Datasource Names button, however, will only list those datasources whose full names begin with jdbc/, jdbc/v4/, or jdbc/v5/. If you know that there is a valid datasource with a name that does not match any of these patterns, type the name in. If the name is correct, it should work.
Note: Depending on the performance of the application server, it might take several seconds to load the list of datasource names.
Note: This button is not displayed if the builder is configured to use an override SQL DataSource.
DataSource Name Enter a JNDI DataSource name. The builder will use this name to locate the DataSource in the JNDI server. This setting is typically something such as: "jdbc/dbname" and it corresponds to the logical name given to the DataSource by the application server where the DataSource was defined.
Verify Connectivity Enabling this input causes the builder to verify that the named DataSource is accessible from the application server on which the model is to be run. The verification is performed when the model containing this builder is regenerated.
Remote JNDI Server Definition (optional)

JNDI Context Factory The context factory class associated with the remote JNDI server from which the named DataSource is to be obtained.
If your application server does not provide a JNDI server, you can use this setting to specify the fully qualified context factory class that is responsible for handling communication with the JNDI server containing the DataSource.
The syntax of this entry depends on the application server or JNDI server you are using. For example, on WebSphere Application Server: com.ibm.ws.naming.util.WsnInitCtxFactory
JNDI URL This URL identifies the port and server on the network where a JNDI server is listening for requests.
For example, on WebSphere Application Server: iiop://host_name:9001
Principal If the JNDI server requires authentication, use this entry to identify a user who has access to the server and is allowed to perform resource lookups on that server.
Note: Application servers handle this input in different ways. For example:

WebSphere Application Server

The Principal and Credentials inputs you provide in this builder will override the ones provided by the datasource on the application server.

Credentials If the JNDI server requires authentication, use this entry to provide the password of the user named as Principal above.
DataSource Authentication And Timeouts (optional)

DataSource User Enter the name of the DataSource user on whose behalf connections are being created.
Note: Application servers handle this input in different ways. For example:

WebSphere Application Server

The user name and password you provide in this builder will override the ones provided by the DataSource on the application server.

DataSource Password Enter the password of the DataSource user.
The note described for the DataSource User input also applies to the DataSource Password input.
Login Timeout Enter the maximum time (in seconds) that the DataSource will wait while attempting to establish a connection to the database.
Acquire Timeout Enter the maximum time (in seconds) to wait for a connection to be returned from the DataSource.
Note: If a connection cannot be returned in the specified amount of time, then a WebAppRuntimeException will be thrown by the builder.
Events, Statistics and Logging (optional)

Log Server Stats Enable this box to generate server statistics for this builder instance. All server statistics are written to server_stats under WEB-INF/logs.
Fire Acquire Events Enable this box to fire an event when a connection is acquired from the DataSource.
Fire Release Events Enable this box to fire an event when a connection is released to the DataSource.

Parent topic: SQL DataSource builder

Library | Support |

Input Name	Description
Name	Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Fetch DataSource Names	Press this button to fetch a list of JDBC DataSources defined on the application server supporting IBM® WebSphere Portlet Factory Designer. The list will be inserted as choices for the DataSource Name input. If no DataSource names are listed in the DataSource Name input, then WebSphere Portlet Factory Designer may not be properly configured to query an application server, the server might not be running, or there are no DataSources defined by the application server. Note: Any valid datasource name can be typed into the DataSource Name builder input. The Fetch Datasource Names button, however, will only list those datasources whose full names begin with jdbc/, jdbc/v4/, or jdbc/v5/. If you know that there is a valid datasource with a name that does not match any of these patterns, type the name in. If the name is correct, it should work. Note: Depending on the performance of the application server, it might take several seconds to load the list of datasource names. Note: This button is not displayed if the builder is configured to use an override SQL DataSource.
DataSource Name	Enter a JNDI DataSource name. The builder will use this name to locate the DataSource in the JNDI server. This setting is typically something such as: "jdbc/dbname" and it corresponds to the logical name given to the DataSource by the application server where the DataSource was defined.
Verify Connectivity	Enabling this input causes the builder to verify that the named DataSource is accessible from the application server on which the model is to be run. The verification is performed when the model containing this builder is regenerated.
Remote JNDI Server Definition (optional)
JNDI Context Factory	The context factory class associated with the remote JNDI server from which the named DataSource is to be obtained. If your application server does not provide a JNDI server, you can use this setting to specify the fully qualified context factory class that is responsible for handling communication with the JNDI server containing the DataSource. The syntax of this entry depends on the application server or JNDI server you are using. For example, on WebSphere Application Server: com.ibm.ws.naming.util.WsnInitCtxFactory
JNDI URL	This URL identifies the port and server on the network where a JNDI server is listening for requests. For example, on WebSphere Application Server: iiop://host_name:9001
Principal	If the JNDI server requires authentication, use this entry to identify a user who has access to the server and is allowed to perform resource lookups on that server. Note: Application servers handle this input in different ways. For example: WebSphere Application Server The Principal and Credentials inputs you provide in this builder will override the ones provided by the datasource on the application server.
Credentials	If the JNDI server requires authentication, use this entry to provide the password of the user named as Principal above.
DataSource Authentication And Timeouts (optional)
DataSource User	Enter the name of the DataSource user on whose behalf connections are being created. Note: Application servers handle this input in different ways. For example: WebSphere Application Server The user name and password you provide in this builder will override the ones provided by the DataSource on the application server.
DataSource Password	Enter the password of the DataSource user. The note described for the DataSource User input also applies to the DataSource Password input.
Login Timeout	Enter the maximum time (in seconds) that the DataSource will wait while attempting to establish a connection to the database.
Acquire Timeout	Enter the maximum time (in seconds) to wait for a connection to be returned from the DataSource. Note: If a connection cannot be returned in the specified amount of time, then a WebAppRuntimeException will be thrown by the builder.
Events, Statistics and Logging (optional)
Log Server Stats	Enable this box to generate server statistics for this builder instance. All server statistics are written to server_stats under WEB-INF/logs.
Fire Acquire Events	Enable this box to fire an event when a connection is acquired from the DataSource.
Fire Release Events	Enable this box to fire an event when a connection is released to the DataSource.