Configure Access for Web (CFGACCWEB2)

Where allowed to run: All environments (*ALL)
Threadsafe: No
Parameters
Examples
Error messages

The Configure iSeries Access for Web (CFGACCWEB2) command is used to configure iSeries Access for Web for the following web serving environments:

Before iSeries Access for Web can be used, it must be configured using this command.

Input parameters are conditional based on the value specified for the Web application server type (APPSVRTYPE) parameter.

This command will use the input configuration parameters to add iSeries Access for Web servlet or portlet configuration information to the web application server.

If multiple web application servers are configured and running on the iSeries server, iSeries Access for Web can be configured to run within each of those web application servers.

When configuring iSeries Access for Web for multiple web application servers, the new configuration can be created based on an existing configuration. The new configuration can share user-generated data with other configurations or a copy of the existing user data can be made for the new configuration.

This command will create a directory structure for user-generated data. User data will be stored to the following locations, depending on the value specified for the Web application server type (APPSVRTYPE) parameter:

When the command runs status information will be displayed indicating what the command is processing. As the command runs, detailed status and error information will also be logged to stream file /QIBM/UserData/Access/Web2/logs/cmds.log.

After the command completes, the web application server may have to be ended and restarted. The iSeries Access for Web configuration will need to be started before it can be accessed.

Restrictions:

Top

Parameters

Keyword Description Choices Notes
APPSVRTYPE Web application server type Character value Required, Positional 1
WASINST Web server instance name Character value, *DEFAULT Optional
WASPRF Web server profile name Character value, *DEFAULT Optional
TCSVRNAME Tomcat server name Character value Optional
TCHOMEDIR Tomcat home directory Path name Optional
TCUSRPRF Tomcat user profile Simple name Optional
APPSVR Application server name Character value, *DEFAULT Optional
NODENAME Node name Character value, *DEFAULT Optional
TGTSVR Target server Character value, *DEFAULT Optional
AUTHTYPE Authentication type *APP, *APPSVR Optional
AUTHMETHOD Authentication method *FORM, *BASIC Optional
WPUSRID WebSphere Portal user ID Character value Optional
WPPWD WebSphere Portal password Character value Optional
WPURL WebSphere Portal config URL Character value Optional
WPDFTPAG WebSphere Portal default pages *CREATE, *NOCREATE Optional
WASUSRID WebSphere user ID Character value, *NONE Optional
WASPWD WebSphere password Character value, *NONE Optional
SRCSVRTYPE Source web server type Character value Optional
SRCSVRINST Source web server instance Character value, *DEFAULT, *WASINST, *WASPRF Optional
SRCAPPSVR Source application server Character value, *DEFAULT Optional
SHRUSRDTA Share user data *NO, *YES Optional
Top

Web application server type (APPSVRTYPE)

Specifies which web application server to configure iSeries Access for Web to run under.

This is a required parameter.

*WAS50
WebSphere Application Server V5.0 for iSeries
*WAS50EXP
WebSphere Application Server V5.0 - Express for iSeries
*WAS51
WebSphere Application Server V5.1 for iSeries
*WAS51EXP
WebSphere Application Server V5.1 - Express for iSeries
*WAS60
WebSphere Application Server V6.0 for OS/400 (Base and Express)
*WAS60ND
WebSphere Application Server Network Deployment V6.0 for OS/400
*WP50
WebSphere Portal V5.0
*ASFTOMCAT
Apache Software Foundation (ASF) Tomcat
Top

Web server instance name (WASINST)

Specifies which IBM WebSphere Application Server instance to configure to run iSeries Access for Web.

This parameter is only applicable when the Web application server type (APPSVRTYPE) parameter is set to one of the following web application servers

When the Web application server type (APPSVRTYPE) parameter is set to *WP50, this parameter is the WebSphere instance that WebSphere Portal has been configured to run within.

*DEFAULT
When IBM WebSphere Application Server was installed, a default instance was automatically created for the WebSphere installation except for WebSphere - Express for iSeries.

For WebSphere - Express for iSeries environments, an instance is not automatically created and must be created by the system administrator.

When *DEFAULT is specified, iSeries Access for Web will be configured within the default WebSphere instance.

name
Specify the name of the WebSphere instance to configure to run iSeries Access for Web.
Top

Web server profile name (WASPRF)

Specifies which IBM WebSphere Application Server profile to configure to run iSeries Access for Web.

This parameter is only applicable when the Web application server type (APPSVRTYPE) parameter is set to one of the following web application servers

*DEFAULT
When IBM WebSphere Application Server was installed, a default profile was automatically created for the WebSphere installation.

When *DEFAULT is specified, iSeries Access for Web will be configured within the default WebSphere profile.

name
Specify the name of the WebSphere profile to configure to run iSeries Access for Web.
Top

Tomcat server name (TCSVRNAME)

Specifies the existing Apache Software Foundation (ASF) Tomcat server that will be configured to run iSeries Access for Web.

A parameter value is required when *ASFTOMCAT is specified for the Web application server type (APPSVRTYPE) parameter.

name
Specify the name of an existing ASF Tomcat server.
Top

Tomcat home directory (TCHOMEDIR)

Specifies the Apache Software Foundation (ASF) Tomcat home directory that the ASF Tomcat server was configured to use.

When the ASF Tomcat server was configured, an integrated file system (IFS) path was specified as the location for the ASF Tomcat servlet engine and its associated files. By default, the directory may have been set to /ASFTomcat/<server_name>. The path can be verified by checking the Tomcat server settings.

This home directory contains subdirectories for logs, applications, and configuration information for the ASF Tomcat server.

The CFGACCWEB2 command will create directories and files within this path for iSeries Access for Web.

A parameter value is required when *ASFTOMCAT is specified for the Web application server type (APPSVRTYPE) parameter.

path-name
Specify the path name of the ASF Tomcat home directory.
Top

Tomcat user profile (TCUSRPRF)

Specifies the user ID that the Apache Software Foundation (ASF) Tomcat server was configured to use.

The CFGACCWEB2 command will use this value to grant the ASF Tomcat server user ID access to iSeries Access for Web files.

This parameter is required and only applicable when *ASFTOMCAT is specified for the Web application server type (APPSVRTYPE) parameter.

simple-name
Specify the name of the user profile for the ASF Tomcat server.
Top

Application server name (APPSVR)

Specifies the existing application server to which iSeries Access for Web is to be configured.

A WebSphere instance/profile can contain one or more application servers. The application server provides the environment in which deployed web applications execute.

This parameter is only applicable when the Web application server type (APPSVRTYPE) parameter is set to configure iSeries Access for Web for one of the following web application servers:

*DEFAULT
The following applies when the APPSVRTYPE parameter is set to *WAS50/*WAS51/*WAS60/*WAS60ND:
  • When the WASINST or WASPRF parameter is set to *DEFAULT, this value will be set to 'server1'
  • When the WASINST or WASPRF parameter is set to something other than *DEFAULT, this value will be set to the value specified for the WASINST or WASPRF parameter.

The following applies when the APPSVRTYPE parameter is set to *WAS50EXP/*WAS51EXP:

  • When the WASINST parameter is set to *DEFAULT, this value will be set to 'default'.
  • When the WASINST parameter is set to something other than *DEFAULT, this value will be set to the value specified in the WASINST parameter.
name
Specify the name of the application server within the WebSphere instance/profile that is to be configured.
Top

Node name (NODENAME)

Specifies the name of the node within the WebSphere instance to which iSeries Access for Web is to be configured.

This parameter is only applicable when the Web application server type (APPSVRTYPE) parameter is set to one of the following web application servers:

*DEFAULT
The following applies when the APPSVRTYPE parameter is set to *WAS50/*WAS51:
  • When the WASINST parameter is set to *DEFAULT, this value will be set to the name of the iSeries server.
  • When the WASINST parameter is set to something other than *DEFAULT, this value will be set to a combination of the iSeries server name and the value specified for the WASINST parameter. For example, if the iSeries server name is SERVERA and the WASINST parameter is set to 'TEST', this value would be set to 'SERVERA_TEST'.

The following applies when the APPSVRTYPE parameter is set to *WAS50EXP/*WAS51EXP:

  • When the WASINST parameter is set to *DEFAULT, this value will be set to a combination of the iSeries server name and 'default'. For example, if the iSeries server name is SERVERA and the WASINST parameter is set to *DEFAULT, this value would be set to 'SERVERA_default'.
  • When the WASINST parameter is set to something other than *DEFAULT, this value will be set to a combination of the iSeries server name and the value specified for the WASINST parameter. For example, if the iSeries server name is SERVERA and the WASINST parameter is set to 'MYINST', this value would be set to 'SERVERA_MYINST'.
name
Specify the name of the node within the WebSphere instance that is to be configured.
Top

Target server (TGTSVR)

Specifies the iSeries server to which iSeries Access for Web is to connect.

This parameter allows iSeries Access for Web to be configured on a central iSeries server to provide a gateway-like function to allow access to another iSeries server in the network.

A web application server such as WebSphere Application Server and iSeries Access for Web may not need to be installed or configured on the iSeries server specified in this parameter.

*DEFAULT
iSeries Access for Web will connect to and serve data from the iSeries server to which it has been installed.
name
Specify the fully qualified domain name for the target iSeries server you want iSeries Access for Web to access data from. The domain name can be determined by accessing the TCP/IP configuration information on the target server.
Top

Authentication type (AUTHTYPE)

Specifies whether the application or the application server authenticates the user.

This parameter is only applicable when the Web application server type (APPSVRTYPE) parameter is set to one of the following web application servers

*APP
iSeries Access for Web will authenticate with i5/OS using a user profile and password.

This option uses HTTP basic authentication to prompt for the user profile and password. To secure authentication information during transmission, HTTPS (secure HTTP) should be used.

*APPSVR
WebSphere Application Server will authenticate with the active user registry. iSeries Access for Web uses Enterprise Identity Mapping (EIM) to map the authenticated WebSphere user identity to an i5/OS user identity.

This option enables iSeries Access for Web to participate in WebSphere single sign-on (SSO) environments.

This option requires global security be enabled for the WebSphere Application Server instance being configured.

This option also requires the IBM Identity Token Connector be installed in the WebSphere Application Server instance being configured.

For additional information, please refer to the iSeries Access for Web InfoCenter information http://www.ibm.com/servers/eserver/iseries/infocenter/

Top

Authentication method (AUTHMETHOD)

Specifies the method used by the application server to identify the user.

This parameter is only applicable when the AUTHTYPE parameter is set to a value of *APPSVR.

*FORM
This method uses an HTML form to prompt for the user ID and password. The information is transmitted in clear text. To secure authentication information during transmission, HTTPS (secure HTTP) should be used.
*BASIC
This method uses HTTP basic authentication to prompt for the user ID and password. To secure authentication information during transmission, HTTPS (secure HTTP) should be used.

For additional information, please refer to the iSeries Access for Web InfoCenter information http://www.ibm.com/servers/eserver/iseries/infocenter/

Top

WebSphere Portal user ID (WPUSRID)

Specifies the IBM WebSphere Portal administrative user ID that will be used to configure iSeries Access for Web within WebSphere Portal.

Changes to the WebSphere Portal configuration require a user ID be specified to make the changes. This is the same administrator level user ID that would be used to login to the WebSphere Portal user interface to perform administrator level functions.

This value is sent to the server unencrypted using an HTTP connection. If the connection could be compromised, this command should only be run within a protected intranet environment.

A parameter value is required when *WP50 is specified for the Web application server type (APPSVRTYPE) parameter.

character-value
Specify the administrative user ID.
Top

WebSphere Portal password (WPPWD)

Specifies the password for the IBM WebSphere Portal administrative user ID specified for the WPUSRID parameter.

This value is sent to the server unencrypted using an HTTP connection. If the connection could be compromised, this command should only be run within a protected intranet environment.

A parameter value is required when *WP50 is specified for the Web application server type (APPSVRTYPE) parameter.

character-value
Specify the password for the IBM WebSphere Portal administrative user.
Top

WebSphere Portal config URL (WPURL)

Specifies the universal resource locator (URL) to access the WebSphere Portal configuration servlet. This servlet will add the necessary iSeries Access for Web configuration information to WebSphere Portal.

This URL is comprised of the following elements:

An example for this value would be 'server_name.your_company.com/wps/config'.

A parameter value is required when *WP50 is specified for the Web application server type (APPSVRTYPE) parameter.

character-value
Specify the URL to access the WebSphere Portal configuration servlet.
Top

WebSphere Portal default pages (WPDFTPAG)

When configuring for WebSphere Portal default WebSphere Portal pages can be created and populated with iSeries Access for Web portlets.

*CREATE
Create a default iSeries Access for Web WebSphere Portal page containing multiple sub-pages. The sub-pages will be populated with iSeries Access for Web portlets.
*NOCREATE
Default iSeries Access for Web WebSphere Portal pages will not be created and iSeries Access for Web portlets will not be deployed to any WebSphere Portal pages.
Top

WebSphere user ID (WASUSRID)

If the WebSphere application server instance/profile specified in the WASINST/WASPRF and APPSVR parameters has security enabled, this parameter is required.

When this command runs it will make changes to the WebSphere instance/profile configuration or the running state of the iSeries Access for Web web application. When WebSphere security has been enabled for an instance/profile, authentication information must be supplied to make those changes.

The WASUSRID and WASPWD parameters provide the required authentication information.

To determine what value to specify for this parameter, refer to the Authentication Mechanisms and User Registries settings under the Security configuration in the WebSphere administration console.

This parameter does not apply to the WebSphere Portal or ASF Tomcat environments.

character-value
Specify the user ID.

For additional information, please refer to the WebSphere Security information in the iSeries InfoCenter information http://www.ibm.com/servers/eserver/iseries/infocenter/

Top

WebSphere password (WASPWD)

If the WebSphere application server instance/profile specified in the WASINST/WASPRF and APPSVR parameters has security enabled, this parameter is required.

When this command runs it will make changes to the WebSphere instance/profile configuration or the running state of the iSeries Access for Web web application. When WebSphere security has been enabled for an instance/profile, authentication information must be supplied to make those changes.

The WASUSRID and WASPWD parameters provide the required authentication information.

To determine what value to specify for this parameter, refer to the Authentication Mechanisms and User Registries settings under the Security configuration in the WebSphere administration console.

This parameter does not apply to the WebSphere Portal or ASF Tomcat environments.

character-value
Specify the password for the user ID.

For additional information, please refer to the WebSphere Security information in the iSeries InfoCenter information http://www.ibm.com/servers/eserver/iseries/infocenter/

Top

Source web server type (SRCSVRTYPE)

Specifies an existing web application server that has been configured to run iSeries Access for Web. The new iSeries Access for Web configuration will be created based on this existing iSeries Access for Web configuration.

This parameter is not applicable and will be ignored when the Web application server type (APPSVRTYPE) parameter is set to *WP50.

*NONE
The new iSeries Access for Web configuration is not based on an existing iSeries Access for Web configuration.
*WAS50
WebSphere Application Server V5.0 for iSeries
*WAS50EXP
WebSphere Application Server V5.0 - Express for iSeries
*WAS51
WebSphere Application Server V5.1 for iSeries
*WAS51EXP
WebSphere Application Server V5.1 - Express for iSeries
*WAS60
WebSphere Application Server V6.0 for OS/400
*WAS60ND
WebSphere Application Server Network Deployment V6.0 for OS/400
*ASFTOMCAT
Apache Software Foundation (ASF) Tomcat
Top

Source web server instance (SRCSVRINST)

This parameter specifies the name of a WebSphere instance/profile or an ASF Tomcat server name where iSeries Access for Web is already configured.

The new iSeries Access for Web configuration will be based on this existing configuration.

The WebSphere instance/profile name or ASF Tomcat server name specified with this parameter must be configured within the web application server specified for the Source web server type (SRCSVRTYPE) parameter.

This parameter is not applicable and will be ignored when the Web application server type (APPSVRTYPE) parameter is set to *WP50.

*DEFAULT
When the web application server was installed, a default instance/profile may have been automatically created. When *DEFAULT is specified, iSeries Access for Web will be configured based on an instance/profile named 'default'.
*WASINST/*WASPRF
When *WASINST/*WASPRF is specified, the value specified in the WASINST/WASPRF parameter will be used.
name
Specify the name of the WebSphere instance/profile or ASF Tomcat server that has already been configured to run iSeries Access for Web.
Top

Source application server (SRCAPPSVR)

The application server provides the environment in which deployed web applications execute. This parameter specifies the name of an application server within a WebSphere instance/profile where iSeries Access for Web is already configured.

The new iSeries Access for Web configuration will be based on this existing configuration.

This parameter is only applicable when the Web application server type (APPSVRTYPE) parameter is not set to *WP50 and the Source web server type (SRCSVRTYPE) parameter is set to one of the following web application servers:

*DEFAULT
The following applies when the SRCSVRTYPE parameter is set to *WAS50/*WAS51/*WAS60/*WAS60ND:
  • When this parameter is set to *DEFAULT and the SRCSVRINST parameter is set to *DEFAULT, this parameter will be set to 'server1'.
  • When this parameter is set to *DEFAULT and the SRCSVRINST parameter is set to something other than *DEFAULT, this parameter will be set to the value specified for the SRCSVRINST parameter.

The following applies when the SRCSVRTYPE parameter is set to *WAS50EXP/*WAS51EXP:

  • When this parameter is set to *DEFAULT and the SRCSVRINST parameter is set to *DEFAULT, this parameter will be set to 'default'.
  • When this parameter is set to *DEFAULT and the SRCSVRINST parameter is set to something other than *DEFAULT, this parameter will be set to the value specified for the SRCSVRINST parameter.
name
Specify the name of the application server within the WebSphere instance/profile that the new configuration will be based on.
Top

Share user data (SHRUSRDTA)

When configuring based on an existing iSeries Access for Web configuration this parameter specifies whether the new configuration will share user-generated data with the existing configuration.

A parameter value is required when a value other than *NONE is specified for the SRCSVRTYPE parameter.

*NO
The new configuration will start with a copy of the existing configuration's user-generated data.
*YES
The new configuration will share the user-generated data with the existing configuration.
Top

Examples

Example 1: Configuring WebSphere Application Server V5.0 for iSeries

CFGACCWEB2   APPSVRTYPE(*WAS50)  WASINST(DEPTXYZ)
             APPSVR(XYZSERVER)

This command will configure iSeries Access for Web for a user created WebSphere instance named DEPTXYZ containing an application server named XYZSERVER within WebSphere Application Server for iSeries V5.0.

Example 2: Configuring WebSphere Application Server V5.0 - Express for iSeries

CFGACCWEB2   APPSVRTYPE(*WAS50EXP)  WASINST(MYINST)
             APPSVR(*DEFAULT)
             SRCSVRTYPE(*WAS50)  SRCSVRINST(DEPTXYZ)
             SRCAPPSVR(XYZSERVER) SHRUSRDTA(*NO)

This command will configure iSeries Access for Web for the MYINST instance of WebSphere Application Server V5.0 - Express for iSeries. This example also shows that this new configuration will be based on a configuration that was performed in a previous example. User-generated data will be copied from the source configuration to this new configuration.

Example 3: Configuring WebSphere Application Server V6.0 for OS/400

CFGACCWEB2   APPSVRTYPE(*WAS60)  WASPRF(default) APPSVR(server1)
             SRCSVRTYPE(*WAS50EXP)  SRCSVRINST(MYINST)
             SRCAPPSVR(*DEFAULT) SHRUSRDTA(*NO)

This command will configure iSeries Access for Web for the default instance of WebSphere Application Server V6.0 for OS/400. This default instance contains an application server named server1. This example also shows that this new configuration will be based on a configuration that was performed in a previous example. User-generated data will be copied from the source configuration to this new configuration.

Example 4: Configuring WebSphere Application Server Network Deployment V6.0 for OS/400

CFGACCWEB2   APPSVRTYPE(*WAS60ND)  WASPRF(default) APPSVR(server1)
             SRCSVRTYPE(*WAS50EXP)  SRCSVRINST(MYINST)
             SRCAPPSVR(*DEFAULT) SHRUSRDTA(*NO)

This command will configure iSeries Access for Web for the default instance of WebSphere Application Server Network Deployment V6.0 for OS/400. This default instance contains an application server named server1. This example also shows that this new configuration will be based on a configuration that was performed in a previous example. User-generated data will be copied from the source configuration to this new configuration.

Example 5: Configuring WebSphere Portal

CFGACCWEB2   APPSVRTYPE(*WP50)  WPUSRID(wpsadmin)
             WPPWD(wpspassword)
             WPURL('myserver.mydomain.com/wps/config')
             WPDFTPAG(*CREATE)

This command will configure iSeries Access for Web for WebSphere Portal V5.0. This example inputs the WebSphere Portal administrator user ID and password, the URL to the portal configuration servlet, and tells the command to create the default iSeries Access for Web WebSphere Portal pages and populate the pages with portlets.

Example 6: Configuring ASF Tomcat

CFGACCWEB2   APPSVRTYPE(*ASFTOMCAT)  TCSVRNAME(TOMCAT)
             TCHOMEDIR('/ASFTomcat/tomcat')
             TCUSRPRF(QTMHHTTP)
             SRCSVRTYPE(*WAS50) SRCSVRINST(DEPTXYZ)
             SRCAPPSVR(XYZSERVER) SHRUSRDTA(*YES)

This command will configure iSeries Access for Web for an Apache Software Foundation (ASF) Tomcat server named TOMCAT. This example also shows that this configuration will be based on a configuration that was performed in a previous example. User-generated data will be shared between the source configuration and this new configuration.

Top

Error messages

*ESCAPE Messages

IAW0001
Configure iSeries Access for Web command failed.
IAW000A
The SHRUSRDTA parameter is required.
IAW000B
Value specified for parameter APPSVRTYPE is not valid.
IAW000C
Value specified for parameter SRCSVRTYPE is not valid.
IAW000D
The TCSVRNAME and TCHOMEDIR and TCUSRPRF parameters are required.
IAW0011
The WPUSRID, WPPWD, and WPURL parameters are required.
Top