setExternalNavigator command

Prerequisites

The following conditions must be met:

• In clustered environments, the command must be run on the deployment manager node. In non-clustered environments, the command must be run on the stand-alone server.
• If the deployment manager or stand-alone server is stopped, use the wsadmin -conntype none option to run the command in disconnected mode (which is the recommended mode for this command).

Location

Start the wsadmin scripting client from the profile_root/bin directory. The setExternalNavigator command does not write to a log file, but the wsadmin scripting client always writes a profile_root/logs/wsadmin.traceout log file where you find exception stack traces and other information.

Syntax

setExternalNavigator
[-de deployment_environment_name]
-icnUrl external_ICN_server_URL 
-icnAdminUser external_ICN_admin_user 
-icnAdminPassword external_ICN_admin_password
[-workflowWebServerURL web_server_URL] 
[-publicIcnURL public_ICN_URL]

Parameters

-de deployment_environment_name

A parameter that specifies the name of the current deployment environment. If there is only one deployment environment in the WebSphere cell, you can omit this parameter.

-icnUrl external_ICN_server_URL

A required parameter that specifies the URL of the external IBM Content Navigator server. The URL format is https://ICN_host:PORT/ICN_Context_Root and must be accessed by using the HTTPS protocol. For example, https://localhost:9443/navigator. This URL would be the URL that client users use in their client browsers to access IBM Content Navigator. If the client users access IBM Content Navigator through a web server such as the IBM HTTP Server (IHS), load balancer, or virtual IP, the -icnUrl value must be set to the URL of the web server, load balancer, or virtual IP. Case client users must access IBM Content Navigator with this URL when it is configured to prevent a Cross-Origin Resource Sharing (CORS) error.

Important: The external_ICN_server_URL value must be all lowercase to prevent a CORS error. The browser normalizes the value that is entered into lowercase. However, CORS is case-sensitive, so if the original URL is not lowercase, you might get an error similar to:

Access to ... from origin 'https://myhostname.x.y.z:9444' has been blocked by CORS policy: The 'Access-Control-Allow-Origin' header has a value 'https://myHostName.x.y.z:9444' that is not equal to the supplied origin.

-icnAdminUser external_ICN_admin_user

A required parameter that specifies the username of the external IBM Content Navigator administrator.

-icnAdminPassword external_ICN_admin_password

A required parameter that specifies the password of the external IBM Content Navigator administrator.

-workflowWebServerURL web_server_URL

An optional parameter that configures the access URL of the IBM Business Automation Workflow server from the external IBM Content Navigator server. If it is not specified, the first application cluster member URL is used. Hence, it is required when the IBM Business Automation Workflow server is accessed through a web server such as the IBM HTTP Server (IHS), load balancer, or virtual IP. The URL format is https://baw_web_server_host:baw_web_server_port.

-publicIcnURL public_ICN_URL

An optional parameter that specifies the web server URL of the external IBM Content Navigator server. This parameter is required if you are using a third-party authentication provider such as WebSEAL for external IBM Content Navigator. The URL format is https://ICN_web_server_host:port/ICN_context_root.

For example, https://icn_web_server_host:9443/navigator