Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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

Field Name	Description
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. The default value is false.
isTemplate	Field Type boolean Description Required. Indicates whether the telemetry definition is a template (true) or not (false). The default value is `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 are: `ConnectedAsset`—Connected Asset `ConnectedVehicle`—Connected Vehicle

Declarative Metadata Sample Definition

The following is an example of a TelemetryDefinition component.

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

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

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