CSV-Import-Script: Dokumentation zum Doublettencheck erweitert
[kivitendo-erp.git] / scripts / csv-import-from-shell.sh
1 #!/bin/bash
2
3 # Ein Script, das demonstriert, wie sich CSV-Dateien über die
4 # Kommandozeile importieren lassen. Dabei gibt es zwei Orte, an denen
5 # das Script angepasst werden muss. Diese sind entsprechend mit
6 # Kommentaren versehen.
7 #
8 # Der Aufruf erfolgt mit einem Parameter: dem Dateinamen der
9 # CSV-Datei. Als Ausgabe erscheint bei Erfolg gar nichts (und
10 # Exit-Code 0). Im Fehlerfall werden eine Meldung und der Name einer
11 # temporären Datei ausgegeben, in der der HTML-Code der Fehlermeldung
12 # sichtbar ist. Exit-Code ist dann 2.
13
14 # ---- Logindaten und URL anpassen: ----
15 login=MyLxOfficeUserName
16 password=MySecretPassword
17 url='https://localhost/kivitendo-erp/controller.pl'
18
19 function fail {
20   echo "$@"
21   exit 1
22 }
23
24 test -z "$1" && fail "Kein CSV-Dateiname angegeben."
25 test -f "$1" || fail "Datei '$1' nicht gefunden."
26 file="$1"
27
28 function do_curl {
29   local action="$1"
30
31   # ---- Hier ebenfalls die Parameter anpassen, falls notwendig. ----
32   # Die anpassbaren Parameter und ihre Werte sind:
33
34   # Allgemeine Parameter für alle importierbaren Sachen:
35
36   #   "profile.type": zu importierende Objekte: "parts": Artikel;
37   #   "customers_vendors": Kunden/Lieferanten; "contacts":
38   #   Ansprechpersonen; "addresses": Lieferanschriften
39
40   #   "escape_char": "quote", "singlequote" oder das Escape-Zeichen
41   #   selber
42
43   #   "quote_char": die gleichen Optionen wie "escape_char"
44
45   #   "sep_char": "comma", "semicolon", "space", "tab" oder das
46   #   Trennzeichen selber
47
48   #   "settings.numberformat": "1.000,00", "1000,00", "1,000.00",
49   #   "1000.00"
50
51   #   "settings.charset": Name eines Zeichensatzes. Meist "CP850" oder
52   #   "UTF-8".
53
54   #   "settings.duplicates": Doublettencheck; "no_check", "check_csv",
55   #   "check_db". Falls angestellt wird, werden weitere Einstellungen
56   #   "settings.duplicates_....=1" benötigt, die vom Programm logisch
57   #   mit "und" verknüpft werden. Diese Einstellungen sind für jeden
58   #   Typ weiter unten beschrieben.
59
60   # Parameter für Artikel:
61
62   #   "settings.default_buchungsgruppe": Standard-Buchungsgruppe;
63   #   Datenbank-ID einer Buchungsgruppe
64
65   #   "settings.apply_buchungsgruppe": Buchungsgruppe wo anwenden:
66   #   "never", "all", "missing"
67
68   #   "settings.parts_type": Artikeltyp: "part", "service", "mixed"
69
70   #   "settings.article_number_policy": Artikel mit existierender
71   #   Artikelnummer: "update_prices", "insert_new"
72
73   #   "settings.sellprice_places": Anzahl Nachkommastellen
74   #   Verkaufspreise
75
76   #   "settings.sellprice_adjustment": Wert für Verkaufspreisanpassung
77
78   #   "settings.sellprice_adjustment_type": Art der
79   #   Verkaufspreisanpassung; "percent", "absolute"
80
81   #   "settings.shoparticle_if_missing": Shopartikel setzen falls
82   #   fehlt: "1", "0"
83
84   #   "settings.duplicates_partnumber=1": Doublettencheck nach
85   #   Artikelnummer (nur, wenn "settings.duplicates" auch gesetzt
86   #   ist).
87
88   #   "settings.duplicates_description=1": Doublettencheck nach
89   #   Artikelnummer (nur, wenn "settings.duplicates" auch gesetzt
90   #   ist).
91
92   # Parameter für Kunden/Lieferanten:
93
94   #   "settings.table": Zieltabelle: "customer", "vendor"
95
96   #   "settings.duplicates_name=1": Doublettencheck nach
97   #   Kunden-/Lieferantennamen (nur, wenn "settings.duplicates" auch
98   #   gesetzt ist).
99
100   # Parameter für Ansprechperson:
101
102   #   "settings.duplicates_cp_name=1": Doublettencheck nach Namen der
103   #   Ansprechperson (nur, wenn "settings.duplicates" auch gesetzt
104   #   ist).
105
106   # Parameter für Lieferanschriten:
107   #   Nur die Standard-Parameter von oben
108
109   # Parameter für Projekte:
110
111   #   "settings.duplicates_projectnumber=1": Doublettencheck nach
112   #   Projektnummer (nur, wenn "settings.duplicates" auch gesetzt
113   #   ist).
114
115   curl \
116     --silent --insecure \
117     -F 'action=CsvImport/dispatch' \
118     -F "${action}=1" \
119     -F 'escape_char=quote' \
120     -F 'profile.type=parts' \
121     -F 'quote_char=quote' \
122     -F 'sep_char=semicolon' \
123     -F 'settings.apply_buchungsgruppe=all' \
124     -F 'settings.article_number_policy=update_prices' \
125     -F 'settings.charset=CP850' \
126     -F 'settings.default_buchungsgruppe=395' \
127     -F 'settings.duplicates=no_check' \
128     -F 'settings.numberformat=1.000,00' \
129     -F 'settings.parts_type=part' \
130     -F 'settings.sellprice_adjustment=0' \
131     -F 'settings.sellprice_adjustment_type=percent' \
132     -F 'settings.sellprice_places=2' \
133     -F 'settings.shoparticle_if_missing=0' \
134     -F "{AUTH}login=${login}" \
135     -F "{AUTH}password=${password}" \
136     -F "file=@${file}" \
137     ${url}
138 }
139
140 tmpf=$(mktemp)
141 do_curl 'action_test'  > $tmpf
142
143 if grep -q -i 'es wurden.*objekte gefunden, von denen.*' $tmpf; then
144   rm $tmpf
145   do_curl 'action_import' > $tmpf
146   if grep -i 'von.*objekten wurden importiert' $tmpf ; then
147     rm $tmpf
148   else
149     echo "Import schlug fehl. Ausgabe befindet sich in ${tmpf}"
150     exit 2
151   fi
152 else
153   echo "Test-Import nicht OK. Ausgabe befindet sich in ${tmpf}"
154   exit 2
155 fi