Task summaries

💬

Get access to the Analytics view

Reach out to our Customer Success team to add the Analytics view functionality to your Formant organization. You can reach us through the Intercom messenger in the bottom-right corner of this page, or at [email protected].

A task summary is a special kind of event type in Formant. Conceptually, a task summary will report task performance or other general information for a given time range. For example, you might want to store how many feet were driven, or how many apples picked, for each mission.

Task summaries

In Formant, a task summary is a formatted dataset which describes a single event or a sequence of tasks, routines, or actions taken by your robot. A task summary can contain any JSON data and be linked to a specific device.

Before you can create a task summary, you must first define how that data is organized. This structured format allows Formant to uniformly display and analyze your tasks in the timeline view or in an analytics view. You'll do this by creating and uploading a task summary format with the API.

Task summary formats

A task summary format is a JSON Schema which defines the manner in which the task summary data is organized. You must generate and upload a task summary format before you submit task summaries.

View task summaries on Formant timeline

Task summaries appear as events on your device's timeline.

Task summaries appear as events on your device's timeline.

When you upload a task summary to Formant and associate it with a device, it will appear on your device's timeline alongside other events.

Creating task summaries using the Task Summary API

For more information on loading task summaries and task summary formats into Formant, see Create a task summary.

👋

If you notice an issue with this page or need help, please reach out to us! Use the 'Did this page help you?' buttons below, or get in contact with our Customer Success team via the Intercom messenger in the bottom-right corner of this page, or at [email protected].