Installing and Running Gateway Components as Windows Services

Copyright © Cloud Software Group, Inc. All Rights Reserved

Chapter 2 Installing TIBCO API Exchange Gateway : Installing and Running Gateway Components as Windows Services

Installing and Running Gateway Components as Windows Services

This section describes the procedure to install and run the Core Engine (asg-engine) and other components of TIBCO API Exchange Gateway as a Windows service.

Install and Run the Config UI Server as a Windows Service

1.

Navigate to the ASG_HOME/bin directory.

2.

Copy the existing asg-configui.tra file as follows:

copy asg-configui.tra JHF_asg-configui.tra

3.

Using a text editor, edit the JHF_asg-configui.tra file as follows:

a.

Locate APP_ARGS variable to set the path to the asg_core.ear EAR file.

      tibco.env.APP_ARGS=ASG_HOME %ASG_PORT%

For example:

      tibco.env.APP_ARGS=C:\tibcoasg\asg\2.1 %ASG_PORT%

b.

To install the Config UI server as a Windows service, add the following properties:

ntservice.name=ASG-ConfigUI

ntservice.displayname=TIBCO ASG Config UI

ntservice.starttype=automatic

ntservice.binary.path.absolute=ASG_HOME/bin/asg-configui.exe --propFile ASG_HOME/bin/JHF_asg-configui.tra

ntservice.interactive=false

c.

Add the following property to configure the location of the log directory (Optional):

      Engine.Log.Dir ASG_HOME/bin/configui/logs

d.

Verify that RV_HOME and HAWK_HOME variables are set appropriately to the directory where TIBCO Rendezvous and TIBCO Hawk® products are installed.

e.

Verify that tibco.class.path.extended variable includes the HAWK_HOME/lib directory at the beginning, as follows:

      tibco.class.path.extended       %HAWK_HOME%/lib%PSP%%CUSTOM_EXT_PREPEND_CP%%PSP%%STD_EXT_CP%      %PSP%%CUSTOM_EXT_APPEND_CP%%PSP%

f.

Save the JHF_asg-configui.tra file.

4.

Open a command prompt window. Change to the ASG_HOME/bin directory. Run the following command:

   asg-configui --propFile JHF_asg-configui.tra --install

5.

Open the Services Manager on the Windows system. Verify that TIBCO ASG Config UI is added as a service in the local services list.

6.

Right-click the TIBCO ASG Config UI service and select Start to run the Config UI server.

•

To uninstall a Windows service, type the following command:

asg-configui --propFile JHF_asg-configui.tra --uninstall

•

If you make any change to the JHF_asg-configui.tra file after the service is registered, make sure to run --uninstall and --install again to register the changes.

Install and Run the Core Engine as a Windows Service

1.

Navigate to the ASG_HOME/bin directory.

2.

Copy the existing asg-engine.tra as follows:

copy asg-engine.tra JHF_asg-engine.tra

3.

Using a text editor, edit the JHF_asg-engine.tra file as follows:

a.

Locate APP_ARGS variable to set the path to the asg_core.ear EAR file.

      tibco.env.APP_ARGS=ASG_HOME/bin/asg_core.ear

For example,

      tibco.env.APP_ARGS=C\:/tibcoasg/asg/2.1/bin/asg_core.ear

To run the Core Engine with a project configuration, add the project configuration name in the tibco.env.APP_ARGS variable as follows:

tibco.env.APP_ARGS=ASG_HOME/bin/asg_core.ear -u asg-caching-core -a ASGProject Configuration Name

b.

To install the Core Engine as a Windows service, add the following properties:

ntservice.name=ASG-Caching-Core Engine

ntservice.displayname=TIBCO ASG Gateway Caching Core Engine

ntservice.starttype=automatic

ntservice.binary.path.absolute=ASG_HOME/bin/asg-engine.exe --propFile ASG_HOME/bin/JHF_asg-engine.tra

ntservice.interactive=false

c.

Add the following property to configure the location of the log directory (Optional):

      Engine.Log.Dir ASG_HOME/bin/logs

d.

Verify that RV_HOME and HAWK_HOME variables are set appropriately to the directory where TIBCO Rendezvous and TIBCO Hawk products are installed.

e.

Edit the tibco.class.path.extended variable to include the HAWK_HOME/lib directory at the beginning, as follows:

      tibco.class.path.extended       %HAWK_HOME%/lib%PSP%%CUSTOM_EXT_PREPEND_CP%%PSP%%STD_EXT_CP%      %PSP%%CUSTOM_EXT_APPEND_CP%%PSP%

f.

Save the JHF_asg-engine.tra file.

4.

Open a command prompt window. Change to the ASG_HOME/bin directory. Run the following command:

   asg-engine.exe --propFile JHF_asg-engine.tra --install

5.

Open the Services Manager on the Windows system. Verify that TIBCO ASG Gateway Caching Core Engine is added as a service in the local services list.

6.

Right-click the TIBCO ASG Gateway Caching Core Engine service and click Start to run the cache-enabled Core Engine.

•

To uninstall a Windows service, type the following command:

asg-engine.exe --propFile JHF_asg-engine.tra --uninstall

•

If you make any change to the JHF_asg-engine.tra file after the service is registered, make sure to run --uninstall and --install again to register the changes.

Install and Run the Central Logger as a Windows Service

1.

Navigate to the ASG_HOME/bin directory.

2.

Copy the existing asg-engine.tra file as follows:

copy asg-engine.tra JHF_asg-cl.tra

3.

Using a text editor, edit the JHF_asg-cl.tra file as follows :

a.

Locate APP_ARGS variable to set the path to the asg_core.ear EAR file.

      tibco.env.APP_ARGS=ASG_HOME/bin/asg_core.ear -u asg-cl

For example,

      tibco.env.APP_ARGS=C:/tibcoasg/asg/2.1/bin/asg_core.ear -u       asg-cl

To run the Central Logger with a project configuration, add the project configuration name in the tibco.env.APP_ARGS variable as follows:

tibco.env.APP_ARGS=ASG_HOME/bin/asg_core.ear -u asg-cl -a ASGProject Configuration Name

b.

To install the Central Logger as a Windows service, add the following properties::

ntservice.name=ASG-Central-Logger

ntservice.displayname=TIBCO ASG Central Logger

ntservice.starttype=automatic

ntservice.binary.path.absolute=ASG_HOME/bin/asg-engine.exe --propFile ASG_HOME/bin/JHF_asg-cl.tra

ntservice.interactive=false

c.

Add the following property to configure the location of the log directory (Optional):

      Engine.Log.Dir ASG_HOME/bin/centrallogger/logs

d.

Verify that RV_HOME and HAWK_HOME variables are set appropriately to the directory where TIBCO Rendezvous and TIBCO Hawk products are installed.

e.

Verify that the tibco.class.path.extended variable includes HAWK_HOME/lib directory at the beginning, as follows:

      tibco.class.path.extended       %HAWK_HOME%/lib%PSP%%CUSTOM_EXT_PREPEND_CP%%PSP%%STD_EXT_CP%      %PSP%%CUSTOM_EXT_APPEND_CP%%PSP%

f.

Save the JHF_asg-cl.tra file.

4.

Open a command prompt window . Change to the ASG_HOME/bin directory. Run the following command:

   asg-engine.exe --propFile JHF_asg-cl.tra --install

5.

Open the Services Manager on the Windows system. Verify that TIBCO ASG Central Logger is added as a service in the local services list.

6.

Right-click the TIBCO ASG Central Logger service and click Start to run the Central Logger.

•

To uninstall a Windows service, type the following command:

asg-engine.exe --propFile JHF_asg-cl.tra --uninstall

•

If you make any change to the JHF_asg-cl.tra file after the service is registered, make sure to run --uninstall and --install again to register the changes.

Install and Run the Global Throttle Manager as a Windows Service

1.

Navigate to the ASG_HOME/bin directory.

2.

Copy the existing asg-engine.tra file as follows:

copy asg-engine.tra JHF_asg-gtm.tra

3.

Using a text editor, edit the JHF_asg-gtm.tra file as follows :

a.

Locate APP_ARGS variable to set the path to the asg_core.ear EAR file.

      tibco.env.APP_ARGS=ASG_HOME/bin/asg_core.ear -u       asg-gtm

For example,

      tibco.env.APP_ARGS=C:/tibcoasg/asg/2.1/bin/asg_core.ear -u       asg-gtm

b.

To install the Global Throttle Manager as a Windows service, add the following properties:

ntservice.name=ASG-GTM

ntservice.displayname=TIBCO ASG Global Throttle Manager

ntservice.starttype=automatic

ntservice.binary.path.absolute=ASG_HOME/bin/asg-engine.exe --propFile ASG_HOME/bin/JHF_asg-gtm.tra

ntservice.interactive=false

c.

Add the following property to configure the location of the log directory (Optional):

      Engine.Log.Dir ASG_HOME/bin/gtm/logs

d.

Verify that RV_HOME and HAWK_HOME variables are set appropriately to the directory where TIBCO Rendezvous and TIBCO Hawk products are installed.

e.

Verify that the tibco.class.path.extended variable includes HAWK_HOME/lib directory at the beginning, as follows:

      tibco.class.path.extended       %HAWK_HOME%/lib%PSP%%CUSTOM_EXT_PREPEND_CP%%PSP%%STD_EXT_CP%      %PSP%%CUSTOM_EXT_APPEND_CP%%PSP%

f.

Save the JHF_asg-gtm.tra file.

4.

Open a command prompt window. Change to the ASG_HOME/bin directory. Run the following command:

   asg-engine.exe --propFile JHF_asg-gtm.tra --install

5.

Open the Services Manager on the Windows system. Verify that TIBCO ASG Global Throttle Manager is added as a service in the local services list.

6.

Right-click the TIBCO ASG Global Throttle Manager service and click Start to run the Global Throttle Manager.

•

To uninstall a Windows service, type the following command:

asg-engine.exe --propFile JHF_asg-gtm.tra --uninstall

•

If you make any change to the JHF_asg-gtm.tra file after the service is registered, make sure to run --uninstall and --install again to register the changes.

Install and Run the Cache Agent as a Windows Service

1.

Navigate to the ASG_HOME/bin directory.

2.

Copy the existing asg-engine.tra file as follows:

copy asg-engine.tra JHF_asg-cache-agent.tra

3.

Using a text editor, edit the JHF_asg-cache-agent.tra file as follows:

a.

Locate APP_ARGS variable to set the path to the asg_core.ear EAR file.

      tibco.env.APP_ARGS=ASG_HOME/bin/asg_core.ear -u       asg-cache

For example,

      tibco.env.APP_ARGS=C:/tibcoasg/asg/2.1/bin/asg_core.ear -u       asg-cache

b.

To install the Cache Agent as a Windows service, add the following properties:

ntservice.name=ASG-Cache-Agent

ntservice.displayname=TIBCO ASG Cache Agent

ntservice.starttype=automatic

ntservice.binary.path.absolute=ASG_HOME/bin/asg-engine.exe --propFile ASG_HOME/bin/JHF_asg-cache-agent.tra

ntservice.interactive=false

c.

Add the following property to configure the location of the log directory (Optional):

      Engine.Log.Dir ASG_HOME/bin/cache/logs

d.

Verify that RV_HOME and HAWK_HOME variables are set appropriately to the directory where TIBCO Rendezvous and TIBCO Hawk products are installed.

e.

Verify that the tibco.class.path.extended variable includes HAWK_HOME/lib directory at the beginning, as follows:

      tibco.class.path.extended       %HAWK_HOME%/lib%PSP%%CUSTOM_EXT_PREPEND_CP%%PSP%%STD_EXT_CP%      %PSP%%CUSTOM_EXT_APPEND_CP%%PSP%

f.

Save the JHF_asg-cache-agent.tra file.

4.

Open a command prompt window. Change to the ASG_HOME/bin directory. Run the following command:

   asg-engine.exe --propFile JHF_asg-cache-agent.tra --install

5.

Open Services Manager on the Windows system. Verify that TIBCO ASG Cache Agent is added as a service in the local services list.

6.

Right-click the TIBCO ASG Cache Agent service and click Start to run the Cache Agent.

•

To uninstall a Windows service, type the following command:

asg-engine.exe --propFile JHF_asg-cache-agent.tra --uninstall

•

If you make any change to the JHF_asg-cache-agent.tra file after the service is registered, make sure to run --uninstall and --install to register the changes.

Install and Run the Cache Cleanup Agent as a Windows Service

1.

Navigate to the ASG_HOME/bin directory.

2.

Copy the existing asg-engine.tra file as follows:

copy asg-engine.tra JHF_asg-cache-cleanup.tra

3.

Using a text editor, edit the JHF_asg-cache-cleanup.tra file as follows:

a.

Locate the APP_ARGS variable to set the path to the asg_core.ear EAR file.

      tibco.env.APP_ARGS=ASG_HOME/bin/asg_core.ear -u       asg-cache-cleanup

For example,

      tibco.env.APP_ARGS=C:/tibcoasg/asg/2.1/bin/asg_core.ear -u       asg-cache-cleanup

b.

To install the Cache Cleanup Agent as a Windows service, add the following properties:

ntservice.name=ASG-Cache-Cleanup

ntservice.displayname=TIBCO ASG Cache Cleanup

ntservice.starttype=automatic

ntservice.binary.path.absolute=ASG_HOME/bin/asg-engine.exe --propFile ASG_HOME/bin/JHF_asg-cache-cleanup.tra

ntservice.interactive=false

c.

Add the following property to configure the location of the log directory (Optional):

      Engine.Log.Dir ASG_HOME/bin/cachecleanup/logs

d.

Verify that RV_HOME and HAWK_HOME variables are set appropriately to the location where the RV and HAWK products are installed.

e.

Verify that the tibco.class.path.extended variable includes HAWK_HOME/lib directory at the beginning, as follows:

      tibco.class.path.extended       %HAWK_HOME%/lib%PSP%%CUSTOM_EXT_PREPEND_CP%%PSP%%STD_EXT_CP%      %PSP%%CUSTOM_EXT_APPEND_CP%%PSP%

f.

Save the JHF_asg-cache-cleanup.tra file.

4.

Open a command prompt window. Change to the ASG_HOME/bin directory. Run the following command:

   asg-engine.exe --propFile JHF_asg-cache-cleanup.tra --install

5.

Open the Services Manager on the Windows system. Verify that TIBCO ASG Cache Cleanup is added as a service in the local services list.

6.

Right-click the TIBCO ASG Cache Cleanup service and click Start to run the Cache Cleanup Agent.

•

To uninstall a Windows service, type the following command:

asg-engine.exe --propFile JHF_asg-cache-agent.tra --uninstall

•

If you make any change to the JHF_asg-cache-agent.tra file after the service is registered, make sure to run --uninstall and --install again to register the changes.