Copyright © TIBCO Software Inc. All Rights Reserved

Configuring the API Exchange Gateway Engine and the Portal Engine

The configuration steps consist of configuring the following:

1.	The asg.properties file on the API Exchange Gateway host

2.	The asg-portal.properties file on the host that is running the management portal.

(On Host 1) Configure the asg.properties File

1.	Go to the TIBCO_HOME/asg/2.1/templates/asg directory and edit the asg.properties file.

2.	Check the port number for the tibco.clientVar.DefaultImplementation/Connections/HTTP/FacadeHTTPConnection/Port property

3.	Ensure that the port number specified is different than the port number specified for the tibco.clientVar.DefaultImplementation/Connections/HTTP/FacadeHTTPConnection/Port= property that is specified in the asg-portal.properties file.

(On Host 1) Configure the Central Logger on the Gateway Engine

To enable display of usage statistics on the Organizations page of the Management Portal, you must configure Central Logger for the Gateway component and specify a quota usage checking interval.

For general information on configuring Central Logger, see the “Central Logger” section in Chapter 14 of the TIBCO API Exchange Gateway User’s Guide, “Gateway Management Features.”

To configure the Central Logger on the gateway host:

1.	Enable central logging in the asg.properties file for the gateway.

For specific information, see “Enable Reporting to Central Logger” in Chapter 14 of the TIBCO API Exchange Gateway User’s Guide, “Gateway Management Features.”

2.	Configure the asg_cl.properties file to specify the necessary database connection parameters for central logging.

For specific information, see “Setup the database connection parameters” in Chapter 14 of the TIBCO API Exchange Gateway User’s Guide, “Gateway Management Features.”

(On Host 1) Configure the asg_portal.properties File

Configure General Configuration Settings

On the host that will run the management portal, complete these steps to edit the asg_portal.properties file to specify general configuration to allow the portal to communicate with the API Exchange Gateway:

1.	Set Reporting to Off. Make sure that the reportingEnables variable is set to false:

   # Turn on or off reporting to CL

     tibco.clientVar.ASG/Logging/reportingEnabled=false

 

2.	Specify the driver and URL for MySQL:

   # Portal Engine MySQL

   asg.portal.engine.mysql.database.driver=com.mysql.jdbc.Driver

   asg.portal.engine.mysql.database.url=jdbc:mysql://
   <portal_engine_IP_address>:3306/asg_openapi?autoReconnect=true

 

where portal_engine_IP_address is the IP address of the host running the portal.

3.	Specify the URL where Swagger specifications are located:

# Portal Engine Swagger specification document location URL prefix

   asg.portal.engine.swagger.spec.url.prefix   =https://portal_engine_IP_address/joomlaUpgrade/uploads/swaggerSpecs/

where portal_engine_IP_address is the IP address of the host running the portal.

 

The URL might be http:// or https://, depending on the Apache configuration for Joomla.

4.	Specify the Portal Server URL prefix:

# Portal Server URL prefix

asg.portal.url.prefix =https://portal_engine_IP_address/joomlaUpgrade

where portal_engine_IP_address is the IP address of the host running the portal.

 

The URL might be http:// or https://, depending on the Apache configuration for Joomla.

5.	Save the asg_portal.properties file.

Set Properties for Central Logging

On the host that will run the management portal, edit the asg_portal.properties file to specify properties for the Central Logger:

1.	Edit the asg-portal.properties file to specify database properties for the Central Logger:

−	Identify the Central Logger database. The following example identifies a MySQL database:

# Central Logger database

asg.portal.engine.cl.database.driver=com.mysql.jdbc.Driver

asg.portal.engine.cl.database.url=jdbc:mysql://localhost:3306/asgstat?autoReconnect=true

−	Configure the Central Logger database connection pool. The following example shows a sample configuration for the database connection pool:

# Central Logger database connection pool

asg.portal.engine.cl.db.connectionPool.initialConnections=3

asg.portal.engine.cl.db.connectionPool.maxConnections=10

asg.portal.engine.cl.db.connectionPool.waitIfBusy=true

−	Specify the database username and password, as shown in the following example:

# Central Logger database username/password

asg.portal.engine.cl.db.username=root

asg.portal.engine.cl.db.password=root

2.	Edit the asg-portal.properties file to specify the quota checking interval. The default usage check interval is 10 minutes. The following example sets the quota checking interval to 1 minute:

# Quota usage checking interval in minutes

asg.portal.engine.quotaUsageCheckInterval=1

Starting the Configuration

To start the configuration (for example, Book Query) issue the following command:

asg-engine.exe - -a BookQuery

To start the portal project, enter the following command:

asg-portal-engine -a PortalProject

Starting the asg-engine Configuration to Support Quota Notification

To support quota throttle notification (notification when usage for a particular application reaches a limit set for a specified environment), start each engine in the portal environment using the -n EngineName parameter for the asg-engine command:

asg-engine.exe -n EngineName

where EngineName specifies a unique engine name.

Copyright © TIBCO Software Inc. All Rights Reserved