Running ETL using TrueSight Server Automation jobs
A script is available for you to download and use to create a TrueSight Server Automation Network Shell Script Job for running ETL from TrueSight Server Automation. The script, which is called run_etl_from_om.nsh, is included in the content_installer.zip file, which is located in the <TSSA-DWInstallationDirectory>/bsa/content_installer directory. When you extract the contents of the content_installer.zip file and run the content installer, the script is added to TrueSight Server Automation as the Run ETL from OM Script Network Shell script. For information about running the content installer, see Installing-Inventory-templates-and-other-scripts.
You can use the Run ETL from OM script to create a Network Shell Script Job that you can use to run ETL on specified servers. You can execute the job for a one-time run or you can create a schedule for the job. The job performs the same task as the run_etl command (see Running-ETL-using-an-NSH-script).
You can schedule ETL runs for multiple sites in a batch job. For more information, see Scheduling-ETL-for-multiple-sites.
This topic describes how to create a Network Shell Script Job for the Run ETL from OM script, including the flags and parameters.
To create a Network Shell Script Job for the run_etl_from_om.nsh script
- In the TrueSight Server Automation Console, navigate to the Depot/BladeLogic Reports Scripts/Run ETL from OM folder.
- Select Run ETL From OM Script.
- Create a NSH Script Job for the Run ETL From OM Script script.
The details about parameters and flags that you can set are included in the table in this topic. For information about creating a Network Shell Script Job, see Creating Network Shell Script Jobs in the TrueSight Server Automation documentation. - Create a schedule for the job if you want to run ETL on a schedule.
When you create a Network Shell Script Job, you specify the parameters and flags to be used when the job runs.
If you do not want to use an optional parameter, ensure that you have removed the flag as well as the value in the Parameters panel. For example, if you do not want the script to run with the RPT_PROP parameter, remove the -f flag and the property file name.
If you do not remove the flag for an unused parameter, the script returns an error.The following table lists the parameters and flags that you can specify in the Parameters panel of the job creation wizard.
Parameter | Required? | Flag | Description/Value |
|---|---|---|---|
ETL_HOME | Yes | -h | The directory in which the ETL-related files are located. The default location is <TSSA-DWInstallationDirectory>/shared/odi/bin (see the following image for an example, including a sample directory). |
SITE | Yes | -s | The site ID. This ID must be a valid site ID from the BL_SITE table. You can determine the site ID using the TrueSight Server Automation - Data Warehouse console. |
RPT_PROP | No | -f | The property file to run (for a list of the property files representing specific scenarios for report data groups see Property-files). |
LVL_PRL | No | -p | Indicates the number of scenarios to run in parallel. |
LOGLEVEL | No | -d | Indicates the log (or debug) level, which can be a value of 1 to 5, with 1 indicating the lowest logging level (minimal logging) and 5 indicating the highest logging level (detailed logging). |
COG_FLAG | No | -l | Overrides the locking mechanism for the reports data model (1 indicates to override the locking mechanism; 0 indicates to not override the locking mechanism). |
Your job settings should look similar to the settings illustrated in the following example:
