test

Sun Java System Portal Server 7.1 Configuration Guide

Creating a Custom Configuration XML File

If a sample configuration file does not suit your desired setup and if a custom configuration XML file must be constructed, follow the instructions in this section. Sample configuration XML files are provided at the PortalServer-base/samples/psconfig directory. In order to set up your custom configuration file, you must follow this process:

  1. Construct the required basic configuration file XML file. For more information, refer to Constructing the Required Basic XML File.

    This basic configuration is required to make the portal psadmin command usable.

  2. Construct the <ComponentsToConfigure> element depending on which components are to be configured on this host. See Configuring Portal Server Components for more information.

  3. Construct the following configuration information based on the components to configure on this host:

    Configuring Basic Portal Server

    Configuring a Sample Portal

    Configuring Web Container

    Configuring Search Server

    Configuring Secure Remote Access

    Configuring Gateway

    Configuring Netlet Proxy

    Configuring Rewriter Proxy

  4. Run the ./psconfig --config configuration-xml-file command.

Constructing the Required Basic XML File

This section describes the overall Portal Server, header/footer, shared components, and the Access Manager elements in the configuration file. See the example2.xml file.

Procedure To Construct the Required Basic XML File

  1. Edit the example2.xml file.

  2. In the example2.xml file, replace the following tokens with the actual values.

    @HOST.DOMAIN@

    The host and domain name of the machine on which configuration is occurring

    @AMADMIN.PASSWORD@

    Administrator's password for the Access Manager instance with which Portal Server is to be configured

    @AMLDAPUSER.PASSWORD@

    Internal LDAP user password for the Access Manager instance with which Portal Server is to be configured

    @DIRMGR.PASSWORD@

    Administrator's password of the Directory Server with which Portal Server is to be configured

  3. Modify the following values in the file as needed.

    PortalServerConfiguration xsi:noNamespaceSchemaLocation

    If Portal Server is installed in a non-default location, then change this location to the non-default location.

    SharedComponents JCIFSLibDir

    If Netfile utility is required, install the optional JCIFS package and specify the lib directory path name.

    SharedComponents JChardet

    Install the optional JChardet package and specify the lib directory path name.

    AccessManager InstallationDirectory ProdDir, DataDir, ConfigDir

    Specify the installation path name of Access Manager if Access Manager was not installed in the default location.

    PortalConfiguration InstallationDirectory ProdDir, DataDir, ConfigDir

    Specify the installation path name of Portal Server if Portal Server was not installed in the default location.

Configuring Portal Server Components

Portal Server components that can be installed and configured across different nodes include the core Portal Server , Secure Remote Access (SRA), Gateway, Netlet Proxy, and Rewriter Proxy. The <ComponentsToConfigure> element is constructed based on which components are configured on this host.

ProcedureTo Configure Portal Server Components

  1. Include the following in the configuration XML file.

    <ComponentsToConfigure>
		<component>portalserver</component>
		<component>gateway</component>
		<component>netletproxy</component>
		<component>rewriterproxy</component>
</ComponentsToConfigure>

    To exclude components, remove the corresponding <component> element.

Configuring Basic Portal Server

This section explains how to configure a basic Portal Server.

ProcedureTo Configure Basic Portal Server

  1. Open the configuration XML file.

  2. Replace the following tokens in the configuration XML file.

    @HOST.DOMAIN@

    The host and domain name of the machine on which Portal Server is to be configured.

    @PORT@

    Web container port at which Portal Server has to be deployed.

  3. Modify the following values in the configuration XML file.

    PortalConfiguration PortalServer PortalAccessURL (optional)

    If the DEPLOY URI is not the default, change /portal to the changed URI value.

    PortalConfiguration PortalServer PortalWebappURI (optional)

    If the DEPLOY URI is not the default, change /portal to the changed URI value. Ensure that both PortalAccessURL and PortalWebappURI are specified in the configuration XML file.

    PortalConfiguration PortalServer PortalID

    Change portal1 to the required portal ID, which should be unique.

    PortalConfiguration PortalServer Instance InstanceID

    Change myInstance to the required instance ID, which should be unique.

    PortalConfiguration PortalServer SearchServerID (optional)

    Specifies which Search Server this portal samples are configured with. This is needed only if samples are configured.

Configuring a Sample Portal

Portal Server software three types of sample portals: the Developer Sample, Enterprise Sample, and Community Sample. Each sample is created under its own sub-org for ease of management. You can configure any of the samples or all of the samples.

ProcedureTo Configure a Sample Portal

  1. Include the following in the configuration XML file.

    <PortalConfiguration>
		<PortalServer 
			.
			.
			.
		>
			<SamplePortal>
				<Sample Name="DeveloperPortal"/>
				<Sample Name="EnterprisePortal"/>
				<Sample Name="CommunityPortal"/>
			</SamplePortal>
			.
			.
			.
		</PortalServer>
</PortalConfiguration>

Configuring Web Container

The Web container configuration varies with the container to be configured. In the configuration XML file, there is one <WebContainerProperties> element specified for the web container under the <PortalServer><Instance> element and one under the <SearchServer> element.

ProcedureTo Configure the Web Container

  1. Open the configuration XML file.

    • For Web Server, open example1.xml, examples 3 to 9, example13.xml, or example17.xml.

    • For Application Server, open the example14.xml file.

  2. Replace the tokens with actual values.

    For Web Server:

    @HOST.DOMAIN@

    The host and domain name of the machine on which the Portal Server instance is to be configured

    @PORT@

    Web Server port

    @INSTANCENAME@

    Web Server instance name

    @ADMIN.PORT@

    Web Server administration port

    @PASSWORD@

    Web Server administrator's password

    For Application Server:

    @HOST.DOMAIN@

    The host and domain name of the machine on which the Portal Server instance is to be configured

    @PORT@

    Application Server port

    @ADMIN.PORT@

    Application Server administration port

    @PASSWORD@

    Application Server administrator's password

    @MASTER.PASSWORD@

    Application Server master password if specified

  3. Modify the following values in the configuration XML file as needed.

    For Application Server:

    WebContainerInstallDir

    If Application Server is installed at a non-default location insert the installation path name.

    WebContainerDomainName, WebContainerInstanceDir, WebContainerDocRoot

    If deploying to a non-default Application Server domain insert the appropriate name.

    WebContainerInstanceName

    Instance name within the Application Server domain. The server is the name of the first instance which is created by default at the same time the Application Server 8.1 domain is created. This can be changed to the name of any other created instance within that domain.

Configuring Search Server

The Search Server is deployed to a specific web container instance which is defined by a <WebContainerProperties> element. Multiple Search servers can be specified by having multiple <SearchServer> elements within a <PortalConfiguration> section, each with a unique ID. A Portal Server can be associated with a specific search server by specifying the SearchServerID attribute within the <PortalServer> element.

ProcedureTo Configure Search Server

  1. In the configuration XML file, include the SearchServerID attribute within the <PortalServer> element.

    <PortalConfiguration>
		<SearchServer SearchServerID="search1">
			<WebContainerProperties
				.
				.
				.
			/>
		</SearchServer>
		<PortalServer 
			SearchServerID="search1">
		</PortalServer>
</PortalConfiguration>

Configuring Secure Remote Access

The SRA core component can only be installed and configured on the same node as the Portal Server component. The Portal Server and SRA core components have to be configured at the same time. So the SRA core component cannot be configured on a host that already has an existing Portal Server.

ProcedureTo Configure Secure Remote Access

  1. Add Secure remote access support to Portal Server by adding the <component>sracore</component> to the <ComponentsToConfigure> section.

  2. Add the following section to the <PortalConfiguration> section.

    <PortalConfiguration>
		.
		.
		.
		<SecureRemoteAccessCore
			GatewayProtocol="https"
			PortalServerDomain="@DOMAIN@" 
			GatewayPort="@GATEWAY.PORT@"
			GatewayProfileName="default"
		LogUserPassword="@SRA.LOGUSER.PASSWORD@"/>
</PortalConfiguration>

  3. Replace the tokens with actual values.

    @DOMAIN@

    Domain name of the machine on which Portal Server is to be configured

    @GATEWAY.PORT@

    Port on which Gateway is to run

    @SRA.LOGUSER.PASSWORD@

    SRA log user password

  4. Modify the GatewayProfileName value if the default profile will not be used.

Configuring Gateway

This section explains how to configure Gateway with Portal Server.

ProcedureTo Configure Gateway

  1. Open the example10.xml file.

  2. Replace the following tokens with actual values.

    @HOST.DOMAIN@

    The host and domain name of the machine on which Gateway is to be configured

    @GATEWAY.PORT@

    Port on which Gateway will run

    @IPADDRESS@

    IP address of the machine on which Gateway will run

    @PSHOST.DOMAIN@

    The host and domain name of the machine on which the Portal Server instance is to be configured

    @PORT@

    Port on which the Portal Server instance will run

    @SRA.LOGUSER.PASSWORD@

    SRA log user password

    @SRA.CERTDB.PASSWORD@

    SRA certificate database password

  3. Modify the following values as needed.

    Gateway Profile

    Change if the default profile will not be used

    Gateway SRAInstance StartInstance

    Change if start on installation is not required

    CertificateInformation

    Change attributes in this section accordingly

Configuring Netlet Proxy

This section explains how to configure the Netlet proxy.

ProcedureTo Configure Netlet Proxy

  1. Open the example11.xml file.

  2. Replace the tokens with the actual values.

    @HOST.DOMAIN@

    The host and domain name of the machine on which Netlet Proxy will be configured

    @NETLET.PROXY.PORT@

    Port on which Netlet Proxy will run

    @IPADDRESS@

    IP address of the machine on which Netlet Proxy will run

    @PSHOST.DOMAIN@

    The host and domain name of the machine on which the Portal Server instance will be configured

    @PORT@

    Port on which the Portal Server instance will run

    @SRA.LOGUSER.PASSWORD@

    SRA log user password

    @SRA.CERTDB.PASSWORD@

    SRA certificate database password

  3. Modify the following values as needed.

    NetletProxy Profile

    Change if the default profile will not be used

    NetletProxy SRAInstance StartInstance

    Change if start on installation is not required

    CertificateInformation

    Change attributes in this section accordingly

Configuring Rewriter Proxy

This section explains how to configure Rewriter Proxy.

ProcedureTo Configure Rewriter Proxy

  1. Open the example12.xml file.

  2. Replace the tokens with the actual values.

    @HOST.DOMAIN@

    The host and domain name of the machine on which Rewriter Proxy will be configured

    @REWRITER.PROXY.PORT@

    Port on which Rewriter Proxy will run

    @IPADDRESS@

    IP address of the machine on which Rewriter Proxy will run

    @PSHOST.DOMAIN@

    The host and domain name of the machine on which portal instance will be configured

    @PORT@

    Port on which Portal Server instance runs

    @SRA.LOGUSER.PASSWORD@

    SRA log user password

    @SRA.CERTDB.PASSWORD@

    SRA Certificate database password

  3. Modify the following values as needed.

    RewriterProxy Profile

    Change if the default profile is not to be used

    RewriterProxy SRAInstance StartInstance

    Change if start on install is not required

    CertificateInformation

    Change attributes in this section accordingly