Starting Core Engine

To start the Core Engine, use the following command format. See Table 11, Core Engine Command-Line Options for the various command-line options. 

ASG_HOME/bin/asg-engine [-h] [--propFile startup property file] [--propVar varName=value
] [-p custom property file] [-n engine name] [-d][-a asg config folder] [-c CDD file] [-u processing unit ID]  [EAR file]
Core Engine Command-Line Options
Option Description 
-h
 Displays this help. 
--propFile
 Specifies the location of the startup property file (TRA file).

When you execute asg-engine, by default, it looks for a property file of the same name (asg-engine.tra) in the directory where you execute the command. This property file provides the startup values and other parameters to the engine executable.

To explicitly specify a path and file name of the startup property file, use the --propFile parameter. For example, to use asg_startup.tra file as the startup property file for the Core Engine, specify the --propFile parameter as follows:

asg-engine --propFile c:\tibco\mylocation\asg_startup.tra 

--propVar
 Used to provide a value for a specified variable. This value overrides any other design-time value. The format is propVar varName=value . For example to specify the value of the %jmx_port% variable used in TRA files to configure a JMX connection, use this: --propVar jmx_port=XXXX, where XXXX is the port number. 
-p
 Specifies the path and file name of a custom property file to be passed to asg-engine. You can also pass multiple custom property files. 
-n
 Provides a name for the Core Engine. The name provided here is used in the console and log files.

The default value is the processing unit name. 

-d
 Starts the debugger service on the Core Engine for remote debugging. 
-a
 Specifies the location of a TIBCO API Exchange Gateway configuration directory. 
-c
 Specifies the path and file name for the Cluster Deployment Descriptor (CDD) file to be used.

The default is default.cdd. 

-u
 Specifies the processing unit name to be used for this engine. This processing unit name must exist in the CDD file referred to the -c option.

The following processing unit names are available. See Processing Units of Core Engine for processing units details.

  • asg-core: Starts the Core Engine.
  • asg-caching-core: Starts the Core Engine in Cache Agent enabled mode.
  • asg-gtm: Starts the Global Throttle Manager.
  • asg-cache: Starts the Cache Agent.
  • asg-cache-cleanup: Starts the Cache Cleanup Agent.
  • asg-cl: Starts the Central Logger.

    The default processing unit is asg-caching-core. 

EAR filename and path
 Specifies the path and file name for the EAR file to be used.

If you do not specify the EAR file name and no tibco.repourl property is set, the EAR file defaults to ASG_HOME/bin/asg_core.ear for all processing units of TIBCO API Exchange Gateway.

If you do not specify the EAR file name and tibco.repourl property is set, the Core Engine uses the tibco.repourl property as the EAR file path and name. To use this property, add it to the asg-engine.tra file. If you deploy the Core Engine using TIBCO Administrator, the property is added to the generated TRA file automatically.