Connecting to z/OS Connect
Run the z/OS Connect Configuration Wizard to create the XML fragments used to connect the Data Virtualization Manager server to your z/OS Connect environment.
Before you begin
If you are using RACF, in order for the z/OS Connect server and the Data Virtualization Manager server to connect and function properly, CBIND resource classes are required. For more information, see RACF CBIND resource classes.
About this task
The z/OS Connect Configuration Wizard is used to provide the z/OS Connect systems programmer with the Data Virtualization information to include in the z/OS Connect server.xml file. If you do not have all of the information that the wizard prompts you to enter, you can choose to exclude that information from being generated. Completing this wizard is optional.
Procedure
- To start the z/OS Connect Configuration Wizard, in the Studio Navigator click z/OS Connect Configuration.
-
The z/OS Connect Configuration page displays the default IBM Data Virtualization Manager for z/OS service provider settings. You can choose to
complete the following Data Virtualization configuration fields (all blank fields are optional):
Section Fields HTTP Endpoint Enter the following Data Virtualization Manager server HTTP endpoint port numbers to use when connecting to a z/OS Connect server: - HTTP Port
- HTTPS Port
Exclude this fragment: If you already have the HTTP endpoint settings configured in a server.xml file or if you do not know the HTTP port numbers, you can choose to exclude this information from being generated.
WOLA Enter the names to use to identify a specific z/OS Connect instance or a region in which to connect. To identify a Data Virtualization Manager server on a z/OS Connect instance, enter the following information: - Register Name: Identifies a specific path between the Data Virtualization Manager server and a z/OS Connect instance. The name
must be unique and it must match the
RNAMEparameter name that is defined in the Data Virtualization Manager server IN00 file. - WOLA Group Name: The name of the WOLA group to use. The name must be
unique and it must match the
WNAMEparameter name that is defined in the Data Virtualization Manager server IN00 file.
JDBC Data Virtualization Manager server z/OS connect service provider supports JDBC TCP/IP for Restful services. Enter the following values to support the JDBC configuration while generating the server.xml: - Pool Size Max Total: The maximum connections allowed in the connection pool.
- Pool Size Max Idle: The maximum idle connections allowed in the connection pool.
- Pool Size Max Statements: The maximum statements can be handled in the connection pool.
- Include Service UserId/Password: Select the checkbox to use the jdbcServiceUserID or jdbcServiceUserPassword for service registration during server startup. If the checkbox is not selected, registration occurs when the dvs/refresh command is invoked. By selecting this checkbox, the jdbcServiceUserID or jdbcServiceUserPassword is generated in the server.xml file.
Note:If you wish to exclude the z/OS connect JDBC configuration support, select the Disable JDBC support checkbox. This will remove any JDBC configuration in server.xml and restore it to WOLA. Selecting this checkbox will disable the JDBC configuration.
Security SAF Group: Enter the z/OS Connect SAF group name.
Exclude this fragment: If you already have the SAF group name configured in the z/OS Connect server.xml file or if you do not know the name, you can choose to exclude this information from being generated.
-
Click Finish.
Review the results that display in the XML Editor and make any necessary modifications. You can copy XML fragments from the generated server.xml file into the z/OS Connect server.xml file. You can also choose to export and send the generated server.xml file to the appropriate z/OS Connect systems programmer.
The following shows the results of a sample server.xml file with JDBC configuration enabled:
<?xml version="1.0" encoding="UTF-8"?> <!-- Sample z/OS Connect Server Configuration for the DVS Service Provider. This is not a complete server.xml file. It contains several XML sections that you can copy and paste into your actual server.xml file on the host. --> <server> <!-- HTTP Endpoint Details --> <httpEndpoint httpsPort="12346" httpPort="12345" host="*" id="defaultHttpEndpoint"/> <!-- Enable SAF Security with Group Name (ZCONUSER) --> <webAppSecurity allowFailOverToBasicAuth="true"/> <safRegistry id="saf"/> <safAuthorization id="saf2"></safAuthorization> <zosconnect_zosConnectManager globalInvokeGroup="ZCONUSER" globalOperationsGroup="<!-- Adapter Details with WOLA Group Name (RDVWOLA) --> <zosLocalAdapters wolaName3="NAME3" wolaName2="NAME2" wolaGroup="RDVWOLA"/> <!-- DVS Service Details with Register Name (DVSR1) --> <zosconnect_zosConnectService invokeURI="/dvs" serviceDescription="" serviceRef="dvsService" serviceName="dvsService" id="zosConnectDvsService"/> < usr_dvsService id="dvsService" invokeURI="/dvs" serviceName="DVSS1" registerName="DVSR1" connectionFactoryRef="wolaCF"/> <connectionFactory jndiName="eis/ola" id="wolaCF"> <properties.ola/> </connectionFactory> <zosconnect_zosConnectService serviceRef="svc1" serviceAsyncRequestTimeout="600s" serviceName="dvs1" id="sdef1"/> <zosconnect_localAdaptersConnectService connectionWaitTimeout="7200" connectionFactoryRef="wolaCF" serviceName="DVSS1" registerName="DVSR1" id="svc1"/> <zosconnect_zosConnectManager id="dvsy1" requireSecure="false" requireAuth="true" preserveJsonObjectPayloadOrder="true" asyncRequestTimeout="600s"/> </server> JDBC connector configuration The jdbcServiceUser and jdbcServicePassword are needed for enabling Services Registration on Server startup, else registration will happen when dvs/refresh is invoked. The jdbcServiceUser and jdbcServicePassword will be used only for the service registration and startup. -\-> <usr_dvsService invokeURI="/dvs" serviceName="DVSS1" registerName="DVS-REGISTER" connectionFactoryRef="wolaCF" id="dvsService" connectorType="JDBC" jdbcHost="rs28" jdbcPort="16180" poolMaxTotal="100" poolMaxIdle="20" poolMaxStatements="200" jdbcServiceUser="input service user id" jdbcServicePassword="input service user password"/>The following shows the results of a sample server.xml file with JDBC configuration disabled:
<?xml version="1.0" encoding="UTF-8"?> <!-- Sample z/OS Connect Server Configuration for the DVS Service Provider. This is not a complete server.xml file. It contains several XML sections that you can copy and paste into your actual server.xml file on the host. --> <server> <!-- HTTP Endpoint Details --> <httpEndpoint httpsPort="12346" httpPort="12345" host="*" id="defaultHttpEndpoint"/> <!-- Enable SAF Security with Group Name (ZCONUSER) --> <webAppSecurity allowFailOverToBasicAuth="true"/> <safRegistry id="saf"/> <safAuthorization id="saf2"></safAuthorization> <zosconnect_zosConnectManager globalInvokeGroup="ZCONUSER" globalOperationsGroup="<!-- Adapter Details with WOLA Group Name (RDVWOLA) --> <zosLocalAdapters wolaName3="NAME3" wolaName2="NAME2" wolaGroup="RDVWOLA"/><!-- DVS Service Details with Register Name (DVSR1) --> <zosconnect_zosConnectService invokeURI="/dvs" serviceDescription="" serviceRef="dvsService" serviceName="dvsService" id="zosConnectDvsService"/> < usr_dvsService id="dvsService" invokeURI="/dvs" serviceName="DVSS1" registerName="DVSR1" connectionFactoryRef="wolaCF" connectorType="JDBC" jdbcPort="16180" poolMaxTotal="100" poolMaxIdle="20" poolMaxStatements="200" jdbcHost="rs28" jdbcProperties="Charset=IBM037" jdbcServiceUser="user1" jdbcServicePassword="p***" /> <connectionFactory jndiName="eis/ola" id="wolaCF"> <properties.ola/> </connectionFactory> <zosconnect_zosConnectService serviceRef="svc1" serviceAsyncRequestTimeout="600s" serviceName="dvs1" id="sdef1"/> <zosconnect_localAdaptersConnectService connectionWaitTimeout="7200" connectionFactoryRef="wolaCF" serviceName="DVSS1" registerName="DVSR1" id="svc1"/> <zosconnect_zosConnectManager id="dvsy1" requireSecure="false" requireAuth="true" preserveJsonObjectPayloadOrder="true" asyncRequestTimeout="600s"/> </server> JDBC connector configuration The dvs?refresh needs to be invoked for the Registration of the services after the Server startup. --> <usr_dvsService invokeURI="/dvs" serviceName="DVSS1" registerName="DVS-REGISTER" connectionFactoryRef="wolaCF" id="dvsService" connectorType="JDBC" jdbcHost="rs28" jdbcPort="16180" poolMaxTotal="100" poolMaxIdle="20" poolMaxStatements="200"/> <connectionFactory jndiName="eis/ola" id="wolaCF"> <properties.ola/> </connectionFactory> <zosconnect_zosConnectService serviceRef="svc1" serviceAsyncRequestTimeout="600s" serviceName="dvs1" id="sdef1"/> <zosconnect_localAdaptersConnectSerProcedure to enable JDBC TCP/IP Web service connector in z/OS Connect server.xml
To set the JDBC TCP/IP web service connector configuration, edit the generated server.xml file and add the following JDBC connector parameters:
Parameter Description Mandatory/Optional connectorType Specify the connector type as JDBC.
Note: The WOLA configurations can co-exist, and they will not be accessed or used if connectorType is set to JDBC.Mandatory jdbcPort Specify the port on which the DVM server listens for the incoming JDBC requests. Mandatory jdbcHost Specify the host where the DVM server is located. If not specified, the z/OS Connect host will be used as the DVM host.
Optional jdbcServiceUser Specify the ServiceUserId to be used to connect to the DVM server to register the service during the z/OS Connect server startup. If the ServiceUserId is not provided, the dvs/refresh command is used to register the services before they are used.
Optional jdbcServicePassword Specify the ServicePassword to be used to connect to the DVM server to register the service during the z/OS Connect server startup. If the ServicePassword is not provided, the dvs/refresh command is used to register the services before they are used. Optional poolMaxTotal Specify the maximum size for the JDBC connection pool. The size will be determined by the number of concurrent requests.
The default value is 100.
Optional poolMaxIdle Specify the maximum idle connections to be retained in the JDBC connection pool.
The default value is 20.
Optional poolMaxStatements Specify the maximum statements to be retained in the statement pool.
The default value is 200.
Optional jdbcProperties Specify the JDBC connection properties to override.
For more details about the properties, refer JDBC Connection Properties.
Optional Note:- Do not use /dvs for a base path name while creating APIs in the IBM Data Studio. This causes a conflict as /dvs is used as the invokeURI attribute for the service provider on zcEE.
- After the service provider is deployed and configured, z/OS Connect initializes the services if the required JDBC connector configurations, namely, jdbcPort, jdbcServiceUser, and jdbcServicePassword, are available. If the configurations are not available, the <i>http://<host>:<port>/dvs?refresh</i> needs to be executed first for the services to be registered, before executing the first service to retrieve the required values.