TelemetryActionDefinition

Represents the action taken on a telemetry signal sent from a connected asset or vehicle, such as getting the current status of a vehicle or its component, or sending a request to perform a remote action on the vehicle or its component.

Parent Type

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

File Suffix and Directory Location

TelemetryActionDefinition components have the suffix .TelemetryActionDefinition and are stored in the TelemetryActionDefinitions folder.

Version

TelemetryActionDefinition components are available in API version 65.0 and later.

Fields

actionName

Field Type: string
Description: Required. The full name of the action related to a telemetry definition.

description

Field Type: string
Description: The description of the telemetry action 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.

executionProcedure

Field Type: string
Description: The execution procedure that's used to fulfill telemetry action related processes.

isActive

Field Type: boolean
Description: Indicates whether the telemetry definition version is active (true) or not (false).
Default value: false

isProtected

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

masterLabel

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

telemetryDefinitionVersion

Field Type: string
Description: Required. The telemetry definition version related to the action.

Declarative Metadata Sample Definition

The following is an example of a TelemetryActionDefinition component.

1<?xml version="1.0" encoding="UTF-8"?>
2<TelemetryActionDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3    <actionName>HoodStatusControl</actionName>
4    <description>Action to monitor and control vehicle hood open/close status and switch operations</description>
5    <developerName>HoodStatusControl</developerName>
6    <executionProcedure>HoodControlFlow</executionProcedureIdentifier>
7    <isActive>true</isActive>
8    <isProtected>false</isProtected>
9    <masterLabel>Hood Status Control</masterLabel>
10    <telemetryDefinitionVersion>VehicleBodyMonitoringv1</telemetryDefinitionVersion>
11</TelemetryActionDefinition>

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>TelemetryActionDefinition</name>
6    </types>
7    <version>65.0</version>
8</Package>

Manufacturing Cloud Developer Guide