Versions Compared

Old Version 24

changes.mady.by.user Patrice Neff

Saved on

compared with

New Version 25

changes.mady.by.user Patrice Neff

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

KeyData TypeDescription
Data Source
source_typeString

Which source type to connect to. Valid values:

csv, excel, database.

A connection string for where to find the original data. At the moment, only the csv protocol is supported - others may be added in the future.

Example: csv:///clients.csv

source_scriptStringThe Data Loader Plugin to load. This and the source_type are mutually exclusive.
...

Additional connection options are specified as key/value pairs as well.

Use the same options as for the data loader, with the dashes replaced with underscores. For example if the data loader is invoked with squirro_data_load --source-type csv --source-file test.csv, then the source configuration in KEE is:

Code Block
languagejs
{
    "source_type": "csv",
    "source_file": "test.csv",
}

Check the Data Loader Reference for all the possible options. Plugin-specific options are documented in each plugin.

KEE Configuration
strategyStringThe name of the strategy to use for matching on this data source. This needs to reference to a strategy key that has been defined in the Strategies section of the config file.
field_idStringThe name of the column in the input data which is the unique identifier of a row.
generate_idBooleanAutomatically generate unique identifiers for rows. Can be used if (and only if) field_id is not specified.
field_matchingListNames of the columns of the input data that contain the object names used for the KEE matching. This is generally the primary name and often an alias column.
hierarchyString

Specifies a hierarchy in the data. This hierarchy can be used in the tagging for example to tag an item with the matching company and all of the parent companies as well.

The format of this configuration is Parent Column -> Child Column

See the hierarchy section for examples.

multivalueList
A list of column names that can contain multiple values. This is commonly used for the alias column.

The default separator for multiple values in the source data is the pipe (|) but this can be changed by specifying the separator after a colon.

Example:

Code Block
languagejs
{
    "sources": {
        "companies": {
            // Other keys omitted for clarity
            …
            "multivalue": [
                "Aliases",  // Aliases are multiple values, separate with pipe |
                "Sectors:,",  // Sectors are multiple values, separate with comma ,
            ]
        }
    }
}

...