TelemetryActionDefStep

Represents a step in the action for a telemetry signal definition.

Parent Type

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

File Suffix and Directory Location

TelemetryActionDefStep components have the suffix .TelemetryActionDefStep and are stored in the TelemetryActionDefSteps folder.

Version

TelemetryActionDefStep components are available in API version 65.0 and later.

Fields

delayInSeconds

Field Type: int
Description: Indicates a delay (in seconds) before the step is executed.

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.

groupName

Field Type: string
Description: Required. The name of the group that the telemetry action definition step belongs to. Steps in a group are shown together in an intake form.

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 TelemetryActionDefStep, which is defined when the TelemetryActionDefStep is created.

operationType

Field Type: TelemetryActnDefStepOpType (enumeration of type string)
Description: Required. Specifies the type of the operation that’s performed in the telemetry action definition step.

Values are:
- Retrieve
- Submit

remoteEndPointUrl

Field Type: string
Description: The URL of the remote end point to which a request is shared to execute the telemetry action step.

sequenceNumber

Field Type: int
Description: Required. The sequence number of a step in the action related to a telemetry definition.

targetComponentPath

Field Type: string
Description: Required. The hierarchical path representing the target component in the telemetry system of a connected asset or vehicle where the action is targeted.

telemetryActionDefinition

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

Declarative Metadata Sample Definition

The following is an example of a TelemetryActionDefStep component.

1<?xml version="1.0" encoding="UTF-8"?>
2<TelemetryActionDefStep xmlns="http://soap.sforce.com/2006/04/metadata">
3    <delayInSeconds>0</delayInSeconds>
4    <developerName>HoodStatusControl_HoodPositionStep</developerName>
5    <groupName>BodyControlResponse</groupName>
6    <isProtected>false</isProtected>
7    <masterLabel>Hood Position Monitor</masterLabel>
8    <operationType>Submit</operationType>
9    <remoteEndPointUrl>https://api.sample-vehicle-management.com/hood</remoteEndPointUrl>
10    <targetComponentPath>Vehicle.Body.Hood</targetComponentPath>
11    <telemetryActionDefinition>HoodStatusControl</telemetryActionDefinition>
12</TelemetryActionDefStep>

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