Task: create-virtual-portal
Portal ConfigEngine task that creates a new virtual portal.
Use the create-virtual-portal task to create a new 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. Run these tasks separately after you create the virtual portal. For example, we can use the XML configuration interface create content and grant access permissions. For details, about the access permissions that are required for virtual portal administrators, see the section Configuring the sub-administrators for virtual portals.. For details about how to use the XML configuration interface see The XML configuration interface.
- VirtualPortalTitle
- The title of the virtual portal.
- This option is required.
- VirtualPortalRealm
- The realm of the virtual portal.
- This input is required if we have realms that are enabled in the portal installation. If we do not have realms that are enabled, do not specify a value for the realm.
- Virtual portal context or host name
- We can address virtual portals by using either a portal context or a virtual host name. If we specify a host name, the context is ignored:
Notes:
- VirtualPortalContext
- The portal context of the virtual portal. The context must be unique.
- VirtualPortalHostName
- The host name of the virtual portal. Notes:
- This URL is used internally to access the virtual portal instance, even if we specify a context URL that is easy to use. Make sure that the host name specified here is accessible.
- We cannot use the same virtual portal host name twice in the same portal installation. The host name must be unique for the portal installation. Host names must be valid host names that are either registered on your local DNS, or internally using the "hosts" file. Host names must be registered on the system before creating a virtual portal.
- After you create the virtual portal, we cannot change the host name specified for the virtual portal. If we must use a different host name for a virtual portal, see the topic about Using a new host name for an existing virtual portal.
- If we use web content libraries, do not specify a context URL for the new virtual portal that matches the name of a library on the server. If the name of a library and the URL context of a virtual portal have the same value, incorrect rendering of web content can result.
- If we use a host name for creating the virtual portal, we need to update the global web server plug-in configuration in the WebSphere Integrated Solutions Console and restart the web server. If we have more than one virtual portal, we need to do this only once. For more information about updating the global web server plug-in configuration, read Creating or updating a global web server plug-in configuration file in the IBM WebSphere Application Server product documentation.
- Specify either a host name or a context.
- If we specify both a host name and a context, the host name takes precedence and the context is ignored.
- There are some strings that we cannot use as URL mappings for virtual portals, for example vp. These strings are reserved names and correspond with URL codec names. For a list of these reserved strings, see Shaping the user experience.
- Use only ASCII characters for the URL Context. For example, we cannot use a URL Context such as språk. If we use non-ASCII characters, the portal shows an error message such as the following EJPAH2009E: Invalid characters were found in a context name or label. Similarly, we cannot use escaped URL encoding either. For example, a URL Context such as spr%E5k.
- VirtualPortalObjectId
- The object ID used to reference the virtual portal. If you do not specify VirtualPortalObjectId, the portal generates a new virtual portal object ID.
- VirtualPortalId
- The short numeric ID used to reference the virtual portal. It is good practice to explicitly set a value for VirtualPortalId. If we do not specify a value for the virtual portal ID, the portal generates a new virtual portal ID. However, that generated virtual portal ID might not be unique.
- 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.
- We can create our own national language support file to specify more titles and descriptions in other languages for your virtual portal.
- If we specify an NLS file, the value that is given for the virtual portal title in that NLS file overrides the title specified by the VirtualPortalTitle input parameter.
- If we specify an NLS file, do not use prefixes in that NLS file.
- If we 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 the virtual portal is created without titles in other languages and without descriptions. If we specify no NLS file, the value specified by the VirtualPortalTitle input parameter shows to users as the title of the virtual portal in all language environments. This action is independent of the system and browser locale and the user preferences.
- To pass a description for the virtual portal to the configuration task, we must specify this action 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 available with HCL WebSphere Portal and their language codes refer to Language support.
Syntax
You pass the parameters in the parameter list for each configuration task as appropriate. We do this by either of the following methods:
- Specifying the parameter and value that is preceded by -D on the command line.
- Define them in the file wkplc.properties.
Note: The property file must be encoded in the ISO 8859-1 character encoding format.
./ConfigEngine.sh create-virtual-portal -DWasPassword=password -DPortalAdminPwd=password -DVirtualPortalTitle=MyVirtualPortalTitle -DVirtualPortalContext=virtual_portal_context_url
- Add the Site Builder and Script Application libraries If you add virtual portals to the portal installation after we install CF09 or a later cumulative fix and we use Site Builder or the Script Application, we need to add the appropriate library or libraries to each new virtual portal.
References:
- Virtual portal roles and their capabilities
- The XML configuration interface
- Command reference for the Portal Scripting Interface
- Language support
- Create or updating a global web server plug-in configuration file