D.4.2 scripts Subdirectory

The scripts subdirectory within the ingestion_manager directory contains the UNIX Bourne Shell scripts to run runtime components.

Executing a run script runs a new instance of a component. If an application component terminates successfully, a script returns a zero return code. If the component fails to terminate successfully, the script returns a non-zero status (normally 1).

The following table defines the run scripts for starting each component and any special instructions.

Table D-11 Run Scripts by Component

Script Names Description or Special Instructions
runFDT.sh Launches the FDT. This script stops after it processes all qualifying files that it finds in the /data/firm/transform directory at the time the process starts. The system processes an input file if the processing data and batch name are correct.

You can stop the FDT immediately by using the UNIX kill command to stop the process ID for the Java process that is a child of the runFDT.sh process.
runDL.sh <data type> Launches an instance of the data loader (runDL.sh). For example: runDL.sh Customer

To run a specific data loader, specify a valid component that the run script recognizes. If the script does not recognize the component, it exits with an error and identifies the valid list of parameters. For valid component names, see Figure 40 .

runRebuildIndexes.sh Launches a process to rebuild the indexes of the given component. Processing requires this script only during use of a live market feed.

A valid <component> value is one of InsideQuote, ReportedMarketSale, or MarketCenterQuote.
process_firm_summary.sh Calls a database procedure to build summary statistics about the Oracle client (firm) data.
process_market_summary.sh Calls a database procedure to build summary statistics about the Market data.
market_analyze.sh Calls a database procedure to create internal database statistics for Market tables.
firm_analyze.sh Calls a database procedure to create internal database statistics for Oracle client (firm) tables.
runIMC.sh Launches the Ingestion Manager Cleaner (IMC) utility. The utility terminates after it finishes removing old data subdirectories and their contents.
env.sh Contains common configuration settings required to run Data Management subsystem components. The run*.sh scripts use this script.

truncate_table.sh

<schema.tablename>

 Truncates a specified table in the database. Processing runs this script prior to loading reference data when an Oracle client wants to perform a full refresh of the data.
runUtility.sh <datatype> Launches a Java based utility to derive the contents of a given database table. You must run runDL.sh <data type> after this script has executed successfully.

For example:

runUtility.sh AccountDailySecurityProfile
runDL.sh AccountDailySecurityProfile
runDP.sh <data type> Launches an instance of the data Pre-processor(runDP.sh). For example: runDP.sh Customer

To run a specific Data Pre-processor, specify a valid input component that the run script recognizes. If the script does not recognize the input component, it exits with an error and identifies the valid list of parameters. For valid component names, see Figure40
The run scripts in the following table configure the executing environment for the Java component, and then execute it. All run scripts invoke the env.sh script to define environment variables that the components require. The run scripts also start the Java program with appropriate command line parameters, which the following table describes.

Table D-12 Environment Variable Descriptions

Parameter Description
classpath Directs the Java Runtime Environment (JRE) to the location of Java programs and supporting Java classes.
Djava.security.policy Sets the location of the policy file that provides directory and network access rights to the component.
server Instructs Java JRE to optimize for server-based processing.
Xms<NNNN>* Indicates the minimum number of megabytes (as NNNN) to reserve for Java memory allocation.
Xmx<NNNN>* Indicates the maximum number of megabytes (as NNNN) to reserve for Java memory allocation. Note: Setting Xmx too small may result in component failure.

Note:

Default values that are appropriate to the operating system in use , such as Linux or Solaris, are automatically set in the env.sh file:
  • For 64-bit operating systems, the maximum value should not be greater than 3500 MB.
  • For 32-bit operating systems, the maximum value should not be greater than 1800 MB.

Minimum values vary by component; the env.sh file specifies these values.