Deploying the Web Gateway with WebSphere Application Server Version 7.0

Use these instructions to deploy the Web Gateway enterprise application to WebSphere® Application Server Version 7.0.

Before you begin

Before deploying the Web Gateway application, you must follow the instructions in the topic Preparing to deploy the Web Gateway with WebSphere Application Server Version 7.0 to set up the application server environment.

About this task

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.

Procedure

  1. From the WebSphere Application Server Version 7.0 administration console, select Applications > New Application.
  2. From the options list, select New Enterprise Application.
  3. On the Preparing for the application installation page, select the com.ibm.wmqfte.web.ear file from the install-directory/web directory of the WebSphere MQ File Transfer Edition Server installation, and click Next.
  4. On the following screen, select Detailed to show all installation options and parameters, and click Next.
  5. Click Next in each of steps 1 - 5 to accept the default values.
  6. In step 6 (Initialize parameters for servlets), supply values for the following parameters:
    agentName
    The name of the WebSphere MQ File Transfer Edition agent that acts as the source for Web Gateway-initiated transfers. This agent must be configured as a web agent and be installed on the same system as the application server where you are deploying the Web Gateway application. You must provide a value for this parameter.

    You must create a web agent, it is not created by the deployment process. For information about how to create a web agent, see fteCreateWebAgent (create a WebSphere MQ File Transfer Edition web agent).

    coordinationQMgr
    The name of the coordination queue manage that is used by the Web Gateway for logging of transfer information. You must provide a value for this parameter.

    fileSpaceRoot
    The root directory path for file spaces created and managed by the Web Gateway. Each file space is located in a subdirectory, under this root directory, with the same name as the file space. If you change the value of this parameter after creating file spaces, the location of those file spaces remains unchanged. If you leave the value of this parameter blank, the application server home directory is used as the default file space root.
    Note: Use a new, empty directory as your file space root.
    webGatewayName
    The name of the Web Gateway that you are deploying. You must provide a value for this parameter.

    The name of the Web Gateway is not case-sensitive and must conform to the WebSphere MQ object naming conventions. For more information, see Object naming conventions for WebSphere MQ File Transfer Edition.

    tempFileUploadDir
    The directory path for the storage of temporary files related to Web Gateway-initiated transfers. The temporary file upload directory is used to temporarily store files when they are uploaded to the Web Gateway. When the upload to the Web Gateway is complete, the web agent transfers the files from the temporary file upload directory to the destination agent. If you do not provide a value for this parameter, the application server temporary directory (the value of java.io.tmpdir) is used.

    maxTempFileUploadSpace
    The maximum amount of space, in MB, that a user is allowed for storing temporary files related to Web Gateway-initiated transfers. When a user uploads files to an agent they are temporarily stored on the file system until they have been transferred. This parameter can be used to limit the amount of space an upload user can use at any one time. If you do not provide a value for this parameter, the amount of temporary file storage available to a user is unlimited.

    defaultMQMDUserID
    The default WebSphere MQ Message Descriptor (MQMD) user ID to associate with a requesting user when there is no specific MQMD user ID defined for the user. You can define mappings between users and MQMD user IDs by using the WMQFTE Web Gateway user administration API. If you do not provide a value for this parameter, then a user that does not have an MQMD user ID defined cannot perform a file upload.

    For more information about defining mappings between users and MQMD user IDs, see the topics Web Gateway administration API reference and Example: Mapping web user IDs to MQMD user IDs.

    Note: If you want, you can change these values after deployment without redeploying the application. To change these values, go to Applications > Application types > WebSphere enterprise applications > WebSphere MQ FTE Web Gateway > Initialize parameters for servlets.
  7. Click Next.
  8. In step 7 (Bind listeners for message-driven beans), in the Target Resource JNDI Name field, enter jms/WMQFTEActivationSpec. Click Next.
  9. Click Next in each of steps 8 - 10 to accept the default values.
  10. In step 11 (Map resource references to resources) perform the following steps:
    1. For both items in the javax.jms.QueueConnectionFactory section, in the Target Resource JNDI Name field, enter jms/WMQFTEWebAgentConnectionFactory.
    2. In the javax.sql.DataSource section, locate the entry where the Resource Reference field has a value of jdbc/wmqfte-filespace. In the Target Resource JNDI Name field, enter jdbc/wmqfte-filespace.
    3. In the javax.sql.DataSource section, locate the entry where the Resource Reference field has a value of jdbc/wmqfte-database. In the Target Resource JNDI Name field, enter jdbc/wmqfte-database.
    Click Next.
  11. Click Next in each of steps 12 - 13 to accept the default values.
  12. In step 14 (Map security roles to users or groups) map the required users or groups to the roles defined in the enterprise application. For example:
    1. Select wmqfte-admin, wmqfte-filespace-create, wmqfte-filespace-modify, and wmqfte-filespace-delete from the table.
    2. Click Map groups.
    3. Click Search.
    4. Select the group administrators from the list and click the top arrow button.
    5. Click OK.
    6. Select wmqfte-filespace-create, wmqfte-filespace-modify, and wmqfte-filespace-permissions from the table.
    7. Click Map groups.
    8. Click Search.
    9. Select the group managers from the list and click the top arrow button.
    10. Click OK.
    11. Select wmqfte-filespace-permissions, wmqfte-agent-upload, wmqfte-filespace-user, and wmqfte-audit from the table.
    12. Click Map groups.
    13. Click Search.
    14. Select the group employees from the list and click the top arrow button.
    15. Click OK.
    For more information about Web Gateway roles, see User roles for the Web Gateway. Click Next.
  13. Optional: If you want to use a non-default context root for your Web Gateway, in step 13 (Map context roots for Web modules), you can change the context root of the Web Gateway.
  14. Optional: If you want to use a non-default context root for your Web Gateway administrative console, in step 13 (Map context roots for Web modules), you can change the context root of the administrative console.
  15. Click Finish on the summary page to install the enterprise application.
  16. You can now start the application from the WebSphere Application Server Version 7.0 administration console:
    1. Select Applications > Application Types > WebSphere enterprise applications from the console navigation.
    2. Select the check box for the WebSphere MQ File Transfer Edition Web Gateway enterprise application from the collection table, and click Start.

Results

You can now start to use the Web Gateway, for example by deploying a web application that uses the Web Gateway to submit file transfers and transfer status requests. To use the sample application provided with the Web Gateway, follow the instructions in the topic Sample web page.

To check your Web Gateway installation, use the installation verification application that is provided with the Web Gateway. For instructions, see Verifying your Web Gateway installation.


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.htm