This documentation is for WSO2 API Manager 2.0.0 View documentation for the latest release.
Setting up OpenEdge - API Manager 2.0.0 - WSO2 Documentation
Provide Feedback
||
Skip to end of metadata
Go to start of metadata

The following sections describe how to set up the default H2 database with OpenEdge:

Setting up the database and users

Follow the steps below to set up an OpenEdge (OE) database.

  1. Download and install OpenEdge on you computer.
  2. Go to the <OE_HOME>/bin/ directory and use the proenv script to set up the environment variables. 
  3. Add <OE_HOME>/java/prosp.jar to the CLASSPATH environment variable.
  4. Create an empty database using the prodb script as follows. This script creates a database by copying an existing database provided with the installation.
    prodb CARBON_DB <OE-installation-directory>/empty8
  5. Start the database using the proserve script as follows. Provide the database name and a port as arguments to this script using the -db and -S parameters.
    proserve -db CARBON_DB -S 6767
  6. Use the sqlexp script to start the default SQL explorer that comes with the OpenEdge installation. Connect to the database you just created by using the -db and -S parameters as follows:
    sqlexp -db CARBON_DB -S 6767
  7. Use the following commands to create a user and grant that user the required permissions to the database:

    CREATE USER 'wso2carbon','wso2carbon';
    GRANT dba,resource TO 'wso2carbon';
    COMMIT;
  8. Log out from the SQL explorer by typing the following command: exit

Setting up the drivers

Copy the <OE_HOME>/java/openedge.jar file to your WSO2 product's <PRODUCT_HOME>/repository/components/lib/ directory. 

Setting up datasource configurations

A datasource is used to establish the connection to a database. By default, WSO2_CARBON_DB datasource is used to connect to the default  H2 database, which stores registry and user management data. After setting up the OpenEdge database to replace the default H2 database, either change the default configurations of the WSO2_CARBON_DB datasource, or configure a new datasource to point it to the new database as explained below.

Changing the default WSO2_CARBON_DB datasource

Follow the steps below to change the type of the default WSO2_CARBON_DB datasource.

  1. Edit the default datasource configuration in the <PRODUCT_HOME>/repository/conf/datasources/m aster-datasources.xml file as shown below.

    <datasource>
         <name>WSO2_CARBON_DB</name>
         <description>The datasource used for registry and user manager</description>
         <jndiConfig>
               <name>jdbc/WSO2CarbonDB</name>
         </jndiConfig>
         <definition type="RDBMS">
               <configuration>
                   <url>jdbc:datadirect:openedge://localhost:6767;databaseName=CARBON_DB</url>
                   <username>regadmin</username>
                   <password>regadmin</password>
                   <driverClassName>com.ddtek.jdbc.openedge.OpenEdgeDriver</driverClassName>
                   <maxActive>80</maxActive>
                   <maxWait>60000</maxWait>
                   <minIdle>5</minIdle>
                   <testOnBorrow>true</testOnBorrow>
                   <validationQuery>SELECT 1</validationQuery>
                   <validationInterval>30000</validationInterval>
    			   <defaultAutoCommit>false</defaultAutoCommit>
               </configuration>
         </definition>
    </datasource>

    The elements in the above configuration are described below:

    ElementDescription
    urlThe URL of the database. The default port for a DB2 instance is 50000.
    username and passwordThe name and password of the database user
    driverClassNameThe class name of the database driver
    maxActiveThe maximum number of active connections that can be allocated  at the same time from this pool. Enter any negative value to denote an unlimited number of active connections.
    maxWaitThe maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception. You can enter zero or a negative value to wait indefinitely.
    minIdleThe minimum number of active connections that can remain idle in the pool without extra ones being created, or enter zero to create none.

    testOnBorrow  

    The indication of whether objects will be validated before being borrowed from the pool. If the object fails to validate, it will be dropped from the pool, and another attempt will be made to borrow another.
    validationQueryThe SQL query that will be used to validate connections from this pool before returning them to the caller.
    validationIntervalThe indication to avoid excess validation, and only run validation at the most, at this frequency (time in milliseconds). If a connection is due for validation, but has been validated previously within this interval, it will not be validated again.
    defaultAutoCommit

    This property is not applicable to the Carbon database in WSO2 products because auto committing is usually handled at the code level, i.e., the default auto commit configuration specified for the RDBMS driver will be effective instead of this property element. Typically, auto committing is enabled for an RDBMS drivers by default.

    When auto committing is enabled, each SQL statement will be committed to the database as an individual transaction, as opposed to committing multiple statements as a single transaction.

    For more information on other parameters that can be defined in the <PRODUCT _HOME>/repository/conf/datasources/ master-datasources.xml file, see Tomcat JDBC Connection Pool.

Configuring new  datasources to manage registry or user management data

Follow the steps below to configure new datasources to point to the new  databases you create to manage registry and/or user management data separately.

  1. Add a new datasource with similar configurations as the WSO2_CARBON_DB datasource above to the <PRODUCT_HOME>/repository/conf/datasources/ master-datasources.xml file. Change its elements with your custom values. For instructions, see Setting up datasource configurations.
  2. If you are setting up a separate database to store registry-related data, update the following configurations in the <PRODUCT_HOME>/repository/conf/ registry.xml file.

    <dbConfig name="wso2registry">
    	<dataSource>jdbc/MY_DATASOURCE_NAME</dataSource>
    </dbConfig>
  3. If you are setting up a separate database to store user management data, update the following configurations in the <PRODUCT_HOME>/repository/conf/ user-mgt.xml file.

    <Configuration>
    	<Property name="dataSource">jdbc/MY_DATASOURCE_NAME</Property>
    </Configuration>

Creating database tables

To create the database tables, connect to the database that you created earlier and run the following scripts

  • To create tables in the registry and user manager database (WSO2CARBON_DB), use the below script:

    <PRODUCT_HOME>/dbscripts/openedge.sql

Follow the steps below to create the database tables by executing the scripts.

  1. Modify the OpenEdge script provided with the product to create the tables manually. Make a backup of the <PRODUCT_HOME>/dbscripts/openedge.sql script under the name openedge_manual.sql.
  2. Replace all the "/" symbols in the openedge_manual.sql script with the ";" symbol.
  3. At the end of the openedge_manual.sql script, add the following line and save the script:
    COMMIT;
  4. Run the modified script using the SQL explorer as follows:
    sqlexp -db CARBON_DB -S 6767 -user wso2carbon -password wso2carbon <PRODUCT_HOME>/dbscripts/openedge_manual.sql
  5. Restart the server.

    You can create database tables automatically when starting the product for the first time by using the -Dsetup parameter as follows:

    • For Windows: <PRODUCT_HOME>/bin/wso2server.bat -Dsetup

    • For Linux: <PRODUCT_HOME>/bin/wso2server.sh -Dsetup

  • No labels