Projekt

Allgemein

Profil

« Zurück | Weiter » 

Revision 216ee4d4

Von Roman Karuschka vor 10 Monaten hinzugefügt

  • ID 216ee4d4386e9c53a317f23dcabc8e449753d21b
  • Vorgänger e7b13644
  • Nachfolger ed8cfcf6

Update der Installationsdokumentation, Abschnitt Voraussetzungen

Unterschiede anzeigen:

doc/dokumentation.xml
106 106
        ohne große Probleme auf den derzeit aktuellen verbreiteten
107 107
        Distributionen läuft.</para>
108 108

  
109
        <para>Mitte 2020 (ab Version 3.5.6) empfehlen wir:</para>
109
        <para>Anfang 2024 (ab Version 3.5.6) empfehlen wir:</para>
110 110

  
111 111
        <itemizedlist>
112 112
          <listitem>
......
119 119
              <listitem>
120 120
                <para>11.0 "Bullseye"</para>
121 121
              </listitem>
122
              <listitem>
123
                <para>12.0 "Bookworm"</para>
124
              </listitem>
122 125
            </itemizedlist>
123 126
          </listitem>
124 127

  
125 128
          <listitem>
126
            <para>20.04 "Focal Fossa" LTS
127
          </para>
129
            <para>Ubuntu</para>
130
            <itemizedlist>
131
             <listitem>
132
              <para>20.04 "Focal Fossa" LTS</para>
133
             </listitem>
134
             <listitem>
135
              <para>22.04 "Jammy Jellyfish" LTS</para>
136
             </listitem>
137
            </itemizedlist>
128 138
          </listitem>
129 139

  
130 140
          <listitem>
......
152 162

  
153 163
        <programlisting>./scripts/installation_check.pl</programlisting>
154 164

  
165
      <note id="List-Moreutils">
166
        <para>Das Paket <literal>List::MoreUtils</literal> wird benötigt um das Script ausführen zu können!</para>
167
      </note>
155 168
        <para>Die vollständige Liste der benötigten Perl-Module lautet:</para>
156 169

  
157 170
        <itemizedlist>
......
442 455
        <literal>XML::Writer</literal> sind notwendig. Ohne startet kivitendo
443 456
        nicht.</para>
444 457

  
445
        <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
446
        <literal>DateTime</literal>, <literal>Rose::Object</literal>,
447
        <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
448
        neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
449

  
450 458
        <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
451 459
        hinzugekommen.</para>
452 460

  
453 461
        <para><literal>Email::Address</literal> und
454
        <literal>List::MoreUtils</literal> sind schon länger feste
455
        Abhängigkeiten, wurden aber bisher mit kivitendo mitgeliefert. Beide
456
        sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
457
        zukünftigen Version aber aus dem Paket entfernt werden. Es wird
462
        <literal>List::MoreUtils</literal> wurden aus dem Lieferumfang entfernt. Es wird
458 463
        empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
459 464
        installieren.</para>
460 465

  
466
        <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
467
        <literal>DateTime</literal>, <literal>Rose::Object</literal>,
468
        <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
469
        neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
470

  
471

  
461 472
        <sect3>
462 473
          <title>Debian und Ubuntu</title>
463 474
          <para>Für Debian und Ubuntu stehen die meisten der benötigten
......
574 585
      </sect2>
575 586
    </sect1>
576 587
    <sect1 id="Installation mittels Ansible"
577
	   xreflabel="Inatallation mittels Ansible">
588
           xreflabel="Inatallation mittels Ansible">
578 589
      <title>Installation mittels Ansible auf Ubuntu 22.04</title>
579 590
      <para>
580 591
        Ansible ist ein Open-Source-Automatisierungstool, das verwendet
......
1606 1617
        so startet dieser nach Beendigung automatisch erneut.</para>
1607 1618

  
1608 1619
      </sect2>
1609
      <sect2 id="Tasks-konfigurieren"
1610
             xreflabel="Tasks-konfigurieren">
1620
      <sect2 id="Tasks-konfigurieren">
1611 1621
        <title>Exemplarische Konfiguration eines Hintergrund-Jobs, der die Jahreszahl in allen Nummernkreisen zum Jahreswechsel erhöht</title>
1612 1622

  
1613 1623
        <para>Hintergrund-Jobs werden über System -> Hintergrund-Jobs und Task-Server -> Aktuelle Hintergrund-Jobs anzeigen -> Aktions-Knopf 'erfassen' angelegt. </para>
......
6288 6298
            </varlistentry>
6289 6299

  
6290 6300
          </variablelist>
6291
        </sect3>
6292 6301

  
6293
        <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten-cvars">
6294
          <title>Benutzerdefinierte Variablen für jeden Posten auf der Rechnung</title>
6295
          <para>
6296
            Für jeden Posten stehen auch die benutzerdefinierten Variablen zum
6297
            Artikel zur Verfügung. Ihre Namen bestehen aus dem Präfix
6298
            <varname>ic_cvar_</varname> und dem vom Benutzer festgelegten
6299
            Variablennamen.
6300
          </para>
6301
          <para>
6302
            Ebenso stehen die benutzerdefinierten Variablen zum positionsbezogenen
6303
            Projekt unter dem Namen mit dem Präfix <varname>project_cvar_</varname>
6304
            und dem vom Benutzer festgelegten Variablennamen zur Verfügung.
6305
          </para>
6306 6302
        </sect3>
6307 6303

  
6308 6304
        <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
......
6373 6369
          <para>Analog stehen die benutzerdefinierten Variablen für
6374 6370
          Ansprechpersonen mit dem Namenspräfix <varname>cp_cvar_</varname>
6375 6371
          zur Verfügung.</para>
6376

  
6377
          <para>Auch für das globale Projekt des Belegs stehen die
6378
          benutzerdefinierten Variablen mit dem Namenspräfix
6379
          <varname>project_cvar_</varname> zur Verfügung.</para>
6380 6372
        </sect3>
6381 6373
      </sect2>
6382 6374

  
......
8253 8245
        Artikel des Lieferanten an, somit ist es möglich diese Artikel auszuwählen und gleich mitzubestellen</para>
8254 8246
      </sect2>
8255 8247
    </sect1>
8256

  
8257
    <sect1 id="features.timerecording">
8258
      <title>Zeiterfassung</title>
8259
      <para>
8260
        Seit der Version 3.5.7 enthält kivitendo ein Modul zur Zeiterfassung.
8261
        Damit ist es möglich, auftrags-, kunden- oder projektbezogen,
8262
        Arbeitszeiten zu erfassen. Die erfassten Zeiten können über einen
8263
        Hintergrund-Job in Lieferscheine umgewandelt werden.
8264
      </para>
8265
      <sect2 id="features.timerecording.config">
8266
        <title>Konfiguration</title>
8267
        <para>
8268
          Die Zeiterfasssung funktioniert auch ohne Konfiguration, sofern der Benutzer
8269
          die entsprechenden Rechte besitzt. Allerdings ist
8270
          es möglich, Artikel für die Zeiterfassung zu konfigurieren, die im Bericht
8271
          ausgewertet und bei der Umwandlung zum Lieferschein verwendet werden
8272
          können.
8273
          Zudem kann auf benutzerebene eingestellt werden, ob Zeiten mit Start- und
8274
          End-Zeit oder mit Datum und Dauer erfasst werden sollen.
8275
        </para>
8276
        <sect3 id="features.timerecording.config.rights">
8277
          <title>Zugriffsrechte</title>
8278
          <para>
8279
            In der Rechteverwaltung im Admin-Bereich können im Zusammenhang mit
8280
            der Zeiterfassung drei verschiedene Rechte vergeben werden:
8281

  
8282
            <itemizedlist>
8283
              <listitem>
8284
                <para><emphasis>Zeiterfassungen erfassen, bearbeiten und ansehen</emphasis></para>
8285
                <para>Diese Recht steuert, ob eine Gruppe den Menüpunkt zur
8286
                Zeiterfassung überhaupt sehen und diese verwenden kann.</para>
8287
              </listitem>
8288

  
8289
              <listitem>
8290
                <para><emphasis>Zeiterfassungseinträge aller Mitarbeiter anzeigen</emphasis></para>
8291
                <para>Ohne dieses Recht darf ein Benutzer einer Benutzergruppe,
8292
                die die Zeiterfassung verwenden darf, nur Zeiteinträge im Bericht
8293
                sehen, bei denen dieser als Mitarbeiter eingetragen ist.</para>
8294
              </listitem>
8295

  
8296
              <listitem>
8297
                <para><emphasis>Zeiterfassungseinträge aller Mitarbeiter bearbeiten</emphasis></para>
8298
                <para>Ohne dieses Recht darf ein Benutzer einer Benutzergruppe,
8299
                die die Zeiterfassung verwenden darf, nur Zeiteinträge anlegen
8300
                und bearbeiten, bei denen dieser als Mitarbeiter eingetragen ist.</para>
8301
              </listitem>
8302
          </itemizedlist>
8303
            
8304
          </para>
8305
        </sect3>
8306
        <sect3 id="features.timerecording.config.part">
8307
          <title>Artikel für Zeiterfassung</title>
8308
          <para>
8309
            Unter <emphasis><guimenu>System</guimenu>
8310
            → <guisubmenu>Artikel für Zeiterfassung</guisubmenu></emphasis>
8311
            können Artikel zur Nutzung mit der Zeiterfassung erfasst werden. Diese Artikel
8312
            müssen eine zeitbasierte Einheit haben.
8313
          </para>
8314
        </sect3>
8315
        <sect3 id="features.timerecording.config.time_or_duration">
8316
          <title>Benutzereinstellungen</title>
8317
          <para>
8318
            Unter <emphasis><guimenu>Programm</guimenu>
8319
            → <guisubmenu>Benutzereinstellungen</guisubmenu></emphasis>
8320
            im Reiter <emphasis>Persönliche Einstellungen</emphasis> bei
8321
            <emphasis>Datum und Dauer für Zeiterfassung verwenden</emphasis>
8322
            kann der Benutzer angeben, ob Zeiten mit Start- und End-Zeit oder mit
8323
            Datum und Dauer erfasst werden sollen.
8324
          </para>
8325
        </sect3>
8326
      </sect2>
8327
      <sect2 id="features.timerecording.add">
8328
        <title>Erfassen</title>
8329
        <para>
8330
          Über den Menüpunkt <emphasis><guimenu>Produktivität</guimenu>
8331
          → <guisubmenu>Zeiterfassung</guisubmenu></emphasis>
8332
          gelangt man zur Erfassungsmaske der Zeiterfassung. Je nach Einstellung
8333
          muss ein Datum oder Datum und Start-Zeit angegeben werden. Ebenso sind
8334
          die Felder <emphasis>Kunde</emphasis> und
8335
          <emphasis>Beschreibung</emphasis>
8336
          Pflichtfelder.
8337
        </para>
8338
        <para>
8339
          Wird ein Auftrag oder ein Projekt, dem ein Kunde zugeordnet ist,
8340
          ausgewählt, so wird das Feld <emphasis>Kunde</emphasis>
8341
          automatisch mit dem zugehörigen Kunden gefüllt und für die
8342
          manuelle Bearbeitung gesperrt.
8343
        </para>
8344
        <para>
8345
          Die End-Zeit bzw. die Dauer ist kein Pflichtfeld, damit
8346
          man einen Eintrag z.B. beim Start der Arbeit anlegen und
8347
          später am Ende dann die End-Zeit bzw. Dauer erfassen kann.
8348
          Bei Eingabe über Start- und End-Zeit dürfen sich die Zeiten für
8349
          ein und denselben Mitarbeiter nicht überlappen.
8350
        </para>
8351
        <para>
8352
          Falls der Bearbeiter das Recht
8353
          <emphasis>Zeiterfassungseinträge aller Mitarbeiter
8354
          bearbeiten</emphasis> besitzt, kann auch der Mitarbeiter für
8355
          diesen Zeiteintrag ausgewählt werden.
8356
        </para>
8357
      </sect2>
8358
      <sect2 id="features.timerecording.report">
8359
        <title>Bericht</title>
8360
        <para>
8361
          Ein Bericht über die erfassten Zeiten lässt sich über
8362
          <emphasis><guimenu>Produktivität</guimenu> → <guisubmenu>Berichte</guisubmenu>
8363
          → <guisubmenu>Zeiterfassung</guisubmenu></emphasis> ausgeben.
8364
          Hier lassen sich die Zeiten auch filtern, sortieren und exportieren.
8365
        </para>           
8366
        <para>
8367
          Ausgewählte Zeiteinträge können über <emphasis><guimenu>Aktionen</guimenu>
8368
          → <guisubmenu>Als gebucht markieren</guisubmenu></emphasis> als schon gebucht
8369
          markiert werden. Dies geschieht normalerweise bei der Konvertierung
8370
          zum Lieferschein und kann hier händisch durchgeführt werden, wenn diese
8371
          Zeitbuchungen bei der Konvertierung nicht mehr berücksichtigt werden sollen.
8372
        </para>
8373
      </sect2>
8374
      <sect2 id="features.timerecording.conversion">
8375
        <title>Konvertierung zu Lieferscheinen</title>
8376
        <para>
8377
          Über den Hintergrund-Job
8378
          <emphasis>ConvertTimeRecordings</emphasis> können
8379
          Zeiteinträge in Lieferscheine umgewandelt werden. Hierbei
8380
          werden alle noch nicht gebuchten Zeiteinträge eines
8381
          bestimmten Zeitraums für bestimmte Kunden gesammelt und
8382
          in Lieferscheine umgewandelt.
8383
          Pro Kunde wird ein Lieferschein generiert und
8384
          pro Artikel wird eine Positionszeile erzeugt. Dabei werden
8385
          Einträge mit gleichen Beschreibungen zusammengefasst. Die
8386
          Details landen im Langtext der Position.
8387
        </para>
8388
        <para>
8389
          Ohne übergebene Parameter im Feld <emphasis>Daten</emphasis> werden alle
8390
          Zeiteinträge des letzten Monats für alle Kunden umgewandelt. Dabei
8391
          werden die Zeiten auf volle Viertelstunden aufgerundet (siehe auch
8392
          <xref linkend="features.timerecording.configuration"/>).
8393
        </para>
8394
        <sect3 id="features.timerecording.configuration" xreflabel="Konfigurations-Optionen der Zeiterfassung">
8395
          <title>Konfigurations-Optionen</title>
8396
          <para>
8397
            Zur generellen Konfiguration von Hintergrund-Jobs und zur Übergabe
8398
            von Parametern als Daten an diese, siehe <xref linkend="config.task-server"/>
8399
            bzw. <xref linkend="Tasks-konfigurieren"/>).
8400
          </para>
8401
          <para>
8402
            Folgende Parameter können als <emphasis>Daten</emphasis> an den
8403
            Hintergrund-Job zur Konvertierung übergeben werden:
8404
            <itemizedlist>
8405
              <listitem>
8406
                <para>
8407
                  <emphasis>from_date</emphasis>
8408
                </para>
8409
                <para>
8410
                  Das Startdatum, von welchen an die Zeiteinträge berücksicht werden.
8411
                  Voreinstellung ist der erste Tag des vorherigen Montats.
8412
                </para>
8413
                <para>
8414
                  Beispiel (das Zeitformat hängt von der persönlichen Einstellungen ab):
8415
                  <programlisting>from_date: 01.12.2020</programlisting>
8416
                </para>
8417
              </listitem>
8418
              <listitem>
8419
                <para>
8420
                  <emphasis>to_date</emphasis>
8421
                </para>
8422
                <para>
8423
                  Das Datum, bis zu welchem die Zeiteinträge zur Konvertierung gesammelt
8424
                  werden. Voreinstellung ist der letzte Tag des vorherigen Montas.
8425
                </para>
8426
                <para>
8427
                  Beispiel (das Zeitformat hängt von der persönlichen Einstellungen ab):
8428
                  <programlisting>to_date: 15.12.2020</programlisting>
8429
                </para>
8430
              </listitem>
8431

  
8432
              <listitem>
8433
                <para>
8434
                  <emphasis>customernumbers</emphasis>
8435
                </para>
8436
                <para>
8437
                  Eine Liste mit Kundennummern, für die Zeiteinträge gesammelt werden
8438
                  sollen. Wird diese Liste nicht angegeben, werden Einträge für
8439
                  alle Kunden berücksichtig.
8440
                </para>
8441
                <para>
8442
                  <programlisting>customernumbers: [c1,22332,334343]</programlisting>
8443
                </para>
8444
              </listitem>
8445
              <listitem>
8446
                <para>
8447
                  <emphasis>override_part_id</emphasis>
8448
                </para>
8449
                <para>
8450
                  Die Datenbank-Id einer zeitbasierten Dienstleistung, die verwendet
8451
                  werden soll, um die Zeiteinträge zu buchen. Dieser Wert überschreibt
8452
                  den Eintrag des Artikels des Zeiteintrags.
8453
                </para>
8454
              </listitem>
8455
              <listitem>
8456
                <para>
8457
                  <emphasis>default_part_id</emphasis>
8458
                </para>
8459
                <para>
8460
                  Die Datenbank-Id einer zeitbasierten Dienstleistung, die verwendet
8461
                  werden soll, um die Zeiteinträge zu buchen, falls im Zeiteintrag
8462
                  kein Artikel gespeichert ist.
8463
                </para>
8464
              </listitem>
8465
              <listitem>
8466
                <para>
8467
                  <emphasis>rounding</emphasis>
8468
                </para>
8469
                <para>
8470
                  Ist dieser Wert <literal>0</literal>, so werden die Zeiten nicht gerundet.
8471
                  Ist der Wert <literal>1</literal> (oder "wahr" in Perl"), so werden die Zeiten auf volle Viertelstunden aufgerundet, also z.B. 0.25h, 0.5h, 0.75h,
8472
                  1.25h ...
8473
                </para>
8474
                <para>
8475
                  Voreinstellung ist <literal>1</literal> ("wahr").
8476
                </para>
8477
              </listitem>
8478
              <listitem>
8479
                <para>
8480
                  <emphasis>link_order</emphasis>
8481
                </para>
8482
                <para>
8483
                  Ist der Wert <literal>1</literal> (oder "wahr" in Perl"), so verknüpft
8484
                  der Hintergrund-Job den erzeugten Lieferschein mit dem im Zeiteintrag
8485
                  angegebenen Auftrag.
8486
                  Ist kein Auftrag angegeben, wird versucht, einen Auftrag für den
8487
                  angegebenen Kunden und die angegebene Projektnummer zu finden.
8488
                </para>
8489
                <para>
8490
                  Folgende Kriterien werden zum Finden eines Vorgängerauftrags angwendet:
8491
                  <itemizedlist>
8492
                    <listitem><para>
8493
                      Auftrag ist im Zeiteintrag angegeben <emphasis>oder</emphasis>
8494
                    </para></listitem>
8495
                    <listitem><para>
8496
                      Datenbank-Id des Projekts des Auftrags ist gleich
8497
                      der Datenbank-Id des Zeiteintrags <emphasis>oder</emphasis> der in den Daten
8498
                      übergebenen Projekt-Id
8499
                    </para></listitem>
8500
                    <listitem><para>
8501
                      Kunde des Auftrags ist gleich Kunde des Zeiteintrags
8502
                    </para></listitem>
8503
                    <listitem><para>
8504
                      der Auftrag muss mindestens eine zugehörige zeitbasierte Position haben
8505
                    </para></listitem>
8506
                    <listitem><para>
8507
                      das Projekt muss gültig und aktiv sein
8508
                    </para></listitem>
8509
                  </itemizedlist>
8510
                </para>
8511
                <para>
8512
                  Voreinstellung ist aus. Wenn dieser Parameter gesetzt ist, läuft der
8513
                  Hintergrund-Job auf einen Fehler, falls kein geeigneter Vorgängerauftrag
8514
                  gefunden werden kann.
8515
                </para>
8516
                <para>
8517
                  Der Job beachtet nicht, ob der Auftrag schon geliefert oder geschlossen
8518
                  ist.
8519
                  Wenn der Kundenauftrag überliefert wird, muss dies organisatorisch
8520
                  geklärt werden. Der Kundenauftrag kann auch bereits geschlossen sein,
8521
                  d.h. der Betrag ist vollständig fakturiert, aber die Leistungen sind
8522
                  noch nicht vollständig geliefert (einfacher Fall: "Vorauskasse").
8523
                </para>
8524
                <para>
8525
                  siehe auch den Hintergrund-Job
8526
                  <literal>CloseProjectsBelongingToClosedSalesOrder</literal>
8527
                  für eine weitergehende Automatisierung der Abläufe.
8528
                </para>
8529
                </listitem>
8530
                <listitem>
8531
                  <para>
8532
                    <emphasis>override_project_id</emphasis>
8533
                  </para>
8534
                  <para>
8535
                    Verwende diese Datenbank-Id für das Projekt an Stelle des
8536
                    im Zeiteintrag angegebenen Projekts, um den zugehörigen Auftrag
8537
                    zu finden. Dieser Parameter wird nur berücksichtig, wenn
8538
                    <emphasis>link_order</emphasis> wahr ist.
8539
                  </para>
8540
                </listitem>
8541
                <listitem>
8542
                  <para>
8543
                    <emphasis>default_project_id</emphasis>
8544
                  </para>
8545
                  <para>
8546
                    Verwende diese Datenbank-Id für das Projekt, falls
8547
                    im Zeiteintrag kein Projekt angegeben ist, um den
8548
                    zugehörigen Auftrag zu finden.
8549
                    Dieser Parameter wird nur berücksichtig, wenn
8550
                  </para>
8551
                </listitem>
8552
            </itemizedlist>
8553
          </para>
8554
        </sect3>
8555
      </sect2>
8556
    </sect1>
8557
    
8558 8248
  </chapter>
8559 8249

  
8560 8250
  <chapter>

Auch abrufbar als: Unified diff