Revision 7ee0aa19
Von Max Wessendorf vor 10 Monaten hinzugefügt
| doc/dokumentation.xml | ||
|---|---|---|
| 1606 | 1606 |
so startet dieser nach Beendigung automatisch erneut.</para> |
| 1607 | 1607 |
|
| 1608 | 1608 |
</sect2> |
| 1609 |
<sect2 id="Tasks-konfigurieren"> |
|
| 1610 |
<title>Exemplarische Konfiguration eines Hintergrund-Jobs, der die Jahreszahl in allen Nummernkreisen zum Jahreswechsel erhöht</title> |
|
| 1609 |
</sect1> |
|
| 1610 |
<sect1 id="Hintergrund-Job konfigurieren"> |
|
| 1611 |
<title>Konfiguration der Hintergrund-Jobs</title> |
|
| 1611 | 1612 |
|
| 1612 | 1613 |
<para>Hintergrund-Jobs werden über System -> Hintergrund-Jobs und Task-Server -> Aktuelle Hintergrund-Jobs anzeigen -> Aktions-Knopf 'erfassen' angelegt. </para> |
| 1613 |
<para>Nachdem wir über das Menü dort angelangt sind, legen wir unseren exemplarischen Hintergrund-Jobs "Erhöhung der Nummernkreise" mit folgenden Werten an:</para>
|
|
| 1614 |
<para>Nachdem wir über das Menü dort angelangt sind, legen wir hier unseren Hintergrund-Jobs an:</para>
|
|
| 1614 | 1615 |
<itemizedlist> |
| 1615 | 1616 |
<listitem> |
| 1616 | 1617 |
<para><literal>Aktiv:</literal> Hier ein 'Ja' auswählen</para> |
| ... | ... | |
| 1619 | 1620 |
<para><literal>Ausführungsart:</literal> 'wiederholte Ausführung' auswählen</para> |
| 1620 | 1621 |
</listitem> |
| 1621 | 1622 |
<listitem> |
| 1622 |
<para><literal>Paketname:</literal> 'SetNumberRange' auswählen</para>
|
|
| 1623 |
<para><literal>Paketname:</literal> Hintergrundjob auswählen</para>
|
|
| 1623 | 1624 |
</listitem> |
| 1624 | 1625 |
<listitem> |
| 1625 | 1626 |
<para><literal>Ausführungszeitplan:</literal> Hier entsprechend Werte wie in der crontab eingeben.</para><para>Syntax:</para> |
| ... | ... | |
| 1641 | 1642 |
4 = Monat (1-12) |
| 1642 | 1643 |
5 = Wochentag (0-7, Sonntag ist 0 oder 7) |
| 1643 | 1644 |
</programlisting> |
| 1644 |
<para>Um die Ausführung auf eine Minute vor Sylvester zu setzen, müssen die folgenden Werte eingetragen werden:</para>
|
|
| 1645 |
<para>Um die Ausführung auf eine Minute vor den Jahreswechsel zu setzen, müssen die folgenden Werte eingetragen werden:</para>
|
|
| 1645 | 1646 |
<programlisting>59 23 31 12 *</programlisting> |
| 1646 | 1647 |
</listitem> |
| 1647 | 1648 |
<listitem> |
| 1648 |
<para><literal>Daten:</literal>In diesem Feld können optionale Parameter für den Hintergrund im JSON-Format gesetzt werden. Der Hintergrund-Job <literal>SetNumberRange</literal> akzeptiert zwei Variable nämlich <literal>digit_year</literal> sowieso <literal>multiplier</literal>.</para><para> <literal>digit_year</literal> kann zwei Werte haben entweder 2 oder 4, darüber wird gesteuert ob die Jahreszahl zwei oder vierstellig kodiert wird (für 2019, dann entweder 19 oder 2019). Der Standardwert ist vierstellig.</para><para> <literal>multiplier</literal> ist ein Vielfaches von 10, darüber wird die erste Nummer im Nummernkreis (die Anzahl der Stellen) wie folgt bestimmt:</para> |
|
| 1649 |
<programlisting> |
|
| 1649 |
<para><literal>Daten:</literal>In diesem Feld können optionale Parameter für den Hintergrund im YAML-Format gesetzt werden.</para> |
|
| 1650 |
</listitem> |
|
| 1651 |
</itemizedlist> |
|
| 1652 |
<sect2 id="Hintergrund-Job SetNumberRange"> |
|
| 1653 |
<title>SetNumberRange</title> |
|
| 1654 |
<para> Der Hintergrund-Job <literal>SetNumberRange</literal> akzeptiert im Feld <literal>Daten</literal> zwei Variablen nämlich <literal>digit_year</literal> sowieso <literal>multiplier</literal>.</para><para> <literal>digit_year</literal> kann zwei Werte haben entweder 2 oder 4, darüber wird gesteuert ob die Jahreszahl zwei oder vierstellig kodiert wird (für 2019, dann entweder 19 oder 2019). Der Standardwert ist vierstellig.</para><para> <literal>multiplier</literal> ist ein Vielfaches von 10, darüber wird die erste Nummer im Nummernkreis (die Anzahl der Stellen) wie folgt bestimmt:</para> |
|
| 1655 |
<programlisting> |
|
| 1650 | 1656 |
multiplier Nummernkreis 2020 |
| 1651 | 1657 |
10 -> 20200 |
| 1652 | 1658 |
100 -> 202000 |
| ... | ... | |
| 1655 | 1661 |
<para>Wir gehen jetzt beispielhaft von einer letzten Rechnungsnummer von RE2019456 aus. Demnach sollte ab Januar 2020 die erste Nummer RE2020001 sein. Da der Task auch Präfixe berücksichtigt, kann dies mit folgenden JSON-kodierten Werten umgesetzt werden:</para> |
| 1656 | 1662 |
<para><literal>Daten:</literal></para><programlisting>multiplier: 100 |
| 1657 | 1663 |
digits_year: 4</programlisting> |
| 1664 |
|
|
| 1665 |
</sect2> |
|
| 1666 |
<sect2 id="Hintergrund-Job ImportRecordEmails"> |
|
| 1667 |
<title>ImportRecordEmails</title> |
|
| 1668 |
<para> Der Hintergrund-Job <literal>ImportRecordEmails</literal> kann vollständig über das Feld Daten konfiguriert werden. Er benötigt folgende Variablen:</para> |
|
| 1669 |
<itemizedlist> |
|
| 1670 |
<listitem> |
|
| 1671 |
<para><literal>hostname:</literal> Hier wird der Emailserver eingetragen</para> |
|
| 1672 |
</listitem> |
|
| 1673 |
<listitem> |
|
| 1674 |
<para><literal>username:</literal> Benutzername, mit dem sich am Emailserver angemeldet wird. (Häufig die Emailadresse)</para> |
|
| 1675 |
</listitem> |
|
| 1676 |
<listitem> |
|
| 1677 |
<para><literal>password:</literal> Passwort des Benutzers</para> |
|
| 1678 |
</listitem> |
|
| 1679 |
<listitem> |
|
| 1680 |
<para><literal>base_folder:</literal> Hier wird der Ordner eingetragen, aus dem die Emails importert werden sollen. (bspw. INBOX)</para> |
|
| 1681 |
</listitem> |
|
| 1682 |
<listitem> |
|
| 1683 |
<para><literal>port:</literal> Port am Emailserver. Default ist 993</para> |
|
| 1684 |
</listitem> |
|
| 1685 |
<listitem> |
|
| 1686 |
<para><literal>ssl:</literal> Gibt an ob SSL verwendet werden soll. Default: 1</para> |
|
| 1658 | 1687 |
</listitem> |
| 1659 | 1688 |
</itemizedlist> |
| 1660 |
</sect2> |
|
| 1661 |
</sect1> |
|
| 1689 |
|
|
| 1690 |
<para> Optional können außerdem folgende Variablen verwendet werden:</para> |
|
| 1691 |
|
|
| 1692 |
<itemizedlist> |
|
| 1693 |
<listitem> |
|
| 1694 |
<para><literal>email_import_ids_to_delete:</literal> Hier können IDs von Importen eingetragen werden, deren Emails aus dem Emailjournal gelöscht werden sollen.</para> |
|
| 1695 |
</listitem> |
|
| 1696 |
<listitem> |
|
| 1697 |
<para><literal>process_imported_emails:</literal> Wenn nach dem Import noch weitere Verarbeitung der angehangenen Dokument erfolgen soll, müssen hier die jeweiligen Schritte eingetragen werden. Aktuell ist es möglich, dass angehangene Zugpferd-Rechnung direkt verbucht und mit der Email verknüpft werden. Dazu muss hier '[zugpferd]' eingetragen werden.</para> |
|
| 1698 |
</listitem> |
|
| 1699 |
<listitem> |
|
| 1700 |
<para><literal>processed_imap_flag:</literal> Das hier eingetragenen Flag wird nach dem Verarbeiten an der Email gesetzt.</para> |
|
| 1701 |
</listitem> |
|
| 1702 |
<listitem> |
|
| 1703 |
<para><literal>not_processed_imap_flag:</literal> Dieses Flag wird gesetzt, wenn die Email nicht verarbeitet werden konnte.</para> |
|
| 1704 |
</listitem> |
|
| 1705 |
<listitem> |
|
| 1706 |
<para><literal>record_type:</literal> Einträge im Email-Journal können direkt einem Belegtypen zugrorndet werden. Wenn alle Emails, die mit einem Hintergrundjob importiert werden, den gleichen Belegtypen haben, kann man diesen hier festlegen und alle Einträge im Emailjournal werden entsprechend zugrordnet. Für Eingangsrechnungen muss man hier 'ap_transaction' setzen.</para> |
|
| 1707 |
</listitem> |
|
| 1708 |
</itemizedlist> |
|
| 1709 |
|
|
| 1710 |
<para>Alternativ ist auch eine Konfiguration über die kivi.conf möglich. Ein entsprechendes Beispiel findet sich in der kivi.conv.default</para> |
|
| 1711 |
|
|
| 1712 |
</sect2> |
|
| 1713 |
</sect1> |
|
| 1714 |
|
|
| 1662 | 1715 |
<sect1 id="Benutzerauthentifizierung-und-Administratorpasswort"> |
| 1663 | 1716 |
<title>Benutzerauthentifizierung und Administratorpasswort</title> |
| 1664 | 1717 |
|
Auch abrufbar als: Unified diff
Doku: Hintergrundjobs konfigurieren und angefangen einzelne Jobs und deren Conf zu beschreiben