Task: create-virtual-portal

Use this task to create the virtual portal. This task creates the virtual portal itself, but it does not create any default content for the virtual portal or grant any access permissions to the virtual portal administrators. You need to perform these tasks separately after creating the virtual portal. For example, you can use the XML configuration interface create content and grant access permissions. For details about the access permissions required for virtual portal administrators see the section Sub-administrators of a virtual portal and their access roles and permissions under the topic Virtual portal roles and their capabilities. For details about how to use the XML configuration interface see The XML configuration interface.

Parameters

VirtualPortalTitle

The title of the virtual portal.

This option is required.

VirtualPortalRealm

The realm of the virtual portal.

This input is required if you have realms enabled in your portal installation. If you do not have realms enabled, do not specify a value for the realm.

Virtual portal context or host name

You can address virtual portals by using either a portal context or a virtual host name. If you specify a host name, the context is ignored:

VirtualPortalContext

The portal context of the virtual portal. The context must be unique.

If you set the host name parameter described later, the VirtualPortalContext parameter is ignored.

Either the host name or the context option is required.

VirtualPortalHostName

The host name of the virtual portal.

If you specify the host name, the portal uses the host name, and the VirtualPortalContext parameter is ignored.

You cannot use the same virtual portal host name twice in the same portal installation.

After you have created the virtual portal, you cannot change the host name that you have specified for the virtual portal.

Either the host name or the context option is required.

VirtualPortalNlsFile

The national language support (NLS) file for the virtual portal. Provide the path and file name of your national language support file. This input is optional.

You can create your own national language support file to specify additional titles and descriptions in other languages for your virtual portal.

If you specify an NLS file, the value given for the virtual portal title in that NLS file overrides the title that you specify by the VirtualPortalTitle input parameter.

If you specify an NLS file, do not use prefixes in that NLS file.

If you do not specify an NLS file, the virtual portal is created with the title that you give as the value to the VirtualPortalTitle input parameter only, but without titles in other languages and without descriptions. If you specify no NLS file, the value that you specify by the VirtualPortalTitle input parameter will show to users as the title of the virtual portal in all language environments, independent of the system and browser locale and the user preferences.

If you want to pass a description for the virtual portal to the configuration task, you have to specify this in the NLS file.

For more information about the NLS file and its format see the Command reference for the Portal Scripting Interface and then under the section Property File Format.

For a list of the languages that are available with WebSphere® Portal and their language codes refer to Language support.

Syntax