Install and configure the SDO repository

Service Data Objects (SDO) is an open standard for enabling applications to handle data from different data sources in a uniform way, as data graphs. Service integration bus-enabled web services use an SDO repository for storing and serving WSDL definitions. Create and configure your preferred database to store SDO data, and to install and configure an SDO repository on each server that we plan to use for bus-enabled web services.

Determine the servers or clusters on which to install and configure an SDO repository as described in Planning your bus-enabled web services installation, then add each server or cluster as a member of a bus as described in Configure the members of a bus.

An SDO repository can work with most database products. For specific information about choosing and configuring the preferred database, consult the database administrator or database product documentation, and read the notes in this topic on database usage.

To install and configure an SDO repository:

• Install the preferred database product.

• Create a JDBC provider and a data source for our database.

• Run the installSdoRepository.jacl script one or more times, to install the SDO application on each server and to set the database type that the SDO repository is to use.

For more information about how to do this, first read the following notes on database usage and on the installSdoRepository.jacl script, and then complete the steps for one of these configurations:

• Configure the SDO repository for a single server, and to use the embedded Derby database.
• Configure the SDO repository for a single server, and to use a database other than embedded Derby.
• Configure the SDO repository for a network deployment cell.

on database usage:

• (iSeries) For a single server configuration, we can use either your preferred database or the embedded Apache Derby database supplied with WebSphere Application Server. (ZOS) In a z/OS environment we cannot use the embedded Derby database, because this database can be accessed by only one process at a time and even a single server on z/OS can run in multiple processes.

• For a network deployment configuration we can use either your preferred database or the supplied Derby database and associated Network Server application. However, be aware of the limitations of Derby Network Server. For example, it does not support transactions.

• The SDO repository dictates the schema and table names that it uses, so different repositories must use different databases to ensure that they do not access the same data. Use one SDO repository for each cell, so that if we have multiple cells we use multiple databases, one for each cell.

• DB2 on z/OS does not have the concept of multiple databases. On z/OS systems, each SDO repository must use a different DB2 instance to ensure that different repositories do not access the same data.

• Create the database for our preferred database supplier using the Table.ddl file from the relevant app_server_root/util/SdoRepository/database_type directory. The Table.ddl file describes the database table needed by the SDO repository.

• The -editBackendId flag on the installSdoRepository.jacl script determines the database type that the repository is to use. The back end ID determines what database-specific rules the application follows when talking to the database. See the associated note on the installSdoRepository.jacl script.
• Some databases require a user ID that has been granted permissions to access the SDO repository database. Create a user ID for user name SDOREP before creating the tables for Oracle, Sybase, and SQL Server databases. Because of the way these databases handle user names and table names, the user name must be SDOREP to enable the SDO repository to access its table with the fully qualified name SDOREP.BYTESTORE. Make sure that you grant permission for the SDOREP user to read from, and write to, the database.

• If we use an Informix database, do not disable logging.

• The SDO repository does not require XA support. In most cases we can use either an XA or a non-XA data source. However, if the database is Oracle 8 or 9, use the Oracle JDBC driver (non-XA) for the SDO repository data source.

• We might also choose to complete other steps such as creating an index of the primary key to improve database performance. Do not change the schema, table and column names.

• If we are configuring this SDO repository for use with a cell containing a mixture of WAS v6.0, v6.1 and later application servers, we must use a database that is compatible with all these versions.

on the installSdoRepository.jacl script:

• Use the wsadmin scripting client to run the script.

• (iSeries) Run the script from within QShell.

• The script is provided in the app_server_root/bin directory, where app_server_root is the root directory for the installation of WAS. If we choose to run the wsadmin scripting client from another directory, specify the full path to the script on the command option. For example to work with a profile other than the default profile, change to the app_server_root/profiles/profile/bin directory then specify the following path to the script:(iSeries)

  wsadmin -f app_server_root/bin/installSdoRepository.jacl
  

  (Dist) (ZOS)

  wsadmin.ext -f app_server_root/bin/installSdoRepository.jacl
  

  (Dist) (ZOS) where .ext is the file extension .bat for a Windows system, or .sh for a UNIX, Linux or z/OS system.

• The -editBackendId flag on the installSdoRepository.jacl script determines the database type that the repository is to use. The back end ID determines what database-specific rules the application follows when talking to the database. To see the full list of available back end ID values, use the -listBackendIds flag:

  wsadmin -f installSdoRepository.jacl -listBackendIds
  

  All the back end ID values in the list can be used when the SDO repository is installed on one or more WAS v7.0 or later application servers. Values marked with (*) cannot be used when the SDO repository is installed on v6.0 servers. Values marked with (**) cannot be used when the SDO repository is installed on v6.0 or v6.1 servers.

• If the data source already exists, or there has been a previous broken or partial installation of the SDO repository application, the installSdoRepository.jacl script fails to complete and configuration changes are not saved. In these cases, run the SDO repository uninstall script, fix the problem, then rerun the installSdoRepository.jacl script.

Subtopics

• The SDO repository uninstall script
  Use this script to uninstall a Service Data Objects (SDO) repository that was previously installed, or failed to install correctly.
• Bus-enabled web services installation files and locations
  

Related:

SDO data graphs

Start the wsadmin scripting client

Implement JAX-RPC handlers to access SDO messages

Service Data Objects (SDO)

About this task

If we are creating a single server configuration and we want to use embedded Derby, we run the installSdoRepository.jacl script with the -createDb switch. This action creates the Derby database and installs the SDO repository.

To configure the SDO repository for a single server and to use the embedded Derby database:

Tasks

1. Open a command prompt, then change to app_server_root/bin.

2. Enter the following command: (iSeries)

   wsadmin -f installSdoRepository.jacl -createDb
   

   (Dist) (ZOS)

   wsadmin.ext -f installSdoRepository.jacl -createDb
   

   The -createDb flag tells the command to create a default Derby database. If we omit this flag, the command still installs an SDO repository configured to use Derby, but the command does not also create the database.

Configure the SDO repository for a single server, and to use a database other than embedded Derby

About this task

If we are creating a single server configuration that uses a database other than embedded Derby, we install your preferred database product, then create a JDBC provider and a data source, then run the installSdoRepository.jacl script twice:

1. One time to install the SDO application on the application server.

2. One time to set the database type that the SDO repository is to use.

To configure the SDO repository for a single server and to use a database other than embedded Derby:

Tasks

1. Create the database for our preferred database supplier using the Table.ddl file from the relevant app_server_root/util/SdoRepository/database_type directory.

   For an illustration of the process for creating tables in DB2, see Recreating database tables from the exported table data definition language. See Deploy data access (EJB) applications.

2. Create a J2C authentication alias.

   This is for use with the data source that we create in the next step. Check that the authentication alias matches the login details for our database instance, otherwise a connection will not be made.

3. Create and configure a JDBC provider and data source.

   Set the following data source properties:

   • Set the authentication property to use the authentication alias we created in the previous step.

   • Select the Use this Data Source in container managed persistence (CMP) check box.

   • Set the Name property to a name of our own choosing. For example, SDO Repository DataSource.

   • Set the JNDI name property to the following exact value: jdbc/com.ibm.ws.sdo.config/SdoRepository.

   • Set any other properties that are required settings for our chosen database.

4. Optional: Test the data source connection:

   This option does not work in all configurations. The availability of this option depends on the scope at which the data source is defined, and the scope of any WAS variables used in the JDBC provider and data source configurations. For more information about testing connections to data sources, see Test connection service.

   1. In the administrative console, navigate to Resources -> JDBC -> Data sources.

   2. Select the SDO repository data source.

   3. Click Test connection.

5. Configure the SDO repository:

   1. Open a command prompt, then change to app_server_root/bin.

   2. Install the SDO repository application on the server: (iSeries)

      wsadmin -f installSdoRepository.jacl
      

      (Dist) (ZOS)

      wsadmin.ext -f installSdoRepository.jacl
      

   3. Set the database type that the SDO repository is to use:

      (iSeries)

      wsadmin -f installSdoRepository.jacl -editBackendId database_type
      

      (Dist) (ZOS)

      wsadmin.ext -f installSdoRepository.jacl -editBackendId database_type
      

      for example:(iSeries)

      wsadmin -f installSdoRepository.jacl -editBackendId DB2UDB_V82
      

      (Dist) (ZOS)

      wsadmin.ext -f installSdoRepository.jacl -editBackendId DB2UDB_V82
      

Configure the SDO repository for a network deployment cell

About this task

If we are working in a network deployment environment, we install your preferred database product, then create a JDBC provider and a data source, then run the installSdoRepository.jacl script several times for each cell:

1. One time to install the SDO application on the deployment manager.

2. One time to set the database type that the SDO repository is to use.
3. Several times to install an instance of the SDO application on each server or cluster that we plan to use for one or more of the bus-enabled web services roles.

To configure the SDO repository for a network deployment cell:

Tasks

1. Create the database for our preferred database supplier using the Table.ddl file from the relevant app_server_root/util/SdoRepository/database_type directory.

   For an illustration of the process for creating tables in DB2, see Recreating database tables from the exported table data definition language. See Deploy data access (EJB) applications.

2. Create the following node-level WAS variables on all affected nodes, including the deployment manager node.

   We can set these variables at either node or cell scope, depending upon the configuration. However for multi-platform nodes we cannot usefully set WAS_INSTALL_ROOT at cell scope, because the nodes have different installation directories.

   1. In the administrative console, navigate to Environment -> WebSphere variables then set the scope to node level.

   2. Check that the WAS_INSTALL_ROOT variable exists, with a value of the root directory for the installation of WAS.

   3. Create a new variable your_database_JDBC_DRIVER_PATH, with a value of the location under which the database JAR files will be stored (in a later step) on each of the host machines within the cell.

3. Create a J2C authentication alias.

   This is for use with the data source that we create in the next step. Check that the authentication alias matches the login details for our database instance, otherwise a connection will not be made.

4. Create and configure a JDBC provider and data source.

   Set the following data source properties:

   • Set the authentication property to use the authentication alias we created in the previous step.

   • Select the Use this Data Source in container managed persistence (CMP) check box.

   • Set the Name property to a name of our own choosing. For example, SDO Repository DataSource.

   • Set the JNDI name property to the following exact value: jdbc/com.ibm.ws.sdo.config/SdoRepository.

   • Set any other properties that are required settings for our chosen database.

5. Deploy the database client JAR files on each of the host machines within the cell.

   The JAR files must be deployed to the location given by the your_database_JDBC_DRIVER_PATH variable that you declared in a previous step, otherwise remote nodes will not be able to connect to the SDO repository.

6. Configure the SDO repository:

   1. Open a command prompt, then change to app_server_root/bin.

   2. Install the SDO repository application on the deployment manager for this cell: (iSeries)

      wsadmin -f installSdoRepository.jacl deployment_manager_node deployment_manager_server
      

      (Dist) (ZOS)

      wsadmin.ext -f installSdoRepository.jacl deployment_manager_node deployment_manager_server
      

      for example:(iSeries)

      wsadmin -f installSdoRepository.jacl dmgrNode dmgr
      

      (Dist) (ZOS)

      wsadmin.sh -f installSdoRepository.jacl dmgrNode dmgr
      

   3. Set the database type that the SDO repository is to use:

      (iSeries)

      wsadmin -f installSdoRepository.jacl -editBackendId database_type
      

      (Dist) (ZOS)

      wsadmin.ext -f installSdoRepository.jacl -editBackendId database_type
      

      for example:(iSeries)

      wsadmin -f installSdoRepository.jacl -editBackendId DB2UDB_V82
      

      (Dist) (ZOS)

      wsadmin.ext -f installSdoRepository.jacl -editBackendId DB2UDB_V82
      

   4. Install an instance of the SDO repository on each server or cluster that we plan to use for one or more of the bus-enabled web services roles:

      • For each server that is not part of a cluster, repeat the following command:(iSeries)

        wsadmin -f installSdoRepository.jacl node server
        

        (Dist) (ZOS)

        wsadmin.ext -f installSdoRepository.jacl node server
        

      • For each cluster, repeat the following command:(iSeries)

        wsadmin -f installSdoRepository.jacl -cluster cluster_name
        

        (Dist) (ZOS)

        wsadmin.ext -f installSdoRepository.jacl -cluster cluster_name