OpaccERP logo

F-Script

Anwendung / Praxis: F-Script

ST-DOC2MAIL.FX

Die F-Scripts ST-DOC2MAIL.FX, ST-DOC2MAIL.FS und KD-DOC2MAIL.FS erlauben die projektspezifische Implementierung des Versands von Dokumenten per E-Mail. (z.B. BC 51012)
Bei der Ausführung von ST-DOC2MAIL.FX wird folgendes geprüft:
  • Prüfung ob KD-DOC2MAIL.FS vorhanden.
  • Wenn ja, wird das KD-... Script verwendet. Wenn nein, wird das F-Script Kunden-Präfix ausgelesen (BC 98216).
  • Prüfung ob xx-DOC2MAIL.FS vorhanden. (xx = Kunden-Präfix)
  • Wenn ja, wird das xx-... Script verwendet. Wenn nein, werden die ST-... Scripts auf xx-... kopiert und anschliessend die xx-... Scripts verwendet.
  • Ist im BC 98216 kein Kunden-Präfix definiert, werden die ST-... Scripts auf KD-... kopiert und anschliessend die KD-... Scripts verwendet.

ST-DOC2MAIL.FX - Variablen für die Steuerung

Variable Beschreibung Mögliche Werte / Beispiele
«X(Doc2Mail.IsMainDoc)»
Hauptdokument J/N
0/1
«X(Doc2Mail.MainDocLevel)»
Stufe des Hauptdokuments.
1 - 5
«X(Doc2Mail.MainDocShortCut)»
ShortCut des Hauptdokuments.
A - Z
«X(Doc2Mail.SubDocShortCut)»
ShortCut des Subdokuments.
A - Z
«X(Doc2Mail.Document)»
Dateianhang welcher erzeugt wird.
<fileName>.<fileType>
«X(Doc2Mail.Language)»
Sprache gem. Dokument.
D / E / F / I
«X(Doc2Mail.PostProcessing)»
Nachbearbeitung der Dateien.
0/1
0 - Keine Nachbearbeitung (Default)
1 - Die durch die Verarbeitung von Haupt-/Subdokument erstellten PDF-Dateien (Output) werden an das F-Script KD-DOC2MAIL_POSTPROC.FS übergeben.

KD-DOC2MAIL.FS - Subroutinen

Je nach Kontext werden (aus ST-DOC2MAIL.FX heraus) die folgenden Subroutinen in KD-DOC2MAIL.FS mehrmals (pro Hauptdokument und selektierte Subdokumente) gestartet:
Hinweis
Hinweis
Beachten Sie, dass für Einkaufs- und Servicedokumente entsprechende Subroutinen mit anderen Namen Doc2Mail.PurDoc... bzw. Doc2Mail.AsstDoc... existieren. Die Funktionalität ist jeweils gleich wie bei Doc2Mail.SalDoc...
Subroutine Rückgabe (Variablen) Beschreibung Mögliche Werte / Beispiele
/Doc2Mail.InitLibrary
Erlaubt die Aktivierung einer Sprachlibrary.
Default: ST-DOCS.LBx
/Doc2Mail.SalDoc.GlobalSettings
«X(Doc2Mail.Subject)»
Betreff der E-Mail.
«X(Doc2Mail.To)»
Empfängeradresse (to)
E-Mail-Adresse(n) - mehrere Adressen mit Semikolon getrennt.
«X(Doc2Mail.Cc)»
Kopie (cc)
E-Mail-Adresse(n) - mehrere Adressen mit Semikolon getrennt.
«X(Doc2Mail.Bcc)»
Blindkopie (bcc)
E-Mail-Adresse(n) - mehrere Adressen mit Semikolon getrennt.
«X(Doc2Mail.BodyText)»
Textfile welches den Mailtext enthält.
Textfile im Format UTF8. Das Textfile muss sich im Verzeichnis \Insyde\Tmp\ befinden.
Sie können auch eine html-Datei als Body-Text übergeben.
«X(Doc2Mail.PostProcessing)»
Steuert das PostProcessing.
0/1
0 - Kein PostProcessing.
1 - Startet nach dem Erstellen der PDF-Dokumente automatisch das PostProcessing. (Siehe ST-DOC2MAIL_POSTPROC.FX.)
/Doc2Mail.SalDoc.Documents
«X(Doc2Mail.Rename)»
Umbenennen eines Dokuments bzw. der Datei. (Haupt- und Sub-Dokument)
«X(Doc2Mail.Rename=<newFileName>.PDF)»
«X(Doc2Mail.Document)»
Entfernt das Dokument. Dafür muss die Variable leer definiert werden.
«X(Doc2Mail.Document=)»
/Doc2Mail.SalDoc.Attachments
«nXARR(Doc2MailAttachments)»
Zusätzliche Mail-Anhänge.
Erlaubte RemoteFolder sind:
TMP
TX
IP
«nXARR(Doc2MailAttachments +FILE1.PDF)»
«nXARR(Doc2MailAttachments +\IP\FILE2.PDF)»
«nXARR(Doc2MailAttachments +\IP\SUB\FILE3.DOC)»
«nXARR(Doc2MailAttachments +\TX\FILE4.PDF)»
«nXARR(Doc2MailAttachments +IP\TEST\FILE5.PDF)»

ST-DOC2MAIL_POSTPROC.FX

Bei der Ausführung von ST-DOC2MAIL_POSTPROC.FX wird folgendes geprüft:
  • Prüfung ob KD-DOC2MAIL_POSTPROC.FS vorhanden.
  • Wenn ja, wird das KD-... Script verwendet. Wenn nein, wird das F-Script Kunden-Präfix ausgelesen (BC 98216).
  • Prüfung ob xx-DOC2MAIL_POSTPROC.FS vorhanden. (xx = Kunden-Präfix)
  • Wenn ja, wird das xx-... Script verwendet. Wenn nein, werden die ST-... Scripts auf xx-... kopiert und anschliessend die xx-... Scripts verwendet.
  • Ist im BC 98216 kein Kunden-Präfix definiert, werden die ST-... Scripts auf KD-... kopiert und anschliessend die KD-... Scripts verwendet.

KD-DOC2MAIL_POSTPROC.FS - Subroutinen

Über dieses F-Script erfolgt z.B. das Zusammenfassen (Merge) von einzelnen PDF-Dateien oder das nachträgliche Einbetten von Hintergrund-PDF (Logos).
Hinweis
Hinweis
Beachten Sie, dass für Einkaufs- und Servicedokumente entsprechende Subroutinen mit anderen Namen Doc2Mail.PurDoc... bzw. Doc2Mail.AsstDoc... existieren. Die Funktionalität ist jeweils gleich wie bei Doc2Mail.SalDoc...
Subroutine Rückgabe (Variablen) Beschreibung Mögliche Werte / Beispiele
/Doc2Mail.InitLibrary
Erlaubt die Aktivierung einer Sprachlibrary.
Default: ST-DOCS.LBx
/Doc2Mail.SalDoc.ModeDefinition
«X(Doc2Mail.ProcessingMode)»
Definiert den Modus nach welchem PDF-Dateien nachbearbeitet werden.
SINGLE (Default)
Die PDF-Dateien werden einzeln in die Subroutine /Doc2Mail.SalDoc.Documents übergeben.
ALL
Alle erzeugten PDF-Dateien werden als Liste in die Subroutine /Doc2Mail.SalDoc.FinalFunction übergeben.
Hinweis
Hinweis
Der Filename der jeweiligen PDF-Datei kann über die Variable «X(Doc2Mail.Document)» abgefragt werden.
/Doc2Mail.SalDoc.Documents
«X(Doc2Mail.Rename)»
Die Subroutine wird automatisch für jedes Subdokument ein Mal ausgeführt.
Umbenennen eines Dokuments bzw. der Datei. (Haupt- und Sub-Dokument)
«X(Doc2Mail.Rename=<newFileName>.PDF)»
«X(Doc2Mail.Document)»
Filename der PDF-Datei.
Soll das Dokument entfernt werden, muss die Variable leer definiert werden.
«X(Doc2Mail.Document=)»
/Doc2Mail.SalDoc.FinalFunction
Die Subroutine wird automatisch ein Mal ausgeführt.
Ergänzen des Eintrags zur Resultatliste. Erfolgt keine Zuweisung zum «XARR(Doc2MailAttachments)» werden keine PDF-Dateien in das E-Mail übergeben.
«nXARR(Doc2MailAttachments +<Doc2Mail.Document)»