Konfiguration eines Export-Agents

Aus openM2-Wiki
Wechseln zu: Navigation, Suche

Nach Anlage des Agents können folgende Parameter eingegeben werden:

   -user <username> [-pw password] 
   [-domain <domainId, default: 1>]        
   -object {<exportObject OID>|<openM2 path to exportObject>}* 
   [-frequency {ONCE(=default)|MINUTES|DAY|WEEK|MONTH}]
   [-every {<minutes>|<day of month>|MO,TU,WE,TH,FR,SA,SU>] [-TIME <time>]
   [-workdir <working directory, default is .\\>]
   [-tempdir <temporary directory, default is .\\temp>]
   [-errordir <errorfiles directory, default is .\\errorfiles>]
   [-retry <number of retries, default is 10>]
   [-notify <YES|NO(=default)> -notifymailserver <mailserver>
    -notifyreceiver <receiver> -notifysender <sender> -notifysubject <subject>]
   [-connection {ASP(=default)|SERVLET}]
   [-server <name of openM2 server, default is localhost>]
   [-apppath <openM2 application path, default is /openM2/app/>] 
   [-translator {<translator OID>|<name of translator>}]
   [-logging {NONE(=default)|NEW|APPEND}] 
   [-logfilename <name of the log file>] 
   [-logpath <path for the log file, default is the path set in -path>]
   [-wait] [-hierarchical] [-singlefile] [-recursive] [-includecontainer] 
   [-delete] [-deleterecursive] [-resolvekeymapping] [-storeexternalids] 
   [-resolvequery] [-resolvereference] [-usereferenceoid]
   [-connectortype {FILE(=default)|FTP|MAIL|SAP|HTTPMULTIPART}]
   [-ftpserver <ftp server> -ftpuser <username> -ftppassword <password>
    -ftppath <path on ftp server to read the files from>]
   [-mailserver <mail server> -mailprotocol {IMAP|POP3}
    -mailuser <username> -mailpassword <password>
    -mailreceiver <receiveraddress> -mailsender <senderaddress>]        
   [-sapurl <SAP business connector gateway URL> -sapname <name of sap server>]
   [-httpmultiparturl <HTTP multipart connector target URL>]
   [-help] [--help] [-?]

Folgende Parameter müssen beim Aufruf beachtet werden.

Parameter Beschreibung
-user MUSS-Einstellung: openM2-Benutzername, mit dem sich der Agent in openM2 anmeldet
-pw MUSS-Einstellung: Passwort für die Benutzeranmeldung. Wird kein -pw Parameter angegeben, so fragt der Exportagent interaktiv nach einem Passwort.
-domain ID der openM2 Domäne, auf welcher sich der Agent einloggen soll.

Standardmäßig wird hier 1 verwendet, welches die erste Domäne eines openM2 Systems referenziert.
Auf openM2 Systemen mit mehr als einer Domäne muss darauf geachtet werden, dass die korrekte Domain-ID angegeben wird.

-object openM2 Object, welches exportiert werden soll. Dieser Parameter kann auch mehrfach angegeben werden, um mehreren Ablagen oder Objecte exportieren zu können. (Dies wird durch die Angabe von + bei -object+ symbolisiert)

Folgende Werte sind zulässig:
* Die OID eines openM2 Containers
* Ein Pfad zu einem openM2 Container

Pfade müssen der Definition für Pfadangaben in Importscripts entsprechen. D.h. Über „/Gruppe/Data Interchange/Test" wird ein Container im Gruppenbereich referenziert.
Über „/privat/Administrator/Arbeitskorb" wird der Arbeitskorb des Benutzers Administrator im Privatbereich referenziert.
!!!!Bei Objekten mit Leerraum im Namen, muß der Pfad in Anführugszeichen stehen.

-frequency Definiert die Frequenz, mit der ein Agent aktiviert wird. Wird keine Frequenz angegeben, startet der Agent beim Aufruf ( ONCE ).

Zulässige Werte bei der Angabe der Frequenz sind:
* MINUTES
* DAY
* WEEK
* MONTH

Je nach Wert dieses Arguments werden die Argumente -every und -time interpretiert. Zu beachten ist, dass -every und -time nicht bei jeder Frequency-Einstellung vorhanden sein müssen.

  • Bei MINUTES muss -every gesetzt sein, das den Minutenabstand zur Aktivierung des Agent definiert.
  • Bei DAY muss -time gesetzt sein mit dem Zeitpunkt, an welchem der Agent aktiviert werden soll.
  • Bei WEEK muss -time gesetzt sein mit dem Zeitpunkt, an welchem der Agent aktiviert werden soll.
Zusätzlich kann über -every angegeben werden, zu welchen Wochentagen der Agent aktiviert werden soll. Dabei sind die Kürzel MO,TU,WE,TH,FR,SA,SU für die englischen Bezeichnungen der Wochentage zulässig.

Bei Verwendung mehrere Wochentage müssen diese über ein Komma getrennt angegeben werden.

  • Bei MONTH müssen time und -every angegeben werden, wobei -every den Monatstag und -time den Zeitpunkt der Aktivierung angibt
-every Siehe -frequency
-time Siehe -frequency
-workdir Definiert das Arbeitsverzeichnis, mit welchem der Agent operieren soll.

Wird kein Wert gesetzt, wird das Verzeichnis verwendet, in welchem der Agent gestartet wurde.

-tempdir Entspricht dem Verzeichnis, in welchem Dateien abgelegt werden, welche übertragen werden sollen. Wird kein Wert angegeben, so wird ein Verzeichnis „temp" im Arbeitsverzeichnis angelegt.

Wurde die Verwendung von Datei-Konnektoren eingestellt, entspricht das Arbeitsverzeichnis automatisch dem Verzeichnis, in dem die zu exportierenden Daten abgelegt werden. Sollten E-Mail- oder FTP-Konnektoren eingesetzt werden, so wird das temporäre Verzeichnis verwendet, in welchem beim Export die jeweiligen Exportdateien abgelegt werden. Der weitere Transport der Daten kann über Mail- bzw. FTP-Konnektor erfolgen.

-errordir Entspricht dem Verzeichnis, in welchem Dateien abgelegt werden, welche nach einer bestimmten Anzahl an Fehlversuchen nicht übertragen werden konnten. Wird kein Wert angegeben, so wird ein Verzeichnis „errorfiles" im Arbeitsverzeichnis angelegt.
-retry Definiert die Anzahl an Versuchen, die der Exportagent hat, um eine Datei über den eingestellten Konnektor zu übermitteln.
-notify Aktiviert das Versenden einer email Notifikation, wenn eine Datei nach der angegebenen Anzahl an Fehlversuchen nicht übertragen werden konnte.
-notifymailserver Mailserver, welcher für die Notifikation benutzt werden soll.
-notifyreceiver Empfänger Email-Adresse, welcher für die Notifikation benutzt werden soll.
-notifysender Sender Email-Adresse, welcher für die Notifikation benutzt werden soll.
-notifysubject Email-Betreff, welcher für die Notifikation benutzt werden soll.
-connection Definiert, ob das openM2-System über eine ASP- (MS) oder eine SERVLET- (Apache) Schnittstelle verfügt. Standardmäßig wird eine ASP-Schnittstelle angenommen.
-server Definiert die IP-Adresse oder den Hostnamen des gewünschten openM2-Systems. Standardmäßig wird auf den lokalen Webserver über localhost zugegriffen.
-apppath Definiert den openM2-Applikationspfad am openM2-System. Standardmäßig wird „openM2/app/" verwendet (= Standardeinstellung für openM2-Systeme).

Die Web-Adresse (URL) des openM2-Systems setzt sich aus server + apppath zusammen.

-translator Definiert die Verwendung eines Translators, der bereits im System angelegt sein muss.

Translatoren werden auf 2 Arten referenziert:
* über die eindeutige OID des gewünschten Translators
* über den eindeutigen Namen des gewünschten Translators (Ansonsten wird eine Fehlermeldung ausgegeben).

Zu beachten ist, dass Namen für Translatoren nicht eindeutig sein müssen. Kann der Translator über den Namen nicht eindeutig identifiziert werden, so kann der Translator nicht ausgelesen werden. In diesem Fall wird vom openM2 System eine entsprechende Fehlermeldung generiert.

-logging Steuert, ob das openM2-System eine Log-Datei beim Import verwenden soll.

Mögliche Einstellungen sind:
* NONE: Es wird keine Log-Datei erstellt (= Standardeinstellung).
* NEW: Bei jedem Import wird eine neue Log-Datei erstellt.
* APPEND: Die Log-Eintragungen werden an eine bereits bestehende Log-Datei angehängt.

-logfilename Gewünschter Name der Log-Datei.

Wurde Logging mit NEW aktiviert, so wird zum gewünschten Namen der Logdatei solange eine Ziffer hinzugefügt, bis der Name der Log-Datei eindeutig ist.
Ohne Eintragung wird der Standardname für Log-Dateien verwendet.
Wenn die Log-Eintragungen an eine nicht existierende Log-Datei angehängt werden sollen, so wird eine neue Log-Datei erzeugt.

-logpath Gewünschter Pfad, in welchem die Log-Datei angelegt werden soll.

Wurde Logging aktiviert und für diesen Parameter kein Wert angegeben, so wird das Arbeitsverzeichnis des Agents verwendet.

-wait Normalerweise wird der Agent unabhängig von den Zeiteinstellungen direkt nach dem Aufruf das erste Mal aktiviert.

Wird der Parameter -wait gesetzt, wird die erste Aktivierung bis zum ersten berechneten Zeitpunkt unterdrückt. D.h. wurde der Agent auf jeden Tag um 23:00 eingestellt, dann wartet der Agent auf jeden Fall bis 23:00, bis er das erste Mal aktiv wird.

-hierarchical Aktiviert hierarchischen Export. Dabei wird eine einzige Exportdatei erzeugt und alle Objekte inklusive Ablagen mit allen Substrukturen werden exportiert wobei die hierarchischen Beziehungen in der Exportdatei aufrechterhalten werden.

Anmerkung: Die Aktivierung des hierarchischen Exports aktiviert automatisch die Parameter -singlefile, -recursive und -includeContainer

-singlefile Alle exportierten Objekte werden in eine gemeinsame Datei geschrieben.
-recursive Alle Substrukturen von Ablagen werden mitexportiert.
-includeContainer Ablagenobjekte werden mitexportiert.
-resolvekeymapping Es werden die bereits exportierten Objekte berücksichtig. KeyMapping vergibt einen eigenen Schlüssel, damit bereits exportierte Objekte nicht überschrieben werden können.
-storeexternalids Ist eine Spezialfunktion die es erlaubt, die Antwort einer Applikation, an welche eine Exportdatei übermittelt wird, auszuwerden, und die darin gespeicherten externen Schlüssel im System als KeyMapping einzutragen. Mehr dazu im Kapitel „Rückspeichern externer Schlüssel"
-resolvequery Aktiviert das Auflösen einer Query, sofern unter den zu exportierenden Objekten ein Query-Objekt selektiert wurde. In diesem Fall wird nicht das Query-Objekt sondern das Ergebnis dieser Query exportiert.
-resolvereference Aktiviert das Auflösen einer Referenz. In diesem Fall wird nicht das Referenz-Objekt selbst, sondern das referenzierte Objekt exportiert.
-usereferenceoid Spezialfunktion, welche beim Auflösen einer Referenz zwar das Objekt exportiert, allerdings die OID des Referenz-Objektes einträgt. Hat nur Auswirkungen in Zusammenhang mit der Option -resolvereference
-delete Löschen der exportieren Objekte. Nach einem erfolgreichen Export eines Objektes, welches über die -OBJECT Option angegeben wurde, wird dieses gelöscht. War der Export nicht erfolgreich, so wird das Objekt nicht gelöscht.
-deleterecursive Löscht die Subobjekte eines durch die -OBJECT Option definierten Objektes nicht jedoch das Objekt selbst. Jedes dieser Objekte wird nur dann gelöscht, wenn das Objekt erfolgreich exportiert werden konnte.
-connectortype Definiert den zu verwendenden Konnektor-Typ. Standardmäßig wird ein Datei-Konnektor angelegt, welcher Importdateien aus dem Arbeitsverzeichnis des Agents ausliest.

Zulässige Werte sind:
* FILE: für Datei-Konnektoren
* FTP: für FTP-Konnektoren
* MAIL: für E-Mail-Konnektoren
* SAP: für SAP-XMLRFC-Konnektor
* HTTPMULTIPART: für HTTP-Multipart Konnektoren

Bei FTP-Konnektoren müssen mindestens die Parameter -ftpserver und -ftpuser gesetzt werden, für E-Mail-Konnektoren -mailserver und -mailuser.
Beim SAP-Konnektor müssen die Parameter -sapurl und -sapname definiert werden., bei HTTP-Multipart-Konnektor die Option -httpmultiparturl

-ftpserver Definiert die IP-Adresse oder den Namen des FTP-Servers bei Verwendung von FTP-Konnektoren.
-ftpuser Definiert den Benutzernamen für das Anmelden an einen FTP-Server.
-ftppassword Definiert das Passwort des Benutzers zum Anmelden an einem FTP-Server.
-ftppath Pfad am FTP-Server, aus welchem die Import-Dateien gelesen werden sollen.
-mailserver Definiert die IP-Adresse oder den Namen des E-Mail-Servers bei Verwendung von E-Mail-Konnektoren.
-mailsender Definiert WER das E-Mail verschickt.
-mailreceiver Definiert WER das E-Mail empfängt.
-httpmultiparturl Ziel-URL des HTTP-Multipart-Konnektors
-help

--help
-?

Bei Angabe dieses Parameters wird die Hilfe des Agents ausgegeben.
-debug Damit kann das Debugging des Agent eingeschaltet werden. Dies ist keine offizielle Benutzerfunktion sondern dient nur als Hilfsmittel für Entwickler.


Beispiele für die Zeitsteuerung des Agents:

  • In regelmäßigen Minutenabständen: -frequency MINUTES -every 5 -wait
Bedeutung: alle 5 Minuten prüfen, ob ein neuer Import durchgeführt werden soll.
  • Jeden Tag zu einem bestimmten Zeitpunkt: -frequency DAY -time 23:00 -wait
Bedeutung: jeden Tag um 23:00 überprüfen.
  • An einem bestimmte Tag in der Woche: -frequency WEEK -every MO,TU -time 23:00 -wait
Bedeutung: um 23:00 Uhr jeden Montag und Dienstag
  • Bestimmter Tag eines Monats: -frequency MONTH -every 1 -time 23:00 -wait
Bedeutung: jeden 1. Tag des Monats um 23:00
Icon Info.png
Info
Weitere Konfigurationsbeispiele finden Sie im Anhang dieser Dokumentation.