{% extends 'base.html' %} {% block title %}Site customization{% endblock %} {% block content %}

Customizations

You can customize portions of {{ site_title }} to suit your organization's needs.

Email addresses

{% csrf_token %}
User feedback from the Feedback page is sent to this email address.
Safety suggestions and observations are sent to this email address.
Alerts about user activities that could constitute 'abuse' are sent to this email address. Examples include missed reservations and unauthorized tool access.
The main point of contact for users to obtain {{ facility_name }} information. Automated emails sent from {{ site_title }} are typically 'from' this address.

Calendar settings

{% csrf_token %}
The time the day starts in the calendar view (24h format).
The following settings allow to customize the date format in the different calendar views. See FullCalendar documentation for more information on the syntax.
The column date format for the day view.
The column date format for the week view.
The column date format for the month view.

Application settings

{% csrf_token %}

The name of the facility to use in all templates.
The name of the site to use in all templates/headers.

Login banner

The login banner is an informational message displayed underneath the username and password text boxes on the login page. You can customize this to convey rules for {{ site_title }} users at your organization.

{% csrf_token %}
{% if login_banner %}login_banner.html{% endif %}
{% if login_banner %}
{{ login_banner }}
{% endif %}

Introduction for "Safety suggestions and observations" page

What would you like everyone to know about safety policy and procedures? This introduction will be presented at the top of the safety page. You can use HTML to modify the look of the text.

{% csrf_token %}
{% if safety_introduction %}safety_introduction.html{% endif %}
{% if safety_introduction %}
{{ safety_introduction }}
{% endif %}

"{{ facility_name }} rules tutorial" page

The {{ facility_name }} rules tutorial is an opportunity to provide new users with a tutorial to your lab operating procedures and rules. The HTML you upload is rendered with the Django template engine. You can use JavaScript (including jQuery) within the page. Completion of the HTML form should be POSTed to the 'facility_rules' URL. Upon completion, the user's "training required" attribute is set to false, and they are able to make reservations and control tools.

{% csrf_token %}
{% if facility_rules_tutorial %}facility_rules_tutorial.html{% endif %}
{% if facility_rules_tutorial %}
{{ facility_rules_tutorial }}
{% endif %}

"{{ facility_name }} failed login" page

This page is displayed after authentication when either no matching username could be found in the database or if that user has been deactivated.
The HTML you upload is rendered with the Django template engine. You can use JavaScript (including jQuery) within the page.

{% csrf_token %}
{% if authorization_failed %}authorization_failed.html{% endif %}
{% if authorization_failed %}
{{ authorization_failed }}
{% endif %}

"Jumbotron" watermark

This image is displayed as background for the Jumbotron. It is set as a full background screen, so your image needs to take that into account.
The image you upload should be a valid image file (recommended size is 1500x1000).

{% csrf_token %}
{% if jumbotron_watermark %}jumbotron_watermark.png{% endif %}
{% if jumbotron_watermark %}
jumbotron_watermark
{% endif %}

Cancellation email

This email is sent to a user when a staff member cancels the user's reservation. The following context variables are provided when the email is rendered:

  • reservation - the user's reservation that was cancelled
  • staff_member - the user object of the staff member who cancelled the reservation
  • reason - the reason the staff member provided for cancelling the reservation
{% csrf_token %}
{% if cancellation_email %}cancellation_email.html{% endif %}
{% if cancellation_email %}
{{ cancellation_email }}
{% endif %}

Feedback email

This email is sent when a user submits feedback. The feedback email address (at the top of this page) must also be configured for users to be able to do this. The following context variables are provided when the email is rendered:

  • contents - the user's feedback
  • user - the user object of the user who submitted the feedback
{% csrf_token %}
{% if feedback_email %}feedback_email.html{% endif %}
{% if feedback_email %}
{{ feedback_email }}
{% endif %}

Generic email

A generic email that can be sent to qualified tool users, members of an account, or members of a project. Send these using the email broadcast page. The following context variables are provided when the email is rendered:

  • title - the user specified title of the email
  • greeting - a greeting to the recipients of the email
  • contents - the body of the email
  • template_color - the color to emphasize
{% csrf_token %}
{% if generic_email %}generic_email.html{% endif %}
{% if generic_email %}
{{ generic_email }}
{% endif %}

Missed reservation email

This email is sent when a user misses a reservation. If a tool is not used for an amount of time after the user's reservation has begun, it is marked as missed and removed from the calendar. The following context variables are provided when the email is rendered:

  • reservation - the reservation that the user missed
{% csrf_token %}
{% if missed_reservation_email %}missed_reservation_email.html{% endif %}
{% if missed_reservation_email %}
{{ missed_reservation_email }}
{% endif %}

{{ facility_name }} rules tutorial email

This email is sent when a user completes the {{ facility_name }} rules tutorial. It can contain a free-response answer (quiz question). If you do not upload a template then no notification email is sent to staff when a user completes the training tutorial. The following context variables are provided when the email is rendered:

  • user - the user's model instance
  • making_reservations_rule_summary - a free-response answer provided by the user. Normally, this is provided by the user to summarize their understanding of the {{ facility_name }} rules and proceedures.
{% csrf_token %}
{% if facility_rules_tutorial_email %}facility_rules_tutorial_email.html{% endif %}
{% if facility_rules_tutorial_email %}
{{ facility_rules_tutorial_email }}
{% endif %}

New task email

This email is sent when a new maintenance task is created for a tool. The following context variables are provided when the email is rendered:

  • user - the user who created the task
  • task - the task information
  • tool - the tool that the task is associated with
  • tool_control_absolute_url - the URL of the tool control page for the tool
  • template_color - an HTML color code indicating the severity of the problem. Orange for warning, red for shutdown.
{% csrf_token %}
{% if new_task_email %}new_task_email.html{% endif %}
{% if new_task_email %}
{{ new_task_email }}
{% endif %}

Reservation reminder email

This email is sent to a user two hours before their tool reservation begins. The reservation warning email must also exist for this email to be sent. The following context variables are provided when the email is rendered:

  • reservation - the user's upcoming reservation
{% csrf_token %}
{% if reservation_reminder_email %}reservation_reminder_email.html{% endif %}
{% if reservation_reminder_email %}
{{ reservation_reminder_email }}
{% endif %}

Reservation warning email

This email is sent to a user two hours before their tool reservation begins and maintenance may interfere with the upcoming reservation. The reservation reminder email must also exist for this email to be sent. The following context variables are provided when the email is rendered:

  • reservation - the user's upcoming reservation
  • fatal_error - boolean value that, when true, indicates that it will be impossible for the user to use the tool during their reservation (due to tool maintenance or a missing required dependency)
{% csrf_token %}
{% if reservation_warning_email %}reservation_warning_email.html{% endif %}
{% if reservation_warning_email %}
{{ reservation_warning_email }}
{% endif %}

Safety issue email

This email is sent when a new maintenance task is created for a tool. The following context variables are provided when the email is rendered:

  • issue - the issue information
  • issue_absolute_url - the URL for the detailed view of the issue
{% csrf_token %}
{% if safety_issue_email %}safety_issue_email.html{% endif %}
{% if safety_issue_email %}
{{ safety_issue_email }}
{% endif %}

Staff charge reminder email

This email is periodically sent to remind staff that they are charging a user for staff time. The following context variables are provided when the email is rendered:

  • staff_charge - the staff charge that is in progress
{% csrf_token %}
{% if staff_charge_reminder_email %}staff_charge_reminder_email.html{% endif %}
{% if staff_charge_reminder_email %}
{{ staff_charge_reminder_email }}
{% endif %}

Task status notification email

This email is sent when a tool task has be updated and set to a particular state. The following context variables are provided when the email is rendered:

  • template_color - the color to emphasize
  • title - a title indicating that the message is a task status notification
  • task - the task that was updated
  • status_message - the current status message for the task
  • notification_message - the notification message that is configured (via the admin site) for the status
  • tool_control_absolute_url - the URL of the tool control page for the task
{% csrf_token %}
{% if task_status_notification %}task_status_notification.html{% endif %}
{% if task_status_notification %}
{{ task_status_notification }}
{% endif %}

Unauthorized tool access email

This email is sent when a user tries to access a tool without being logged in to the area in which the tool resides. The following context variables are provided when the email is rendered:

  • operator - the person who attempted to use the tool
  • tool - the tool that the user was denied access to
{% csrf_token %}
{% if unauthorized_tool_access_email %}unauthorized_tool_access_email.html{% endif %}
{% if unauthorized_tool_access_email %}
{{ unauthorized_tool_access_email }}
{% endif %}

Usage reminder email

This email is periodically sent to remind a user that they have a tool enabled. The following context variables are provided when the email is rendered:

  • user - the user who is using a tool or logged in to an area
{% csrf_token %}
{% if usage_reminder_email %}
{{ usage_reminder_email }}
{% endif %}

User reservation created email

This email is sent to a user when the user creates a reservation. The following context variables are provided when the email is rendered:

  • reservation - the user's reservation that was cancelled
{% csrf_token %}
{% if reservation_created_user_email %}reservation_created_user_email.html{% endif %}
{% if reservation_created_user_email %}
{{ reservation_created_user_email }}
{% endif %}

User reservation cancelled email

This email is sent to a user when the user cancels his own reservation. The following context variables are provided when the email is rendered:

  • reservation - the user's reservation that was cancelled
{% csrf_token %}
{% if reservation_cancelled_user_email %}reservation_cancelled_user_email.html{% endif %}
{% if reservation_cancelled_user_email %}
{{ reservation_cancelled_user_email }}
{% endif %}

Tool Rates

You can upload a json file to display tool rates. An example of a valid rates file can be found on Github.

It should be a JSON array of elements, and the following key/values are supported for each element:

  • item_id - the id of the tool or supply
  • table_id - the type of rate, one of "inventory_rate" (for supplies), "primetime_eq_hourly_rate" (for tool), "training_individual_hourly_rate" (for individual training rate), "training_group_hourly_rate" (for group training rate)
  • rate_class - the class, one of "full cost" or "cost shared"
  • rate - the rate amount
  • item - the name of the item (optional)
{% csrf_token %}
{% if rates %}rates.json{% endif %}
{% if rates %}
{{ rates }}
{% endif %}
{% endblock %}