ECommerce: Unterschied zwischen den Versionen

Aus OrgaMon Wiki
Zur Navigation springen Zur Suche springen
 
(119 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
Die B2B Fähigkeiten des OrgaMon ermöglichen es Dienstleistungen des OrgaMon von aussen zu benutzten. Dazu wird im Moment, die von jedem System beherschte XML-RPC Schnittstelle benutzt. Der benutzte TCP/IP Port ist frei einstellbar.
OrgaMon biete eine vielzahl von Kopplungsmöglichkeiten, die es dem Kunden oder Geschäftspartner ermöglichen auf Informationen und Daten zuzugreifen und Prozesse anzustossen.  


== Funktions Überblick ==
* Lieferanten


Erstmalig werden Funktionen f?ch䦴sabl䵦e aus OrgaMon in einem Zentralen Modul (eCommerce) gesammelt. Das Ziel ist, den ganzen Webshop bzw. alle Webanfragen ausschließlich über eCommerce Modul laufen zu lassen. Dabei werden auch erstmals "r" Connections und "w" Connections eingesetzt, was dem zukünftigen raib-Servern zugute kommt (Clustering). Nun eine Liste aller eCommerce Funktionen:
Lieferanten können ihre Systeme mit OrgaMon koppeln, und beispielsweise die Liste der noch zu liefernden Artikel abrufen


== Internet Ablagen ==
* Kunden


Internetablagen dienen der fortgesetzten Dokumentation der Auftragsergebnisse im InterNet. Der Auftraggeber kann jederzeit Ergebnisportionen einsehen oder in sein EDV-System integrieren. Dabei werden auf dem OrgaMon WebServer virtuelles Host eingerichtet, einer für jeden Auftraggeber.
Kunden können ebenfalls uber diese Schnittstelle Zahlungsverpflichtungen oder alte Belege einsehen.


* Anlegen des Benutzers ~SubDomain~
Die B2B Fähigkeiten des OrgaMon ermöglichen es Dienstleistungen des OrgaMon von aussen zu benutzten. Dazu wird im Moment, die von jedem System beherschte XML-RPC Schnittstelle benutzt. Der benutzte TCP/IP Port ist frei einstellbar.


Der Benutzername sollte der TopLevelDomain Prefix des Auftraggebers sein. Die Auftraggeber sei eine Zahnradfabrik. Deren Domain ist http://www.zf.com. Somit ist unser SubDomain zf. Zukünftiger Datenaustausch erfolgt über die Adresse http://zf.orgamon.de. Erster Schritt ist die Anlage des Benutzers zf. Um die Erklärung allgemein zu halten verwenden wir ab jetzt anstelle von "zf" immer ~SubDomain~.
* Webshop


mit yast den Benutzer ~SubDomain~ anlegen!
Der Webshop nutzt neben der Datenbankverbindung vorzugsweise Funktion aus der XML-RPC-API.
Name ist ~SubDomain~
das Passwort muss über Baustelle->Export generiert werden.
!!leeres Home!! ankreuzen
/srv/www/htdocs/~SubDomain~
/bin/false als Shell, um ein login zu verhindern!
Standard-Benutzergruppe ist "ftp", weitere Gruppen "www"


* Internetablage vor-befüllen
== Funktions Überblick ==


#
Der OrgaMon verwendet einen betriebswirtschaftlichen Kernel. In diesem Teil des Quelltextes (eCommerce) sammelt sich die Verarbeitungslogik für alle wesentlichen Buchungsvorgänge (z.B. Zahlungseingang, Warenzugang, Versandbuchung usw.). Eine ausgewählte Zusammenstellung von Kernel-Funktionen sind via XMLRPC von aussen zugänglich. Somit ist es dem TWebShop möglich grosse Teile der Logik via XMLRPC dem OrgaMon zu überlassen.
# Sicherstellen, dass samba Vollzugriff auf die Ablage
# hat.
chmod 777 /srv/www/htdocs/~SubDomain~


* PHP - Script zur Dateianzeige
* mit <code>query;</code> markierte Funktionen ändern nichts an der Datenbank, die Funktionen laufen "read-only" ab
* mit <code>command;</code> markierte Funktion verändern die Daten der Datenbank, Datensätze werden geändert gelöscht oder eingefügt, Dateien im Dateisystem werden erstellt


<nowiki>
== XMLRPC API (cOrgaMon-Web) ==
<?php
  define(SortOrderFileName,"sort.txt");
  function save($s)
  { $fp = fopen(SortOrderFileName,"w");
    fputs($fp,$s);
    fclose($fp);
  }
  function load()
  { $fp = fopen(SortOrderFileName,"r");
    $s = trim(fgets($fp,10));
    fclose($fp);
    return $s;
  }
  // Beim allerersten Skriptaufruf
  if (!file_exists(SortOrderFileName) AND !isset($sortorder))
  { $sortorder = "name";  // Standard-Einstellung
    save($sortorder);
  }
  // Beim jeweils ersten Skriptaufruf
  if (file_exists(SortOrderFileName) AND !isset($sortorder)) { $sortorder = load(); }
  // Beim erneuten Skriptaufruf
  if (file_exists(SortOrderFileName) AND isset($sortorder)) { save($sortorder); }
  ?>
  <html>
  <HEAD>
  <Title>Dateiablage</title>
  <META HTTP-EQUIV="Pragma" content="no-cache">
  <META HTTP-EQUIV="Cache-Control" content="no-cache, must-revalidate">
  <META HTTP-EQUIV="Expires" content="0">
  <STYLE TYPE="text/css">
  <!--
  P.breakhere { page-break-before: always; }
  table.border { border-color:#000000; border-style:solid; }
  td { padding-left:5px; padding-right:5px; border-color:#000000; border-style:solid; border-bottom-style:solid; border-width:0px; border-bottom-width:0px; font-family:Verdana; font-size:13px; }
  a:link    { font-family:Verdana,Arial; font-size:13px;  color:#cc0000; text-decoration:none; }
  a:visited { font-family:Verdana,Arial; font-size:13px;  color:#999999; text-decoration:none; }
  a:active  { font-family:Verdana,Arial; font-size:13px;  color:#cc0000; text-decoration:none; }
  a:hover  { font-family:Verdana,Arial; font-size:13px;  color:#cc0000; text-decoration:none; background-color:#C8D8E0; }
  a:link.head    { font-family:Verdana,Arial; font-size:13px;  color:#000040; text-decoration:underline; }
  a:visited.head { font-family:Verdana,Arial; font-size:13px;  color:#000040; text-decoration:underline; }
  a:active.head  { font-family:Verdana,Arial; font-size:13px;  color:#000040; text-decoration:underline; }
  a:hover.head  { font-family:Verdana,Arial; font-size:13px;  color:#000040; text-decoration:underline; }
  -->
  </STYLE>
  </HEAD>
  <body bgcolor="#ffffff">
  <center>
  <table class=border cellpadding=0 cellspacing=2 border=1 width=500>
  <tr><td colspan=2><b>zip Dateiablage</b><br><br></td></tr>
  <tr>
    <td width=70% bgcolor="#C8D8E0"><font face="Verdana" size=-1><a class="head" href="./<?php echo basename($PHP_SELF); ?>?sortorder=name"><b>
  <?php
  echo "Dateiname</b></a>";
  if ($sortorder=="name")
  {
    echo " v";
  }
  ?>
  </td>
    <td width=30% bgcolor="#C8D8E0"><font face="Verdana" size=-1><a class="head" href="./<?php echo basename($PHP_SELF); ?>?sortorder=date"><b>
  <?php
  echo "Ablagedatum</b></a>";
  if ($sortorder=="date")
  {
    echo " v";
  }
  ?>
  </td>
  </tr>
  <!-- BEGIN BAUSTELLE -->
  <?php
 
  $filename = array();
  $filedate = array();
  $n = 0;
  if ($handle = opendir('.'))
  { while (false !== ($file = readdir($handle)))
    { if (strpos($file,".zip")>1)
      { $filename[$n] = $file;
        $filedate[$n] = filemtime($file);
            $n++;
      }
    } closedir($handle);
  }
  // $sortorder = "name";
  switch($sortorder)
  { case("name") : array_multisort($filename, SORT_ASC, $filedate, SORT_DESC);
                  break;
    case("date") : array_multisort($filedate, SORT_DESC, $filename, SORT_ASC);
                  break;
  }


  for ($i = 0; $i < $n; $i++)
=== BasePlug ===
  { $fn = $filename[$i];
<syntaxhighlight lang="Delphi">
    $fd = $filedate[$i];
    BasePlug():array of string; query;
    echo "<tr>";
    // BasePlug enthält wichtige Umgebungsinformationen für den konnektierten
    // WebShop. So erfährt der WebShop z.B. über BasePlug auf welche Datenbank
    // Datei-Name
    // er konnektieren soll. Oder wo Musik-Downloads zu finden sind. BasePlug
    if (strpos($fn,".html")>1) {
    // verhindert redundante Parametrierung von Shop und OrgaMon. In der Regel
      echo "<td bgcolor=#FFFFCC><font face=\"Verdana\" size=-1>";
    // liefert BasePlug alle Infos an den Shop die er braucht.
      echo "<a href=$fn>";
    //
      echo $fn;
    // Bedeutung der einzelnen Zeilen:
      echo "</a></td>";
    //
    }
    // [00] Datenbank-Verbindungsstring
    else {
    // [01] Anwendungsname mit Versionsnummer
      echo "<td bgcolor=#E8F4F8><font face=\"Verdana\" size=-1>";
    // [02] Datenbank-Layer mit Versionsnummer
      echo "<a href=$fn>";
    // [03] Indy Versions-Nummer
      echo $fn;
    // [04] PDF Pfad (public) (Parameter [[Systemeinstellungen#PDFPathShop]])
      echo "</a></td>";
    // [05] Musik Pfad (Parameter [[Systemeinstellungen#MusicPath]])
    }
    // [06] Pfad zu den Rechnungen (Parameter [[Systemeinstellungen#htmlPath]])
 
    // [07] Pfad der Artikel-Bilder (Icons und Logos auf externer Site) (Parameter [[Systemeinstellungen#BilderURL]])
    // Datei-Datum
    // [08] GUI: TPicUpload Versions-Nummer (Bilder hochladen)
     echo "<td bgcolor=#E8F4F8><font face=\"Verdana\" size=-1>";
    //     CONSOLE: Anzahl der bisher verarbeiteten Anfragen dieser Serverinstanz
    echo date ("d.m.Y", $fd);
    // [09] Tabellenkalkulation mit Versionsnummer (.xls Dokument-Ausgabe)
    echo "&nbsp;&nbsp;";
    // [10] jcl mit Versionsnummer
    echo date ("H:i:s", $fd);
    // [11] jvcl mit Versionsnummer
    echo "</td>";
    // [12] Artikel-Bilder-Pfad (Parameter [[Systemeinstellungen#ShopArtikelBilderURL]])
    // [13] zip mit Versionsnummer
    echo "</tr>";
    // [14] unzip mit Versionsnummer
  }
    // [15] XMLRPC Versionsnummer "@" Hostname der Serverinstanz ":" XMLRPC-Port der Serverinstanz
 
    // [16] memcached Versionsnummer "@" [[Systemeinstellungen#memcachedHost]]
  ?>
    // [17] Datenbank-Benutzer
    // [18] Datenbank-Passwort (verschlüsselt über privaten Key)
  <!-- END BAUSTELLE -->
    // [19] wie [18]
  <!-- INSERT BAUSTELLE -->
    // [20] Datenbank-Client mit Versionsnummer
  </table>
    // [21] PNG - Image Versionsnummer
  </center>
    // [22] Datenbankhost
  </body>
    // [23] Datenbankname
  </html>
    // [24] CONSOLE:Uptime der Serverinstanz "@" Uptime des Servers
</nowiki>
    //     GUI:N/A  
 
    // [25] exif mit Versionsnummer
 
    // [26] eindeutiger Kontext der Serverinstanz
chmod 666 /srv/www/htdocs/~SubDomain~/sort.txt
    // [27] Betriebssystem der Serverinstanz
 
</syntaxhighlight>
 
 
* Virtueller Host auf die Ablage leiten
 
  #
# Datei /etc/apache2/vhosts.d/~SubDomain~.orgamon.de.conf
#
<b>Virtuelle Hosts unter Suse 9.2 Apache 2</b><br>
<br>
<br>
<VirtualHost *>
  ServerName ~SubDomain~.orgamon.de
  DocumentRoot /srv/www/htdocs/~SubDomain~
</VirtualHost>
<Directory /srv/www/htdocs/~SubDomain~>
  AuthType Basic
  AuthName "Mandant Ablage"
  AuthUserFile /srv/www/htdocs/~SubDomain~/.htpasswd
  Require user ~SubDomain~
</Directory>


<b>Verzeichnisschutz mit htpassed</b>
=== ArtikelSuche ===
<source lang="delphi">
    ArtikelSuche(SuchStr: string; [SORTIMENT_R : integer]): array of integer; { ARTIKEL_R } query;
    // Suchmaschine für artikelsuche
    // Optional ist die Suche eingeschränkt auf ein spezielles Sortiment
</source>
<br>
<br>
leider fehlte auf meinem Suse 9.2 der Befehl htpasswd. (Ich hab in mir von einem anderen Server gezogen, was ich dazu alles tun musste das Ding zum Laufen zu bringen: Ich rede nicht gerne davon!). Also ist die erste Hürde, das Ding zu installieren, danach ist es einfach


# Wechsle in das html Verzeichnis, das Du schützen willst
=== ArtikelPreis ===
# Wird ~DasPasswort~ weggelassen wird über die KOmmandozeile
<source lang="delphi">
# 2 fach nachgefragt.
     ArtikelPreis(AUSGABEART_R, ARTIKEL_R:integer): double; query;
htpasswd -c .htpasswd ~SubDomain~ [~DasPasswort~]
 
== XML RPC ==
 
     abu.ArtikelSuche(SuchStr: string): array of integer; { ARTIKEL_R }
    // Suchmaschine f?ikelsuche
    abu.ArtikelPreis(AUSGABEART_R, ARTIKEL_R:integer): double;
     // liefert den Preis des Artikels in dieser Ausgabeart
     // liefert den Preis des Artikels in dieser Ausgabeart
     // kostenlos = 0; //  
     // kostenlos = 0; //  
     // cPreis_vergriffen = -1.0; // Artikel nicht mehr lieferbar.
     // cPreis_vergriffen = -1.0; // Artikel nicht mehr lieferbar.
     // cPreis_aufAnfrage = -2.0; // keine Preisinformation verf?
     // cPreis_aufAnfrage = -2.0; // keine Preisinformation verfügbar
   
   
     abu.Land(LAND_R: integer): string;
</source>
     // liefert die Landesbezeichnung (als ISO-K?
<br>
 
     abu.KontoInfo(PERSON_R: integer): double;
=== Land ===
<source lang="delphi">
     Land(LAND_R: integer): string; query;
     // liefert die Landesbezeichnung (als ISO-Kürzel)
</source>
 
=== KontoInfo ===
<source lang="delphi">
     KontoInfo(PERSON_R: integer): double; command;
     // liefert den Kontostand des Kunden (zu zahlen!)
     // liefert den Kontostand des Kunden (zu zahlen!)
     // erzeugt als Nebeneffekt die aktuelle "Mahnung.html"
     // erzeugt als Nebeneffekt die aktuelle "Mahnung.html"
</source>
     abu.BestellInfo(PERSON_R: integer): integer;
<br>
     // liefert den Lieferr?nd des Lieferanten (Erwartete Mengen!)
 
=== BestellInfo ===
<source lang="delphi">
     BestellInfo(PERSON_R: integer): integer; command;
     // liefert den Lieferrückstand des Lieferanten (Erwartete Mengen!)
     // erzeugt als Nebeneffekt die aktuelle "Bestellung.html"
     // erzeugt als Nebeneffekt die aktuelle "Bestellung.html"
</source>
     abu.Bestellen(PERSON_R: integer): integer;
<br>
     // erstellt aus dem Einkaufswagen des Kunden eine tats䣨liche
 
     // Bestellung. Die (neue) Beleg-Nummer wird zur?eben.
=== Bestellen ===
<source lang="delphi">
    Bestellen(PERSON_R: integer): integer; command;
    // erstellt aus dem Einkaufswagen des Kunden eine tatsächliche
     // Bestellung. Die (neue) Beleg-Nummer wird zurückgegeben.
    //
</source>
<br>
 
=== Vormerken ===
<source lang="delphi">
    Vormerken(PERSON_R: integer): integer; command;
     // erstellt aus dem Einkaufswagen des Kunden eine tatsächliche
     // Bestellung. Die (neue) Beleg-Nummer wird zurückgegeben.
    //
    // Im Ergebnis wie "Bestellen", jedoch wird die Verarbeitung
    // im Hintergrund durchgeführt.
</source>
<br>
 
=== Buchen ===
<source lang="delphi">
    Buchen(BELEG_R, PERSON_R : integer): integer; command;
    //
    // a) BELEG_R>0
    //
    // führt bei einem bereits existierende Beleg (BELEG_R) dazu, dass alles direkt lieferbare
    // sofort verbucht wird und in den Status "geliefert" gesetzt wird. Es wird ein
    // Rechnungsbeleg erstellt, und die Ware wird ausgeliefert betrachtet.
    //
    // BELEG_R = 0 führt zur Vertragsanwendung bei diesem Kunden
    //
    // Rückgabewert:
    //
    // -1 : Es ist ein Fehler aufgetreten! Mehr Info dazu in der EREIGNIS Tabelle
    //  0 : Eine direkte Auslieferung ist nicht nötig oder möglich! Mehr Info dazu in der EREIGNIS Tabelle
    //  1 : Es wurde erfolgreich eine Auslieferung durchgeführt! In der Regel keine Infos in der EREIGNIS Tabelle
     //
     //
    // b) (BELEG_R<1) und (PERSON_R>0)
     abu.ArtikelVersendetag(AUSGABEART_R, ARTIKEL_R:integer): integer;
    //
     // der aktuelle Arbeitszeitbeleg der angegeben Person wird erstellt.
    //
</source>
<br>
 
=== ArtikelVersendetag ===
<source lang="delphi">
    ArtikelVersendetag(AUSGABEART_R, ARTIKEL_R:integer): integer; query;
     //
     //
     // GELBE STATI
     // (NULL,0)
     //  0=keine Info ?erf?eit vorhanden
    //  NULL=wie 0
     //  0=keine Info über die Verfügbarkeit vorhanden
     //
     //
     // ROTE STATI:
     // (1..9)
     //  1=entg?vergriffen
     //  1=entgültig vergriffen
     //  2=zur Zeit vergriffen, Neuauflage jedoch ungewiss
     //  2=zur Zeit vergriffen, Neuauflage jedoch ungewiss
     //  3=zur Zeit vergriffen, Neuauflage jedoch sicher
     //  3=zur Zeit vergriffen, Neuauflage jedoch sicher
    //  4=Zustellung sofort per eMail
    //  5=kann sofort heruntergeladen werden
    //  6= -- bisher ohne Bedeutung --
    //  7= -- bisher ohne Bedeutung --
    //  8= -- bisher ohne Bedeutung --
    //  9= -- bisher ohne Bedeutung --
     //
     //
     //
     // GRÜNE STATI: (10..100)
    // GRÜŽE STATI:
     //  10=heute lieferbar  (=ist unbegrenzt am Lager, ohne Mengenangabe)
     //  10=heute lieferbar  (=ist am Lager, ohne Mengenangabe)
     //  11=morgen lieferbar (=wurde z.B. mit dieser Zusage bereits bestellt und kommt morgen)
     //  11=morgen lieferbar (=wurde z.B. mit dieser Zusage bereits bestellt und kommt morgen)
     //  12=in 2 Tagen lieferbar... (=ist z.B. in dieser Zeit zu beschaffen)
     //  12=in 2 Tagen lieferbar... (=ist z.B. in dieser Zeit zu beschaffen)
Zeile 251: Zeile 180:
     //  14= ... usw ...
     //  14= ... usw ...
     //
     //
     // GRÜŽE STATI:
     // GRÜNE STATI: (101..20000100)
     //  101= heute lieferbar  (=ist am Lager, Lagermenge=1)
     //  101= heute lieferbar  (=ist am Lager, Lagermenge=1)
     //  102= heute lieferbar  (=ist am Lager, Lagermenge=2)
     //  102= heute lieferbar  (=ist am Lager, Lagermenge=2)
Zeile 257: Zeile 186:
     //  ... usw.
     //  ... usw.
     //
     //
     //  GRÜŽE STATI:
     //  GRÜNE STATI:
     // >20020101= Konkretes Lieferdatum (z.B. Erscheinungsdatum!)
     // >20020101= Konkretes Lieferdatum (z.B. Erscheinungsdatum!)
     //  20031003= am 03.10.2003 lieferbar (da es z.B. an diesem Tag erscheint)
     //  20031003= am 03.10.2003 lieferbar (da es z.B. an diesem Tag erscheint)
     //            (Vorbestellungen nat? m?ch)
     //            (Vorbestellungen natürlich möglich)
     //
     //
</source>
     abu.Verlag(VERLAG_R:integer): string;
<br>
 
=== Verlag ===
<source lang="delphi">
     Verlag(VERLAG_R:integer): string; query;
     // Names des Verlages zu einem Verlags-RID
     // Names des Verlages zu einem Verlags-RID
     // ACHTUNG: aus geschichtlichen Gr?sind VERLAG_R zumeist als PERSON_R(s)
     // ACHTUNG: aus geschichtlichen Gründen sind VERLAG_R zumeist als PERSON_R(s)
     // zu verstehen!
     // zu verstehen!
</source>
     abu.Versandkosten(PERSON_R:integer): double;
<br>
     // Liefert passend zum "Kunden,Umfang des Einkaufswagen,Versandart des Kunden" die
 
     // passenden Versandkosten. Im Moment als dummy immer 3,33 ?.
=== Versandkosten ===
<source lang="delphi">
     abu.ArtikelInfo(AUSGABEART_R, ARTIKEL_R, LAND_R, VERLAG_R) : double, string;
     Versandkosten(PERSON_R:integer): double; query;
     // Multi-Info-Funktion f?tere Informationen zu Artikel-Daten
     // Liefert passend zum "Kunden/Umfang des Einkaufswagen/Versandart des Kunden/Rabattstatus" die
     // passenden Versandkosten.  
</source>
 
=== ArtikelInfo ===
<source lang="delphi">
     ArtikelInfo(AUSGABEART_R, ARTIKEL_R, LAND_R, VERLAG_R) : double, string; query;
     // Multi-Info-Funktion für weitere Informationen zu Artikel-Daten
     // Ergebnisse: Preis, "ISO-Landeskennzeichen" "-" "Verlag"
     // Ergebnisse: Preis, "ISO-Landeskennzeichen" "-" "Verlag"
</source>
    abu.BasePlug():array of string;
<br>
    // liefert diverse Informations-String:
 
    // 1) Datenbankname
=== ArtikelRabattPreis ===
    // 2) OrgaMon Versions-Nummer
<source lang="delphi">
    // 3) IBO Versions-Nummer
     ArtikelRabattPreis(AUSGABEART_R,ARTIKEL_R,PERSON_R) : array of double; query;
    // 4) Indy Versions-Nummer
    // 5) PDF Pfad (public)
    // 6) Musik Pfad
    // 7) HTML-Pfad (Rechnungen)
    // 8) Bild-URL
    // 9) Datenbank SYSDBA passwort
    // * Mit Hilfe des Verbindungsstrings sollte auf die entsprechende Datenbank
    //  konnektiert werden.
    // * In der Datenbank sollten nun alle weiteren Parameter, den Shop betreffend
    //  eingegeben sein!
    // f? Shop wichtige Parameter:
    //
    // MusicPath=\\Linus\user\abu\Delphi\abu\Musik\
    // PDFPath=\\Linus\user\hebu\HeBu PDF\A4PDF\
    // XMLRPCHost=BRUTUS
    // XMLRPCPort=3049
     //
    abu.ArtikelRabattPreis(AUSGABEART_R,ARTIKEL_R,PERSON_R) : array of double;
     //
     //
     // wie Artikel-Preis, soll jedoch bei Kunden mit Rabatt-Code verwendet werden,
     // wie Artikel-Preis, soll jedoch bei Kunden mit Rabatt-Code verwendet werden,
     // diese Funktion liefert noch die Rabatt-Zahl dazu!
     // diese Funktion liefert noch die Rabatt-Zahl dazu!
     //
     //
</source>
     abu.PersonNeu : integer; { PERSON_R }
<br>
 
=== PersonNeu ===
<source lang="delphi">
     PersonNeu : integer; { PERSON_R } command;
     //
     //
     // Eine neue Person wird angelegt. Der (neue) RID wird als Ergebnis ge-
     // Eine neue Person wird angelegt. Der (neue) RID wird als Ergebnis ge-
     // liefert. Der Webshop kann nun weitere Eintragungen machen.
     // liefert. Der Webshop kann nun weitere Eintragungen machen.
     //
     //
</source>
     abu.Ort(PERSON_R) : string; { Adress-Ortsangabe }
<br>
 
=== Ort ===
<source lang="delphi">
     Ort(PERSON_R) : [array of] string; { Adress-Ortsangabe } query;
     //
     //
     // Zu der angegebenen Person wird die Orts-Angabe zusammengestellt.
     // Zu der angegebenen Person wird die Orts-Angabe zusammengestellt.
     // Dazu wird Land, Plz, Ortsname und Ortsteil landesspeziefisch
     // Dazu wird Land, Plz, Ortsname und Ortsteil landesspeziefisch
     // kombiniert.
     // kombiniert.
    // In der Regel wird ein einzelner String zurückgegeben, es kann
     abu.Rabatt(PERSON_R) : boolean;
    // aber auch ein mehrzeiliger Text zurückgegeben werden, wenn
    // in der Datenbank eine Mehrzeiligkeit der Ortsangabe gesetzt wurde
    // Im "Orts-Formatierungsstring" siehe [[Land]]
</source>
<br>
 
=== Rabatt ===
<source lang="delphi">
     Rabatt(PERSON_R) : boolean; query;
     // Zu der angegebenen Person wird ermittelt, ob sie Rabatte bekommt.
     // Zu der angegebenen Person wird ermittelt, ob sie Rabatte bekommt.
     // Wenn ja wird true, andernfalls false zur?eben.
     // Wenn ja wird true, andernfalls false zurückzugeben.
</source>
     abu.Preis(AUSGABEART_R,ARTIKEL_R,PERSON_R) : array of double;
<br>
 
=== Preis ===
<source lang="delphi">
     Preis(AUSGABEART_R,ARTIKEL_R,PERSON_R) : array of double; query;
     //
     //
     // Ersetzt in Zukunft die beiden Methoden abu.ArtikelPreis und abu.ArtikelRabattPreis
     // Ersetzt in Zukunft die beiden Methoden abu.ArtikelPreis und abu.ArtikelRabattPreis
     // Falls der Kunde Rabatte bekommt, was beim Login mit abu.Rabatt gepr?rd,
     // Falls der Kunde Rabatte bekommt, was beim Login mit abu.Rabatt geprüft wird,
     // wird der Funktion der wirkliche PERSON_R ?ben, andernfalls 0.
     // wird der Funktion der wirkliche PERSON_R übergeben, andernfalls 0.
     // R?ewerte sind der Preis und der Rabatt (in Prozent, 0 bei PERSON_R == 0).
     // Rückgabewerte sind der Preis und der Rabatt (in Prozent, 0 bei PERSON_R == 0).
     //  
     //  
     //  result[0] Preis in Euro
     //  result[0] Preis in Euro
Zeile 333: Zeile 274:
     //  result[3] Netto-wie-Brutto-Flag: ("1"= JA | "0" = NEIN)
     //  result[3] Netto-wie-Brutto-Flag: ("1"= JA | "0" = NEIN)
     //
     //
   
</source>
     abu.Miniscore(PERSON_R,ARTIKEL_R);
<br>
 
=== Miniscore ===
<source lang="delphi">
     Miniscore(PERSON_R,ARTIKEL_R) : boolean; command;
     //  
     //  
     // Beantragt das Versenden von Miniscores des Artikels ARTIKEL_R  
     // Beantragt das Versenden von Miniscores des Artikels ARTIKEL_R  
     // an den Benutzer PERSON_R  
     // an den Benutzer PERSON_R.
    // Zum Versenden wird die eMail-Vorlage "PDF" benutzt.
    //
</source>
<br>
 
=== LoginInfo ===
<source lang="delphi">
    LoginInfo(PERSON_R : integer) : boolean; command;
    //
    // Beantragt das Versenden einer eMail mit den   
    // Zugangsdaten für den Login für diese Person.
    // ggf. wird das PAsswort neu gesetzt.
    // Zum Versenden wird die eMail-Vorlage "LOGIN" Benutzt.
    //
</source>
<br>
 
=== Senden ===
<source lang="delphi">
    Senden(GeraeteNo: String) : boolean; command;
    //
    // Importiert Neuerungen der OrgaMon-App und stellt das
    // neue Auftragsvolumen bereit.
    //
</source>
 
=== NextVal ===
<source lang="delphi">
    NextVal(Generator: string) : integer; command;
     //
     //
    // Datenbank-Funktion: Führt GEN_ID auf den angegebenen Generator (mit dem Inkrement 1) und liefert das Ergebnis als Integer zurück
    //
</source>
== XMLRPC API (cOrgaMon-App) ==
=== BasePlug ===
<source lang="pascal">
    function BasePlug: array of string; { Infos } query;
    //
    // liefert diverse Informations-String:
    //
    // 1) Arbeitsverzeichnis          J:\OrgaMon\Handy-Server\dat\
    // 2) Programmversion              OrgaMon Rev. 8.665
    // 3) Version einer Komponente    XMLRPC Rev. 1.021
    // 4) Version einer Komponente    ANFiX Rev. 1.069
    // 5) Host                        RAIB42
    // 6) Server Timestamp            13.09.21 12:46:02
    // 7) Aktuelle TAN.Aufrufe Bisher  78321.229
    // 8) Log-Kontext                  Q82GKNEDP
    // 9) Betriebssystem              wine-6.0
</source>
=== StartTAN ===
<source lang="delphi">
    function StartTAN(GerateID:string) : integer; { TAN } command;
    //
    // erwartet eine 3 stellige Geräte Identifiktationsnummer wie z.B. 422
    // Die Funktion holt die passenden Gerätedaten von einem FTP Server
    // Ist das Gerät bekannt, so wird eine neue TAN Nummer gezogen, es wird
    // ein entsprechendes Verzeichnis geöffnet, und Upload Daten können
    // gezogen werden.
    // Format: GERAET,TAN,VERSION,OPTIONEN,UHR,MOMENT,IMEI,SALT
    //
    // GERAET    : z.B. 003
    // TAN        vormalige TAN
    // VERSION    OrgaMon-App Programmversion, z.B. 2.045
    // OPTIONEN  OrgaMon-App Programm-Optionen
    // UHR        Handy Datum - Uhr
    // MOMENT    aktueller Anfrage-Moment
    // IMEI      Handy Identifikation
    // SALT      Identifikations Salt
</source>
=== ProceedTAN ===
<source lang="delphi">
    procedure ProceedTAN (TAN:string); { 0=OK,Ansonsten Fehlercodes } command;
    //
    // verarbeitet alle Eingangsdaten und stellt die Ergebnisdateien
    // im entsprechenden TAN Verzeichnis zur Verfügung.
</source>

Aktuelle Version vom 22. Februar 2024, 18:32 Uhr

OrgaMon biete eine vielzahl von Kopplungsmöglichkeiten, die es dem Kunden oder Geschäftspartner ermöglichen auf Informationen und Daten zuzugreifen und Prozesse anzustossen.

  • Lieferanten

Lieferanten können ihre Systeme mit OrgaMon koppeln, und beispielsweise die Liste der noch zu liefernden Artikel abrufen

  • Kunden

Kunden können ebenfalls uber diese Schnittstelle Zahlungsverpflichtungen oder alte Belege einsehen.

Die B2B Fähigkeiten des OrgaMon ermöglichen es Dienstleistungen des OrgaMon von aussen zu benutzten. Dazu wird im Moment, die von jedem System beherschte XML-RPC Schnittstelle benutzt. Der benutzte TCP/IP Port ist frei einstellbar.

  • Webshop

Der Webshop nutzt neben der Datenbankverbindung vorzugsweise Funktion aus der XML-RPC-API.

Funktions Überblick

Der OrgaMon verwendet einen betriebswirtschaftlichen Kernel. In diesem Teil des Quelltextes (eCommerce) sammelt sich die Verarbeitungslogik für alle wesentlichen Buchungsvorgänge (z.B. Zahlungseingang, Warenzugang, Versandbuchung usw.). Eine ausgewählte Zusammenstellung von Kernel-Funktionen sind via XMLRPC von aussen zugänglich. Somit ist es dem TWebShop möglich grosse Teile der Logik via XMLRPC dem OrgaMon zu überlassen.

  • mit query; markierte Funktionen ändern nichts an der Datenbank, die Funktionen laufen "read-only" ab
  • mit command; markierte Funktion verändern die Daten der Datenbank, Datensätze werden geändert gelöscht oder eingefügt, Dateien im Dateisystem werden erstellt

XMLRPC API (cOrgaMon-Web)

BasePlug

    BasePlug():array of string; query;
    // BasePlug enthält wichtige Umgebungsinformationen für den konnektierten
    // WebShop. So erfährt der WebShop z.B. über BasePlug auf welche Datenbank
    // er konnektieren soll. Oder wo Musik-Downloads zu finden sind. BasePlug
    // verhindert redundante Parametrierung von Shop und OrgaMon. In der Regel
    // liefert BasePlug alle Infos an den Shop die er braucht.
    // 
    // Bedeutung der einzelnen Zeilen:
    //
    // [00] Datenbank-Verbindungsstring
    // [01] Anwendungsname mit Versionsnummer
    // [02] Datenbank-Layer mit Versionsnummer
    // [03] Indy Versions-Nummer
    // [04] PDF Pfad (public) (Parameter [[Systemeinstellungen#PDFPathShop]])
    // [05] Musik Pfad (Parameter [[Systemeinstellungen#MusicPath]])
    // [06] Pfad zu den Rechnungen (Parameter [[Systemeinstellungen#htmlPath]])
    // [07] Pfad der Artikel-Bilder (Icons und Logos auf externer Site) (Parameter [[Systemeinstellungen#BilderURL]])
    // [08] GUI: TPicUpload Versions-Nummer (Bilder hochladen)
    //      CONSOLE: Anzahl der bisher verarbeiteten Anfragen dieser Serverinstanz
    // [09] Tabellenkalkulation mit Versionsnummer (.xls Dokument-Ausgabe)
    // [10] jcl mit Versionsnummer
    // [11] jvcl mit Versionsnummer
    // [12] Artikel-Bilder-Pfad (Parameter [[Systemeinstellungen#ShopArtikelBilderURL]])
    // [13] zip mit Versionsnummer
    // [14] unzip mit Versionsnummer
    // [15] XMLRPC Versionsnummer "@" Hostname der Serverinstanz ":" XMLRPC-Port der Serverinstanz
    // [16] memcached Versionsnummer "@" [[Systemeinstellungen#memcachedHost]]
    // [17] Datenbank-Benutzer
    // [18] Datenbank-Passwort (verschlüsselt über privaten Key)
    // [19] wie [18]
    // [20] Datenbank-Client mit Versionsnummer
    // [21] PNG - Image Versionsnummer
    // [22] Datenbankhost
    // [23] Datenbankname
    // [24] CONSOLE:Uptime der Serverinstanz "@" Uptime des Servers
    //      GUI:N/A  
    // [25] exif mit Versionsnummer
    // [26] eindeutiger Kontext der Serverinstanz
    // [27] Betriebssystem der Serverinstanz


ArtikelSuche

    ArtikelSuche(SuchStr: string; [SORTIMENT_R : integer]): array of integer; { ARTIKEL_R } query;
    // Suchmaschine für artikelsuche
    // Optional ist die Suche eingeschränkt auf ein spezielles Sortiment


ArtikelPreis

    ArtikelPreis(AUSGABEART_R, ARTIKEL_R:integer): double; query;
    // liefert den Preis des Artikels in dieser Ausgabeart
    // kostenlos = 0; // 
    // cPreis_vergriffen = -1.0; // Artikel nicht mehr lieferbar.
    // cPreis_aufAnfrage = -2.0; // keine Preisinformation verfügbar


Land

    Land(LAND_R: integer): string; query;
    // liefert die Landesbezeichnung (als ISO-Kürzel)

KontoInfo

    KontoInfo(PERSON_R: integer): double; command;
    // liefert den Kontostand des Kunden (zu zahlen!)
    // erzeugt als Nebeneffekt die aktuelle "Mahnung.html"


BestellInfo

    BestellInfo(PERSON_R: integer): integer; command;
    // liefert den Lieferrückstand des Lieferanten (Erwartete Mengen!)
    // erzeugt als Nebeneffekt die aktuelle "Bestellung.html"


Bestellen

    Bestellen(PERSON_R: integer): integer; command;
    // erstellt aus dem Einkaufswagen des Kunden eine tatsächliche
    // Bestellung. Die (neue) Beleg-Nummer wird zurückgegeben.
    //


Vormerken

    Vormerken(PERSON_R: integer): integer; command;
    // erstellt aus dem Einkaufswagen des Kunden eine tatsächliche
    // Bestellung. Die (neue) Beleg-Nummer wird zurückgegeben.
    // 
    // Im Ergebnis wie "Bestellen", jedoch wird die Verarbeitung
    // im Hintergrund durchgeführt.


Buchen

    Buchen(BELEG_R, PERSON_R : integer): integer; command;
    //
    // a) BELEG_R>0
    //
    // führt bei einem bereits existierende Beleg (BELEG_R) dazu, dass alles direkt lieferbare
    // sofort verbucht wird und in den Status "geliefert" gesetzt wird. Es wird ein
    // Rechnungsbeleg erstellt, und die Ware wird ausgeliefert betrachtet.
    // 
    // BELEG_R = 0 führt zur Vertragsanwendung bei diesem Kunden
    // 
    // Rückgabewert: 
    // 
    // -1 : Es ist ein Fehler aufgetreten! Mehr Info dazu in der EREIGNIS Tabelle
    //  0 : Eine direkte Auslieferung ist nicht nötig oder möglich! Mehr Info dazu in der EREIGNIS Tabelle
    //  1 : Es wurde erfolgreich eine Auslieferung durchgeführt! In der Regel keine Infos in der EREIGNIS Tabelle
    //
    // b) (BELEG_R<1) und (PERSON_R>0)
    // 
    // der aktuelle Arbeitszeitbeleg der angegeben Person wird erstellt.
    //


ArtikelVersendetag

    ArtikelVersendetag(AUSGABEART_R, ARTIKEL_R:integer): integer; query;
    //
    // (NULL,0)
    //  NULL=wie 0
    //  0=keine Info über die Verfügbarkeit vorhanden
    //
    // (1..9)
    //  1=entgültig vergriffen
    //  2=zur Zeit vergriffen, Neuauflage jedoch ungewiss
    //  3=zur Zeit vergriffen, Neuauflage jedoch sicher
    //  4=Zustellung sofort per eMail
    //  5=kann sofort heruntergeladen werden
    //  6= -- bisher ohne Bedeutung --
    //  7= -- bisher ohne Bedeutung --
    //  8= -- bisher ohne Bedeutung --
    //  9= -- bisher ohne Bedeutung --
    //
    // GRÜNE STATI: (10..100)
    //  10=heute lieferbar  (=ist unbegrenzt am Lager, ohne Mengenangabe)
    //  11=morgen lieferbar (=wurde z.B. mit dieser Zusage bereits bestellt und kommt morgen)
    //  12=in 2 Tagen lieferbar... (=ist z.B. in dieser Zeit zu beschaffen)
    //  13=in 3 Tagen lieferbar...
    //  14= ... usw ...
    //
    // GRÜNE STATI: (101..20000100)
    //  101= heute lieferbar  (=ist am Lager, Lagermenge=1)
    //  102= heute lieferbar  (=ist am Lager, Lagermenge=2)
    //  103= heute lieferbar  (=ist am Lager, Lagermenge=3)
    //  ... usw.
    //
    //  GRÜNE STATI:
    // >20020101= Konkretes Lieferdatum (z.B. Erscheinungsdatum!)
    //  20031003= am 03.10.2003 lieferbar (da es z.B. an diesem Tag erscheint)
    //            (Vorbestellungen natürlich möglich)
    //


Verlag

    Verlag(VERLAG_R:integer): string; query;
    // Names des Verlages zu einem Verlags-RID
    // ACHTUNG: aus geschichtlichen Gründen sind VERLAG_R zumeist als PERSON_R(s)
    // zu verstehen!


Versandkosten

    Versandkosten(PERSON_R:integer): double; query;
    // Liefert passend zum "Kunden/Umfang des Einkaufswagen/Versandart des Kunden/Rabattstatus" die
    // passenden Versandkosten.

ArtikelInfo

    ArtikelInfo(AUSGABEART_R, ARTIKEL_R, LAND_R, VERLAG_R) : double, string; query;
    // Multi-Info-Funktion für weitere Informationen zu Artikel-Daten
    // Ergebnisse: Preis, "ISO-Landeskennzeichen" "-" "Verlag"


ArtikelRabattPreis

    ArtikelRabattPreis(AUSGABEART_R,ARTIKEL_R,PERSON_R) : array of double; query;
    //
    // wie Artikel-Preis, soll jedoch bei Kunden mit Rabatt-Code verwendet werden,
    // diese Funktion liefert noch die Rabatt-Zahl dazu!
    //


PersonNeu

    PersonNeu : integer; { PERSON_R } command;
    //
    // Eine neue Person wird angelegt. Der (neue) RID wird als Ergebnis ge-
    // liefert. Der Webshop kann nun weitere Eintragungen machen.
    //


Ort

    Ort(PERSON_R) : [array of] string; { Adress-Ortsangabe } query;
    //
    // Zu der angegebenen Person wird die Orts-Angabe zusammengestellt.
    // Dazu wird Land, Plz, Ortsname und Ortsteil landesspeziefisch
    // kombiniert.
    // In der Regel wird ein einzelner String zurückgegeben, es kann
    // aber auch ein mehrzeiliger Text zurückgegeben werden, wenn
    // in der Datenbank eine Mehrzeiligkeit der Ortsangabe gesetzt wurde
    // Im "Orts-Formatierungsstring" siehe [[Land]]


Rabatt

    Rabatt(PERSON_R) : boolean; query;
    // Zu der angegebenen Person wird ermittelt, ob sie Rabatte bekommt.
    // Wenn ja wird true, andernfalls false zurückzugeben.


Preis

    Preis(AUSGABEART_R,ARTIKEL_R,PERSON_R) : array of double; query;
    //
    // Ersetzt in Zukunft die beiden Methoden abu.ArtikelPreis und abu.ArtikelRabattPreis
    // Falls der Kunde Rabatte bekommt, was beim Login mit abu.Rabatt geprüft wird,
    // wird der Funktion der wirkliche PERSON_R übergeben, andernfalls 0.
    // Rückgabewerte sind der Preis und der Rabatt (in Prozent, 0 bei PERSON_R == 0).
    // 
    //  result[0] Preis in Euro
    //  result[1] Rabatt in %
    //  result[2] Netto-Flag: ("1" = JA | "0" = NEIN)
    //  result[3] Netto-wie-Brutto-Flag: ("1"= JA | "0" = NEIN)
    //


Miniscore

    Miniscore(PERSON_R,ARTIKEL_R) : boolean; command;
    // 
    // Beantragt das Versenden von Miniscores des Artikels ARTIKEL_R 
    // an den Benutzer PERSON_R. 
    // Zum Versenden wird die eMail-Vorlage "PDF" benutzt.
    //


LoginInfo

    LoginInfo(PERSON_R : integer) : boolean; command;
    // 
    // Beantragt das Versenden einer eMail mit den     
    // Zugangsdaten für den Login für diese Person.
    // ggf. wird das PAsswort neu gesetzt.
    // Zum Versenden wird die eMail-Vorlage "LOGIN" Benutzt.
    //


Senden

    Senden(GeraeteNo: String) : boolean; command;
    //
    // Importiert Neuerungen der OrgaMon-App und stellt das
    // neue Auftragsvolumen bereit.
    //

NextVal

    NextVal(Generator: string) : integer; command;
    //
    // Datenbank-Funktion: Führt GEN_ID auf den angegebenen Generator (mit dem Inkrement 1) und liefert das Ergebnis als Integer zurück
    //

XMLRPC API (cOrgaMon-App)

BasePlug

    function BasePlug: array of string; { Infos } query;
    // 
    // liefert diverse Informations-String:
    //
    // 1) Arbeitsverzeichnis           J:\OrgaMon\Handy-Server\dat\
    // 2) Programmversion              OrgaMon Rev. 8.665
    // 3) Version einer Komponente     XMLRPC Rev. 1.021
    // 4) Version einer Komponente     ANFiX Rev. 1.069
    // 5) Host                         RAIB42
    // 6) Server Timestamp             13.09.21 12:46:02
    // 7) Aktuelle TAN.Aufrufe Bisher  78321.229
    // 8) Log-Kontext                  Q82GKNEDP
    // 9) Betriebssystem               wine-6.0

StartTAN

    function StartTAN(GerateID:string) : integer; { TAN } command;
    // 
    // erwartet eine 3 stellige Geräte Identifiktationsnummer wie z.B. 422
    // Die Funktion holt die passenden Gerätedaten von einem FTP Server
    // Ist das Gerät bekannt, so wird eine neue TAN Nummer gezogen, es wird
    // ein entsprechendes Verzeichnis geöffnet, und Upload Daten können 
    // gezogen werden.
    // Format: GERAET,TAN,VERSION,OPTIONEN,UHR,MOMENT,IMEI,SALT
    //
    // GERAET    : z.B. 003
    // TAN        vormalige TAN
    // VERSION    OrgaMon-App Programmversion, z.B. 2.045
    // OPTIONEN   OrgaMon-App Programm-Optionen
    // UHR        Handy Datum - Uhr
    // MOMENT     aktueller Anfrage-Moment
    // IMEI       Handy Identifikation
    // SALT       Identifikations Salt

ProceedTAN

    procedure ProceedTAN (TAN:string); { 0=OK,Ansonsten Fehlercodes } command;
    // 
    // verarbeitet alle Eingangsdaten und stellt die Ergebnisdateien
    // im entsprechenden TAN Verzeichnis zur Verfügung.
Abgerufen von „https://wiki.orgamon.org/index.php?title=ECommerce&oldid=32707“