DeviceData

The DeviceData module is a Collector module that automatically enriches tracking data with comprehensive device information. This module gathers both static device characteristics (like CPU architecture and OS version) and dynamic information (like battery status and screen orientation) to provide detailed device context for all tracking events.

Collected Data Points

The DeviceData module collects the following information:

Installation/Configuration

The DeviceData module can be configured using three different approaches:

Local and Remote Settings

Configure the module using local JSON settings file (via settingsFile parameter) and/or remote settings (via settingsUrl parameter):

var config = TealiumConfig(account: "tealiummobile",
                          profile: "your-profile", 
                          environment: "dev",
                          settingsFile: "TealiumSettings",
                          settingsUrl: "https://tags.tiqcdn.com/dle/tealiummobile/lib/example_settings.json")

Default initialization - module will be initialized only if configured in settings file specified:

{
    "modules": {
        "DeviceData": {
            "module_type": "DeviceData"
        }
    }
}

Custom configuration - module with specific settings:

{
    "modules": {
        "DeviceData": {
            "module_type": "DeviceData",
            "enabled": true,
            "order": 1,
            "configuration": {
                "device_names_url": "https://custom.endpoint.com/device_names.json",
                "memory_reporting_enabled": true,
                "battery_reporting_enabled": false,
                "screen_reporting_enabled": true
            },
            "rules": {
                "operator": "and",
                "children": [
                    "rule_id_from_settings"
                ]
            }
        }
    }
}

When both local and remote settings are provided, they are deep merged with remote settings taking priority.

Programmatic Configuration

Configure the module programmatically by adding it to the modules parameter in TealiumConfig.

Default initialization - module will be initialized with default settings:

let config = TealiumConfig(account: "tealiummobile",
                          profile: "your-profile", 
                          environment: "dev",
                          modules: [
                              Modules.deviceData(),
                              // other modules...
                          ])

Custom configuration - module with enforced settings:

let config = TealiumConfig(account: "tealiummobile",
                          profile: "your-profile", 
                          environment: "dev",
                          modules: [
                              Modules.deviceData(forcingSettings: { builder in
                                  builder.setDeviceNamesUrl("https://custom.endpoint.com/device_names.json")
                                         .setMemoryReportingEnabled(true)
                                         .setBatteryReportingEnabled(false)
                                         .setScreenReportingEnabled(true)
                                         .setEnabled(true)
                                         .setOrder(1)
                                         .setRules(.and(["rule_id_from_settings"]))
                              }),
                              // other modules...
                          ])

⚠️ Important: Programmatic settings are deep merged onto local and remote settings and will always take precedence. Only provide programmatic settings for configuration values that you never want to be changed remotely, as they will override any remote updates.

Settings Builders Reference

The DeviceData module uses the DeviceDataSettingsBuilder for configuration. This is an extension of the CollectorSettingsBuilder which offers common settings like:

• ModuleSettingsBuilder.setEnabled(_:)
• ModuleSettingsBuilder.setOrder(_:)
• RuleModuleSettingsBuilder.setRules(_:)

DeviceData-specific methods:

• DeviceDataSettingsBuilder.setDeviceNamesUrl(_:) - Set custom URL for device names lookup
• DeviceDataSettingsBuilder.setMemoryReportingEnabled(_:) - Enable/disable memory usage reporting
• DeviceDataSettingsBuilder.setBatteryReportingEnabled(_:) - Enable/disable battery status reporting (default: true)
• DeviceDataSettingsBuilder.setScreenReportingEnabled(_:) - Enable/disable screen info reporting (default: true)