Digests

This document describes all the data available in Jinja2 templates for email digests.

Table of Contents

• Main Context Variables
• Digest Information
• Equipment Data
• Qualifications Data
• Quotes Data
• Leave Data
• Individual Mode

Main Context Variables

The following top-level variables are always available in your templates:

Digest Information

digest    object

Contains the digest configuration:

digest.org    object

Equipment Data

equipment    object

Contains two arrays of equipment items:

Equipment Item Structure

Each item in equipment.expired    or equipment.expiring   :

Example Usage

{% if equipment.expired %}
<h3>Expired Equipment</h3>
<ul>
{% for item in equipment.expired %}
  <li>{{ item.name }} - Expired on {{ item.calibration }}</li>
{% endfor %}
</ul>
{% endif %}

{% if equipment.expiring %}
<h3>Equipment Due for Calibration</h3>
<ul>
{% for item in equipment.expiring %}
  <li>{{ item.name }} - Due {{ item.calibration }}</li>
{% endfor %}
</ul>
{% endif %}

Qualifications Data

qualifications    object

Contains two arrays of qualification items:

Qualification Item Structure

Each item in qualifications.expired    or qualifications.expiring   :

Example Usage

{% if qualifications.expiring %}
<h3>Qualifications Expiring Soon</h3>
<table>
  <tr><th>Employee</th><th>Qualification</th><th>Expires</th></tr>
{% for qual in qualifications.expiring %}
  <tr>
    <td>{{ qual.user.name }}</td>
    <td>{{ qual.name }}</td>
    <td>{{ qual.end }}</td>
  </tr>
{% endfor %}
</table>
{% endif %}

Quotes Data

quotes    object

Contains two arrays of project/quote items:

Quote Item Structure

Each item in quotes.created    or quotes.open   :

Example Usage

{% if quotes.created %}
<h3>New Enquiries</h3>
<ul>
{% for quote in quotes.created %}
  <li>
    <strong>{{ quote.client.name }}</strong>: {{ quote.name }}
    (Created {{ quote.created|date:"Y-m-d" }})
  </li>
{% endfor %}
</ul>
{% endif %}

{% if quotes.open %}
<h3>Quotes Awaiting Decision</h3>
<ul>
{% for quote in quotes.open %}
  <li>
    {{ quote.client.name }}: {{ quote.name }} 
    - Quoted {{ quote.quoted|date:"Y-m-d" }}
    {% if quote.quote_deadline %} (Valid until {{ quote.quote_deadline }}){% endif %}
  </li>
{% endfor %}
</ul>
{% endif %}

Leave Data

leave    object

Contains two arrays of leave items:

Leave Item Structure

Each item in leave.created    or leave.approved   :

Example Usage

{% if leave.created %}
<h3>Pending Leave Requests</h3>
<ul>
{% for request in leave.created %}
  <li>
    {{ request.user.name }} - {{ request.type.name }}
    ({{ request.start }} to {{ request.end }}, {{ request.days }} days)
  </li>
{% endfor %}
</ul>
{% endif %}

{% if leave.approved %}
<h3>Upcoming Leave</h3>
<ul>
{% for absence in leave.approved %}
  <li>
    {{ absence.user.name }}: {{ absence.start|date:"M d" }} - {{ absence.end|date:"M d" }}
  </li>
{% endfor %}
</ul>
{% endif %}

User Object Structure

User objects appear in various places and have this structure:

Individual Mode

When digest.individual    is true   , each recipient gets a personalized email with an additional user    variable:

user    object (only in individual mode)

The full user object for the recipient, containing all user profile data.

Example Usage

{% if user %}
  <p>Hello {{ user.first_name }},</p>
  <p>Here's your personal digest for {{ today|date:"F j, Y" }}:</p>
{% else %}
  <p>Team Digest for {{ today|date:"F j, Y" }}:</p>
{% endif %}

Conditional Display

Use Jinja2 conditionals to show/hide sections:

{% if equipment.expired or equipment.expiring %}
<section class="equipment-section">
  <!-- Equipment content -->
</section>
{% endif %}

{% if leave.created|length > 5 %}
<p class="alert">{{ leave.created|length }} leave requests pending!</p>
{% endif %}

Loops and Filters

Common Jinja2 filters useful for digests:

{{ items|length }}                 <!-- Count items -->
{{ price|floatformat:2 }}          <!-- Format decimal -->
{{ text|truncatewords:20 }}        <!-- Limit text length -->
{{ value|default:"N/A" }}          <!-- Default value -->

{% for item in items|slice:":5" %} <!-- First 5 items -->
  <!-- ... -->
{% endfor %}

Complete Example Template

<!DOCTYPE html>
<html>
<head>
    <title>{{ digest.org.name }} Digest - {{ today|date:"F j, Y" }}</title>
</head>
<body>
    <h1>{{ digest.org.name }} Weekly Digest</h1>
    <p>Report generated on {{ today|date:"l, F j, Y" }}</p>

    {% if quotes.created or quotes.open %}
    <h2>Projects & Quotes</h2>
    
    {% if quotes.created %}
    <h3>New Enquiries ({{ quotes.created|length }})</h3>
    <ul>
    {% for project in quotes.created|slice:":10" %}
        <li>{{ project.client.name }}: {{ project.name }}</li>
    {% endfor %}
    </ul>
    {% endif %}
    
    {% if quotes.open %}
    <h3>Quotes Pending Decision ({{ quotes.open|length }})</h3>
    <ul>
    {% for project in quotes.open %}
        <li>
            {{ project.client.name }}: {{ project.name }}
            - {{ project.currency }} {{ project.price_net|floatformat:2 }}
            {% if project.quote_deadline %}
            (Expires: {{ project.quote_deadline|date:"M d" }})
            {% endif %}
        </li>
    {% endfor %}
    </ul>
    {% endif %}
    {% endif %}

    {% if leave.created or leave.approved %}
    <h2>Leave Management</h2>
    
    {% if leave.created %}
    <h3>Pending Approvals</h3>
    <table>
    {% for request in leave.created %}
        <tr>
            <td>{{ request.user.name }}</td>
            <td>{{ request.start|date:"M d" }} - {{ request.end|date:"M d" }}</td>
            <td>{{ request.days }} days</td>
        </tr>
    {% endfor %}
    </table>
    {% endif %}
    {% endif %}

    {% if equipment.expired %}
    <h2>⚠️ Expired Equipment Calibrations</h2>
    <ul>
    {% for item in equipment.expired %}
        <li>{{ item.name }} ({{ item.category.name }}) - Expired {{ item.calibration }}</li>
    {% endfor %}
    </ul>
    {% endif %}

    {% if user %}
    <hr>
    <p><small>This digest was personalized for {{ user.name }}.</small></p>
    {% endif %}
</body>
</html>

Notes for Template Designers

1. Always check for data existence before displaying sections to avoid empty headers
2. Use the |length    filter to show counts in section headers
3. Consider using |slice    to limit long lists in summary views
4. Format dates consistently throughout the template
5. Test with both individual and non-individual modes if your digest supports both
6. Remember that user    is only available in individual mode
7. All date/datetime fields can be null - always check before displaying

Testing Your Templates

To test your templates with sample data:

1. Create a test digest in the admin panel
2. Set appropriate day ranges for each data type
3. Send test emails to verify formatting
4. Test both with and without data in each section
5. Test individual mode if applicable