Skip to content

tool-usage.schema.md

Latest commit

 

History

History
266 lines (135 loc) · 5.73 KB

tool-usage.schema.md

File metadata and controls

266 lines (135 loc) · 5.73 KB

Tool Usage Schema

https://ns.adobe.com/xdm/datatypes/tool-usage

Tool usage comprises the most common steps used in a site tool or utility, such as calculators, registrations, and requests for more information.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Cannot be instantiated Yes Experimental No Forbidden Permitted datatypes/tool-usage.schema.json

Tool Usage Example

{}

Tool Usage Definitions

Property Type Group
xdm:toolUsageCancelled reference https://ns.adobe.com/xdm/datatypes/tool-usage#/definitions/toolUsage
xdm:toolUsageComplete reference https://ns.adobe.com/xdm/datatypes/tool-usage#/definitions/toolUsage
xdm:toolUsageFailure reference https://ns.adobe.com/xdm/datatypes/tool-usage#/definitions/toolUsage
xdm:toolUsageID string https://ns.adobe.com/xdm/datatypes/tool-usage#/definitions/toolUsage
xdm:toolUsageName string https://ns.adobe.com/xdm/datatypes/tool-usage#/definitions/toolUsage
xdm:toolUsageSaved reference https://ns.adobe.com/xdm/datatypes/tool-usage#/definitions/toolUsage
xdm:toolUsageStart reference https://ns.adobe.com/xdm/datatypes/tool-usage#/definitions/toolUsage
xdm:toolUsageStep reference https://ns.adobe.com/xdm/datatypes/tool-usage#/definitions/toolUsage
xdm:toolUsageStepName string https://ns.adobe.com/xdm/datatypes/tool-usage#/definitions/toolUsage
xdm:toolUsageSubmitted reference https://ns.adobe.com/xdm/datatypes/tool-usage#/definitions/toolUsage
xdm:toolUsageTransaction reference https://ns.adobe.com/xdm/datatypes/tool-usage#/definitions/toolUsage
xdm:toolUsageType string https://ns.adobe.com/xdm/datatypes/tool-usage#/definitions/toolUsage

xdm:toolUsageCancelled

Tool Usage Cancelled

Captured when a visitor cancels out of a tool usage process.

xdm:toolUsageCancelled

  • is optional
  • type: reference
  • defined in this schema

xdm:toolUsageCancelled Type

  • – https://ns.adobe.com/xdm/datatypes/data/measure

xdm:toolUsageComplete

Tool Usage Complete

Captured when a visitor successfully finishes using any type of tool or utility on the site/app.

xdm:toolUsageComplete

  • is optional
  • type: reference
  • defined in this schema

xdm:toolUsageComplete Type

  • – https://ns.adobe.com/xdm/datatypes/data/measure

xdm:toolUsageFailure

Tool Usage Failed

Captured when a step in the tool usage process fails.

xdm:toolUsageFailure

  • is optional
  • type: reference
  • defined in this schema

xdm:toolUsageFailure Type

  • – https://ns.adobe.com/xdm/datatypes/data/measure

xdm:toolUsageID

Tool Usage ID

Captures the ID of the tool process utilized, if applicable. For example, this could be a claim, application, or booking ID, etc.

xdm:toolUsageID

  • is optional
  • type: string
  • defined in this schema

xdm:toolUsageID Type

string

xdm:toolUsageName

Tool Usage Name

Tracks the name of the tool in use.

xdm:toolUsageName

  • is optional
  • type: string
  • defined in this schema

xdm:toolUsageName Type

string

xdm:toolUsageSaved

Tool Usage Saved

Captured when a visitor saves and exits a tool usage process.

xdm:toolUsageSaved

  • is optional
  • type: reference
  • defined in this schema

xdm:toolUsageSaved Type

  • – https://ns.adobe.com/xdm/datatypes/data/measure

xdm:toolUsageStart

Tool Usage Start

Captured when a visitor initializes using any type of tool or utility on the site/app.

xdm:toolUsageStart

  • is optional
  • type: reference
  • defined in this schema

xdm:toolUsageStart Type

  • – https://ns.adobe.com/xdm/datatypes/data/measure

xdm:toolUsageStep

Tool Usage Step

Captured when any intermediary tool step is started on the site/app.

xdm:toolUsageStep

  • is optional
  • type: reference
  • defined in this schema

xdm:toolUsageStep Type

  • – https://ns.adobe.com/xdm/datatypes/data/measure

xdm:toolUsageStepName

Tool Usage Step Name

Tracks the name of the tool step in use.

xdm:toolUsageStepName

  • is optional
  • type: string
  • defined in this schema

xdm:toolUsageStepName Type

string

xdm:toolUsageSubmitted

Tool Usage Submitted

Captured when a visitor submits data during a tool step. Not necessarily synonymous with a successful event.

xdm:toolUsageSubmitted

  • is optional
  • type: reference
  • defined in this schema

xdm:toolUsageSubmitted Type

  • – https://ns.adobe.com/xdm/datatypes/data/measure

xdm:toolUsageTransaction

Tool Usage Transaction

Extension of Transaction Data Type

xdm:toolUsageTransaction

  • is optional
  • type: reference
  • defined in this schema

xdm:toolUsageTransaction Type

  • – https://ns.adobe.com/xdm/datatypes/Transaction

xdm:toolUsageType

Tool Usage Type

Tracks the type or category of the tool in use.

xdm:toolUsageType

  • is optional
  • type: string
  • defined in this schema

xdm:toolUsageType Type

string