Skip to content

README.md

Latest commit

 

History

History
261 lines (204 loc) · 7.82 KB

README.md

File metadata and controls

261 lines (204 loc) · 7.82 KB

OS2Forms Digital Post

Send Digital Post to danish citizens from a webform.

This module uses the SF1601 service from Serviceplatformen. Information and documentation can be obtained by following that link.

Usage

This module provides functionality for sending digital post to danish citizens. A WebformHandler is provided that you can add to your webform, and if configured it will send the submitted data as digital post.

Installation

Enable the module with drush

drush pm:enable os2forms_digital_post

Example forms

See OS2Forms Digital Post examples.

Configuration

Go to /admin/os2forms_digital_post/settings to set up global settings for digital post.

Key

We use os2web_key to provide the certificate for sending digital post, and the key must be of type "Certificate".

Queue

The actual sending of digital post is handled by jobs in an Advanced Queue queue.

The default queue, OSForms digital post (os2forms_digital_post), must be processed by a server cron job (cf. /admin/config/system/queues/manage/os2forms_digital_post?destination=/en/admin/config/system/queues), but this can be changed or a completely diffent queue can be used if nedd be.

If using the default queue, it can be processed by running the command

drush advancedqueue:queue:process os2forms_digital_post

List the queue (and all other queues) with

drush advancedqueue:queue:list

or go to /admin/config/system/queues/jobs/os2forms_digital_post for a graphical overview of jobs in the queue.

Beskedfordeler

The digital post module depends on Beskedfordeler for Drupal to get get information on how or why not a digital post has been delivered (cf. BeskedfordelerEventSubscriber).

See the documentation for Beskedfordeler for Drupal for details on how to set up the Beskedfordeler module.

Testing digital post

This module contains a simple Drush command for sending digital post to a list of recipients:

drush os2forms-digital-post:test:send --help

Fjernprint (physical digital post)

To comply with the address placement in the envelope window (kuvert-rude) an event subscriber is used to inject an address information element into the generated HTML before it is converted to a PDF.

We are only guaranteed to have the necessary information when in a digital post context. For that reason, the injection of address information is only done when in a digital post context. Note also that the information is only injected – it is not styled. This allows flexibility across installations but also means that it is up to individual installations to style it correctly. This should be done in OS2Forms Attachment-templates, see Overwriting templates.

Furthermore, a single-line sender address may be configured on the handler. The value of this field will be injected into the HTML as a sender address, which should be placed within the envelope window just above the recipient address. As with the recipient information, it is up to individual installations to style it correctly.

To see the exact requirements for address and sender placement, see digst_a4_farve_ej_til_kant_demo_ny_rudeplacering.pdf.

The injected HTML

Variations of the injected HTML include extended addresses, c/o and sender address.

Without extended address information, c/o or sender address:

<div id="envelope-window-digital-post">
  <div class="h-card">
    <div class="p-name">Jeppe</div>
    <div><span class="p-street-address">Test vej HouseNr</span></div>
    <div><span class="p-postal-code">2100</span> <span class="p-locality">Copenhagen</span></div>
  </div>
</div>

With just an extended address:

<div id="envelope-window-digital-post">
  <div class="h-card">
    <div class="p-name">Jeppe</div>
    <div><span class="p-street-address">Test vej HouseNr</span> <span class="p-extended-address">Floor AppartmentNr</span></div>
    <div><span class="p-postal-code">2100</span> <span class="p-locality">Copenhagen</span></div>
  </div>
</div>

With just c/o:

<div id="envelope-window-digital-post">
  <div class="h-card">
    <div class="p-name">Jeppe</div>
    <div class="p-name">c/o Mikkel</div><div><span class="p-street-address">Test vej HouseNr</span></div>
    <div><span class="p-postal-code">2100</span> <span class="p-locality">Copenhagen</span></div>
  </div>
</div>

With just the sender address:

<div id="envelope-window-digital-post">
  <div id="sender-address-digital-post">Dokk1, Hack Kampmanns Plads 2, 8000 Aarhus C</div>
  <div class="h-card">
    <div class="p-name">Jeppe</div>
    <div><span class="p-street-address">Test vej HouseNr</span></div>
    <div><span class="p-postal-code">2100</span> <span class="p-locality">Copenhagen</span></div>
  </div>
</div>

With extended address information, c/o and sender address:

<div id="envelope-window-digital-post">
  <div id="sender-address-digital-post">Dokk1, Hack Kampmanns Plads 2, 8000 Aarhus C</div>
  <div class="h-card">
    <div class="p-name">Jeppe</div>
    <div class="p-name">c/o Mikkel</div>
    <div><span class="p-street-address">Test vej HouseNr</span> <span class="p-extended-address">Floor AppartmentNr</span></div>
    <div><span class="p-postal-code">2100</span> <span class="p-locality">Copenhagen</span></div>
  </div>
</div>

Styling of the HTML

The following SCSS can be used to style the injected HTML accordingly:

$margin-top: 25mm;
// There is no exact measurement for margin right in the specifications
$margin-right: 10mm;
$margin-bottom: 20mm;
$margin-left: 17mm;
$page-width: 210mm;
$page-height: 297mm;
$envelope-window-height: 89mm;
$envelope-window-width: 115mm;
$recipient-window-height: 21mm;
$recipient-window-width: 59mm;

@page {
  size: A4;
  margin: 0;
}

body {
  margin-top: $margin-top;
  margin-right: $margin-right;
  margin-bottom: $margin-bottom;
  margin-left: $margin-left;
}

header {
  position: fixed;
  top: 0;
  height: $margin-top;
  width: calc($page-width - $margin-left - $margin-right);
  font-size: 12px;
}

footer {
  position: fixed;
  bottom: 0;
  height: $margin-bottom;
  width: calc($page-width - $margin-left - $margin-right);
  font-size: 12px;
}

// Style the envelope window that may be injected by Digital Post.
// Note that top/left is made from the assumption that @page has margin 0.
// @see \Drupal\os2forms_digital_post\EventSubscriber\Os2formsDigitalPostSubscriber:onPrintRender
#envelope-window-digital-post {
  position: absolute;
  top: $margin-top;
  left: $margin-left;
  height: $envelope-window-height;
  width: $envelope-window-width;
  background: white
}

// If envelope window is present, move webform content down
// @see os2forms_digital_post
#envelope-window-digital-post ~ * .webform-entity-print-body {
  margin-top: $envelope-window-height;
}

// Style the h-card div
#envelope-window-digital-post > .h-card {
  position: absolute;
  top: 16mm;
  left: 4mm;
  font-size: 10px;
  height: $recipient-window-height;
  width: $recipient-window-width;
}

// Style the sender address div
#envelope-window-digital-post > #sender-address-digital-post {
  position: absolute;
  top: 12mm;
  left: 4mm;
  font-size: 8px;
  height: 4mm;
  width: 71mm;
}

// More custom styling...