Preparing to deploy the Web Gateway with WebSphere Application Server Community Edition
Use these instructions to set up your environment before deploying the WebSphere® MQ File Transfer Edition Web Gateway enterprise application to WebSphere Application Server Community Edition. 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.
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
WebSphere Application Server Community Edition can be obtained from the following web page: http://www.ibm.com/software/webservers/appserv/community
Before deploying the Web Gateway application, you must set up the dependent components. These components are the WebSphere MQ resource adaptor, a database written to by a WebSphere MQ File Transfer Edition database logger, a database connector, and a security realm. You must also update the web.xml file and the deployment plan for your environment.
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).
Procedure
- Deploy the WebSphere MQ resource adapter. If your WebSphere Application Server Community Edition instance is running on the same system as the WebSphere MQ queue manager that you want to connect to, see Deploying the WebSphere MQ resource adapter on the same system as the application server. If your WebSphere Application Server Community Edition instance is running on a different system from the WebSphere MQ queue manager that you want to connect to, see Deploying the WebSphere MQ resource adapter on a different system from the application server.
- Define a database connector to connect to the log database. For more information, see Defining a database connector to connect to the log database.
- Define a database connector to connect to the file space database. For more information, see Defining a database connector to connect to the file space database
- Define a security realm. For more information, see Defining a security realm.
- Update the web.xml file. For more information, see Updating the web.xml file.
- Update the openejb-jar.xml file. For more information, see Updating the openejb-jar.xml to configure the Web Gateway to use file spaces.
- If you must deploy the Web Gateway in a non-default environment or are using your own security realm, you must either update the supplied deployment plan or provide a separate deployment plan. For more information, see Update the deployment plan.
- Optional: If you want to deploy the Web Gateway administrative console in a non-default environment update the supplied deployment plan in the com.ibm.wmqfte.web.admin.war file. For more information, see Update the deployment plan for the administrative console.
Results
Deploying the WebSphere MQ resource adapter on the same system as the application server
About this task
Procedure
What to do next
Deploying the WebSphere MQ resource adapter on a different system from the application server
About this task
Procedure
What to do next
Defining a database connector to connect to the log database
Before you begin
About this task
Procedure
- Depending on the level of WebSphere Application Server Community Edition that you are using, from the Console Navigation either select , or select .
- Create a database pool using the Geronimo database pool wizard. In the Name of Database Pool field, type jdbc/wmqfte-database.
- For the Database Type select either DB2 XA or Oracle Thin, as appropriate for your database.
- Click Next.
- In the Driver jar field, select the appropriate jar file for your database.
- In the Database Name field, type the name of the database you are connecting to for transfer status information.
- In the User Name field, type the user name for connecting to and authenticating with your database.
- In the Password and Confirm Password fields, type the password for authenticating with your database.
- In the Server Name field, type the host name or IP address of the host that the database driver needs to connect to.
- In the Port Number field, type the port number you are using if it is not the default port.
- Ensure that the value for Driver Type is 4.
- Select XA from the Transaction Type list.
- Click Deploy.
What to do next
Defining a database connector to connect to the file space database
Before you begin
About this task
Procedure
- Depending on the level of WebSphere Application Server Community Edition that you are using, from the Console Navigation either select , or select .
- Create a database pool using the Geronimo database pool wizard. In the Name of Database Pool field, type jdbc/wmqfte-filespace.
- For the Database Type select either DB2 XA or Oracle Thin, as appropriate for your database.
- Click Next.
- In the Driver jar field, select the appropriate jar file for your database.
- In the Database Name field, type the name of the database you are connecting to for file space information.
- In the User Name field, type the user name for connecting to and authenticating with your database.
- In the Password and Confirm Password fields, type the password for authenticating with your database.
- In the Port Number field, type the port number you are using if it is not the default port.
- Ensure that the value for Driver Type is 4.
- Select XA from the Transaction Type list.
- Click Deploy.
What to do next
Defining a security realm
About this task
Procedure
Updating the web.xml file
About this task
Procedure
What to do next
Updating the openejb-jar.xml to configure the Web Gateway to use file spaces
About this task
Procedure
What to do next
Update the deployment plan
About this task
Procedure
What to do next
Update the deployment plan for the administrative console
About this task
If you want to deploy the Web Gateway administrative console with a non-default context root, you must update the supplied deployment plan to contain the non-default context root. The supplied deployment plan is in the administrative console application file com.ibm.wmqfte.web.admin.war, in the file WEB-INF/geronimo-web.xml. Update the supplied deployment plan for your environment, using a Java SDK jar utility to complete the following steps: