Salesforce Docs Portal

TelemetryDefinition

Represents the definition of the structure of a telemetry signal sent from a connected asset or vehicle.

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

TelemetryDefinition components have the suffix .TelemetryDefinition and are stored in the TelemetryDefinitions folder.

Version

TelemetryDefinition components are available in API version 65.0 and later.

Fields

description

  • Field Type: string
  • Description: The description of the telemetry definition.

developerName

  • Field Type: string
  • Description: The developer’s internal name for the API.

    For example, if you create a record with MyCustomRecord name, you cannot create another record with that same name.

isProtected

  • Field Type: boolean
  • Description: An auto-generated value that doesn’t impact the behavior of the metadata type.
  • Default value: false

isTemplate

  • Field Type: boolean
  • Description: Required. Indicates whether the telemetry definition is a template (true) or not (false).
  • Default value: false

masterLabel

  • Field Type: string
  • Description: Required. A user-friendly name for TelemetryDefinition, which is defined when the TelemetryDefinition is created.

usageType

  • Field Type: TelemetryDefinitionUsageType (enumeration of type string)
  • Description: The usage type of the telemetry definition.
  • Possible values:
    • ConnectedAsset—Connected Asset
    • ConnectedVehicle—Connected Vehicle

Declarative Metadata Sample Definition

The following is an example of a TelemetryDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<TelemetryDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <description>Telemetry definition for monitoring vehicle engine parameters including temperature, RPM, and fuel consumption</description>
    <developerName>VehicleEngineMonitoring</developerName>
    <isProtected>false</isProtected>
    <isTemplate>false</isTemplate>
    <masterLabel>VehicleEngineMonitoring</masterLabel>
    <usageType>ConnectedVehicle</usageType>
</TelemetryDefinition>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>*</members>
        <name>TelemetryDefinition</name>
    </types>
    <version>65.0</version>
</Package>