Generic - Tag CSV file parser

The Generic - Tag CSV file parser ETL enables you to manage the tags for entities that are imported by other ETLs. You can use the Generic - Tag CSV file parser to perform the following tasks:

  • Automatically apply tags to the entities that are imported by other ETLs in the shared entity catalog
  • Remove tags from the required entities

The ETL uses lookup fields to identify the required entities from the shared entity catalog and the TAGDAT dataset to manage tags. To configure the ETL, use an input CSV file that is structured according to the dataset and share the entity catalog of the ETL that is collecting the required entities. When you run the Generic - Tag CSV file parser, depending on the Tag type (single value or multiple value) and operation (ADD or DELETE), tags are automatically updated in the required entities. If the Tag type or Tag is not available, this ETL creates the required Tag type or Tag and updates the required entities.  If there are new entities that are not available in the entity catalog, the ETL enables you to add or manage (includes option to skip entity creation) the new entities.

For more information, refer to the following sections:

Workflow


Generic Tag CSV

Before you integrate

Configuration steps

To integrate TrueSight Capacity Optimization with the Generic - Tag CSV file parser, perform the following task:

  1. Navigate to Administration > ETL & SYSTEM TASKS > ETL tasks.
  2. In the ETL tasks page, click Add > Add ETL under the Last run tab.
  3. In the Add ETL page, set values for the following properties under each expandable tab.

    Note

    Basic properties are displayed by default in the Add ETL page. These are the most common properties that you can set for an ETL, and it is acceptable to leave the default selections for each as is.

    Basic properties

    Property Description
    Run configuration
    ETL module Select Generic - Tag CSV file parser.
    ETL task name Default name is already filled out for you.
    Run configuration name Default name is already filled out for you.
    Deploy status Select Production.
    Description (Optional) Enter a brief description.
    Log level Select how detailed you want the log to be:
    • 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.
    Execute in simulation mode Select Yes.
    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.
    Module description A link that points you to technical documentation for this ETL.
    Datasets By default TAGDAT dataset is selected.
    Entity catalog
    Sharing status Select any one:
    • SHARED: Select this option to apply tags to the entities collected in a shared entity catalog.
      • Sharing with Entity Catalog: Select the required entity catalog that contains the entities to which tags are to be applied.
    • PRIVATE: Select this option if this is the only ETL that imports entities and the lookup table is not shared with any other ETL task.
    Object relationships
    After import

    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.

    Select any one of the following options:

    • leave all new entities in 'Newly Discovered'.
    • move all new entities in a new Domain.
      • New domain: Create a new domain. Specify the following properties under New domain:
        • Parent: Select a parent domain for your new domain from the domain selector control.
        • Name: Specify a name for your new domain.
    • move all new entities in an existing Domain 
      • Domain: Select an existing domain from the domain selector control.
    File location
    File location Select any one of the following methods to retrieve the CSV file:
    • Local directory: Specify a path on your local machine where the CSV file resides.
    • Windows share: Specify the Windows share path where the CSV file resides.
    • FTP: Specify the FTP path where the CSV file resides.
    • SCP: Specify the SCP path where the CSV file resides.
    • SFTP: Specify the SFTP path where the CSV file resides.
    Directory Path of the directory that contains the CSV file.
    Network Share Path (Windows share) Specify the full network address of the shared directory. For example: //hostname/sharedfolder
    Subdirectory (Windows share) Specify the required subdirectory within the shared directory.
    Files to copy (with wildcards) (SCP and SFTP) Before parsing, the SCP and SFTP commands need to make a local temporary copy of the files; this setting specifies which files in the remote directory should be imported.
    File list pattern A regular expression that defines which data files should be read. The default value is (?$<$!done)\$, which tells the ETL to read every file whose name does not end with the string "done". For example, my_file_source.done.
    Recurse into subdirs? Select Yes or No. When set to Yes, TrueSight Capacity Optimization also inspects the subdirectories of the target directories.
    After parse operation Choose what to do after the CSV file has been imported. The available options are:
    • Do nothing: Do nothing after import.
    • Append suffix to parsed file: Append a suffix you add here to the imported CSV file. For example, _done or _impoted, and so on.
    • Archive parsed file in directory: Archive the parsed file in the specified directory.
      • Archive directory (local): Default archive directory path is filled out for you. For example, %BASE/../repository/imprepository
      • Compress archived files: Select Yes or No.
    • Archive bad files in directory: Archive erroneous files in the specified directory.
      • Archive directory (local): Default archive directory path is filled out for you. For example, %BASE/../repository/imprepository
      • Compress archived files: Select Yes or No.
    Parsed files suffix The suffix that will be appended parsed files; default is .done.
    Remote host (Applies to FTP, SFTP, SCP) Enter the name or address of the remote host to connect to.
    Username (Applies to Windows share, FTP, SFTP, SCP) Enter the username to connect to the file location server.
    Password required (Applies to Windows share, FTP, SFTP, SCP) Select Yes or No.
    Password (Applies to Windows share, FTP, SFTP, SCP) Enter a password to connect to the file location server. Applicable if you selected Yes for Password required.
    ETL task properties
    Task group Select a task group to classify this ETL into.
    Running on scheduler Select the scheduler you want to run the ETL on.
    Maximum execution time before warning The number of hours, minutes or days to to execute the ETL for before generating warnings, if any.
    Frequency Select the frequency of 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) 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.

    Note

    To view or configure Advanced properties, click Advanced. You do not need to set or modify these properties unless you want to change the way the ETL works. These properties are for advanced users and scenarios only.

    Advanced properties

    Property Description
    Collection level
    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 Adding and managing 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.

    File location
    Subdirectories to exclude (separated by ';' ) (Local directory) Names of subdirectories to exclude from parsing.
    Input file external validator (Local directory, Windows share, FTP) Select any one of the following options:
    • No external validation: Do not use external validation of the CSV file structure.
    • Use external validation script: Use the following script to validate the CSV file:
      • Script to execute: Specify the validation script to use to validate the input file.
    Additional properties
    List of properties
    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
    Empty dataset behavior Choose one of the following actions if the loader encounters an empty dataset:
    • Abort: Abort the loader.
    • 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: $CPITBASE/output/%AYEAR%AMONTH%ADAY%AHOUR%ZPROG%DSCD%SRCID.
    Capacity Optimization loader output file name Name of the file generated by the TrueSight Capacity Optimization loader; the default value is: $CPITBASE/output/%AYEAR%AMONTH%ADAY%AHOUR%ZPROG%DSCD%SRCID.
    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 on granularities, see Sizing and scalability considerations.

    Reduce priority

    • Normal:
    • 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) 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 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 TrueSight Capacity Optimization. It uses one of the other ETLs that share lookup to create the new entity.
    Scheduling options
    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.


  4. Click Save.
    You return to the Last run tab under the ETL tasks page.
  5. Validate the results in simulation mode: In the ETL tasks table under ETL tasks > Last run, locate your ETL (ETL task name), click  to run the ETL.
    After you run the ETL, the Last exit column in the ETL tasks table will display one of the following values:
    • OK: The ETL executed without any error in simulation mode.
    • WARNING: The ETL execution returned some warnings in simulation mode. Check the ETL log.
    • ERROR: The ETL execution returned errors and was unsuccessful. Edit the active Run configuration and try again.
  6. Switch the ETL to production mode: To do this, perform the following task:
    1. In the ETL tasks table under ETL tasks > Last run, click the ETL under the Name column.
    2. In the Run configurations table in the ETL details page, click  to edit the active run configuration.
    3. In the Edit run configuration page, navigate to the Run configuration expandable tab and set Execute in simulation mode to No.
    4. Click Save.
  7. Locate the ETL in the ETL tasks table and click  to Run it, or schedule an ETL run.
    After you run the ETL, or schedule the ETL for a run, it will extract the data form the source and transfer it to the TrueSight Capacity Optimization database.

Input file format

The input file follows the open ETL structure. You cannot use the following characters in the input file for a tag type or tag:

"[", "]", "%", "<", ">", "\\", "^", "'", ",", ";", ":", "|", "*", "&", "\"", "!", "?", "&", "$", "£", "{", "}", ")", "(", " ", "~"

Following are the sample input files that use different type of lookup fields:

  • Input file that uses single lookup (DS_ENTNM):

    ENTCATNM,DS_ENTNM,ENTNM,TAG,TAGTYPE,ENTTYPENM 
    SYS,vmsingle1,vmsingle1,Production;MailSubsystem,Env,gm:vmw
    SYS,vmsingle2,vmsingle2,QA,Env,gm:vmw
    
  • Input file that uses multiple lookup (STRONGLOOKUPFIELDS and WEAKLOOKUPFIELDS):

    ENTCATNM,DS_ENTNM,ENTNM,TAG,TAGTYPE,ENTTYPENM,STRONGLOOKUPFIELDS,WEAKLOOKUPFIELDS,OPERATION
    SYS,HOSTNAME#vm888.bmc.com##NAME#vm888,vm888,Production;MailSubsystem,Env,gm:vmw,HOSTNAME,NAME
    SYS,HOSTNAME#vm888.bmc.com##NAME#vm888,vm888,MailSubsystem,Env,gm:vmw,HOSTNAME,NAME,DELETE
    SYS,HOSTNAME#vm999.bmc.com##NAME#vm999,vm999,QA,Env,gm:vmw,HOSTNAME,NAME
    

    The above mentioned sample also provides an example for adding multiple tags (separated by ;) and deleting a tag (by specifying the operation type) from the required entity.

 

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

Comments

  1. Ben Davies

    example is missing a ; and has an extra , Last field, second line.

    ENTCATNM,DS_ENTNM,ENTNM,TAG,TAGTYPE,ENTTYPENM SYS,vmsingle1,vmsingle1,Production,MailSubsystem,Env,gm:vmw SYS,vmsingle2,vmsingle2,QA,Env;gm:vmw

    Jun 05, 2020 04:05
  2. Shweta Patil

    Thank you for your comment, Ben. Updated the documentation.

    Jul 20, 2020 11:54