Task: create-virtual-portal | HCL Digital Experience
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. You need to run these tasks separately after you create the virtual portal. For example, you 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.
Parameters
- VirtualPortalTitle
- The title of the virtual portal.
- VirtualPortalRealm
- The realm of the virtual portal.
- 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.
- VirtualPortalHostName
- The host name of the virtual portal. Notes:
- This URL is used internally to access the virtual portal instance, even if you specify a context URL that is easy to use. Make sure that the host name that you specify here is accessible.
- You 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 your system before creating a virtual portal.
- After you create the virtual portal, you cannot change the host name that you specify for the virtual portal. If you 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 you use web content libraries, do not specify a context URL for the new virtual portal that matches the name of a library on your 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 you use a host name for creating the virtual portal, you need to update the global web server plug-in configuration in the WebSphere® Integrated Solutions Console and restart the web server. If you have more than one virtual portal, you 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.
Notes:- You must specify either a host name or a context.
- If you specify both a host name and a context, the host name takes precedence and the context is ignored.
- There are some strings that you 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, you cannot use a URL Context such as språk. If you 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, you cannot use escaped URL encoding either. For example, a URL Context such as spr%E5k.
- VirtualPortalObjectId
- The object ID that is 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 that is used to reference the virtual portal.
It is good practise to explicitly set a value for
VirtualPortalId
. If you 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.
Syntax
- Specifying the parameter and value that is preceded by -D on the command line.
- Defining them in the file wkplc.properties. Note: The property file must be encoded in the ISO 8859-1 character encoding format.
- AIX®
- ./ConfigEngine.sh create-virtual-portal -DWasPassword=password -DPortalAdminPwd=password -DVirtualPortalTitle=MyVirtualPortalTitle -DVirtualPortalContext=virtual_portal_context_url
- HP-UX
- ./ConfigEngine.sh create-virtual-portal -DWasPassword=password -DPortalAdminPwd=password -DVirtualPortalTitle=MyVirtualPortalTitle -DVirtualPortalContext=virtual_portal_context_url
- IBM® i
- ConfigEngine.sh create-virtual-portal -DWasPassword=password -DPortalAdminPwd=password -DVirtualPortalTitle=MyVirtualPortalTitle -DVirtualPortalContext=virtual_portal_context_url
- Linux™
- ./ConfigEngine.sh create-virtual-portal -DWasPassword=password -DPortalAdminPwd=password -DVirtualPortalTitle=MyVirtualPortalTitle -DVirtualPortalContext=virtual_portal_context_url
- Solaris
- ./ConfigEngine.sh create-virtual-portal -DWasPassword=password -DPortalAdminPwd=password -DVirtualPortalTitle=MyVirtualPortalTitle -DVirtualPortalContext=virtual_portal_context_url
- Windows™
- ConfigEngine.bat create-virtual-portal -DWasPassword=password -DPortalAdminPwd=password -DVirtualPortalTitle=MyVirtualPortalTitle -DVirtualPortalContext=virtual_portal_context_url
- z/OS®
- ./ConfigEngine.sh create-virtual-portal -DWasPassword=password -DPortalAdminPwd=password -DVirtualPortalTitle=MyVirtualPortalTitle -DVirtualPortalContext=virtual_portal_context_url