[Index]

Model: data/DataCollection

Lightweight collection of data from external sources

Model Details: data/DataCollection

Title Description Details
Name * The name of this data collection.
  • Field Name: name
  • Type: String
  • MaxLength: 1024
Description The description of this data collection.
  • Field Name: description
  • Type: String
  • MaxLength: 1024
Method * Default: collect
  • Field Name: method
  • Type: String
  • Default: collect
  • MaxLength: 1024
  • Choices: ["Collect", "Purge"]
Device model types
  • Field Name: device_model_types.[n]
  • Type: Array
Device Model Type *
  • Field Name: device_model_types.[n].device_model_type
  • Type: String
  • MaxLength: 1024
Connection Parameters *
  • Field Name: device_model_types.[n].connection_parameters
  • Type: String
  • MaxLength: 1024
Create Automate Resources * Create a resource in Automate for each collected record. Default: True
  • Field Name: device_model_types.[n].create_automate_resources
  • Type: Boolean
  • Default: True
Create Standalone Records * Create a standalone record for each collected record. Default: True
  • Field Name: device_model_types.[n].create_standalone_records
  • Type: Boolean
  • Default: True
Standalone Records Tracking Field This is the name of a timestamp field from the device model being collected. It will be used to determine the most recent record collected and that record's timestamp will be stored. Subsequent executions will provide that value to the device model so that it can commence collection from that point in time onwards.
  • Field Name: device_model_types.[n].standalone_tracking_field
  • Type: String
  • MaxLength: 1024
Standalone Records Tracking Field Date Format The tracking field will be interpreted as a timestamp using this python datetime format. If %f is used, note that MongoDB does not support microseconds so the stored value will have millisecond resolution. Default: %Y-%m-%dT%H:%M:%S.%fZ
  • Field Name: device_model_types.[n].standalone_tracking_field_date_format
  • Type: String
  • Default: %Y-%m-%dT%H:%M:%S.%fZ
  • MaxLength: 1024
Standalone Records Expiry Seconds Standalone records will be kept in the database for the number of seconds configured in this field.
  • Field Name: device_model_types.[n].standalone_expiry_seconds
  • Type: Integer
Move Configuration Configures matching to existing records to determine move destination.
  • Field Name: move_config.[n]
  • Type: Array
Source Model Field
  • Field Name: device_model_types.[n].move_config.[n].left_field
  • Type: String
  • MaxLength: 1024
Source Model Field Regex The first unnamed capture group in the regex will be used to match
  • Field Name: device_model_types.[n].move_config.[n].left_field_regex
  • Type: String
  • MaxLength: 1024
Matched Model Type
  • Field Name: device_model_types.[n].move_config.[n].right_model_type
  • Type: String
  • MaxLength: 1024
Matched Model Field
  • Field Name: device_model_types.[n].move_config.[n].right_field
  • Type: String
  • MaxLength: 1024
Matched Model Field Regex The first unnamed capture group in the regex will be used to match
  • Field Name: device_model_types.[n].move_config.[n].right_field_regex
  • Type: String
  • MaxLength: 1024