Integrate > Third Party Integrations > Importing Data from External Sources > Import from CSV File Job

Import from CSV File Job

This section includes the following topics:

ClosedJob Details

The job details are as follows:

  • Adapter: Import from CSV

  • Input CI Type: Shell

  • Discovered CIs: ConfigurationItem

  • Required Protocols: SSH, NTCMD, Telnet

This job has no Trigger queries associated with it. That is, this job is not triggered automatically (nor are the Import from Properties file and the Import from Database jobs). After you activate the job, you must manually add input CIs to the job so that it runs against a particular destination. For details, see Add the discovered Shell CI to the job.

ClosedAdapter Parameters

The following parameters are included by default:

Parameter

Description
bulkSize

This parameter only works if the parameter flushObjects is true, in which case, when sending discovery results, it sets the size of chunks used to that number of CIs.

Default: 2,000 (CIs).

ciType

The CIT name. This job creates and reports CIs of this type to UCMDB, based on data in the CSV file. For example, if the CSV file contains records for UNIX hosts, you must set the ciType parameter to unix.

csvFile

The full path to the CSV file on the remote machine. The job uses the Shell CI type as input to reach this path on the remote machine.

delimiter

The delimiter used in the CSV file. The comma (,) delimiter is the default but other delimiters are supported. For details, see Delimiters.
flushObjects

This parameter allows customization of the reporting mechanism.

If true, the probe divides the discovery result into chunks, and sends each chunk to the UCMDB Server. This helps prevent out-of-memory issues where a large amount of data is sent. The chunk size can be configured with the bulkSize parameter.

If false (the default value), the probe sends the discovery result without dividing it into chunks.

mappingFile

For details of the mapping file, see External Source Mapping Files.

mappingString

The string containing mapping information used to map the CSV column indexes and attributes to import. You define this mapping in the following format:

  • mapping elements should be separated by commas

  • each mapping element should be specified in a <column number>:<attribute name> format, for example:

    The string 0:host_key,1:name defines the mapping of two attributes of a host CI, where the host's host_key attribute is taken from the value in the first column (0) and the name attribute is taken from the value in the second column (1).
processWithBinaryMode

Indicates whether to copy the target CSV file to Data Flow Probe and decode it using the value of the fileEncoding parameter.

Default: false.

Note: If false, the target CSV file may be in a different encoding method and the fileEncoding parameter in the Import from CSV File job might not be used correctly.

quoteSymbol

Quoting symbol used in the CSV file.

Default symbol: "

rowToStartIndex

For details on setting the row at which DFM starts collecting data, see CSV Files with Column Titles in First Row.
skipEmptyValues This flag determines whether to skip empty values. If true, empty column values are not sent.

For details on overriding an adapter parameter, see "Override Adapter Parameters" in the Developer Reference section of the UCMDB Help.

ClosedMapping Information for the Import from CSV File Job

You can specify mapping information for the Import from CSV File job with one of the following methods:

  • In an external XML file. You must specify the mappingFile parameter. For details, see External Source Mapping Files.

  • Directly in a job's ciType and mappingString parameters, without using an external file.

    Note When using this mapping method, you cannot specify attribute types or converters.

If the mappingFile parameter is specified, the job tries to retrieve mapping information from the XML file. If it is not specified, the job uses the mapping information specified in the ciType and mappingString parameters.

ClosedDelimiters, Quotes, and Escaping Characters

  • Delimiters

    • The delimiter divides values in the same row of a CSV file. Supported delimiters are:

    • Single symbol. Any symbol can be used as a delimiter, for example, the pipe sign (|), the letter O. Delimiters are case sensitive.

    • ASCII code. If an integer number is used as the value for a delimiter parameter, this value is treated as ASCII code, and the related symbol is used as the delimiter. For example, 9 is a valid delimiter because 9 is the ASCII code for the horizontal tab.

    • Known character sequence. A sequence of characters can be used to represent special characters. For example, \t represents the horizontal tab.

  • Quotation Marks

    • You can use double or single quotes in values, that is, all values residing between the two quotes are treated as a single value.

    • If a delimiter symbol is used in a value, the value must be surrounded with quotation marks. For example, the following row includes a comma inside a value, so the value must be quoted:

      • Morganfield, "25 Hope Road, Kingston", Jamaica

    • If a quote character is used in a value, the character must be escaped by inserting a backslash before it:

      • McKinley \"Muddy Waters\" Morganfield, "April 4, 1915"

    This row contains two values:

    - McKinley "Muddy Waters" Morganfield

    - April 4, 1915.

  • Escaping Characters

    • The following characters must always be quoted or escaped:

    • Backslash

    • Single quote

    • Double quote

    • Delimiter, that is, the delimiter used in the same CSV file.

Send Help Center feedback