SET USERROOT Command   

Defines the root location for a VM user's user page. A VM user stores the data he wants to serve in the user page. A VM user can define the user page location as one of the following:

• Minidisk
• SFS directory
• BFS directory

A VM:Webgateway system administrator must configure VM:Webgateway to allow user pages before you can use this command to define your user page location. Enter the QUERY USERPAGES command from a VM userid to determine whether user pages are allowed.

In addition, you can optionally specify a contact name and e-mail address that VM:Webgateway will display on configuration forms and in certain communications to users. Examples of such communications are:

• Messages stating the product's configuration was successfully updated.
• Output generated by a CGI programmer.
• Error documents that VM:Webgateway serves when it encounters problems serving files from the user page. VM:Webgateway uses the e-mail address to include a mailto: URL. With the contact information in an error document, the web browser user who receives the error document can report the problem to someone who can fix it.

Syntax

To define the user page as a minidisk:

To define the user page as an SFS directory:

To define the user page as a BFS directory:

To set the root location of a user page to the system default:

Parameters/Options

userid

Userid of the VM user whose user page location is being defined. To define your own user page location, specify your VM userid for userid. You must have SYSADMIN authorization to specify a userid other than your own or to specify a userid that does not exist on your VM system.

---

Note: Specifying a userid that does not exist can cause problems if you are using accounting because VM:Webgateway includes the non-VM userid in accounting records.

---

MDISK userid vaddr

Minidisk you want to use for the user page. If you do not have SYSADMIN authorization, the userid you specify with the MDISK parameter must be the same as the userid that owns the user page. You cannot use pattern matching in userid or vaddr.

When you serve files from a minidisk, you must identify all the files you want to serve in DIRMAP files. All DIRMAP files and the files you want to serve must reside on this minidisk. The VM:Webgateway service virtual machine must have read access to this minidisk.

SFS sfsdir

SFS directory you want to use for the user page. If you do not have SYSADMIN authorization, the SFS directory must be owned by the userid that owns the user page. Specify the fully qualified directory name. You cannot use pattern matching in sfsdir.

When you serve files from an SFS directory, all files you want to serve must reside in the directory or its subdirectories. The VM:Webgateway service virtual machine must have authorization to read the files you want to serve.

BFS bfsdir

BFS directory you want to use for the user page. If you do not have SYSADMIN authorization, the BFS directory must be owned by the userid that owns the user page. Specify the fully qualified directory name. You must use the exact case of the BFS directory name when specifying bfsdir. You cannot use pattern matching in bfsdir.

When you serve files from a BFS directory, all files you want to serve must reside in the directory or its subdirectories. The VM:Webgateway service virtual machine must have read and search permissions to the directory and the subdirectories it must search to find the files you want to serve. In addition, VM:Webgateway requires read permission to each static file you want to serve and read and execute permission to each CGI program you want to serve.

SYSTEM

Use the system default for your user page location. To determine the system default, enter the QUERY USERROOT command from your VM userid:

vmwebsrv query userroot system

CONTACTNAME [NONE | /name/]

Use the CONTACTNAME parameter to specify a contact name that VM:Webgateway will display on configuration forms and in certain communications to users. Examples of such communications are presented at the top of this page.

If you want to display the contact name, identify it with the name parameter. The value you specify must be preceded and followed by a delimiting character (for example, /Mark/ or "Mark Smith"). If you specify the name parameter, one of several messages will display:

• If you also provide an e-mail address (CONTACTEMAIL parameter), the message reads, "Send comments or questions to name," where name is hyperlinked to the mailto: URL. The e-mail is automatically addressed to the contact's e-mail address.
• If you do not provide an e-mail address (CONTACTEMAIL parameter), the message reads, "Send comments or questions to name." There is no hyperlink to the mailto: URL.

Specify NONE if you do not want to display a contact name on configuration forms or in communications to users. NONE is the default.

The CONTACTNAME parameter is usually used in conjunction with the CONTACTEMAIL parameter.

CONTACTEMAIL [NONE | e-address]

Use the CONTACTEMAIL parameter to specify a contact e-mail address that VM:Webgateway will display on configuration forms and in certain communications to users. Examples of such communications are presented at the top of this page.

If you want to display the contact e-mail address, identify it with the e-address parameter (for example, Mark_Smith@reallybigcorp.com). If you specify the e-address parameter, one of several messages will display:

• If you also provide a contact name (CONTACTNAME parameter), the message reads, "Send comments or questions to name," where name is hyperlinked to the mailto: URL. The e-mail is automatically addressed to the contact's e-mail address.
• If you do not provide a contact name (CONTACTNAME parameter), the message reads, "Send comments or questions to e-address," where e-address is hyperlinked to the mailto: URL.

---

Note: By default, the logical character-delete symbol for a virtual machine is the at sign (@). As a result, when you use the at sign in a contact e-mail address, CMS deletes the at sign and the preceding character. There are several ways to avoid this problem.

• One is to enter the TERMINAL CHARDEL OFF command before entering the CONFIG SOCKET command. (You must then enter the TERMINAL CHARDEL ON command after using the CONFIG SOCKET command.) For more information about these commands, refer to IBM documentation.
• Another way is to place a double-quote character (or whatever the escape character is at your site) just before the at sign so the at sign is taken literally (for example, Fred"@company.com).

---

You can read more about the mailto: URL scheme at http://info.internet.isi.edu:80/in-notes/rfc/files/rfc2368.txt. You can read more about forming the e-mail address portion of the mailto: tag at http://info.internet.isi.edu:80/in-notes/rfc/files/rfc822.txt.

Specify NONE if you do not want to display a contact e-mail address on configuration forms or in communications to users. NONE is the default.

The CONTACTEMAIL parameter is usually used in conjunction with the CONTACTNAME parameter.

Examples

• To define your (userid LEANNA) user page location as your 0191 minidisk, enter the following command from your VM userid:

  vmwebsrv set userroot leanna mdisk leanna 0191

• To define your (userid EMILY) user page location as your SFS directory, VMSYSU:EMILY., enter the following command from your VM userid:

  vmwebsrv set userroot emily sfs vmsysu:emily.

• To define your (userid DANIEL) user page location as your SFS directory, VMSYSU:DANIEL.USERROOT, enter the following command from your VM userid:

  vmwebsrv set userroot daniel sfs vmsysu:daniel.userroot

• To define your (userid ANDREW) user page location as your BFS directory, /../VMBFS:VMSYSU:ANDREW/User-Root, enter the following from your VM userid:

  vmwebsrv set userroot andrew bfs /../VMBFS:VMSYSU:ANDREW/User-Root

• To define your (userid BECKY) user page location as the system default, enter the following command from your VM userid:

  vmwebsrv set userroot becky system

• To define your (userid LEANNA) user page location as your 0191 minidisk and specify yourself as the contact should there be a problem serving a data page, enter the following command from your VM userid:

  vmwebsrv set userroot leanna mdisk leanna 0191 contactname /Leanna/ contactemail LeannaK"@kworld.com

  Note the use of the escape character before the at sign in the e-mail address.