Task: modify-virtual-portal
Portal ConfigEngine task that modifies a virtual portal.
Parameters
Use this task to modify a virtual portal by using its object ID. To determine the correct object ID of the virtual portal, use the task list-all-virtual-portals .
For z/OS®: The z/OS Customization Dialog uses this task to modify a virtual portal by using its object ID. To determine the correct object ID of the virtual portal, use the job EJPSMVPL that the Customization Dialog created in your target control data set.
- VirtualPortalObjectId
- The object ID of the virtual portal. This input is mandatory for identification of the virtual portal that you want to modify.
- VirtualPortalRealm
- The realm of the virtual portal. You can and must specify a realm only if you have realms enabled in your portal installation.
- 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
You pass the parameters in the parameter list for each
configuration task as appropriate. You do this by either of the following
methods:
- Specifying the parameter and value 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 modify-virtual-portal -DPortalAdminPwd=password -DWasPassword=password
- IBM® i
- ConfigEngine.sh modify-virtual-portal -DPortalAdminPwd=password -DWasPassword=password
- Linux
- ./ConfigEngine.sh modify-virtual-portal -DPortalAdminPwd=password -DWasPassword=password
- Solaris
- ./ConfigEngine.sh modify-virtual-portal -DPortalAdminPwd=password -DWasPassword=password
- Windows
- ConfigEngine.bat modify-virtual-portal -DPortalAdminPwd=password -DWasPassword=password
- z/OS
- No syntax. The Customization Dialog calls this task directly. On z/OS, the Customization Dialog provides options for creating, modifying, or deleting a virtual portal, but not for listing virtual portals. However, when you modify or delete a virtual portal, you need the object ID of that virtual portal. When you create, modify, or delete a virtual portal by using the configuration task of the Customization Dialog, the Customization Dialog creates the job EJPSMVPL in your target control data set. You can use this job to list all virtual portals in your configuration. Submit the job EJPSMVPL. Upon completion, examine the job output. Success is indicated with rc=0 in the job output. This way you can determine the object ID of a virtual portal.