Starting GUI

Copyright © Cloud Software Group, Inc. All Rights Reserved

Starting GUI

This section explains the steps to start the configuration server in a test environment.

1.

Open a window.

2.

Navigate to the ASG_HOME/bin directory.

3.

Start the Config UI as follows:

On the Windows platform, type the following command on a command prompt:

   asg-configui.exe

On the UNIX platform, type the following command on a terminal window:

   ./asg-configui

4.

Open a browser window and enter the following URL:

   http://localhost:9200/ConfigUI

To access the Config UI using the HTTPs transport, see Access Config UI through HTTPs Transport.

5.

Enter the login information as follows:

   username:admin

   password:admin

6.

Ensure that the user logs on the Config UI successfully.

7.

Ensure that the following default project configurations are displayed under Projects panel:

−

default

−

GetLocation

−

BookQuery

−

BookQueryWSS

−

Caching

−

BookQueryBE

−

BookQueryBEWSS

−

APIExchange

−

BookQuerySecurity

−

ProductQuery

Access Config UI through HTTPs Transport

To access the Config UI of TIBCO API Exchange Gateway through HTTPs transport, do the following :

1.

Stop the GUI server (if running).

2.

Open a terminal window.

3.

Navigate to the ASG_HOME/bin directory.

4.

Make a copy of the asg-configui.tra file.

5.

Using a text editor, edit the asg-configui.tra file. To enable SSL, set the following properties:

java.property.com.tibco.asg.designtime.configui.launcher.secure=true

java.property.com.tibco.asg.designtime.configui.launcher.SSLEnabled=true

•

To enable SSL, both properties should be set to true.

•

To disable SSL, both properties should be set to false.

•

TIBCO API Exchange Gateway supports one-way SSL to access Config UI using HTTPs transport.

6.

Set the keystore configuration properties as explained in the SSL Properties for HTTPs Transport table.

7.

Save the changes in the file.

SSL Properties for Config UI

The following table explains the SSL properties to specify the keystore configuration for using the HTTPs transport:

Table 40 SSL Properties for HTTPs Transport

Property

Description

java.property.com.tibco.asg.designtime.configui.launcher.secure

To enable SSL connection, set this property to true.

java.property.com.tibco.asg.designtime.configui.launcher.SSLEnabled

Enables the SSL communication. Set this property to true to use HTTPs transport.

The default value is false.

If this property is set to true, it requires the scheme and secure properties to be set correctly for HTTPs transport.

java.property.com.tibco.asg.designtime.configui.launcher.scheme

Set this property to the name of the protocol for SSL.

Set this to https.

java.property.com.tibco.asg.designtime.configui.launcher.keyAlias

The alias used to specify the server certificate in the keystore. If not specified the first key read in the keystore is used.

java.property.com.tibco.asg.designtime.configui.launcher.keystoreFile

The path to the keystore file. The keystore file contains the server certificates. The JKS format keystore type is supported.

For example, C:/tibco/keystores/config.jks

By default, the pathname is the .keystore file. The file is stored in the home directory of the user who is running Tomcat server.

java.property.com.tibco.asg.designtime.configui.launcher.keystorePass

The password used to access the server key from the specified keystore file.

java.property.com.tibco.asg.designtime.configui.launcher.sslProtocol

The version of the SSL protocol to use. If not specified, the default value is TLS.

The following SSL protocols are supported:

SSL,SSLv3,TLSv1,TLSv1.1, TLSv1.2

java.property.com.tibco.asg.designtime.configui.launcher.server

Overrides the server header informaion for the http response.

If this property is set, the value for this attribute overrides the default header of Tomcat or any server set by a web application. For example, Apache

If this property is not set, any value specified by the application is used. If the application does not specify a value, Apache-Coyote/1.1 is used by default.

Changing Login, Host, and Port Information

The values for username, password, host, and port are configured in the ASG_HOME/bin/asg-configui.tra file. By default, the values are shown as follows:

   tibco.env.ASG_HOST=localhost

   tibco.env.ASG_PORT=9200

   tibco.env.ASG_ADMIN_USERNAME=asgadmin

   tibco.env.ASG_ADMIN_PASSWORD=asgadmin

To change the values for username, password, host, and port, follow these steps:

1.

Open a terminal window.

2.

Navigate to the ASG_HOME/bin directory.

3.

Make a copy of the asg-configui.tra file.

4.

Edit the asg-configui.tra file using a text editor to set the following properties, as required:

   tibco.env.ASG_HOST= hostname

   tibco.env.ASG_PORT= port

   tibco.env.ASG_ADMIN_USERNAME= username

   tibco.env.ASG_ADMIN_PASSWORD= password

5.

Stop the GUI server (if running).

6.

Restart the GUI server using the asg-configui executable.

For example,

On the Windows, run the asg-configui.exe.

On the UNIX, type the following command:

   ./asg-configui

For production systems, it is recommended to deploy the ASGConfig.war file on a secure application server running in the production environment. The war file is located under the ASG_HOME/webapp directory.

Property	Description
java.property.com.tibco.asg.designtime.configui.launcher.secure	To enable SSL connection, set this property to true.
java.property.com.tibco.asg.designtime.configui.launcher.SSLEnabled	Enables the SSL communication. Set this property to true to use HTTPs transport. The default value is false. If this property is set to true, it requires the scheme and secure properties to be set correctly for HTTPs transport.
java.property.com.tibco.asg.designtime.configui.launcher.scheme	Set this property to the name of the protocol for SSL. Set this to https.
java.property.com.tibco.asg.designtime.configui.launcher.keyAlias	The alias used to specify the server certificate in the keystore. If not specified the first key read in the keystore is used.
java.property.com.tibco.asg.designtime.configui.launcher.keystoreFile	The path to the keystore file. The keystore file contains the server certificates. The JKS format keystore type is supported. For example, C:/tibco/keystores/config.jks By default, the pathname is the .keystore file. The file is stored in the home directory of the user who is running Tomcat server.
java.property.com.tibco.asg.designtime.configui.launcher.keystorePass	The password used to access the server key from the specified keystore file.
java.property.com.tibco.asg.designtime.configui.launcher.sslProtocol	The version of the SSL protocol to use. If not specified, the default value is TLS. The following SSL protocols are supported: SSL,SSLv3,TLSv1,TLSv1.1, TLSv1.2
java.property.com.tibco.asg.designtime.configui.launcher.server	Overrides the server header informaion for the http response. If this property is set, the value for this attribute overrides the default header of Tomcat or any server set by a web application. For example, Apache If this property is not set, any value specified by the application is used. If the application does not specify a value, Apache-Coyote/1.1 is used by default.