For the complete documentation index, see llms.txt. This page is also available as Markdown.

Set Up

Purpose

This document describes the administrator / integrator process required to configure the Email-to-Checkpoint feature in Didge. It outlines the required form configuration, checkpoint setup, and how checkpoint email addresses are generated and provided for use.

Overview of Admin Responsibilities

To enable Email-to-Checkpoint, an administrator must:

  1. Configure a form with the correct file component and field tag

  2. Create checkpoints using that form (typically one per service provider)

  3. Retrieve and provide the unique checkpoint email address for each provider

Once these steps are completed, the feature operates automatically.


Step 1: Form Configuration

Option A: Use the Global Vendor Reports Form

Didge provides a global form called Vendor Reports, which is already suitable for Email-to-Checkpoint use.

This form may be used without modification.

Option B: Create a Custom Form

Administrators may also create their own form using the Form Builder, provided the following requirements are met.


Mandatory Form Requirements

For Email-to-Checkpoint to function, the form must meet two mandatory requirements:

1. File Component

  • The form must include a File component

  • This component is where emailed attachments will be stored

2. File Component Field Tag

  • Open the File component settings

  • Navigate to the API section

  • Add the following Field Tag:

This tag is required for the server to correctly identify and ingest email attachments.

Without this tag, Email-to-Checkpoint will not function.


Step 2: Checkpoint Creation

  • Using the configured form, create checkpoints as normal within Didge

  • Typically, one checkpoint is created per service provider or report type

Examples:

  • Pest Control Reports

  • Calibration Reports

  • Microbiological Testing

  • Training Provider Reports

Notes:

  • Multiple checkpoints may use the same form

  • Each checkpoint remains independent


Step 3: Checkpoint Email Generation

Once a checkpoint has been created:

  1. Open the checkpoint

  2. In the checkpoint table modal header, locate the email icon

  3. Click the email icon to reveal the checkpoint email address

The email address will appear in the format:

Key Details

  • The number portion is the Operation ID

  • Each checkpoint has a unique email address

  • This email is permanently linked to that checkpoint


Step 4: Providing Emails to the Client

The checkpoint email addresses can be:

  • Provided to the client by the implementation or service team

  • Accessed directly by the client within Didge, if required

Typically, the client is supplied with:

  • A list of checkpoint names

  • Their corresponding Email-to-Checkpoint addresses

  • Instructions to provide each address to the relevant service provider


Runtime Behaviour

Once configured:

  • Any email sent to a checkpoint email address

  • With one or more attachments (e.g. PDF, Word)

  • Will automatically submit those attachments into Didge

  • The files are stored against the correct checkpoint

No further admin or user intervention is required.


Admin Process Summary

To establish Email-to-Checkpoint:

  1. Ensure the form includes a File component with the email.attachments field tag

  2. Create checkpoints using that form

  3. Retrieve and distribute the checkpoint email addresses

After setup, the feature operates automatically and continuously.

Last updated

Was this helpful?