uCosminexus Service Platform, Setup and Operation Guide
![[Contents]](FIGURE/CONTENT.GIF)
![[Glossary]](FIGURE/GLOSS.GIF)
![[Index]](FIGURE/INDEX.GIF)
![[Back]](FIGURE/FRONT.GIF)
Set up both, DB server and DB client, during database setup.
(a) Settings on the DB server (In HiRDB)
Implement the following operations:
- Setting up the character code for the HiRDB server
- Specify any one of Shift JIS Kanji code, EUC Japanese Kanji code, UTF-8, or single-byte character code as the character code. For details on how to change the character code, see the description related to specifying or selecting character codes in "HiRDB System Installation and Design Guide".
- Note
- When the HCSC server is operated in UNIX, the character codes on the HCSC server and HiRDB server must match.
- Setting up the environment
- For details on HiRDB environment settings, see "HiRDB System Installation and Design Guide".
- Setting up the user permissions
- First, decide the name of the connected user. Thereafter, to save the management information on HiRDB, set up permissions for the users who will be connecting to HiRDB. In HiRDB, a user is created by setting up the CONNECT permission for the user.
- Permissions to be set up
- CONNECT permission
This permission is required for using HiRDB. This permission enables the user to connect (CONNECT) to the database. An error occurs if a user who does not have the CONNECT permission attempts to use HiRDB.
- Define schema permission
This permission is required for defining a schema. If you set up the define schema permission, you can define the schema, tables, view tables, indexes, and abstract data types. You can also register a stored procedure and stored function.
- How to set up the permissions
- Use the database definition utility (pddef) and SQL Executer to set up the permissions. For details on how to set up the permissions, see "HiRDB System Operation Guide". For details on how to use the database definition utility, see "HiRDB Command Reference".
- Procedure to set up the permissions by using the database definition utility:
- Set up the following environment variables:
In Windows
SET PDHOST=<Host name or IP address of HiRDB server>
SET PDNAMEPORT=<Port number of HiRDB server>
SET PDUSER=<Name of the user who has DBA permissions>/<password>
|
In UNIX (Bourne shell)
export PDHOST=<Host name or IP address of HiRDB server>
export PDNAMEPORT=<Port number of HiRDB server>
export PDUSER=<Name of the user who has DBA permissions>/<password>
|
- Execute the database definition utility (pddef) with the following command:
- Execute the following SQL statement:
GRANT CONNECT TO <user name># IDENTIFIED BY <password>;
GRANT SCHEMA TO <user name>#;
|
Note#
The user for whom the permissions are specified is the connected user that the messaging infrastructure uses. The value is the same as the PDUSER environment variable that is registered in the HiRDB client environment variable group.
For details on the PDUSER environment variable, see "Table 3-5 Table Environment variables set up in the environment variable group".
- To terminate the database definition utility (pddef) in Windows, press the [Ctrl] key + [Z] key, and then press the [Enter] key.
To terminate the database definition utility (pddef) in UNIX, press the [Ctrl] key + [D] key, and then press the [Enter] key.
- Defining a schema
- Define the schema to store the management information on HiRDB.
- How to define a schema
- Use the database definition utility (pddef) and SQL Executer to define a schema. For details on how to define a schema, see "HiRDB SQL Reference". For details on how to use the database definition utility, see "HiRDB Command Reference".
- Procedure to define a schema by using the database definition utility:
- Set up the following environment variables:
In Windows
SET PDHOST=<Host name or IP address of HiRDB server>
SET PDNAMEPORT=<Port number of HiRDB server>
SET PDUSER=<User name>#/<password>
|
Note#
The user name to be specified is the name of the user for whom permissions are set up.
In UNIX (Bourne shell)
export PDHOST=<Host name or IP address of HiRDB server>
export PDNAMEPORT=<Port number of HiRDB server>
export PDUSER=<User name>#/<password>
|
Note#
The user name to be specified is the name of the user for whom permissions are set up.
- Execute the database definition utility (pddef) with the following command:
- Execute the following SQL statement:
- To exit the database definition utility (pddef) in Windows, press the [Ctrl] key + [Z] key, and then press the [Enter] key.
To exit the database definition utility (pddef) in UNIX, press the [Ctrl] key + [D] key, and then press the [Enter] key.
- Preparing the RD area
- To store the management information tables of the messaging infrastructure, create the RD area as and when required. For details on how to create an RD area, see "HiRDB System Operation Guide".
- Setting up pd_max_users (number of concurrent users)
- In the operand pd_max_users (number of concurrent users) of the HiRDB system common definition, specify the maximum number of DB connections to be used in the execution environment. For details on specifying this value, see "Table 3-4 Table Number of database connections used in the execution environment".
- For details on pd_max_users, see "HiRDB Version 9 System Definition".
(b) Settings on the DB server (In Oracle)
Implement the following operations:
- Setting up the environment
- For details on the environment settings for Oracle, see the documentation published by the Oracle Corporation.
- Creating the connected users and setting up permissions
- To save the management information on Oracle, you must create the connected users for Oracle, and set up the permissions.
- Setting up the permissions
- Set up the following permissions as the system permissions:
- CREATE ANY INDEX system permission
- CREATE SESSION system permission
- CREATE TABLE system permission
- CREATE VIEW system permission
- FORCE ANY TRANSACTION system permission
- Set up the following permissions as the object permissions:
- SELECT permission for SYS.DBA_PENDING_TRANSACTIONS
- EXECUTE permission for SYS.DBMS_SYSTEM
- Furthermore, set up the following role:
- How to set up the connected users and permissions
- Use the Oracle Enterprise Manager Console, or sqlplus to create the user and set up permissions. An example of settings when using Oracle Enterprise Manager Console and sqlplus is as follows:
-
- Example of settings when the Oracle Enterprise Manager console is used
- Connect to the database as a sys user.
- On the navigator tree, click on [Security], then right click [User], and then select [Create].
- Open the [General] tab, and enter the name and password.
- Open the [Role] tab, delete the CONNECT role, and then add SELECT_CATALOG_ROLE.
- Open the [System] tab and set up the system permissions.
- Open the [Object] tab, select [SYS], [View], and [DBA_PENDING_TRANSACTIONS], and then set up the SELECT permission.
- Select [SYS], [Package], and [DBMS_SYSTEM], and then set up the EXECUTE permission.
- Open the [Limit allocation] tab and set up the allocation limit size for the table area.
- Click the [Create] button.
-
- Example of settings when sqlplus is used
- Connect to the database as a sys user.
- Issue the following SQL statement (The value specified for the QUOTA phrase is an example value).
CREATE USER <Name of the user who is granted permission> PROFILE "DEFAULT"
IDENTIFIED BY <password> DEFAULT TABLESPACE "USERS"
TEMPORARY TABLESPACE "TEMP"
QUOTA 10 M ON "USERS"
ACCOUNT UNLOCK;
GRANT CREATE ANY INDEX TO <Name of the user who is granted permission>;
GRANT CREATE SESSION TO <Name of the user who is granted permission>;
GRANT CREATE TABLE TO <Name of the user who is granted permission>;
GRANT CREATE VIEW TO <Name of the user who is granted permission>;
GRANT FORCE ANY TRANSACTION TO <Name of the user who is granted permission>;
GRANT SELECT ON "SYS"."DBA_PENDING_TRANSACTIONS"
TO <Name of the user who is granted permission>;
GRANT EXECUTE ON "SYS"."DBMS_SYSTEM" TO <Name of the user who is granted permission>;
GRANT SELECT_CATALOG_ROLE TO <Name of the user who is granted permission>;
|
Set up Management Server and specify the environment settings. For details, see the description related to the Management Server operating environment in "4.1.15 Information to be set up for using Management Server" in "Application Server System Setup and Operation Guide". For details on the settings for using HCSC-Manager, see "2.1.6 Management Server settings for using HCSC-Manager".
Note that Management Server and Administration Agent form the base for operating the HCSC server. Therefore, specify the settings so that Management Server and Administration Agent start automatically when the OS starts.
For details on how to set up the settings, see "mngautorun (Setting up and cancelling settings for autostart and auto-restart) " in "Application Server Command Reference Guide".
Use the Smart Composer functionality or management portal functionality to set up PRF.
For details on setting up PRF by using the Smart Composer functionality, see "4.8 Setting up the system using other functionality" in "Application Server System Setup and Operation Guide".
For details on setting up PRF by using the management portal functionality, see "3. Configuration and Deletion of the System that executes J2EE Applications" in "Application Server Management Portal Operation Guide".
Implement the following operations:
(a) Setting up a J2EE server
Use the Smart Composer functionality or management portal functionality to set up a J2EE server.
For details on setting up a J2EE server by using the Smart Composer functionality, see "4.8 Setting up the system using other functionality" in "Application Server System Setup and Operation Guide".
For details on setting up a J2EE server by using the management portal functionality, see "3. Configuration and Deletion of the System that Executes J2EE Applications" in "Application Server Management Portal Operation Guide".
- Note
- During setup, make sure that the logical server name and real server name are the same. If the names are different, HCSC server setup might fail.
(b) Setting up the system environment variables for a J2EE server
For details on how to set up the system environment variables for a J2EE server, see the OS documentation. For details on the items to be checked when the system environment variables are set up, see "4.1.13 Items to be checked when the logical server environment variables are set up" in "Application Server System Setup and Operation Guide".
When using the SOAP1.1 mode, you must specify the default settings for the SOAP Communication Infrastructure. When using the SOAP 1.1/1.2 combined mode, you must specify the default settings for the JAX-WS engine. The procedure for specifying each of the default settings are as follows:
- ? Default settings for using the SOAP1.1 mode
- When using the SOAP1.1 mode, specify the default settings for the SOAP Communication Infrastructure as follows:
- To use WSDL4J that is distributed based on Common Public License Version 1.0, obtain the "wsdl4j.jar" file and copy the file to the following directory:
In <Service Platform installation directory>\c4web\lib
|
- Specify the server definition file (c4websv.cfg).
The following table lists and describes the contents to be specified in the server definition file for the SOAP Communication Infrastructure in a J2EE server operated by the HCSC server. For details on creating the server definition file, see "10.2 Setting up the server definition file" in "Application Server SOAP Application Development Guide".
Table 3-1 TableSettings in the server definition file (SOAP Communication Infrastructure)
| Settings |
Key names |
Set value (default) |
Description |
Multi-
reference |
c4web.common.<identifier>.do_multirefs |
false |
You cannot specify this property when using user-defined receptions. If true is specified, the operations are not guaranteed. |
| Data type definition |
c4web.common.<identifier>.send_xsi_types |
true |
You cannot specify this property when using user-defined receptions. If false is specified, the operations are not guaranteed. |
| Character reference option |
c4web.common.<identifier>.character_reference |
false |
You cannot specify this property when using user-defined receptions. If true is specified, the operations are not guaranteed. |
| Option for checking the qualified name of the SOAP Header |
c4web.common.<identifier>.enable_soapheader_check |
true |
When using user-defined receptions, the option for checking the qualified name of the SOAP Header in the user-defined reception forcefully operates as false. |
| Maintaining an HTTP Session |
c4web.application.<identifier>.app_maintainsession |
false |
You cannot specify this property when using user-defined receptions. If true is specified, the operations are not guaranteed. |
- Hint
- The identifier in an HCSC server is a key used for obtaining the information about a running server from the server definition file. The key uses a name wherein the initial "/" is removed from the context root of the SOAP application deployed on the server. Therefore, in HCSC-Messaging, the key name is as follows:
- Standard reception identifier: Cluster name
- User-defined reception identifier: Reception ID of the user-defined reception
-
- (Example) When the cluster name is "cluster1"
- Standard reception identifier: "cluster1"
- Specify the common definition file (c4webcom.cfg).
The following table lists and describes the contents to be specified in the common definition file for the SOAP Communication Infrastructure in a J2EE server operated by the HCSC server. For details on creating the common definition file, see "10.4 Setting up the common definition file" in "Application Server SOAP Application Development Guide".
Table 3-2 TableSettings in the common definition file (SOAP Communication Infrastructure)
| Settings |
Key names |
Set value (default) |
Description |
| Importance of trace file output |
c4web.logger.log_level |
WARN |
Do not specify DEBUG in this property. If DEBUG is specified, a large amount of memory is consumed and throughput is affected as compared to the specification of another value. |
- œDefault settings for using the SOAP1.1/1.2 combined mode
- When using the SOAP1.1/1.2 combined mode, specify the default settings for the JAX-WS engine as follows:
- Specify the common definition file (cjwconf.properties).
The following table lists and describes the contents to be specified in the common definition file for the JAX-WS engine in a J2EE server operated by the HCSC server. For details on creating the common definition file, see "10.1.2 Settings in the common definition file" in "Application Server Web Service Development Guide".
Table 3-3 TableSettings in the common definition file (JAX-WS engine)
| Settings |
Key names |
Set value (default) |
Description |
| Existence of maintenance of an HTTP Session |
javax.xml.ws.session.maintain |
false |
The operations when true is specified are not guaranteed. |
- Specify the proxy settings for the servers.
For details on how to specify the proxy settings, see "10.10 Connecting via a proxy server" in "Application Server Web Service Development Guide".
(d) Specific settings for setting up an HCSC server
Specify the following in the user property file for J2EE servers (usrconf.properties):
| Property |
Specified content |
| ejbserver.rmi.localinvocation.scope |
Specify "app". |
| ejbserver.server.j2ee.feature |
Specify "1.4". |
| ejbserver.jndi.global.enabled |
Specify "false".
For "true", "KDJE47722-W" is output in the Component Container message log, but Service Coordinator does not use (cannot use) the Portable Global JNDI name, so application startup continues and there is no problem. |
| ejbserver.distributedtx.XATransaction.enabled |
Specify "true" or "false".
Check whether the HCSC server accesses multiple resources (such as DB server), and specify "true" to disable and "false" to enable the light transaction functionality. |
Note that not to specify "true" for ejbserver.DynamicStubLoading.Enabled.
Specify the following settings for the container extension library. For details on how to set up the container extension library, see "14. Container Extension Library" in "Application Server Common Container Functionality Guide".
- When the SOAP1.1 mode is used
<Reliable Messaging installation directory>„lib„reliablemessaging-api.jar
<Service Platform installation directory>„c4web„lib„hitsaaj.jar
|
To disable cjjaxws.jar, comment out or delete the cjjaxws.jar line.
- When the SOAP1.1/1.2 combined mode is used
<Reliable Messaging installation directory>„lib„reliablemessaging-api.jar
<Service Platform installation directory>„jaxws„lib„cjjaxws.jar
|
To disable hitsaaj.jar, comment out or delete the hitsaaj.jar line.
At this time, specify in the format "add.class.path=<jar path>".
You can also specify this definition from the management portal. Specify the class path in the extension parameter on the [J2EE Container Settings] screen of the logical J2EE server specified in "Environment Settings of Logical Servers" in the management portal. The value set up here is applied to the option definition file for J2EE servers (usrconf.cfg).
For details on the option definition file for J2EE servers, see "2.3 usrconf.cfg (Option definition file for J2EE servers) " in "Application Server Definition Reference Guide". For details on the settings specified in the "Environment Settings of Logical Servers", see "10. Environment Settings of Logical Servers" in "Application Server Management Portal Operation Guide".
There are two methods for setting up a Web server (HTTP server), the method of using the in-process HTTP server included in the J2EE server and the method of using HTTP Server.
Implement the following operations:
- Setting up the in-process HTTP server
- For details on system setup, see "Application Server System Setup and Operation Guide".
- Setting up the connection timeout value of the in-process HTTP server
- If the connection pooling functionality is used in the SOAP Communication Infrastructure existing in the service requester, the time required for saving the connection in the service requester must be consistent with the connection timeout value in the HCSC-server operating machine.
- To set up the connection timeout value:
- From the management portal, select [Environment settings of logical servers].
- From the server view, select [Logical J2EE server], [J2EE server], and then [<J2EE server name>].
- In the [HTTP server] tab, select the [Communication or Thread Control] tab.
- The [Communication or Thread Control Settings] screen is displayed.
- In [Web Client Connection Settings], click on [Persistent Connection] and then [Timeout], and specify a value that is equal to or greater than the value specified in the c4web.common.connection_pool.timeout property of the common definition file for the SOAP Communication Infrastructure (Web Services). For example, if the c4web.common.connection_pool.timeout property is not specified, the default value 1800 (unit: seconds) is used for operations, so set up 3600, which is a multiple of this value, as the timeout value.
Note that the timeout value can be specified in the range of 0 to 3600. Therefore, set up 0 if the value specified in the c4web.common.connection_pool.timeout property is greater than 1800.
Implement the following operations:
- Setting up HTTP Server
- For details on how to set up HTTP Server, see "HTTP Server".
- Settings for integrating HTTP Server and J2EE server
- To integrate HTTP Server with a J2EE server, you must set up the parameters for Web server integration in the Easy Setup definition file. For details on the parameters, see "4.13 Parameters that can be specified in a logical Web server" in "Application Server Definition Reference Guide".
- Setting up the KeepAliveTimeout value of HTTP Server
- If the connection pooling functionality is used in the SOAP Communication Infrastructure existing in the service requester, the time required for saving the connection in the service requester must be consistent with the KeepAliveTimeout value in the HCSC-server operating machine.
- In KeepAliveTimeout of httpsd.conf, which is an HTTP Server configuration file, specify a value that is equal to or greater than a multiple of the value specified in the c4web.common.connection_pool.timeout property of the common definition file for the SOAP Communication Infrastructure (Web Services). For example, if the c4web.common.connection_pool.timeout property is not specified, the default value 1800 is used for operations, so set up 3600, which is a multiple of this value, in KeepAliveTimeout.
- Note that the value can be specified in the range of 0 to 65535. For details, see "7.4.2 Settings related to connection pooling" in "Application Server SOAP Application Development Guide".
(a) Settings in the DB client (In HiRDB)
Implement the following operations on the execution environment machine:
- Setting up the environment variables
- Set up the following environment variables in Windows:
- In UNIX, set up the following environment variables as the environment variables to be used for starting the J2EE server operated by the HCSC server and for executing Management Server:
- For details on how to set up the environment variables for starting a J2EE server operated by the HCSC server, see "10.9.24 Setting up the environment variables for J2EE servers" in "Application Server Management Portal Operation Guide".
- For details on how to set up the environment variables for executing Management Server, see "10.9 mserverenv.cfg (Environment variable definition file for Management Server)" in "Application Server Definition Reference Guide".
- PDXAMODE
- Specify 1.
- However, when the light transaction functionality is used, you need not set up PDXAMODE.
- PDTXACANUM
- Specify the maximum number of database connections to be used by Service Platform.
- However, when the light transaction functionality is used, you need not set up PDTXACANUM.
- The maximum value of DB connections must be estimated according to the execution environment to be used. The following table lists and describes the triggers at which the execution environment uses a DB connection and the number of database connections.
Table 3-4 Table Number of database connections used in the execution environment
| Database connection usage destination |
Database connection usage trigger |
Number of database connections used |
| Messaging infrastructure |
At startup |
1 |
| When command is executed |
1 |
| When a service component execution request is received |
Number of concurrently executed service components |
| Business process infrastructure |
When a business process execution request is received |
Number of concurrently executed business processes |
| DB adapter |
When a service component execution request is received |
Number of concurrently executed service components |
| Reliable Messaging |
See "3.4.1 DBMS settings (When HiRDB is used)" in "Reliable Messaging". |
- The total number of DB connections used becomes the maximum value.
- PDLANG or LANG
- When the HCSC server is operated in UNIX, specify the same character code as the HiRDB server in PDLANG or LANG, depending on the HiRDB server character code. For details, see the contents related to PDLANG in "HiRDB UAP Development Guide".
- When the HCSC server is operated in Windows, no settings need be specified.
- LC_CTYPE
- When the HCSC server is operated in UNIX, specify the same character code as the HiRDB server.
- When the HCSC server is operated in Windows, no settings need be specified.
- LD_LIBRARY_PATH
- When the HCSC server is operated in Linux(R) or HP-UX (IPF), add the following path:
- <HiRDB operational directory>/client/lib
Specify this path for installing HiRDB/Single Server, HiRDB/Parallel Server, or HiRDB Server.
- In <HiRDB installation directory>/client/lib
Specify this path for installing HiRDB/Run Time, or HiRDB/Developer's Kit.
- When the HCSC server is operated in Windows, no settings need be specified.
- LIBPATH
- When the HCSC server is operated in AIX, add the following path:
- <HiRDB operational directory>/client/lib
Specify this path for installing HiRDB/Single Server, HiRDB/Parallel Server, or HiRDB Server.
- In <HiRDB installation directory>/client/lib
Specify this path for installing HiRDB/Run Time, or HiRDB/Developer's Kit.
- When the HCSC server is operated in Windows, no settings need be specified.
- Setting up the environment variable group
- To register the environment variable group:
- In Windows
- Select "System Group" with the tool for registering the HiRDB client environment variables, and register the environment variable group. In this case, specify the name of the environment variable group registered here in the DB Connector property definition.
- In UNIX
- Register the group in the configuration file of the HiRDB client environment variable group. In this case, specify the configuration file path of the environment variable group registered here in the DB Connector property definition.
- For details on how to register the environment variable group, see the contents related to the registration of an environment variable group in "HiRDB UAP Development Guide".
- For details on DB Connector properties, see "4.2.2 Defining DB Connector properties" in "Application Server Application Setup Guide".
- The following lists and describes the environment variables set up in the environment variable group.
Table 3-5 Table Environment variables set up in the environment variable group
| Name of the environment variable |
Contents to be set up |
| PDHOST |
Specify the database host name or IP address. |
| PDUSER |
Specify the database user name and database password. |
| PDNAMEPORT |
Specify the database port number. |
| PDSWAITTIME |
Specify a value greater than the Component Container transaction timeout value#. |
| PDCWAITTIME |
Specify a value greater than the Component Container transaction timeout value#. |
| PDSWATCHTIME |
Specify 0. |
- Note#
- Specify the transaction timeout value for Component Container in the user property file for J2EE servers. For details on the transaction timeout value for Component Container, see "8.6.4 Setting up a transaction timeout" in "Application Server System Design Guide".
(b) Settings in the DB client (In Oracle)
Set up Oracle JDBC Thin Driver. For details on the setup for Oracle JDBC Thin Driver, see "3.1.2(7)(b) Setting up Oracle JDBC Thin Driver".
The JDBC driver to be used must be selected after considering the usage conditions.
The following table lists and describes how to select the JDBC driver to be used.
Table 3-6 Table JDBC drivers to be used
| Used DBMS |
Used JDBC driver |
JDBC driver package |
| HiRDB (Version 8 or Version 9)#1 |
HiRDB TYPE4 JDBC Driver |
JP.co.Hitachi.soft.HiRDB.JDBC.HiRDBDriver |
| Oracle |
Oracle JDBC Thin Driver |
- oracle.jdbc.driver.OracleDriver
- oracle.jdbc.OracleDriver#2
|
- Note#1
- When DB Connector for HiRDB Type4 JDBC Driver is used
- Note#2
- When ORACLE11G is specified in the dbtype property of the HCSC server setup definition file
For details on setting up HiRDB Type4 JDBC Driver, see the contents related to HiRDB Type4 JDBC Driver in "HiRDB UAP Development Guide".
Note that you must specify the following settings in order to use the HCSC server:
- Specify the JAR file for HiRDB Type4 JDBC Driver (pdjdbc2.jar) as the class path in <Service Platforminstallation directory>/manager/config/mserver.cfg file. At this time, specify the file in the "web.add.class.path=<Path of pdjdbc2.jar>" format.
- Example 1 (For HiRDB/Run Time)
- web.add.class.path=<HiRDB/Run Time installation directory>/client/lib/pdjdbc2.jar
- Example 2 (For HiRDB/Single Server)
- web.add.class.path=<HiRDB/Single Server installation directory>#/client/lib/pdjdbc2.jar
- Note#
- <HiRDB installation directory> is the directory named hirdb_s.
- Specify the JAR file for HiRDB Type4 JDBC Driver (pdjdbc2.jar) as the class path in the option definition file for J2EE servers (usrconf.cfg). At this time, specify the file in the "add.class.path=<Path of pdjdbc2.jar>" format.
- Example 1 (For HiRDB/Run Time)
- add.class.path=<HiRDB/Run Time installation directory>/client/lib/pdjdbc2.jar
- Example 2 (For HiRDB/Single Server)
- add.class.path=<HiRDB/Single Server installation directory>#/client/lib/pdjdbc2.jar
- Note#
- <HiRDB installation directory> is the directory named hirdb_s.
-
- You can also specify this definition from the management portal. Specify the class path in the extension parameter on the [J2EE Container Settings] screen of the logical J2EE server specified in "Environment Settings of Logical Servers" in the management portal. The value set up here is applied to the option definition file for J2EE servers (usrconf.cfg).
- For details on the option definition file for J2EE servers, see "2.3 usrconf.cfg (Option definition file for J2EE servers)" in "Application Server Definition Reference Guide". For details on the settings specified in the "Environment Settings of Logical Servers", see "10. Environment Settings of Logical Servers" in "Application Server Management Portal Operation Guide".
- Specify the JAR file for HiRDB Type4 JDBC Driver (pdjdbc2.jar) as the class path in the extension parameter on the [J2EE Container Settings] screen of the logical J2EE server specified in "Environment Settings of Logical Servers" in the management portal. At this time, specify in the "add.class.path=<Path of pdjdbc2.jar>" format.
The value set up here is applied to the option definition file for J2EE servers (usrconf.cfg).
For details on specifying settings in the "Environment Settings of Logical Servers", see "10. Environment Settings of Logical Servers" in "Application Server Management Portal Operation Guide".
- Example 1 (For HiRDB/Run Time)
- add.class.path=<HiRDB/Run Time installation directory>/client/lib/pdjdbc2.jar
- Example 2 (For HiRDB/Single Server)
- add.class.path=<HiRDB/Single Server installation directory>#/client/lib/pdjdbc2.jar
- Note#
- <HiRDB installation directory> is the directory named hirdb_s.
-
- Specify the JAR file for HiRDB Type4 JDBC Driver (pdjdbc2.jar) as the class path in HCSC_ADDCLASSPATH of the HCSC-Messaging command definition file.
For details on the HCSC-Messaging command definition file, see "HCSC-Messaging command definition file" in "Service Platform Reference Guide".
For details on setting up Oracle JDBC Thin Driver, see "4.1.7 Setting up the database connection environment (in Oracle)" in "Application Server System Setup and Operation Guide" or the manual for the database being used.
You must specify the following settings in order to use the HCSC server. Note that the type of Oracle JDBC Thin Driver differs depending on the Oracle version in use; therefore, take care when you specify the class path of the JAR file for Oracle JDBC Thin Driver.
- Specify the JAR file for Oracle JDBC Thin Driver as the class path in <Service Platforminstallation directory>/manager/config/mserver.cfg file. At this time, specify the file in the "web.add.class.path=<Path of Oracle JDBC Thin Driver>" format.
- Example (For Oracle 11g (JDK6))
- web.add.class.path=<Oracle Client installation directory>/jdbc/lib/ojdbc6.jar
- Specify the JAR file for Oracle JDBC Thin Driver as the class path in the option definition file for J2EE servers (usrconf.cfg). At this time, specify the file in the "add.class.path=<Path of Oracle JDBC Thin Driver>" format.
- Example (For Oracle 11g (JDK6))
- add.class.path=<Oracle Client installation directory>/jdbc/lib/ojdbc6.jar
You can also specify this definition from the management portal. Specify the class path in the extension parameter on the [J2EE Container Settings] screen of the logical J2EE server specified in "Environment Settings of Logical Servers" in the management portal. The value set up here is applied to the option definition file for J2EE servers (usrconf.cfg).
For details on the option definition file for J2EE servers, see "2.3 usrconf.cfg (Option definition file for J2EE servers)" in "Application Server Definition Reference Guide". For details on the settings specified in the "Environment Settings of Logical Servers", see "10. Environment Settings of Logical Servers" in "Application Server Management Portal Operation Guide".
- Specify the JAR file for Oracle JDBC Thin Driver as the class path in the extension parameter on the [J2EE Container Settings] screen of the logical J2EE server specified in "Environment Settings of Logical Servers" in the management portal. At this time, specify in the "add.class.path=<Path of Oracle JDBC Thin Driver>" format.
The value set up here is applied to the option definition file for J2EE servers (usrconf.cfg).
For details on specifying settings in the "Environment Settings of Logical Servers", see "10. Environment Settings of Logical Servers" in "Application Server Management Portal Operation Guide".
- Example (For Oracle 11g (JDK6))
- add.class.path=<Oracle Client installation directory>/jdbc/lib/ojdbc6.jar
- Specify the JAR file for Oracle JDBC Thin Driver as the class path in HCSC_ADDCLASSPATH of the HCSC-Messaging command definition file.
For details on the HCSC-Messaging command definition file, see "HCSC-Messaging command definition file" in "Service Platform Reference Guide".
HCSC server uses DB Connector to connect to the database. There are cases in which database access is managed or not managed in the transaction depending on the processing timing and table types; therefore, you must prepare two DB Connectors, DB Connector whose transaction support type is XATransaction or LocalTransaction, and DB Connector whose transaction support type is NoTransaction.
Note that for DB Connector whose transaction support type is XATransaction or LocalTransaction, use DB Connector that can be integrated with Reliable Messaging in order to improve the processing performance.
Specify the display name for each DB Connector in "dbcon-xadisplayname" and "dbcon-nodisplayname" of the HCSC server setup definition file. For details on the HCSC server setup definition file, see "HCSC server setup definition file" in "Service Platform Reference Guide".
(a) Importing DB Connector
You must select the DB Connector to be imported after considering the usage conditions. The following table lists and describes how to select the RAR file to be imported.
Table 3-7 TableHow to select the RAR file to be imported (When Reliable Messaging is used)
| Properties in the HCSC server setup definition file |
Used database |
Usage of light transaction functionality |
| Used |
Not used |
| dbcon-xadisplayname |
HiRDB (Version 8 or Version 9)# |
DBConnector_HiRDB_
Type4_CP_Cosminexus_RM.rar |
DBConnector_HiRDB_Type4_
XA_Cosminexus_RM.rar |
| Oracle |
DBConnector_Oracle_CP_
Cosminexus_RM.rar |
DBConnector_Oracle_XA_
Cosminexus_RM.rar |
| dbcon-nodisplayname |
HiRDB (Version 8 or Version 9)# |
DBConnector_HiRDB_Type4_CP.rar |
| Oracle |
DBConnector_Oracle_CP.rar |
- Note#
- When HiRDB Type4 JDBC Driver is used as the JDBC driver.
For details on how to import DB Connector, see "4.2 Settings for connecting to the database" in "Application Server Application Setup Guide". For the property definitions, see "4.1 Connector property file" in "Application Server Application and Resource Definition Reference Guide".
For details on the light transaction functionality, see "3.14.5 Light transaction" in "Application Server Common Container Functionality Guide". For details on how to set up the functionality, see "10.9.7 Setting up a transaction" in "Application Server Management Portal Operation Guide".
When a DB adapter is used, import DB Connector that is used by the DB adapter. The following table lists and describes how to select the RAR file to be imported.
Table 3-8 Table How to select the RAR file to be imported (When a DB adapter is used)
| Used JDBC driver |
Used database |
Usage of light transaction functionality |
| Used |
Not used |
| HiRDB TYPE4 JDBC Driver |
HiRDB (Version 8 or Version 9) |
DBConnector_HiRDB_Type4_CP.rar |
DBConnector_HiRDB_Type4_XA.rar |
| Oracle JDBC Thin Driver |
Oracle |
DBConnector_Oracle_CP.rar |
DBConnector_Oracle_XA.rar |
(b) Defining properties
After you import DB Connector, see "4.1 Connector Property File" in "Application Server Application and Resource Definition Reference Guide" to define the properties. However, you must specify the contents listed in the following table in the properties.
- Note
- The transaction support type (value specified in the <transaction-support> tag) must be the same in DB Connector that can be integrated with Reliable Messaging and DB Connector used with the DB adapter.
- The value specified in the <transaction-support> tag differs as follows depending on whether a light transaction or global transaction is applied:
- When a light transaction is applied to the J2EE server
LocalTransaction
- When a global transaction is applied to the J2EE server
XATransaction
Table 3-9 Table DB Connector property file settings to be specified in dbcon-xadisplayname (Oracle)
| Settings |
Set value |
| <display-name> tag |
DB Connector display name |
| databaseName property specified in the <config-property> tag |
Database name#1 |
| bufSize property specified in the <config-property> tag |
Value greater than the maximum message length used in the system#2 |
| <transaction-support> tag |
XATransaction#3 |
| LocalTransaction#4 |
- Note#1
- The set value differs depending on DB Connector to be used. For details on the set values, see "4.1 Connector Property File" in "Application Server Application and Resource Definition Reference Guide". You must also set up the information required for connecting to the database together with this value.
- Note#2
- The DB Connectors to be used are as follows. Specify these DB Connectors when REAL is specified in the LONGVARBINARY_Access property.
- EDBConnector_DABJ_XA_Cosminexus_RM.rar
- EDBConnector_DABJ_CP_Cosminexus_RM.rar
- Note#3
- When the light transaction functionality is not used, specify this value for the following DB Connectors:
- EDBConnector_DABJ_XA_Cosminexus_RM.rar
- EDBConnector_Oracle_XA_Cosminexus_RM.rar
- Note#4
- When the light transaction functionality is used, specify this value for the following DB Connectors:
- EDBConnector_DABJ_CP_Cosminexus_RM.rar
- EDBConnector_Oracle_CP_Cosminexus_RM.rar
Table 3-10 Table DB Connector property file settings to be specified in dbcon-xadisplayname (HiRDB Type4)
| Settings |
Set value |
| <display-name> tag |
DB Connector display name |
| maxBinarySize property specified in the <config-property> tag |
Value greater than the maximum message length used in the system#1 |
| <transaction-support> tag |
XATransaction#2 |
| LocalTransaction#3 |
- Note#1
- Specify this value when REAL is specified in the LONGVARBINARY_Access property. Make sure you specify a value other than 0.
- Note#2
- When the light transaction functionality is not used, specify this value for the following DB Connectors:
- EDBConnector_HiRDB_Type4_XA_Cosminexus_RM.rar
- Note#3
- When the light transaction functionality is used, specify this value for the following DB Connectors:
- EDBConnector_HiRDB_Type4_CP_Cosminexus_RM.rar
- Note
- Set up the information required for connecting to the database. For details on the set values, see "4.1 Connector Property File" in "Application Server Application and Resource Definition Reference Guide".
Table 3-11 Table DB Connector property file settings to be specified in dbcon-nodisplayname (Oracle)
| Settings |
Set value |
| <display-name> tag |
DB Connector display name |
| databaseName property specified in the <config-property> tag |
Database name#1 |
| bufSize property specified in the <config-property> tag |
Value greater than the maximum message length used in the system#2 |
| <transaction-support> tag |
NoTransaction#3 |
- Note#1
- The set value differs depending on database to be used. For details on the set values, see "4.1 Connector Property File" in "Application Server Application and Resource Definition Reference Guide". You must also set up the information required for connecting to the database together with this value.
- Note#2
- The DB Connectors to be used are as follows. Specify these DB Connectors when REAL is specified in the LONGVARBINARY_Access property.
- EDBConnector_DABJ_CP.rar
- Note#3
- Specify this value when the following DB Connectors are used:
- EDBConnector_DABJ_CP.rar
- EDBConnector_Oracle_CP.rar
Table 3-12 Table DB Connector property file settings to be specified in dbcon-nodisplayname (HiRDB Type4)
| Settings |
Set value |
| <display-name> tag |
DB Connector display name |
| maxBinarySize property specified in the <config-property> tag |
Value greater than the maximum message length used in the system#1 |
| <transaction-support> tag |
NoTransaction#2 |
- Note#1
- Specify this value when REAL is specified in the LONGVARBINARY_Access property. Make sure you specify a value other than 0.
- Note#2
- Specify this value when the following DB Connectors are used:
- EDBConnector_HiRDB_Type4_CP.rar
- Note
- Set up the information required for connecting to the database. For details on the set values, see "4.1 Connector Property File" in "Application Server Application and Resource Definition Reference Guide".
Table 3-13 Table Connector property file settings to be specified when a DB adapter is used
| Settings |
Set value |
| <display-name> tag |
DB Connector display name#1 |
| databaseName property specified in the <config-property> tag |
Database name#2 |
| <transaction-support> tag |
XATransaction |
| LocalTransaction |
- Note#1
- You can also set up this value in the <linked-to> tag of the HITACHI Application Integrated Property File of the DB adapter. For details on the HITACHI Application Integrated Property File, see "3.3.5 Defining a DB adapter" in "Service Platform Reception and Adapter Definition Guide".
- Note#2
- The set value differs depending on DB Connector to be used. For details on the set values, see "4.1 Connector Property File" in "Application Server Application and Resource Definition Reference Guide".
Set up Reliable Messaging. For details on the operations, see "3. System Setup" in "Reliable Messaging". To customize the properties among the setup operations, use the following methods:
(a) Setting up the configuration properties for Reliable Messaging
The following table lists and describes the configuration properties to be set up and the values to be specified. In the authentication information (User and Password), specify the user name and password of the connected user to be used by Reliable Messaging for accessing HiRDB or Oracle.
Table 3-14 Table Configuration properties to be set up and the values to be specified
| Property name |
Specified content |
Set value |
| RMSystemName |
System name |
Specify a system name that is unique in the entire system to be integrated. |
| RMLinkedDBConnectorName |
Display Name of DB Connector to be integrated |
Specify the display Name of DB Connector to be integrated. |
| RMSHConnectFlag |
Existence of a shared queue for reception to be used when applications are integrated between multiple systems by using a shared queue |
When you use standard asynchronous reception (MDB (DB queue)), specify "true".
When you do not use standard asynchronous reception (MDB (DB queue)), or when you are using a database in which a DB queue cannot be used, specify "false". |
| RMTRConnectFlag |
Usage of transmit between queues |
Specify "true". |
| RMMaxDeliveryNum |
Maximum delivery count |
Set up a value other than 0 (1 to 512) (recommended value: 10) |
| RMDeadMessageQueueName |
Name of dead message queue |
Set up an identifier from 1 to 20 characters.
Make sure you use the dead message queue.
Use the dead message queue as the local queue. |
(b) Points to be considered
- Do not change the value of the configuration property "RMWaitRestoration". Operate the property with the default value "true" for Reliable Messaging.
- The dead message queue specified in the dead message queue name "RMDeadMessageQueueName" is a special queue to which the messages, where the delivery count has reached the maximum value and the service components are not invoked, are moved when you use asynchronous standard receptions (MDB (WS-R) and MDB (DB queue)) and asynchronous service adapters (MDB (WS-R) adapter and MDB (DB queue) adapter).
If the dead message queue name is not specified and the dead message queue is not created, note that the processing for invoking the service components is re-executed infinitely.
Create the queue to be used as the dead message queue after Reliable Messaging is set up and starts for the first time.
- When you use Oracle as the database, you cannot use asynchronous standard reception (MDB (DB queue)) and asynchronous MDB (DB queue) adapter.
When using TP1/ RPC reception, set up the TP1 inbound adapter. If the J2EE server has been set up, you can set up the adapter at any time.
For details on the set up of TP1 inbound adapter, see "4.12.2 Setting up a resource adapter" in "Application Server Common Container Functionality Guide". Note that to set up the TP1 inbound adapter, you must set up the HITACHI Connector property definition file.
HCSC server uses DB Connector to connect to the database. There are cases in which database access is managed or not managed in the transaction depending on the processing timing and table types; therefore, you must prepare two DB Connectors, DB Connector whose transaction support type is XATransaction or LocalTransaction, and DB Connector whose transaction support type is NoTransaction.
Note that for DB Connector whose transaction support type is XATransaction or LocalTransaction; use DB Connector that can be integrated with Reliable Messaging in order to improve the processing performance.
Specify the display name for each DB Connector in "dbcon-xadisplayname" and "dbcon-nodisplayname" of the HCSC server setup definition file. For details on the HCSC server setup definition file, see "HCSC server setup definition file" in "Service Platform Reference Guide".
You must select the DB Connector to be imported after considering the usage conditions. The following table lists and describes how to select the RAR file to be imported.
Table 3-15 Table How to select the RAR file to be imported (When database is used and Reliable Messaging is not used)
| Properties in the HCSC server setup definition file |
Used database |
RAR files to be imported |
| dbcon-xadisplayname |
HiRDB
(Version 8 or Version 9)# |
- When the light transaction functionality is used
DBConnector_HiRDB_Type4_CP.rar
- When the light transaction functionality is not used
DBConnector_HiRDB_Type4_XA.rar
|
| Oracle |
- When the light transaction functionality is used
DBConnector_Oracle_CP.rar
- When the light transaction functionality is not used
DBConnector_Oracle_XA.rar
|
| dbcon-nodisplayname |
HiRDB
(Version 8 or Version 9)# |
DBConnector_HiRDB_Type4_CP.rar |
| Oracle |
DBConnector_Oracle_CP.rar |
- Note#
- When using HiRDB Type4 JDBC Driver in JDBC Driver.
When a DB adapter is used, import DB Connector that is used by the DB adapter. The following table lists and describes how to select the RAR file to be imported.
Table 3-16 Table How to select the RAR file to be imported (When a DB adapter is used)
| Used JDBC driver |
Used database |
RAR files to be imported |
| HiRDB TYPE4 JDBC Driver |
HiRDB
(Version 8 or Version 9) |
- When the light transaction functionality is used
DBConnector_HiRDB_Type4_CP.rar
- When the light transaction functionality is not used
DBConnector_HiRDB_Type4_XA.rar
|
| Oracle JDBC Thin Driver |
Oracle |
- When the light transaction functionality is used
DBConnector_Oracle_CP.rar
- When the light transaction functionality is not used
DBConnector_Oracle_XA.rar
|
For details on how to import DB Connector, see "4.2 Settings for connecting to the database" in "Application Server Application Setup Guide". For the property definitions, see "4.1 Connector property file" in "Application Server Application and Resource Definition Reference Guide".
For details on the light transaction functionality, see "3.14.5 Light transaction" in "Application Server Common Container Functionality Guide". For details on how to set up the functionality, see "10.9.7 Setting up a transaction" in "Application Server Management Portal Operation Guide".
(b) Defining properties
After you import DB Connector, see "4.1 Connector Property File" in "Application Server Application and Resource Definition Reference Guide" to define the properties. However, you must specify the contents listed in the following table in the properties.
Table 3-17 Table DB Connector property file settings to be specified in dbcon-xadisplayname (Oracle)
| Settings |
Set value |
| <display-name> tag |
DB Connector display name |
| databaseName property specified in the <config-property> tag |
Database name#1 |
| bufSize property specified in the <config-property> tag |
Value greater than the maximum message length used in the system#2 |
| <transaction-support> tag |
When the light transaction functionality is not used |
XATransaction#3 |
| When the light transaction functionality is used |
LocalTransaction#4 |
- Note#1
- The set value differs depending on DB Connector to be used. For details on the set values, see "4.1 Connector Property File" in "Application Server Application and Resource Definition Reference Guide". You must also set up the information required for connecting to the database together with this value.
- Note#2
- Use the following DB Connectors. Specify these DB Connectors when REAL is specified in the LONGVARBINARY_Access property.
- EDBConnector_DABJ_XA.rar
- EDBConnector_DABJ_CP.rar
- Note#3
- Specify this value for the following DB Connectors:
- EDBConnector_DABJ_XA.rar
- EDBConnector_Oracle_XA.rar
- Note#4
- Specify this value for the following DB Connectors:
- EDBConnector_DABJ_CP.rar
- EDBConnector_Oracle_CP.rar
-
Table 3-18 Table DB Connector property file settings to be specified in dbcon-xadisplayname (HiRDB Type4)
| Settings |
Set value |
| <display-name> tag |
DB Connector display name |
| maxBinarySize property specified in the <config-property> tag |
Value greater than the maximum message length used in the system#1 |
| <transaction-support> tag |
When the light transaction functionality is not used |
XATransaction#2 |
| When the light transaction functionality is used |
LocalTransaction#3 |
- Note#1
- Specify this value when REAL is specified in the LONGVARBINARY_Access property. Make sure you specify a value other than 0.
- Note#2
- Specify this value for the following DB Connector:
- EDBConnector_HiRDB_Type4_XA.rar
- Note#3
- Specify this value for the following DB Connector:
- EDBConnector_HiRDB_Type4_CP.rar
- Note
- Set up the information required for connecting to the database. For details on the set values, see "4.1 Connector Property File" in "Application Server Application and Resource Definition Reference Guide".
-
Table 3-19 Table DB Connector property file settings to be specified in dbcon-nodisplayname (Oracle)
| Settings |
Set value |
| <display-name> tag |
DB Connector display name |
| databaseName property specified in the <config-property> tag |
Database name#1 |
| bufSize property specified in the <config-property> tag |
Value greater than the maximum message length used in the system#2 |
| <transaction-support> tag |
NoTransaction#3 |
- Note#1
- The set value differs depending on database to be used. For details on the set values, see "4.1 Connector Property File" in "Application Server Application and Resource Definition Reference Guide". You must also set up the information required for connecting to the database together with this value.
- Note#2
- Use the following DB Connectors. Specify these DB Connectors when REAL is specified in the LONGVARBINARY_Access property.
- EDBConnector_DABJ_CP.rar
- Note#3
- Specify this value when the following DB Connectors are used:
- EDBConnector_DABJ_CP.rar
- EDBConnector_Oracle_CP.rar
-
Table 3-20 Table DB Connector property file settings to be specified in dbcon-nodisplayname (HiRDB Type4)
| Settings |
Set value |
| <display-name> tag |
DB Connector display name |
| maxBinarySize property specified in the <config-property> tag |
Value greater than the maximum message length used in the system#1 |
| <transaction-support> tag |
NoTransaction#2 |
- Note#1
- Specify this value when REAL is specified in the LONGVARBINARY_Access property. Make sure you specify a value other than 0.
- Note#2
- Specify this value when the following DB Connectors are used:
- EDBConnector_HiRDB_Type4_CP.rar
- Note
- Set up the information required for connecting to the database. For details on the set values, see "4.1 Connector Property File" in "Application Server Application and Resource Definition Reference Guide".
Table 3-21 Table Connector property file settings to be specified when a DB adapter is used
| Settings |
Set value |
| <display-name> tag |
DB Connector display name#1 |
| databaseName property specified in the <config-property> tag |
Database name#2 |
| <transaction-support> tag |
XATransaction |
| LocalTransaction |
- Note#1
- You can also set up this value in the <linked-to> tag of the HITACHI Application Integrated Property File of the DB adapter. For details on the HITACHI Application Integrated Property File, see "3.3.5 Defining a DB adapter" in "Service Platform Reception and Adapter Definition Guide".
- Note#2
- The set value differs depending on DB Connector to be used. For details on the set values, see "4.1 Connector Property File" in "Application Server Application and Resource Definition Reference Guide".
All Rights Reserved. Copyright (C) 2015, Hitachi, Ltd.