Skip to content
Orbit GroundControl home
Orbit GroundControl home

Decode

📦 As a starting point we recommend first understanding the concept of TransportShapes and TransportComposers before diving into this article.

Overview

Orbit Decode revolutionises how unstructured order emails are handled, converting them into actionable Transport (Order, Shipment and/or Tour) objects within the Orbit platform. Decode fundamentally simplifies the handling of order emails saving valuable time in daily operaitons. Through automation and AI, Decode frees users from tedious manual tasks, paving the way for more efficient and error-free data processing.

This document aims to demystify Decode, outlining its features, workflows, and the synergy between its components.

Key Highlights

  • MagicInboxes: Specialised email addresses – each configurable with specific field presets and validations – that automatically process incoming emails into compatible Transports within Orbit, including attachments.

  • Versatile Entry Points: Beyond MagicInboxes, users can input data by dragging and dropping emails into the MissionControl UI, manually pasting text, or uploading attachments.

  • Comprehensive Review: Decoded data is presented alongside the original email, with intuitive indicators highlighting the source of each data point.

Decode Process

As a transformative feature designed to redefine the workflows of Orbit users, understanding the individual components that constitute the decoding process is essential. Generally, it's practical to distinguish three distinct stages within each Decode process: Getting Data into the system, processing of the data in the background, and the final review of decoded data inside an automatically filled-out TransportComposer.

As highlighted earlier, we advise first understanding the TransportShape and TransportComposer concept. Nevertheless, here's a brief refresher on the crucial elements that are important for understanding the Decode flow:

  1. TransportComposers: Customisable forms allowing users to create Offers, Orders, Shipments, and/or Tours, all within one go.

    1. TransportDrafts: Preliminary versions of TransportComposer forms, automatically saved as users make edits.

  2. TransportShapes: Configuration objects for full customisation of TransportComposers.

Understanding the Role of TransportShapes in Decode

TransportShapes play a central role in configuring how Decode operates. Specifically, a TransportShape:

  • Defines available fields: It specifies which fields are present for data entry or processing within Decode.

  • Sets display names (placeholders): It determines how each field is labelled or described in the UI, ensuring clarity for users.

  • Controls validation logic: It outlines how fields are validated, both when processes are completed manually and when using Auto Actions.

  • Determines available actions/AutoActions: It defines which actions can be performed and which of these can be triggered automatically (AutoActions).

  • Important: Presets defined directly within a TransportShape are not applied in Decode. Instead, you should use MagicInbox Presets and MagicInbox Fallbacks to manage default values and fallback logic.

  • Specifies object creation: It establishes which objects—Order, Shipment, Tour—can be generated from the Decode process.

By carefully configuring your TransportShapes, you ensure that Decode behaves consistently and efficiently according to your business requirements.

1. Data Inflow

The first step of each Decode Job is all about getting relevant data into the system. Decode is optimised on the principle that each email message, including its attachments, should encapsulate all relevant information about a transport. This means that, whatever entry point into Decode you choose, try to limit every job to one isolated transportation context. Or in other words: Ensure that each transport is contained within a single Decode Job, avoiding fragmentation across multiple jobs (1 Decode Job = 1 Email = 1 Transport).

Currently, our system limits attachment processing to a maximum of 30 attachments per email. This includes images embedded within the email body or footer, which may not be immediately apparent as attachments.

Currently, there are two distinct entry points for initialising Decode jobs.

Entry point: Magic Inboxes

A MagicInbox is an Orbit-generated email address that automatically creates a Decode Job for every incoming email. A Magic Inbox is always linked to a TransportShape and may include Presets and MagicFields for fields that are visible as per the TransportShape configuration and may override Decode’s data output. To set up this flow, follow these steps:

  1. Make sure your users role has the relevant Permissions to manage MagicInboxes

  2. Go into Orbit MissionControl’s Settings > Magic Inboxes > Create MagicInbox

    1. Give the MagicInbox a name.

    2. Link a TransportShape to the Magic Inbox

  3. After creation, you may (optionally) set up some field presets on the MagicInbox. For every Decode Job generated, the corresponding TransportComposer will be automatically populated with these preset values, regardless of the specific data decoded from the emails.

  4. After creation, you also may (optionally) set up so-called MagicFields. MagicFields allow you to customize data extraction from emails beyond the predefined transport schema. If your TransportShape has configured some properties, you may for example instruct the AI how to correctly set this specific property.

  5. Now you can copy the generated email address and give this to your clients or set up appropriate forwarding.

Screenshot 2024-02-26 at 14.38.31.png

Additionally, you are able to provide custom instructions to the AI model that evaluates emails for this inbox. Use this to explain any particularities or give custom commands to the AI model. Ensure the instructions are written in clear, human-readable text, as if you were instructing a person.

It's recommended to write these instructions in the language you expect the emails to be in. However, any language will work.

Example:

“Attention: Euro pallets are always abbreviated as PTN.”

Entry point: MissionControl UI

Of course, you are not limited to only generating Decode Jobs via incoming emails. A Job can just as well be triggered manually from Orbit MissionControl:

  1. Go To Orders > Drafts > Create Decode Jobs

  2. Now you can drag and drop emails from your desktop

    1. Currently we support .msg and .eml file formats

    2. First, save the email from your email client to your computer

    3. Next, drag and drop the saved file(s) into the designated upload area

    4. A unique Decode Job is created for each file you drop

  3. Optionally, you can also create a Decode Job without any email files

    1. Press on “create manually”

    2. Copy and paste text contents into the rich text field

    3. Optionally, upload files

Screenshot 2024-02-26 at 14.37.34.png

2. Background Processing

Regardless of the chosen entry point, the transformative process begins behind the scenes immediately after we detect incoming email data. An empty TransportDraft is created at this stage. While it initially lacks any specific Transport details, it serves to monitor the Decode Job's progression. Each Decode Job is uniquely represented by a TransportDraft, and you can track the current status of any Decode Job by locating its corresponding draft in the Orders > Drafts list.

TransportDrafts generated via Decode feature exclusive status indicators to denote their progress:

  • Pulsating Orange: Indicates the job is actively being processed in the background.

  • Green: Signifies the job has been successfully processed and is ready for review.

  • Red: Indicates a processing failure of the job.

  • Gray Checkmark: Confirms the TransportComposer has been submitted and resulted in the generation of output objects. This is considered a “done” job.

Upon the successful processing of a Decode Job, an in-app notification will alert you, making it possible to review all decoded data. Editing the TransportDraft is permissible only at this stage, with all other statuses serving purely for informational purposes.

3. User review

Upon reaching the green status, a Decode Job prompts the user to review the decoded data. The interface for this task is divided into two sections: a TransportComposer on the left and the original email content including all attachments on the right.

The TransportComposer has been automatically filled out with all the decoded transportation data. Additionally, every pre-filled input field is highlighted with a small decode icon to signal its automatic completion.

When you click on any of these pre-filled fields, direct your focus to the right section of the window. In this area, we visually indicate the segments in the email likely responsible for the data in the specific field, along with a matching score. This score reflects our confidence level in the source identification, acknowledging the inherent uncertainties in the artificial intelligence's processing of the job.

At the bottom of the TransportComposer, you'll find a "check" button designed to execute all validations and highlight any fields needing further user attention. After ensuring all fields are correctly completed and validated, you can proceed to submit the TransportComposer.

This marks the end of the Decode Job. Subsequently, the associated TransportDraft is marked with a checkmark and linked to the generated output objects (orders, shipments, or tours). Further editing of this specific TransportDraft is no longer possible.

By this stage, the previously unstructured email has been successfully integrated into the Orbit platform, transforming it into structured, actionable data.

OrbitDecode-ReviewUIDocs.png

🪝 Of course, both Decode and MagicInboxes are compatible with Orbit’s webhooks. You can subscribe to the creation of mailboxes, the receipt of emails, as well as to the completion of decode jobs.