Preparing to deploy the Web Gateway with WebSphere Application Server Version 7.0

Use these instructions to define required resources before deploying the WebSphere® MQ File Transfer Edition Web Gateway enterprise application to WebSphere Application Server Version 7.0. You must customize the example deployment plan for your environment.

Before you begin

Before configuring or using the Web Gateway, refer to Scenarios for the Web Gateway and How the Web Gateway fits into your WebSphere MQ File Transfer Edition topology. These topics explain the purpose and components of the Web Gateway.

To check that you are using an application server version that is supported for use with the Web Gateway, refer to the web page WebSphere MQ File Transfer Edition System Requirements.

Note: The user that your application server runs as must be the same as, or in the same group as, the user that your web agent runs as.
Before starting your application server setup, complete the following tasks to prepare your WebSphere MQ environment for working with the Web Gateway.
Determine which user ID the application server uses to connect to WebSphere MQ. This user ID must be given the Set identity context permission in your WebSphere MQ environment. For example, if the application server is running as appuser1, who is a member of group appgrp, and connecting to a local WebSphereMQ queue manager called qm1 using a bindings mode connection, then run the following command:
setmqaut -m qm1 -g appgrp +setid -t qmgr
You must also give the user ID the Set identity context permission on the web agent command queue. For example, if the application server is running as appuser1, who is a member of group appgrp, and the web agent is called WEBAGENT and it connects to a local WebSphereMQ queue manager called qm2 using a bindings mode connection, then run the following command:
setmqaut -m qm2 -g appgrp +setid -t queue -n SYSTEM.FTE.COMMAND.WEBAGENT

About this task

Before deploying the Web Gateway application, you must carry out the following tasks to set up the application server environment. For transfer status information, the Web Gateway application requires access to a database that is written to by a WebSphere MQ File Transfer Edition database logger. See Configuring a WebSphere MQ File Transfer Edition logger for instructions on how to set up the database and use the database logger application. To access this database from within a WebSphere Application Server Version 7.0 environment you must define a Java™ Database Connectivity (JDBC) provider and data source.

The Web Gateway also requires a WebSphere MQ File Transfer Edition web agent installed on the same system as the application and run as the same user, or a user in the same group, as the application server. For instructions on how to create and configure this agent, see fteCreateWebAgent (create a WebSphere MQ File Transfer Edition web agent).

Note: Several times during the following steps, the WebSphere Application Server Version 7.0 administrative console prompts you to save your configuration. When you are prompted, save your configuration.

Procedure

  1. If you plan to connect the Web Gateway or web agent to a queue manager in bindings mode, you must set the native library path. For information about how to set the native library path in WebSphere Application Server Version 7.0, see Setting the native library path in WebSphere Application Server Version 7.0.
  2. Enable the correct level of security in WebSphere Application Server Version 7.0. To do this perform the following steps:
    1. Select Security > Global security.
    2. Ensure that Enable administrative security is selected.
    3. Ensure that Enable application security is selected.
    4. Ensure that Use Java 2 security to restrict application access to local resources is not selected.
    5. Click Apply.
  3. Define a JNDI queue connection factory:
    1. Select Resources > JMS > Queue connection factories from the WebSphere Application Server Version 7.0 or later administration console navigation.
    2. Select the Scope drop-down list and change the scope to the appropriate value. For example, Node=yourNode, Server=yourServer.
    3. Create a queue connection factory using the console wizard, by clicking New.
    4. Select WebSphere MQ messaging provider, and click OK.
    5. At Step 1 of the wizard, in the Name field, enter WMQFTEWebAgentConnectionFactory and in the JNDI name field, enter jms/WMQFTEWebAgentConnectionFactory. Click Next.
    6. At Step 2 of the wizard, select Enter all the required information into this wizard, and click Next.
    7. At Step 2.1 of the wizard, in the Queue manager or queue sharing group name field, enter the name of the queue manager that the Web Gateway agent connects to, and click Next.
    8. At Step 2.2 of the wizard, enter the connection details of the queue manager that the Web Gateway agent connects to, and click Next.
    9. At Step 3 of the wizard, click Test Connection. Click Next.
    10. At Step 4 of the wizard, review the summary information and click Finish.
    11. On the Queue connections factories panel, select the resource you created.
    12. In the Advanced section, ensure that the Support distributed two phase commit protocol check box is selected.
      Note: Ensure you have completed this step before proceeding. Failure to do so can cause the Web Gateway to fail to operate correctly.
  4. Define a JNDI queue:
    1. Select Resources > JMS > Queues from the WebSphere Application Server Version 7.0 or later administration console navigation.
    2. Select the Scope drop-down list and change the scope to the appropriate value. For example, Node=yourNode, Server=yourServer.
    3. Create a queue using the console wizard, by clicking New.
    4. Select WebSphere MQ messaging provider, and click OK.
    5. At Step 1 of the wizard, in the Name field, enter WMQFTEWebAgentRequestQueue. In the JNDI name field, enter jms/WMQFTEWebAgentRequestQueue. In the Queue name field, enter SYSTEM.FTE.WEB.gateway_name. The variable gateway_name is the name that you choose to give to the Web Gateway instance. In the Queue manager or queue sharing group name field, enter the name of the queue manager that the Web Gateway agent connects to, and click OK.
  5. Define an activation specification:
    1. Select Resources > JMS > Activation specification from the WebSphere Application Server Version 7.0 or later administration console navigation.
    2. Select the Scope dropdown list and change the scope to the appropriate value. For example, Node=yourNode, Server=yourServer.
    3. Create an activation specification using the console wizard, by clicking New.
    4. Select WebSphere MQ messaging provider, and click OK.
    5. At Step 1 of the wizard, in the Name field, enter WMQFTEActivationSpec and in the JNDI name field, enter jms/WMQFTEActivationSpec. Click Next.
    6. At Step 1.1 of the wizard, in the Destination JNDI name field, enter jms/WMQFTEWebAgentRequestQueue, from the Destination type dropdown list, select Queue, and click Next.
    7. At Step 2 of the wizard, select Enter all the required information into this wizard, and click Next.
    8. At Step 2.1 of the wizard, in the Queue manager or queue sharing group name field, enter the name of the queue manager that the Web Gateway agent connects to, and click Next.
    9. At Step 2.2 of the wizard, enter the connection details of the queue manager that the Web Gateway agent connects to, and click Next.
    10. At Step 3 of the wizard, click Test Connection. Click Next.
    11. At Step 4 of the wizard, review the summary information and click Finish.
    12. Click the name of the Activation Specification that you have just created. In the Additional Properties section of the Configuration tab, click Advanced Properties. In the Connection Consumer section of the Advanced Properties panel, enter 1 into the Maximum server sessions field.
      Note: Ensure you have completed this step before proceeding. Failure to do so can cause the Web Gateway to fail to operate correctly.
  6. Define a JDBC provider. If you have already deployed a JEE database logger, this data source is already defined at your selected scope.
    1. Select Resources > JDBC > JDBC Providers from the WebSphere Application Server Version 7.0 or later administration console navigation.
    2. Select the Scope dropdown list and change the scope to the appropriate value. For example, Node=yourNode, Server=yourServer.
    3. Create a JDBC provider using the console wizard, by clicking New.
    4. At Step 1 of the wizard, the values you provide depend on the type of database you are using.
      • If you are using DB2®, select DB2 from the Database type list, DB2 Universal JDBC Driver Provider from the Provider type list and XA Data Source from the Implementation type list. Click Next.
      • If you are using Oracle, select Oracle from the Database type list, Oracle JDBC Driver from the Provider type list and XA Data Source from the Implementation type list. Click Next.
    5. At Step 2 of the wizard, ensure that the directory location of the required database jar files is set correctly. Click Next.
    6. Click Finish on the summary page to create the JDBC provider.
  7. Define a data source, so that the Web Gateway application can retrieve transfer status information. If you have already deployed a JEE database logger, this data source is already defined at your selected scope.
    1. Select Resources > JDBC > Data sources from the WebSphere Application Server Version 7.0 or later administration console navigation.
    2. Select the Scope dropdown list and change the scope to the appropriate value. For example, Node=yourNode, Server=yourServer.
    3. Create a data source using the console wizard, by clicking New.
    4. At Step 1 of the wizard, in the Data source name field, enter wmqfte-database and in the JNDI name field, enter jdbc/wmqfte-database. Click Next.
    5. At Step 2 of the wizard, use the Select an existing JDBC provider dropdown list to select the JDBC provider created in the above steps. Click Next.
    6. Db2: At Step 3 of the wizard, in the Driver type field, enter 4.
    7. Db2: Enter the required details in the Database name, Server name, and Port number fields, and click Next.

      Oracle: Enter the required connection URL in the URL field and choose the correct data store helper in the Data store helper class name field.

    8. At Step 4 of the wizard, if you have configured the authentication on your database, supply the required Component-managed authentication alias and Container-managed authentication alias in the respective dropdown boxes, and click Next.
    9. Click Finish on the summary page to create the data source.
  8. Define a second data source, so that the Web Gateway application can store information about the user file spaces that you create and use:
    1. Create the database and database tables that are required to work with file spaces. For more information, see Setting up a database for use with file spaces.
    2. Repeat steps 7a to 7i, but for step 7d type wmqfte-filespace into the Data source name field and jdbc/wmqfte-filespace into the JNDI name field, and click Next.
  9. Optional: If you have already configured your database you can verify the configuration of the data sources:
    1. Select Resources > JDBC > Data sources from the WebSphere Application Server Version 7.0 or later administration console navigation.
    2. Click the Test Connection button.

Results

You can now deploy the Web Gateway EAR file to the application server. Carry out the steps in the topic Deploying the Web Gateway with WebSphere Application Server Version 7.0.

Task Task

Feedback

Timestamp icon Last updated: Tuesday, 30 January 2018
http://www.ibm.com/support/knowledgecenter/SSEP7X_7.0.4/com.ibm.wmqfte.doc/web_was7_prep.htm