ETL common configuration properties

Basic properties that are displayed by default in the Add ETL page are the most common properties that you can set for an ETL. You can choose to leave the default selections for each property as is. Advanced properties are for advanced users and scenarios only. You do not need to set or modify these properties unless you want to change the way the ETL works.


  Run configuration

Property Description
ETL task name By default, this field is populated based on the selected ETL module. You can specify a different name for the ETL Task. Duplicate names are allowed.
Run configuration name The default name is already filled out. This field is used to differentiate between various configurations you can specify for the ETL task. You can then run the ETL task based on the configuration.
Deploy status
You can select Production or Test to mark the ETL tasks. For example, you can start by marking the task as Test and change it to Production after you have seen that the results are as expected.
Description (Optional) Enter a brief description for this ETL.
Log level Select how much detail you want the ETL log to show. The log includes Error, Warning and Info type of log information.
  • 1 - Light: Add bare minimum activity logs to the log file.
  • 5 - Medium: Add medium-detailed activity logs to the log file.
  • 10 - Verbose: Add detailed activity logs to the log file. Info,

Note

Log levels 5 and 10 are typically used for debugging or troubleshooting ETL issues. Using a log level of 5 is general practice, however, you may choose level 10 to get a high level of detail while troubleshooting.

Execute in simulation mode Select Yes if you want to to validate the connectivity between the ETL engine and the target, and to ensure that the ETL does not have any other configuration issues.
When set to Yes, the ETL will not store actual data into the data warehouse. This option is useful while testing a new ETL task.
ETL module

Ensure that the ETL module is selected.

Module description Displays a short description of the ETL module.

  Entity catalog

Property Description
Sharing status Set the sharing status by selecting one of the following options:
  • Shared entity catalog: Select this option if, for the same entities, data is coming from multiple sources, for example, BPA ETL.
    • Sharing with Entity Catalog: Available when you select Shared entity catalog. Select an entity catalog from the drop-down list.
  • Private entity catalog: Select this option if, for the same entity, data is coming from a single source.

  Object relationships

Property Description
Associate new entities to

Specify the domain where you want to add the entities created by the ETL. You can select an existing domain or create a new one.

Note: By default, a new domain is created for each ETL, with the same name of the extractor module. As the ETL is created, a new hierarchy rule with the same name of the ETL task is automatically created, with status "active," if you update the ETL specifying a different domain, the hierarchy rule is updated automatically.

Select any one of the following options:

  • New domain: Create a new domain. Specify the following properties:
    • Parent: Select a parent domain for your new domain from the domain selector control.
    • Name: Specify a name for your new domain.
  • Existing domain: Select an existing domain. Make a selection for the following property:
    • Domain: Select an existing domain from the domain selector control.
      If the selected domain is already used by other hierarchy rules, a Domain conflict option is displayed. Select one of the following options:
      • Enrich domain tree: Create a new independent hierarchy rule to add a new set of entities, relations, or both that are not defined by other ETLs (for example this ETL is managing storage while others are managing servers).
      • ETL Migration: This configuration is recommended if a  new ETL manages the same set of entities, relations, or both (already defined in current domain tree). A typical use case is the migration from one or more ETLs to a new ETL instance. It will stop all relations imported by ETL instances and restore only valid relations after the first run; this configuration reuses an existing hierarchy rule to correctly manage relation updates.

  ETL task properties

Property Description
Task group (Optional) Select a task group by which to classify this ETL.
Running on scheduler Select the scheduler over which you want to run the ETL. The type of schedulers available are:
  • Primary Scheduler: Runs on the Application Server.
  • Generic Scheduler: Runs on a separate machine.
  • Remote: Runs on different remote machines.
Maximum execution time before warning Indicate the number of hours, minutes or days for which to execute the ETL before generating warnings or alerts, if any.
Frequency Select the frequency for ETL execution. Available options are:
  • Predefined: Select a Predefined frequency from Each Day, Each Week, or Each Month.
  • Custom: Enter a Custom frequency (time interval) as the number of minutes, hours, days, or weeks to run the ETL in.
Start timestamp: hour\minute
(Applies to Predefined frequency)
Indicate the HH:MM start timestamp to add to the ETL execution running on a Predefined frequency.
Custom start timestamp Select a yyyy-mm-dd hh:mm timestamp to add to the ETL execution running on a Custom frequency.


  Run configuration

Property Description
Datasets

Enables you to select or deselect metric groups for which data will be populated Available datasets. You cannot include additional datasets to the run configuration of the ETL.

  1. Click Edit.
  2. Select one (click) or more (shift+click) datasets that you want to exclude from Available datasets and click >> to move them to Selected datasets.
  3. Click Apply.

  Collection level

Property Description
Metric profile selection

Select any one:

  • Use Global metric profile: Select this to use an out-of-the-box global profile, that is available on the Metric profiles page. By default, all ETL modules use this profile.
  • Select a custom metric profile: Any metric profiles you add in the Add metric profile page (Administration > DATAWAREHOUSE > Metric profiles).
For more information, see Adding and managing metric profiles.
Levels up to

The metric level defines the amount of metric imported into the data warehouse. If you increase the level, additional load is added to the data warehouse while decreasing the metric level reduces the number of imported metrics.

Choose the metric level to apply on selected metrics:

  • [1] Essential
  • [2] Basic
  • [3] Standard
  • [4] Extended
For more information, see Aging Class mapping.

  Additional properties

Property Description
List of properties

Additional properties can be specified for this ETL that act as user inputs during execution. You can specify values for these properties either at this time, or from the "You can manually edit ETL properties from this page" link that is displayed for the ETL in view mode.

  1. Click Add.
  2. Add an additional property in the etl.additional.prop.n box.
  3. Click Apply.
    Repeat this task to add more properties.

  Loader configuration

Property Description
Empty dataset behavior Choose one of the following actions if the loader encounters an empty dataset:
  • Warn: Warn about loading an empty dataset.
  • Ignore: Ignore the empty dataset and continue parsing.
ETL log file name Name of the file that contains the ETL execution log; the default value is: %BASE/log/%AYEAR%AMONTH%ADAY%AHOUR%MINUTE%TASKID
Maximum number of rows for CSV output A number which limits the size of the output files.
CSV loader output file name Name of the file generated by the CSV loader; the default value is: %BASE/output/%DSNAME%AYEAR%AMONTH%ADAY%AHOUR%ZPROG%DSID%TASKID
Capacity Optimization loader output file name Name of the file generated by the TrueSight Capacity Optimization loader; the default value is: %BASE/output/%DSNAME%AYEAR%AMONTH%ADAY%AHOUR%ZPROG%DSID%TASKID
Detail mode
Select the level of detail:
  • Standard: Data will be stored on the database in different tables at the following time granularities: Detail (configurable, by default: 5 minutes), Hourly, Daily, Monthly.
  • Raw also: Data will be stored on the database in different tables at the following time granularities: Raw (as available from the original data source), Detail (configurable, by default: 5 minutes), Hourly, Daily, Monthly.
  • Raw only: Data will be stored on the database in a table only at Raw granularity (as available from the original data source).

For more information, see Accessing data using public views and Sizing and scalability considerations.
Reduce priority

Select either Normal or High.

Remove domain suffix from datasource name (Only for systems)  If set to True, the domain name is removed from the data source name. For example, server.domain.com will be saved as server.
Leave domain suffix to system name (Only for systems) (Only for systems) If set to True, the domain name is maintained in the system name. For example: server.domain.com will be saved as such.
Update grouping object definition (Only for systems) If set to True, the ETL will be allowed to update the grouping object definition for a metric loaded by an ETL.
Skip entity creation (Only for ETL tasks sharing lookup with other tasks) If set to True, this ETL does not create an entity, and discards data from its data source for entities not found in Capacity Optimization. It uses one of the other ETLs that share lookup to create the new entity.

  Scheduling options

Property Description
Hour mask Specify a value to execute the task only during particular hours within the day. For example, 0 – 23 or 1,3,5 – 12.
Day of week mask Select the days so that the task can be executed only during the selected days of the week. To avoid setting this filter, do not select any option for this field.
Day of month mask Specify a value to execute the task only during particular days within a month. For example, 5, 9, 18, 27 – 31.
Apply mask validation By default this property is set to True. Set it to False if you want to disable the preceding Scheduling options that you specified. Setting it to False is useful if you want to temporarily turn off the mask validation without removing any values.
Execute after time Specify a value in the hours:minutes format (for example, 05:00 or 16:00) to wait before the task must be executed. This means that once the task is scheduled, the task execution starts only after the specified time passes.
Enqueueable Select one of the following options:
  • False (Default): While a particular task is already running, if the next execution command arises – it is ignored.
  • True: While a particular task is already running, if the next execution command arises – it is placed in a queue and is executed as soon as the current execution ends.

Related topic

Collecting data via ETL modules

Was this page helpful? Yes No Submitting... Thank you

Comments