Basis- Programmierschnittstellen (BC-DWB)

Transkript

1 Basis- Programmierschnittstellen (BC-DWB) HELP.BCDWBLIB Release 4.6C

2 SAP AG Copyright Copyright 2001 SAP AG. Alle Rechte vorbehalten. Weitergabe und Vervielfältigung dieser Publikation oder von Teilen daraus sind, zu welchem Zweck und in welcher Form auch immer, ohne die ausdrückliche schriftliche Genehmigung durch SAP AG nicht gestattet. In dieser Publikation enthaltene Informationen können ohne vorherige Ankündigung geändert werden. Die von SAP AG oder deren Vertriebsfirmen angebotenen Software-Produkte können Software- Komponenten auch anderer Software-Hersteller enthalten. Microsoft, WINDOWS, NT, EXCEL, Word, PowerPoint und SQL Server sind eingetragene Marken der Microsoft Corporation. IBM, DB2, OS/2, DB2/6000, Parallel Sysplex, MVS/ESA, RS/6000, AIX, S/390, AS/400, OS/390 und OS/400 sind eingetragene Marken der IBM Corporation. ORACLE ist eine eingetragene Marke der ORACLE Corporation. INFORMIX -OnLine for SAP und Informix Dynamic Server TM sind eingetragene Marken der Informix Software Incorporated. UNIX, X/Open, OSF/1 und Motif sind eingetragene Marken der Open Group. HTML, DHTML, XML, XHTML sind Marken oder eingetragene Marken des W3C, World Wide Web Consortium, Massachusetts Institute of Technology. JAVA ist eine eingetragene Marke der Sun Microsystems, Inc. JAVASCRIPT ist eine eingetragene Marke der Sun Microsystems, Inc., verwendet unter der Lizenz der von Netscape entwickelten und implementierten Technologie. SAP, SAP Logo, R/2, RIVA, R/3, ABAP, SAP ArchiveLink, SAP Business Workflow, WebFlow, SAP EarlyWatch, BAPI, SAPPHIRE, Management Cockpit, mysap.com Logo und mysap.com sind Marken oder eingetragene Marken der SAP AG in Deutschland und vielen anderen Ländern weltweit. Alle anderen Produkte sind Marken oder eingetragene Marken der jeweiligen Firmen. 2 April 2001

3 SAP AG Symbole Symbol Bedeutung Achtung Beispiel Hinweis Empfehlung Syntax April

4 SAP AG Inhalt... 7 BC - Basis-Programmierschnittstellen...8 Änderungen in Release 4.0A...9 Programmierung mit der Hintergrundsteuerung...10 Programmiertechniken...11 Jobs einplanen und verwalten: Einfaches Verfahren...12 Jobs einplanen: Einfaches Verfahren mit BP_JOBVARIANT_SCHEDULE...13 Mit dem einfachen Verfahren eingeplante Jobs mit BP_JOBVARIANT_OVERVIEW verwalten16 Jobs einplanen: Ganzsteuerungsverfahren...18 Jobs mit dem Ganzsteuerungsverfahren einplanen: Überblick...19 Wo werden Job-Attribute angegeben?...21 Angaben zur Startzeit von Benutzern ermitteln...23 Startzeitpunkte für periodisch wiederholte Jobs ermitteln...26 Druck- und Archivierungsangaben ermitteln...27 Programmbeispiel: Deklarationen, Einrichtung und Druckangaben...28 Programmbeispiel: Jobs mit JOB_OPEN anlegen...30 Programmbeispiel: ABAP-Job-Step hinzufügen...31 Programmbeispiel: Job-Step für ein externes Kommando oder Programm hinzufügen Programmbeispiel: Job-Step mit ABAP SUBMIT hinzufügen...34 Programmbeispiel: Sofort-Start mit JOB_CLOSE...35 Programmbeispiel: Sofortiger Start mit Mail-Empfänger von Spoolaufträgen...36 Programmbeispiel: Startzeit-Fenster mit JOB_CLOSE...38 Programmbeispiel: Job-Start an einem Arbeitstag (JOB_CLOSE)...40 Programmbeispiel: Job-Start bei Ereignis (JOB_CLOSE)...41 Programmbeispiel: Mit JOB_CLOSE auf Vorgänger-Job warten...42 Programmbeispiel: Start bei Änderung der Betriebsart (JOB_CLOSE)...45 Job-Ergebnisse: Job-Protokolle anzeigen...46 Job-Protokolle anzeigen...47 Job-Protokoll in eine interne Tabelle kopieren...48 Jobs verwalten: Job-Listen generieren...49 Programmbeispiel: Job-Listen generieren...50 Job-Status anzeigen: SHOW_JOBSTATE...52 Jobs auswählen und löschen...55 Job-Starts über Ereignisse auslösen...57 Ereigniskonzepte...58 Ereignisse: Überblick...60 Ereignisse definieren...61 Ereignisse aus ABAP-Programmen auslösen...62 Ereignisse aus externen Programmen auslösen...63 Ausgelöste Ereignisse und Argumente ermitteln...65 Externe Programme ausführen...66 Parallelverarbeitung implementieren...67 Spezielle Techniken: Externe Programme starten...78 Erweiterte Einplanung 1: Job-Folgen erstellen...80 Erweiterte Einplanung 2: Parallele Jobs einplanen und synchronisieren...82 Erweiterte Einplanung 3: Job festlegen April 2001

5 SAP AG Funktionsbausteine der Hintergrundverarbeitung...85 JOB_OPEN: Hintergrund-Jobs anlegen...86 JOB_SUBMIT, ABAP SUBMIT: Job-Steps einem Job hinzufügen...87 JOB_CLOSE: Jobs an die Hintergrundsteuerung übergeben...88 BP_JOBVARIANT_SCHEDULE und BP_JOBVARIANT_OVERVIEW: Einfache Einplanung und Verwaltung von Jobs...89 BP_CALCULATE_NEXT_JOB_STARTS: Startzeitpunkt für periodisch wiederholte Jobs ermitteln...90 BP_CHECK_EVENTID: Ereignisbezeichnungen prüfen...91 BP_EVENT_RAISE: Ereignis aus einem ABAP-Programm auslösen...92 BP_JOB_COPY: Hintergrund-Jobs kopieren...93 BP_JOB_DELETE: Hintergrund-Jobs löschen...94 BP_JOB_GET_PREDECESSORS: Vorgänger-Job eines Jobs ermitteln...95 BP_JOB_GET_SUCESSORS: Nachfolger-Jobs eines Jobs ermitteln...96 BP_JOB_MAINTENANCE: Job-Pflegefunktionen...97 BP_JOB_SELECT: Jobs aus der Datenbank auswählen...98 BP_FIND_JOBS_WITH_PROGRAM: Jobs, die bestimmte Programme ausführen, aus der Datenbank lesen...99 BP_JOBLIST_PROCESSOR: Job-Listen für Benutzer anzeigen SHOW_JOBSTATE: Status eines Jobs prüfen BP_JOBLOG_READ: Job-Protokolle lesen BP_JOBLOG_SHOW: Job-Protokolle anzeigen BP_START_DATE_EDITOR: Starttermin anzeigen/anfordern BP_JOB_READ: Job-Spezifikationen abrufen SHOW_JOBSTATE: Job-Status anzeigen Funktionsbausteine für die Parallelverarbeitung Datenübernahme Methoden zur Datenübernahme Datenübernahme: Batch-Input im Überblick Der Transaktions-Recorder Transaktionen aufzeichnen Aufzeichnung ausführen Aufzeichnungseditor verwenden Batch-Input-Mappe aus Aufzeichnung generieren Datenübernahmeprogramm generieren Funktionsbaustein generieren Funktionsbaustein verwenden Testdatei erstellen Datenübernahme durchführen Konvertierungsprogramm erstellen SAP-Datenstruktur für das Konvertierungsprogramm generieren Datenumsetzung SAP-Datenstruktur füllen Datenübernahme-Methode auswählen Datenübernahmeprogramm ausführen Batch-Input-Berechtigungen April

6 SAP AG Zusätzliche Informationen CALL TRANSACTION USING für Datenübernahme verwenden Batch-Input-Mappen anlegen Mappen mit BDC_OPEN_GROUP anlegen Daten in eine Mappe einfügen: BDC_INSERT Mappen schließen: BDC_CLOSE_GROUP Batch-Input-Mappen verarbeiten CALL DIALOG für Batch-Input verwenden Die Datenübernahme-Datenstruktur Systemdaten ermitteln Häufige Datenübernahmefehler Direct-Input Programmierung mit externen Kommandos Programmiertechniken SXPG_CALL_SYSTEM: Externes Kommando ausführen (Schnellverfahren) SXPG_COMMAND_EXECUTE: Berechtigung zum Ausführen eines externen Kommandos prüfen und Kommando ausführen SXPG_COMMAND_CHECK: Berechtigung zum Ausführen eines externen Kommandos prüfen SXPG_COMMAND_LIST_GET: Liste externer Kommandos lesen SXPG_COMMAND_DEFINITION_GET: Einzelne externe Kommandos lesen SXPG_DUMMY_COMMAND_CHECK: Schnittstelle für gesonderte Prüfmodule Common Application Interfaces April 2001

7 SAP AG April

8 SAP AG BC - Basis-Programmierschnittstellen BC - Basis-Programmierschnittstellen Programmierung mit der Hintergrundsteuerung [Seite 10] Daten mit Batch-Input übernehmen [Seite 108] Programmierung mit externen Kommandos [Seite 158] Funktionsbausteine der Hintergrundverarbeitung [Seite 85] Allgemeine Programmierschnittstellen [Seite 179] Änderungen in Release 4.0A [Seite 9] 8 April 2001

9 SAP AG Änderungen in Release 4.0A Änderungen in Release 4.0A Programmierschnittstelle der Hintergrundverarbeitung Externe Kommandos, siehe Programmbeispiel: Job-Step für ein externes Kommando oder Programm hinzufügen [Seite 32] Automatisches Verschicken von Job-Ausgabe an SAPoffice-Benutzer, siehe Programmbeispiel: Sofortiger Start mit Mail-Empfänger von Spoolaufträgen [Seite 36] April

10 SAP AG Programmierung mit der Hintergrundsteuerung Programmierung mit der Hintergrundsteuerung In diesem Abschnitt wird die Programmierschnittstelle der Hintergrundsteuerung beschrieben. Mit dieser Schnittstelle können Sie Jobs zur Hintergrundverarbeitung einplanen und verwalten. 10 April 2001

11 SAP AG Programmiertechniken Programmiertechniken Mit der Programmierschnittstelle der Hintergrundsteuerung können Sie von Ihren Programmen aus Hintergrund-Jobs einplanen und verwalten. Sie möchten dem Benutzer in einem Menü einen Langläufer-Report anbieten. In der entsprechenden Transaktion können Sie: wahlweise den Benutzer Angaben zum Job eingeben lassen, beispielsweise den Starttermin und die Startzeit, und den Job zur Verarbeitung durch die Hintergrundsteuerung einplanen. Mit der Programmierschnittstelle können Sie sowohl ABAP-Programme als auch externe Programme im Hintergrund verarbeiten. Die Programmierschnittstelle stellt zudem Funktionsbausteine zur Durchführung der folgenden Aufgaben bereit: Jobs verwalten (anzeigen, kopieren und löschen) Ereignisse überprüfen und auslösen, zu denen Sie andere Hintergrund-Jobs verarbeiten möchten von Hintergrund-Jobs erzeugte Protokolle anzeigen Die folgenden Themen enthalten Anleitungen zu den wichtigsten Aufgaben, die bei der Einplanung und Verwaltung von Hintergrund-Jobs anfallen. April

12 SAP AG Jobs einplanen und verwalten: Einfaches Verfahren Jobs einplanen und verwalten: Einfaches Verfahren Die Programmierschnittstelle enthält zwei Funktionsbausteine, mit denen Sie Hintergrund-Jobs schnell und einfach einplanen und verwalten können. Diese Funktionsbausteine sind sehr benutzerfreundlich, bieten jedoch weniger Optionen und damit geringere Programmierkontrolle bei der Einplanung und Verwaltung von Jobs; sie sind daher besonders gut geeignet, wenn Sie lediglich einen Job einplanen und den Programmieraufwand dabei möglichst gering halten möchten. Im folgenden werden die beiden Funktionsbausteine beschrieben: BP_JOBVARIANT_SCHEDULE [Seite 13]: Für die Einplanung eines Jobs zur Ausführung. Mit diesem Funktionsbaustein wird die Einplanung eines Jobs erheblich vereinfacht. Sie müssen lediglich einen ABAP-Report angeben. Daraufhin werden Bildschirmbilder angezeigt, in denen die Benutzer die zu verwendende Variante angeben und einen Zeitpunkt für den einmaligen oder wiederholten Start definieren können. BP_JOBVARIANT_OVERVIEW [Seite 16]: Für die Verwaltung von Jobs. Dieser Funktionsbaustein vereinfacht die Verwaltung von Jobs. Die Benutzer können nicht aktive Jobs löschen und Job-Protokolle sowie Spoolaufträge abgeschlossener Jobs anzeigen. 12 April 2001

13 SAP AG Jobs einplanen: Einfaches Verfahren mit BP_JOBVARIANT_SCHEDULE Jobs einplanen: Einfaches Verfahren mit BP_JOBVARIANT_SCHEDULE Möchten Sie einen Job von einem Programm aus mit dem einfachen Verfahren einplanen, müssen Sie lediglich den Funktionsbaustein BP_JOBVARIANT_SCHEDULE aufrufen. Dieses Verfahren hat folgende Merkmale: Vereinfachte Job-Struktur: Der Funktionsbaustein plant einen Job ein, der nur aus einem Job-Step besteht. Für die meisten Verarbeitungsoptionen gelten Standardwerte. Beim Druck werden beispielsweise die Standardwerte des Benutzers verwendet, der den Job eingeplant hat; Sie können beim Aufruf des Funktionsbausteins kein anderes Ausgabegerät angeben. Es können nur ABAP-Reports eingeplant werden. Zum Start von externen Programmen müssen Sie das Ganzsteuerungsverfahren verwenden. Es stehen nicht alle Startzeitoptionen zur Verfügung, und die ereignisgesteuerte Einplanung wird nicht unterstützt. So arbeiten Sie mit dem Funktionsbaustein: 1. Beim Aufruf des Funktionsbausteins geben Sie den Report an, der eingeplant werden soll. 2. Der Funktionsbaustein zeigt eine Liste verschiedener Reportvarianten an, aus der der Benutzer eine Variante auswählen muß. Sie müssen sicherstellen, daß die erforderlichen Varianten bereits definiert wurden. 3. Der Benutzer wählt entweder den Sofort-Start oder gibt Datum und Uhrzeit für den Start ein. Wahlweise kann der Benutzer auch festlegen, daß der Job in regelmäßigen Abständen neu gestartet wird. Der Job wird daraufhin eingeplant. Mit dem folgenden Programm-Coding können die Benutzer den Report RSTWGZS2 einplanen und damit den Status der Online-Dokumentation überprüfen: call function 'BP_JOBVARIANT_SCHEDULE' exporting title_name = 'Überprüfung der Dokumentation' Anzeige als Titel des Einplanungsbildes job_name = 'DokuPrüf' Name des Hintergrund- Jobs prog_name = 'RSTWGZS2' Name des auszu- führenden ABAP- Reports - auch zur Variantenauswahl verwendet. exceptions no_such_report = 01. PROG_NAME- Programm nicht gefunden. April

14 SAP AG Jobs einplanen: Einfaches Verfahren mit BP_JOBVARIANT_SCHEDULE call function 'BP_JOBVARIANT_OVERVIEW' Eingeplante Jobs exporting auflisten title_name = 'Überprüfung der Dokumentation' Anzeige als Titel des Übersichtsbildes job_name = 'DokuPrüf' Jobs mit diesem Namen werden aufgelistet prog_name = 'RSTWGZS2' exceptions no_such_job = 01. Mit diesem Programm-Coding werden zwei Bildschirmbilder aufgerufen. Auf dem ersten Bild kann der Benutzer neue Varianten hinzufügen oder eine Auswahl aus den bereits vorhandenen Varianten treffen. Auf dem zweiten Bild kann der Benutzer den Zeitpunkt für die einmalige oder wiederholte Ausführung des Jobs angeben. Der Funktionsbaustein zeigt eine Meldung an, wenn der Benutzer den Hintergrund-Job einplant. 14 April 2001

15 SAP AG Jobs einplanen: Einfaches Verfahren mit BP_JOBVARIANT_SCHEDULE Unter Mit dem einfachen Verfahren eingeplante Jobs mit BP_JOBVARIANT_OVERVIEW verwalten [Seite 16] wird genauer beschrieben, wie die Benutzer Hintergrund-Jobs schnell und einfach verwalten können. April

16 SAP AG Mit dem einfachen Verfahren eingeplante Jobs mit BP_JOBVARIANT_OVERVIEW verwalten Mit dem einfachen Verfahren eingeplante Jobs mit BP_JOBVARIANT_OVERVIEW verwalten Der Funktionsbaustein BP_JOBVARIANT_OVERVIEW bietet den Benutzern eine vereinfachte Anzeige- und Verwaltungsfunktion für Jobs, die mit dem einfachen Verfahren eingeplant wurden. Mit dem Funktionsbaustein können die Benutzer: die folgenden Einzelheiten zu den ausgewählten Jobs anzeigen: Job-Titel, Reportname, Reportvariante, Angaben zur Startzeit, Status sowie Benutzer, der den Job eingeplant hat die Angaben zur Startzeit und zum Neustart für Jobs ändern, die noch nicht ausgeführt wurden das Job-Protokoll sowie die Spool-Ausgabe der abgeschlossenen Jobs anzeigen Jobs löschen, die nicht gerade ausgeführt werden Mit dem folgenden Programm-Coding können die Benutzer Jobs überprüfen, die sie mit dem unter Jobs einplanen: Einfaches Verfahren mit BP_JOBVARIANT_SCHEDULE [Seite 13] gezeigten, einfachen Verfahren eingeplant haben. call function 'BP_JOBVARIANT_SCHEDULE' Jobs einplanen; Gegenstück zu exporting BP_JOBVARIANT_OVERVIEW title_name = 'Überprüfung der Dokumentation' Anzeige als Titel des Einplanungsbildes job_name = 'DokuPrüf' Name des Hintergrund- Jobs prog_name = 'RSTWGZS2' Name des auszu- führenden ABAP- Reports - auch zur Variantenauswahl verwendet exceptions no_such_report = 01. PROG_NAME-Programm nicht gefunden. call function 'BP_JOBVARIANT_OVERVIEW' exporting title_name = 'Überprüfung der Dokumentation' Anzeige als Titel des Übersichtsbildes job_name = 'DokuPrüf' Jobs mit diesem Namen werden aufgelistet. prog_name = 'RSTWGZS2' 16 April 2001

17 SAP AG Mit dem einfachen Verfahren eingeplante Jobs mit BP_JOBVARIANT_OVERVIEW verwalten exceptions no_such_job = 01. Daraufhin wird das folgende Bildschirmbild angezeigt: In diesem Bild haben die Benutzer die folgenden Möglichkeiten, sofern sie über die erforderlichen Berechtigungen verfügen: noch nicht gestartete Jobs löschen oder deren Startzeitpunkt ändern Job-Protokolle oder Spoolaufträge bereits abgeschlossener Jobs anzeigen April

18 SAP AG Jobs einplanen: Ganzsteuerungsverfahren Jobs einplanen: Ganzsteuerungsverfahren Durch die Einplanung eines Hintergrund-Jobs wird die Hintergrundsteuerung angewiesen, die im Job enthaltenen Programme zu verarbeiten. Ein Job kann mehrere ABAP- und/oder externe Programme enthalten. Sie haben zwei Möglichkeiten, einen Job einzuplanen: das einfache Verfahren mit dem Funktionsbaustein BP_JOBVARIANT_SCHEDULE Weitere Einzelheiten hierzu finden Sie unter Jobs einplanen und verwalten: Einfaches Verfahren [Seite 12]. das Ganzsteuerungsverfahren mit den Funktionsbausteinen JOB_OPEN, JOB_SUBMIT und JOB_CLOSE Bei diesem Verfahren können Sie die Job-Optionen, wie beispielsweise Druck und Startzeit, vollständig steuern. In den folgenden Abschnitten wird das Ganzsteuerungsverfahren genauer beschrieben. 18 April 2001

19 SAP AG Jobs mit dem Ganzsteuerungsverfahren einplanen: Überblick Jobs mit dem Ganzsteuerungsverfahren einplanen: Überblick So planen Sie Hintergrund-Jobs von einem Programm aus mit dem Ganzsteuerungsverfahren ein: 1. Legen Sie den Job mit dem Funktionsbaustein JOB_OPEN an. JOB_OPEN übergibt einen Namen an die Hintergrundsteuerung. Das System gibt zusammen mit dem Job-Namen eine eindeutige Identifikationsnummer für den Job zurück. 2. Ermitteln Sie die Job-Spezifika (Report oder Programm, Startzeit usw.). Sie können diese Informationen selbst ermitteln oder dazu die folgenden Funktionsbausteine einsetzen: BP_START_DATE_EDITOR: Fordert den Benutzer auf, die Startzeit für den Hintergrund-Job anzugeben. GET_PRINT_PARAMETERS: Fordert den Benutzer auf, Angaben zum Drucken und zur optischen Archivierung zu machen. Im nichtinteraktiven Modus können Sie diese Angaben auch selbst mit GET_PRINT_PARAMETERS vornehmen. GET_PRINT_PARAMETERS ist nicht unbedingt erforderlich für Testprogramme sowie für Programme, die keine druckbare Ausgabe erzeugen (kein WRITE- Schlüsselwort). Beispiel: Für einen Hintergrund-Job, der lediglich Datenbankänderungen durchführt, muß GET_PRINT_PARAMETERS nicht aufgerufen werden. In Produktivprogrammen für die Einplanung von Jobs, die Ausgaben erzeugen, sollten Sie dagegen stets GET_PRINT_PARAMETERS aufrufen. Andernfalls verwendet das R/3-Spool-System Standardwerte für die Aufbereitung und den Druck der vom Job erzeugten Ausgabe. Dabei könnte es passieren, daß die Druckergebnisse nicht Ihren Erwartungen entsprechen. 3. Fügen Sie Ihrem Job mit dem Funktionsbaustein JOB_SUBMIT oder dem ABAP- Schlüsselwort SUBMIT einen Job-Step hinzu. Jedes in einem Job enthaltene Programm bildet einen eigenen Job-Step, d. h. eine unabhängige Arbeitseinheit innerhalb des Hintergrund-Jobs. Bis auf den Starttermin und das ausführende Zielsystem können Sie für jeden Job-Step individuelle Attribute angeben. Sie können für jeden Job-Step beispielsweise spezifische Angaben zum Drucken und zu den Berechtigungen definieren. Sie können einem Job beliebig viele Job-Steps hinzufügen. Ein Job kann Job-Steps enthalten, die ABAP-Programme und externe Programme ausführen. JOB_SUBMIT und ABAP SUBMIT unterscheiden sich in einem Punkt. Mit SUBMIT können Sie Auswahlkriterien für einen ABAP-Report dynamisch angeben, wenn der Hintergrund-Job übergeben wird. Mit JOB_SUBMIT können Sie lediglich eine bereits vorhandene Variante für den Report angeben. Sie müssen SUBMIT beispielsweise dann einsetzen, wenn der Benutzer Ihres Programms die Auswahlkriterien für einen ABAP-Report im Dialog zur Laufzeit angibt. Mit JOB_SUBMIT können Sie nur eine bereits vorhandene Variante für den Report angeben. April

20 SAP AG Jobs mit dem Ganzsteuerungsverfahren einplanen: Überblick 4. Schließen Sie den Job ab, und übergeben Sie ihn zur Ausführung an die Hintergrundsteuerung mit dem Funktionsbaustein JOB_CLOSE. Mit JOB_CLOSE geben Sie zahlreiche Attribute zum Startzeitpunkt sowie zur Laufzeit an. Ein Job kann erst gestartet werden, wenn Sie ihn abgeschlossen haben. Über JOB_CLOSE können Sie ermitteln, ob ein Job lediglich eingeplant oder auch zur Ausführung freigegeben wurde. Wurde er nur eingeplant, kann er erst ausgeführt werden, wenn er von einem Verwalter ausdrücklich freigegeben wird. Wenn der Job dagegen automatisch freigegeben wurde, kann die Hintergrundsteuerung den Job starten, sobald der angegebene Startzeitpunkt erreicht wird. In den folgenden Fällen ist der Job nur eingeplant, nicht jedoch freigegeben: Der Benutzer, der den Job einplant, hat keine Freigabeberechtigung. Für den Job wurde kein Startzeitpunkt angegeben. Wenn Sie einen Job zur wiederholten Ausführung einplanen, können Sie mit dem Funktionsbaustein BP_CALCULATE_NEXT_JOB_STARTS ermitteln, zu welchen Zeitpunkten der Job ausgeführt werden soll. 20 April 2001

21 SAP AG Wo werden Job-Attribute angegeben? Wo werden Job-Attribute angegeben? Die folgende Tabelle erklärt für jedes Attribut eines Jobs: ob das Attribut für den ganzen Job gilt oder nur für einen einzelnen Job-Step. Jedes in einem Job enthaltene Programm bildet einen eigenen Job-Step, d.h. eine unabhängige Arbeitseinheit innerhalb des Hintergrund-Jobs. Bis auf den Starttermin und das ausführende Zielsystem können Sie für jeden Job-Step individuelle Attribute angeben. wo und wie die Werte für die einzelnen Attribute zugeordnet werden. Programmbeispiele für die Attribute finden Sie im nächsten Abschnitt. Die Werte für die meisten Attribute sind im ABAP-Baustein LBTCHDEF vordefiniert. Job-Attribute Attribut Job/Job-StepAngabe in Job-Name Job JOB_OPEN, Parameter JOBNAME, siehe Programmbeispiel: Jobs mit JOB_OPEN anlegen [Seite 30] Job-Nummer Job JOB_OPEN (vom System zurückgegeben), Parameter JOBCOUNT unter Programmbeispiel: Jobs mit JOB_OPEN anlegen [Seite 30] Job-Priorität Job Immer auf C gesetzt. Mit der Hintergrundprogrammierung kann keine andere Priorität gesetzt werden. Andere Prioritäten müssen Sie manuell mit Transaktion SM36 oder SM37 setzen. Sofort-Start Job JOB_CLOSE, Parameter STRTIMMED, siehe Programmbeispiel: Sofort-Start mit JOB_CLOSE [Seite 35] Angaben zum Start und Wiederholungsperiode Job JOB_CLOSE, verschiedene Parameter. Siehe Programmierbeispiele in Jobs mit dem Ganzsteuerungsverfahren einplanen: Überblick [Seite 19]. Zielsystem für die Ausführung Job JOB_CLOSE, Parameter TARGETSYSTEM, siehe Programmbeispiel: Startzeit-Fenster mit JOB_CLOSE [Seite 38] Job nach Ausführung automatisch löschen Empfänger für per Mail gesendete Spoolaufträge, die von dem Job erzeugt wurden Job Job JOB_OPEN, Parameter DELANFREP JOB_CLOSE, Parameter RECIPIENT_OBJ [Seite 36] April

22 SAP AG Wo werden Job-Attribute angegeben? Reportname Job-Step JOB_SUBMIT unter Programmbeispiel: ABAP-Job-Step hinzufügen [Seite 31] ABAP SUBMIT unter Programmbeispiel: Job-Step mit ABAP SUBMIT hinzufügen [Seite 34] Reportvariante Job-Step JOB_SUBMIT, Parameter VARIANT, ABAP SUBMIT, Parameter USING SELECTION- SET Werte für Variablen Job-Step ABAP SUBMIT, verschiedene Parameter. Siehe ABAP Benutzerhandbuch [Extern] Name und betriebssystemspezifische Variante des externen Kommandos Name des externen Programms Argument-String für externes Programm Zielsystem für externes Programm Steuerungsoptionen für externes Programm Benutzer für Job- Laufzeitberechtigungen Druck- und Archivierungsangaben Job-Step Job-Step Job-Step Job-Step Job-Step Job-Step Job-Step JOB_SUBMIT, Parameter COMMANDNAME und OPERATINGSYSTEM [Seite 32] JOB_SUBMIT, Parameter EXTPGM NAME unter Programmbeispiel: Job-Step für ein externes Kommando oder Programm hinzufügen [Seite 32] JOB_SUBMIT, Parameter EXTPGM PARAM unter Programmbeispiel: Job-Step für ein externes Kommando oder Programm hinzufügen [Seite 32] Parameter JOB SUBMIT, EXTPGM SYSTEM unter Programmbeispiel: Job-Step für ein externes Kommando oder Programm hinzufügen [Seite 32] JOB_SUBMIT, verschiedene Parameter. Siehe Programmbeispiel: Job-Step für ein externes Kommando oder Programm hinzufügen [Seite 32] JOB_SUBMIT, Parameter AUTHCKNAM ABAP SUBMIT unter Programmbeispiel: ABAP-Job-Step hinzufügen [Seite 31] JOB_SUBMIT, ABAP SUBMIT unter Verwendung von GET PRINT PARAMETERS für die Angaben, siehe Programmbeispiel: Deklarationen, Einrichtung und Druckangaben [Seite 28] 22 April 2001

23 SAP AG Angaben zur Startzeit von Benutzern ermitteln Angaben zur Startzeit von Benutzern ermitteln Mit dem Funktionsbaustein BP_START_DATE_EDITOR können die Benutzer angeben, wann und wie ein Job gestartet werden soll. Dieser Funktionsbaustein bietet die gleichen Optionen wie die Standardeinplanungstransaktion: Sofort-Start, Startfenster, Vorgänger-Job, Ereignis usw. Programmbeispiel Dieser Abschnitt enthält Beispiele für die Funktionsbausteine BP_START_DATE_EDITOR und JOB_CLOSE. * Von BP_START_DATE_EDITOR zurückgegebene Datenstruktur * DATA STARTSPECS LIKE TBTCSTRT. DATA START_MODIFY_FLAG LIKE BTCH0000-INT4. * * BP_START_DATE_EDITOR: Fordert Benutzer in einem Dialogfenster * auf, Angaben zum Job-Start zu machen. Der Benutzer hat folgende * Optionen: * - Sofort-Start * - Startzeit und -datum sowie letzte Zeit und letztes Datum * - Start nach Ereignis * - Start nach Aktivierung einer neuen Betriebsart * - Start nach Vorgänger-Job * - Start an einem bestimmten Arbeitstag des Monats, ab * Monatsanfang oder Monatsende * - Vorgehensweise, falls Start auf einen Feiertag fällt * * Der Benutzer kann alle Optionen zum Starttermin wählen. Zur * Auswahlbegrenzung sollten Sie Ihr eigenes Eingabefenster * programmieren. Sie können auch TBTCSTRT-STRTDTTYP auswerten, * um zu ermitteln, ob der Benutzer eine passende Startangabe * gewählt hat (siehe unten). * * BP_START_DATE_EDITOR überprüft die Angaben des Benutzers auf * mögliche Fehler oder Widersprüchlichkeiten und gibt eventuell * eine Fehlermeldung aus. * Nur die Felder TBTCSTRT im unten gezeigten Beispiel sollten * verwendet werden, da andere Felder für den internen Gebrauch * reserviert sind. Setzen Sie die Felder TBTCSTRT nicht direkt. CALL FUNCTION 'BP_START_DATE_EDITOR' EXPORTING STDT_DIALOG = BTC_YES Baustein im interaktiven Modus STDT_OPCODE = BTC_EDIT_STARTDATE Bearbeitungsmodus STDT_INPUT = STARTSPECS Tabelle für Benutzerauswahl STDT_TITLE = 'Titel' Titel für Dialogfenster IMPORTING STDT_OUTPUT = STARTSPECS Benutzerauswahl STDT_MODIFY_TYPE = START_MODIFY_FLAG April

24 SAP AG Angaben zur Startzeit von Benutzern ermitteln EXCEPTIONS OTHERS = 99. Flag: Hat Benutzer Angaben geändert? Werte: - BTC_STDT_MODIFIED, Änderungen vorgenommen - BTC_STDT_NOT_MODIFIED, keine Änderungen vorgenommen * * Flag zur Angabe des Sofort-Starts in JOB_CLOSE: Für den * Sofort-Start müssen Sie ein Flag setzen, um die Benutzerauswahl * an JOB_CLOSE zu übermitteln. In allen anderen Fällen müssen * Sie nur die von BP_START_DATE_EDITOR zurückgegebenen Werte an * JOB_CLOSE übergeben. * Die vom Benutzer nicht gesetzten Parameter haben den Wert SPACE * und haben keine Auswirkung auf JOB_CLOSE. * * Alle JOB_CLOSE-Parameter können nur zusammen mit * BP_START_DATE_EDITOR gesetzt werden. Andernfalls * sollten Sie nur die erforderlichen * Parameter in * Ihrem Aufruf von JOB_CLOSE setzen. * DATA: STARTIMMEDIATE LIKE BTCH0000-CHAR1. CASE STARTSPECS-STARTDTTYP. Optionen werden unten aufgelistet. WHEN BTC_STDT_IMMEDIATE. Benutzerwahl: Sofort-Start. STARTIMMEDIATE = 'X'. WHEN BTC_STDT_DATETIME. Benutzerangabe: Startdatum und Startuhrzeit WHEN BTC_STDT_EVENT. Benutzer hat Ereignis und eventuell Argument angegeben, ODER Benutzer hat Start bei Aktivierung einer bestimmten Betriebsart gewählt (Job-Start auch in diesem Fall ereignisgesteuert). <Optionale Fehlerverarbeitung, wenn Sie verhindern möchten, daß der Benutzer einen Job ereignisabhängig einplant> WHEN BTC_STDT_AFTERJOB. Benutzerangabe: Vorgänger-Job. < Optionale Fehlerverarbeitung, wenn Sie verhindern möchten, daß der Benutzer einen Job nach Vorgänger einplant> WHEN BTC_STDT_ONWORKDAY Benutzerangabe: Job-Start an einem bestimmten Arbeitstag des Monats. ENDCASE. * * Verwendung der vom Benutzer in JOB_CLOSE gemachten Startangaben. * CALL FUNCTION 'JOB_CLOSE' EXPORTING JOBNAME = JOBNAME JOBCOUNT = JOBNUMBER STRTIMMED = STARTIMMEDIATE SDLSTRTDT = STARTSPECS-SDLSTRTDT 24 April 2001

25 SAP AG Angaben zur Startzeit von Benutzern ermitteln SDLSTRTTM = STARTSPECS-SDLSTRTTM LASTSTRTDT = STARTSPECS-LASTSTRTDT LASTSTRTTM = STARTSPECS-LASTSTRTTM PRDDAYS = STARTSPECS-PRDDAYS Werte anders als Null PRDHOURS = STARTSPECS-PRDHOURS in PRD*-Feldern PRDMINS = STARTSPECS-PRDMINS bedeuten, daß ein PRDMONTHS = STARTSPECS-PRDMONTHS Startdatum/Startzeit- PRDWEEKS = STARTSPECS-PRDWEEKS Job periodisch wieder- holt werden soll. TARGETSYSTEM = STARTSPECS-INSTNAME * AT_OPMODE = Diesen Parameter weglassen, wenn der Benutzer Angaben zur Startzeit gemacht hat. Wird automatisch von BP_START_DATE_EDITOR gesetzt. AT_OPMODE_PERIODIC = STARTSPECS-PERIODIC Mit generischem Flag in Tabelle TBTCSTRT setzen. PRED_JOBNAME = STARTSPECS-PREDJOB PRED_JOBCOUNT = STARTSPECS-PREDJOBCNT PREDJOB_CHECKSTAT = STARTSPECS-CHECKSTAT EVENT_ID = STARTSPECS-EVENTID EVENT_PARAM = STARTSPECS-EVENTPARM EVENT_PERIODIC = STARTSPECS-PERIODIC Mit generischem Flag in Tabelle TBTCSTRT setzen. CALENDAR_ID = STARTSPECS-CALENDARID STARTDATE_RESTRICTION = STARTSPECS-PRDBEHAV START_ON_WORKDAY_NOT_BEFORE = STARTSPECS-NOTBEFORE START_ON_WORKDAY_NR = STARTSPECS-WDAYNO WORKDAY_COUNT_DIRECTION = STARTSPECS-WDAYCDIR START_ON_WORKDAY Jobs werden automatisch zur periodischen Ausführung eingeplant, wenn PRDMONTHS gesetzt wurde. IMPORTING JOB_WAS_RELEASED = JOB_RELEASED EXCEPTIONS OTHERS = 99. April

26 SAP AG Startzeitpunkte für periodisch wiederholte Jobs ermitteln Startzeitpunkte für periodisch wiederholte Jobs ermitteln Mit BP_CALCULATE_NEXT_JOB_STARTS können Sie die Startzeitpunkte von Jobs ermitteln, die in regelmäßigen Abständen ausgeführt werden. Dieser Funktionsbaustein verwendet die Identifikation eines einzelnen Jobs aus JOB_OPEN. Startdatum und Startuhrzeit werden in einer internen Tabelle mit dem Format TBTCJOB zurückgegeben. 26 April 2001

27 SAP AG Druck- und Archivierungsangaben ermitteln Druck- und Archivierungsangaben ermitteln Wenn ein ABAP-Programm eines Hintergrund-Jobs Listenausgabe generiert, wird diese Ausgabe in einem Spoolauftrag im R/3-Spool-System abgelegt. Sie können die Verarbeitung des Spoolauftrags mit GET_PRINT_PARAMETERS definieren. Sie können entweder Ihre eigenen Druck- und Archivierungsoptionen im nichtinteraktiven Modus angeben oder Ihren Benutzern das Standarddialogfenster für Druck- und Archivierungsoptionen anzeigen. Ein Programmbeispiel finden Sie unter Programmbeispiel: Deklarationen, Einrichtung und Druckangaben [Seite 28]. Sie können die Daten in den von GET_PRINT_PARAMETERS gepflegten Strukturen für Druck und Archivierung nicht direkt ändern, sondern Sie müssen GET_PRINT_PARAMETERS verwenden, um diese Strukturen zu füllen. Weitere Einzelheiten zu Druck- und Archivierungsangaben Sie sollten einen Aufruf von GET_PRINT_PARAMETERS in jedes Programm integrieren, das in Produktivsystemen zur Einplanung von Jobs verwendet wird. Zu dieser Grundregel bestehen folgende Ausnahmen: Programme zur Einplanung von Jobs, die keine Ausgabe erzeugen (kein WRITE- Schlüsselwort). Beispiel: Soll das Programm einen Job einplanen, der lediglich Datenbankänderungen durchführt, muß GET_PRINT_PARAMETERS nicht aufgerufen werden. Testprogramme. Für die Ausführung von Testprogrammen muß GET_PRINT_PARAMETERS nicht aufgerufen werden. Wenn Sie GET_PRINT_PARAMETERS nicht angeben, verwendet das Spool-System Standardwerte für die Ausgabe. Das Zielausgabegerät sowie die Spoolauftragsangaben richten sich nach den Festwerten im Benutzerstammsatz des Benutzers, der den Job eingeplant hat. Die Ausgabe wird mit 80 Zeichen pro Zeile und 59 Zeilen pro Seite aufbereitet. Diese Standardwerte stimmen jedoch nicht unbedingt mit den Anforderungen der Ausgabe überein. So könnte für die Ausgabe beispielsweise eine andere Zeilenlänge erforderlich sein. Wenn Sie GET_PRINT_PARAMETERS aufrufen, müssen Sie festlegen, daß der Funktionsbaustein im BATCH-Modus ausgeführt werden soll. Weiterhin müssen Sie den Namen des Reports angeben, der im jeweiligen Job-Step ausgeführt werden soll. Der Funktionsbaustein sucht im Report nach den Angaben für LINE-SIZE und LINE-COUNT im Schlüsselwort REPORT. Unter Berücksichtigung dieser Angaben (falls vorhanden) und des Zielausgabegerätes wählt GET_PRINT_PARAMETERS dann die passende Aufbereitung für die Ausgabe. Wenn der Benutzer das Ausgabegerät interaktiv festlegt, zeigt der Funktionsbaustein ein Dialogfenster an, in dem die gewählte Aufbereitung bestätigt werden muß. April

28 SAP AG Programmbeispiel: Deklarationen, Einrichtung und Druckangaben Programmbeispiel: Deklarationen, Einrichtung und Druckangaben REPORT BCSAMPLE. * * Sie müssen LBTCHDEF für alle Aufgaben der Hintergrund- * verarbeitung angeben. Verwenden Sie nur die in Beispielen * genannten LBTCHDEF-Definitionen als Werte. LBTCHDEF * deklariert auch Werte, die nur intern in der Hintergrund- * steuerung verwendet werden. * * Falls Sie ein externes Programm einplanen möchten, müssen Sie * RSXPGDEF angeben, um Konstanten für die Control-Flags für * externe Programme zu definieren. * INCLUDE LBTCHDEF. Definitionen der Hintergrundverarbeitung. INCLUDE RSXPGDEF. Definitionen für externe Programme. * * DATA-Beispieleintrag zur Job-Einplanung. * DATA: JOBNUMBER LIKE TBTCJOB-JOBCOUNT, Job-ID und JOBNAME LIKE TBTCJOB-JOBNAME, Job-Name. STARTDATE LIKE TBTCJOB-SDLSTRTDT, Angaben zu Startzeit und STARTTIME LIKE TBTCJOB-SDLSTRTTM, Fenstern. LASTSTARTDATE LIKE TBTCJOB-LASTSTRTDT, LASTSTARTTIME LIKE TBTCJOB-LASTSTRTTM, JOB_RELEASED LIKE BTCH0000-CHAR1. JOB_CLOSE: Wurde Job freigegeben? * * Hintergrund-Jobs verwenden die folgenden Datenstrukturen: * TBTCJOB: Job-Definition * TBTCSTRT: Job-Startzeit (mit Funktionsbaustein * BP_START_DATE_EDITOR) * * In Produktivprogrammen für die Einplanung von Jobs sollten Sie * GET_PRINT_PARAMETERS aufrufen, um die Druck- und Archivierungs- * parameter anzugeben. Einzelheiten finden Sie unter * Druck- und Archivierungsangaben ermitteln [Seite 27] * * Hintergrund-Jobs verwenden die folgenden Druck- und * Archivierungstabellen: * PRI_PARAMS: Druckoptionen * ARC_PARAMS: Archivierungsoptionen * * Struktur für Druckparameter * DATA USER_PRINT_PARAMS LIKE PRI_PARAMS. * * Struktur für Parameter zur optischen Archivierung * 28 April 2001

29 SAP AG Programmbeispiel: Deklarationen, Einrichtung und Druckangaben DATA USER_ARC_PARAMS LIKE ARC_PARAMS. * * Zusätzliche Druck-/Archivierungsdeklarationen * DATA COUNT(3) TYPE N VALUE 1, VALID TYPE C. * GET_PRINT_PARAMETERS: Zeigt dem Benutzer das R/3-Standard- * dialogfenster für Druck- und Archivierungsangaben an. * Sie können Standardwerte für Druck- und Archivierungsoptionen * exportieren. Im interaktiven Modus werden diese Werte als * Standardwerte angezeigt; im nichtinteraktiven Modus können sie * direkt in die Parameterstrukturen eingetragen werden. Verwenden * Sie die Parameter IMPORTING OUT*, um die Druck- und * Archivierungsangaben an JOB_SUBMIT oder ABAP SUBMIT zu * übergeben. CALL FUNCTION 'GET_PRINT_PARAMETERS' EXPORTING MODE = 'BATCH' REPORT = '<REPORTNAME>' NO_DIALOG = ' ' IMPORTING OUT_PARAMETERS = USER_PRINT_PARAMS OUT_ARCHIVE_PARAMETERS = USER_ARC_PARAMS VALID = VALID EXCEPTIONS OTHERS = 99. IF VALID = SPACE. <Programm beenden, Benutzer hat Auswahl der Druckoptionen abgebrochen> ENDIF. April

30 SAP AG Programmbeispiel: Jobs mit JOB_OPEN anlegen Programmbeispiel: Jobs mit JOB_OPEN anlegen * * Legen Sie mit JOB_OPEN einen Job an. Der Funktionsbaustein gibt * eine eindeutige Job-Nummer zurück. Der Job wird von dieser * Nummer und vom Job-Namen identifiziert. Es stehen weitere, * optionale Parameter zur Verfügung. * JOBNAME = 'Frei wählbare Namen für die von Ihnen angelegten Jobs'. CALL FUNCTION 'JOB_OPEN' EXPORTING JOBNAME = JOBNAME IMPORTING JOBCOUNT = JOBNUMBER EXCEPTIONS CANT_CREATE_JOB = 01 INVALID_JOB_DATA = 02 JOBNAME_MISSING = 03 OTHERS = 99. IF SY-SUBRC > 0. <Fehlerverarbeitung> ENDIF. 30 April 2001

31 SAP AG Programmbeispiel: ABAP-Job-Step hinzufügen Programmbeispiel: ABAP-Job-Step hinzufügen * * Job-Step hinzufügen: ABAP-Programm * CALL FUNCTION 'JOB_SUBMIT' EXPORTING AUTHCKNAM = SY-UNAME Benutzer für die Laufzeitberechtigungen JOBCOUNT = JOBNUMBER Wert aus JOB_OPEN JOBNAME = JOBNAME Wert aus JOB_OPEN REPORT = 'REPORT' auszuführender Report VARIANT = 'VARIANT' mit dem Report zu verwendende Variante PRIPARAMS = USER_PRINT_PARAMS Druckoptionen des Benutzers ARCPARAMS = USER_ARC_PARAMS Archivierungsoptionen des Benutzers Beide Optionen stammen aus GET_PRINT_PARAMETERS EXCEPTIONS BAD_PRIPARAMS = 01 INVALID_JOBDATA = 02 JOBNAME_MISSING = 03 JOB_NOTEX = 04 JOB_SUBMIT_FAILED = 05 LOCK_FAILED = 06 PROGRAM_MISSING = 07 PROG_ABAP_AND_EXTPG_SET = 08 OTHERS = 99. IF SY-SUBRC > 0. <Fehlerverarbeitung> ENDIF. * Die Fehlerverarbeitung bei einem schweren Fehler sollte * BP_JOB_DELETE mit FORCEDMODE = 'X' aufrufen, um den Job aus der * Datenbank zu entfernen. Dies ist für die Fehlerverarbeitung in * allen Aufrufen nach JOB_OPEN erforderlich. * (Die Hintergrundsteuerung bereinigt automatisch bei einem * Problem in JOB_OPEN.) * * Ein Programmbeispiel finden Sie unter * Jobs auswählen und löschen [Seite 55]. * April

32 SAP AG Programmbeispiel: Job-Step für ein externes Kommando oder Programm hinzufügen Programmbeispiel: Job-Step für ein externes Kommando oder Programm hinzufügen Mit Release 4.0 gibt es jetzt zwei Methoden zum Einplanen von externen Programmen und Kommandos in einem Job-Step. Dies sind: Externe Kommandos: Vordefinierte symbolische Namen für Kommandos oder Programme auf Betriebssystemebene. Externe Kommandos sind für normale Benutzer gedacht. Da sie in R/3 vordefiniert sind und einer Berechtigungsprüfung unterliegen, hat der Administrator die Kontrolle darüber, was Benutzer über Hintergrund-Jobs auf Betriebssystemebene tun können. Externe Programme: Betriebssystemkommandos, die direkt in die Job-Step-Angaben eingegeben werden und für die im R/3-System keine spezielle Berechtigungsprüfung durchgeführt wird. Die Verwendung externer Programme ist Administratoren vorbehalten (spezielle Berechtigung erforderlich). Sie können in einem Job-Step entweder ein externes Kommando oder ein externes Programm einplanen, aber nicht beides. Zur Einplanung eines externen Kommandos verwenden Sie die Parameter COMMANDNAME und OPERATING SYSTEM. Zur Einplanung eines externen Programms verwenden Sie den Parameter EXTPGM_NAME. Sowohl externe Kommandos als auch externe Programme verwenden die EXTPGM-Parameter mit Ausnahme von EXTPGM_NAME. Um weitere Informationen zu erhalten, suchen Sie im CCMS Handbuch [Extern] nach Externe Programme. * * Job-Step hinzufügen: externes Programm * CALL FUNCTION 'JOB_SUBMIT' EXPORTING AUTHCKNAM = SY-UNAME Benutzer für Lauf- zeitberechtigungen JOBCOUNT = JOBNUMBER aus JOB_OPEN JOBNAME = JOBNAME aus JOB_OPEN COMMANDNAME = EXTERNAL_COMMAND Name eines vordefinierten externen Kommandos. COMMANDNAME und EXTPGM_NAME schließen sich gegenseitig aus. Beide verwenden die OPERATINGSYSTEM= 'AIX' EXTPGM-Parameter. Betriebssystem für die Wahl der COMMANDNAME-Variante. EXTPGM_NAME = '/usr/exe/myexe' Pfadname eines externen Programms; eine Berechtigung für S_RZL_ADM (RZ- Leitstand: System- Administration) 32 April 2001

33 SAP AG Programmbeispiel: Job-Step für ein externes Kommando oder Programm hinzufügen ist erforderlich. EXTPGM_PARAM = '<Parameter>' Programm-Parameter EXTPGM_SYSTEM = 'host01' Host für Ausführung EXTPGM_WAIT_FOR_TERMINATION = 'X' Control-Flags für EXTPGM_STDOUT_IN_JOBLOG = 'X' externe Programme: EXTPGM_SET_TRACE_ON = 'X' siehe RSXPGDEF EXTPGM_STDERR_IN_JOBLOG = 'X' Dokumentation für EXTPGM-Optionen EXCEPTIONS INVALID_JOBDATA = 02 JOBNAME_MISSING = 03 JOB_NOTEX = 04 JOB_SUBMIT_FAILED = 05 LOCK_FAILED = 06 PROGRAM_MISSING = 07 PROG_ABAP_AND_EXTPG_SET = 08 BAD_XPGFLAGS = 09 OTHERS = 99. IF SY-SUBRC > 0. <Fehlerverarbeitung> ENDIF. April

34 SAP AG Programmbeispiel: Job-Step mit ABAP SUBMIT hinzufügen Programmbeispiel: Job-Step mit ABAP SUBMIT hinzufügen * * Job-Step hinzufügen: ABAP-Schlüsselwort SUBMIT * SUBMIT ist eine voll kompatible Alternative zum * Funktionsbaustein JOB_SUBMIT. SUBMIT ermöglicht es, * eine Variante anzugeben oder Parameterwerte direkt * anzugeben. Siehe hierzu auch die ABAP-Syntax- * Dokumentation (help submit im ABAP-Editor). * SUBMIT REPORTNAME AND RETURN USER SY-UNAME Benutzer für Laufzeitberechtigungen VIA JOB JOBNAME NUMBER JOBNUMBER Job-Name und Job-Nummer aus JOB_OPEN TO SAP-SPOOL Druck- und Archivierungsoptionen aus GET_PRINT_PARAMETERS Beide Optionen stammen aus GET_PRINT_PARAMETERS SPOOL PARAMETERS USER_PRINT_PARAMS ARCHIVE PARAMETERS USER_ARC_PARAMS WITHOUT SPOOL DYNPRO. 34 April 2001

35 SAP AG Programmbeispiel: Sofort-Start mit JOB_CLOSE Programmbeispiel: Sofort-Start mit JOB_CLOSE * * Job zur Verarbeitung übergeben: Sofort-Start * CALL FUNCTION 'JOB_CLOSE' EXPORTING JOBCOUNT = JOBNUMBER Job-Identifikation: Nummer JOBNAME = JOBNAME und Name. STRTIMMED = 'X' Plant Job für Sofort-Start ein. Der Job wird nur sofort gestartet, wenn der Benutzer die Berechtigung RELE hat, die für die Freigabe eines Jobs erforderlich ist. IMPORTING JOB_WAS_RELEASED = JOB_RELEASED " Wenn der Benutzer eine " Freigabeberechtigung hat, " wird der Job bei der Ein- " planung automatisch frei- " gegeben. Das Feld ist auf " 'x' gesetzt, wenn der Job " freigegeben wurde. " Andernfalls wird der Job " zwar eingeplant, muß aber " von einem Verwalter frei- " gegeben werden, damit er " gestartet werden kann. EXCEPTIONS * CANT_START_IMMEDIATE Nicht mehr verwendet. Wurde ersetzt * durch IMPORTING-Parameter * JOB_WAS_RELEASED. INVALID_STARTDATE = 01 JOBNAME_MISSING = 02 JOB_CLOSE_FAILED = 03 JOB_NOSTEPS = 04 JOB_NOTEX = 05 LOCK_FAILED = 06 OTHERS = 99. IF SY-SUBRC > 0. <Fehlerverarbeitung> ENDIF. April

36 SAP AG Programmbeispiel: Sofortiger Start mit Mail-Empfänger von Spoolaufträgen Programmbeispiel: Sofortiger Start mit Mail-Empfänger von Spoolaufträgen Mit Release 4.0 können Sie automatisch von einem Hintergrund-Job erstellte Spoolaufträge an einen SAPoffice-Benutzer senden. Das folgende Programmbeispiel zeigt, wie Sie die SWOTOBJID-Struktur erzeugen, die JOB_CLOSE benötigt, um den SAPoffice-Benutzer zu identifizieren. Weitere Informationen finden Sie in der ABAP-Dokumentation zur Programmierung mit Business-Object-Repository- Objekten. INCLUDE LBTCHDEF. * * Business-Object-Repository-Objekt einfügen INCLUDE <CNTN01>. DATA BEGIN OF LOCAL_JOB. INCLUDE STRUCTURE TBTCJOB. DATA END OF LOCAL_JOB. DATA BEGIN OF LOCAL_STEP_TBL OCCURS 10. INCLUDE STRUCTURE TBTCSTEP. DATA END OF LOCAL_STEP_TBL. * * Datendeklarationen für den Mail-Empfänger DATA RECIPIENT TYPE SWC_OBJECT. DATA RECIPIENT_OBJ LIKE SWOTOBJID. SWC_CONTAINER CONTAINER. * Datendeklarationen für den Hintergrund-Job EXECHOST LIKE SY-HOST DEFAULT 'host1', EXESERVR LIKE BTCTGTSRVR-SRVNAME DEFAULT 'host1_sid_00', ABAPNAME LIKE SY-REPID DEFAULT 'Program2run', EMPFNAME LIKE SY-UNAME DEFAULT 'JSmith'. * Empfängerobjekt generieren (siehe als Beispiel Report RSSOKIF1) *** 1. Empfänger erstellen: IF EMPFNAME <> SPACE. "** 1.1 Objektreferenz auf ein Empfängerobjekt erzeugen SWC_CREATE_OBJECT RECIPIENT 'RECIPIENT' SPACE. "** 1.2 Importparameter für Methode "** recipient.createaddress in Container schreiben "** und Container leeren SWC_CLEAR_CONTAINER CONTAINER. "** Adreßelement einstellen (interner Benutzer 'JMEIER') SWC_SET_ELEMENT CONTAINER 'AddressString' EMPFNAME. "** Adreßtyp einstellen (interner Benutzer) SWC_SET_ELEMENT CONTAINER 'TypeId' 'B'. 36 April 2001

37 SAP AG Programmbeispiel: Sofortiger Start mit Mail-Empfänger von Spoolaufträgen "** 1.3 Methode recipient.createaddress aufrufen SWC_CALL_METHOD RECIPIENT 'CreateAddress' CONTAINER. "** Etwaige Fehlermeldung von Methodenausnahme ausgeben IF SY-SUBRC NE 0. MESSAGE ID SY-MSGID TYPE 'E' NUMBER SY-MSGNO. ENDIF. SWC_CALL_METHOD RECIPIENT 'Save' CONTAINER. SWC_OBJECT_TO_PERSISTENT RECIPIENT RECIPIENT_OBJ. ENDIF. *** Empfänger wurde angelegt und kann in einem Hintergrund-Job *** verwendet werden CALL FUNCTION 'JOB_OPEN'... CALL FUNCTION 'JOB_SUBMIT'... IF EMPFNAME <> SPACE. CALL FUNCTION 'JOB_CLOSE' EXPORTING JOBCOUNT JOBNAME STRTIMMED TARGETSYSTEM TARGETSERVER RECIPIENT_OBJ IMPORTING JOB_WAS_RELEASED EXCEPTIONS CANT_START_IMMEDIATE = 1 INVALID_STARTDATE = 2 JOBNAME_MISSING = 3 JOB_CLOSE_FAILED = 4 JOB_NOSTEPS = 5 JOB_NOTEX = 6 LOCK_FAILED = 7 OTHERS = 8. = LOCAL_JCOUNT = LOCAL_JOBNAME = 'X' = EXECHOST = EXESERVR = RECIPIENT_OBJ = JOBLOS IF ( SY-SUBRC <> 0). WRITE: / 'Job_Close(empfname) Problem:', SY-SUBRC. ELSE. WRITE: / 'Job_Close(empfname) done'. ENDIF. ELSE. "no empfname... ENDIF. April

38 SAP AG Programmbeispiel: Startzeit-Fenster mit JOB_CLOSE Programmbeispiel: Startzeit-Fenster mit JOB_CLOSE * * Job übergeben: Startzeit-Fenster definiert, mit periodischer * Wiederholung und Zielsystem, auf dem der Job ausgeführt werden * soll. * * In diesem Fall müssen Sie Angaben zum Startzeitpunkt machen. * Sie können den Job sofort mit einem JOB_CLOSE-Parameter * starten, den Startzeitpunkt selbst festlegen oder den Benutzer * den Startzeitpunkt mit BP_START_DATE_EDITOR festlegen lassen. * * Beispiel: Startangaben selbst festlegen. * STARTDATE = ' '. STARTTIME = '160000'. LASTSTARTDATE = ' '. LASTSTARTTIME = '180000'. CALL FUNCTION 'JOB_CLOSE' EXPORTING JOBCOUNT = JOBNUMBER Job-ID: Nummer und JOBNAME = JOBNAME Name. SDLSTRTDT = STARTDATE Start des Startzeit- SDLSTRTTM = STARTTIME Fensters LASTSTRTDT = LASTSTARTDATE Optional: Ende des LASTSTRTTM = LASTSTARTTIME Startzeit-Fensters PRDMONTHS = '1' Neustart bei Intervallen der PRDWEEKS = '1' Summe der PRD*-Parameter PRDDAYS = '1' PRDHOURS = '1' PRDMINS = '1' STARTDATE_RESTRICTION = BTC_DONT_PROCESS_ON_HOLIDAY Job-Start auf Arbeitstage beschränken; Job nicht an Feiertagen starten. Andere Werte: BTC_PROCESS_BEFORE_HOLIDAY BTC_PROCESS_AFTER_HOLIDAY CALENDAR_ID = '01' ID des R/3-Fabrikkalenders TARGETSYSTEM = 'hs0011' zur Ermittlung der Arbeitstage Optional: Name des Hostsystems, auf dem der Job ausgeführt werden soll. Nur setzen, wenn unbedingt erforderlich. Beispiel: Auf das erforderliche Laufwerk kann nur von einem bestimmten Hostsystem aus zugegriffen werden. IMPORTING JOB_WAS_RELEASED = JOB_RELEASED " Wenn der Benutzer die " Freigabeberechtigung hat, 38 April 2001

39 SAP AG Programmbeispiel: Startzeit-Fenster mit JOB_CLOSE EXCEPTIONS INVALID_STARTDATE = 01 JOBNAME_MISSING = 02 JOB_CLOSE_FAILED = 03 JOB_NOSTEPS = 04 JOB_NOTEX = 05 LOCK_FAILED = 06 OTHERS = 99. " wird der Job bei der Ein- " planung automatisch frei- " gegeben. Dieses Feld wird " auf 'x' gesetzt, wenn der " Job freigegeben wurde. " Andernfalls wird der Job " zwar eingeplant, muß aber " von einem Verwalter frei- " gegeben werden, damit er " gestartet werden kann. IF SY-SUBRC > 0. <Fehlerverarbeitung> ENDIF. April

40 SAP AG Programmbeispiel: Job-Start an einem Arbeitstag (JOB_CLOSE) Programmbeispiel: Job-Start an einem Arbeitstag (JOB_CLOSE) * Start an einem bestimmten Arbeitstags eines Monats in * Übereinstimmung mit dem Fabrikkalender. * * In diesem Beispiel werden der Arbeitstag und seine Nummer * vorgegeben. Diese Angaben könnten auch mit BP_START_DATE_EDITOR * vom Benutzer ermittelt werden. * CALL FUNCTION 'JOB_CLOSE' EXPORTING CALENDAR_ID = '01' " ID des R/3-Fabrikkalenders " zur Bestimmung der Arbeitstage JOBCOUNT = JOBNUMBER JOBNAME PRDMONTHS = JOBNAME = 1 Angabe, ob Job z. B. monatlich oder zweimal im Monat wiederholt werden soll. Andere PRD*-Felder dürfen nicht verwendet werden. Sie werden ignoriert. START_ON_WORKDAY_NOT_BEFORE = SY-DATUM " Job nicht vor angegebenem Datum " starten (heutiges Datum) START_ON_WORKDAY_NR = '03' " Job am dritten Arbeitstag des Fabrik- " kalenders starten, ab Monats- " anfang oder Monatsende, wie in " workday_count_direction angegeben. WORKDAY_COUNT_DIRECTION = BTC_BEGINNING_OF_MONTH " Angabe, ob Arbeitstagnummer sich nach " Monatsanfang oder Monatsende richtet. " Zulässige Werte: " - BTC_BEGINNING_OF_MONTH: Dritter " Arbeitstag nach Monatsanfang " - BTC_END_OF_MONTH: Dritter " Arbeitstag vor Monatsende IMPORTING JOB_WAS_RELEASED = JOB_RELEASED Prüfung, ob Job freigegeben wurde. EXCEPTIONS INVALID_STARTDATE = 2 JOBNAME_MISSING = 3 JOB_CLOSE_FAILED = 4 JOB_NOSTEPS = 5 JOB_NOTEX = 6 LOCK_FAILED = 7 OTHERS = April 2001

41 SAP AG Programmbeispiel: Job-Start bei Ereignis (JOB_CLOSE) Programmbeispiel: Job-Start bei Ereignis (JOB_CLOSE) * * Job zur Verarbeitung übergeben: Job soll gestartet werden, wenn * das angegebene Ereignis eintritt. * CALL FUNCTION 'JOB_CLOSE' EXPORTING JOBCOUNT = JOBNUMBER Job-ID: Nummer JOBNAME = JOBNAME und Name. EVENT_ID = 'EVENT_NAME' Name des Ereignisses, auf das der Job warten soll. EVENT_PARAM = 'Zusätzlicher qualifizierender Wert' EVENT_PERIODIC = 'X' Job neu starten, wenn Ereignis ausgelöst wird. EXCEPTIONS CANT_START_IMMEDIATE = 01 INVALID_STARTDATE = 02 JOBNAME_MISSING = 03 JOB_CLOSE_FAILED = 04 JOB_NOSTEPS = 05 JOB_NOTEX = 06 LOCK_FAILED = 07 OTHERS = 99. IF SY-SUBRC > 0. <Fehlerverarbeitung> ENDIF. April

42 SAP AG Programmbeispiel: Mit JOB_CLOSE auf Vorgänger-Job warten Programmbeispiel: Mit JOB_CLOSE auf Vorgänger-Job warten * Start bei erfolgreicher Beendigung des Vorgänger-Jobs. In * diesem Beispiel wählt der Benutzer den Vorgänger-Job aus * einer Job-Liste aus. Die Jobs werden mit BP_JOB_SELECT * ausgewählt und mit BP_JOBLIST_PROCESSOR zur Auswahl * angezeigt. * * Wichtig: Wenn Sie einen Vorgänger-Job direkt in Ihrem Programm * angeben (nicht interaktiv gewählt), achten Sie darauf, daß * der Vorgänger-Job den Status Eingeplant oder Freigegeben * aufweist, wenn Sie den Nachfolger-Job einplanen. Anderenfalls * schlägt die Einplanung des Nachfolger-Jobs fehl. Das heißt, * ein Job, der aktiv oder bereits abgeschlossen ist, kann nicht * als Vorgänger-Job angegeben werden. * * Datendeklarationen: BP_JOB_SELECT und BP_JOBLIST_PROCESSOR * DATA JSELECT LIKE BTCSELECT. DATA SEL_JOBLIST LIKE TBTCJOB OCCURS 100 WITH HEADER LINE. DATA SELECTED_JOB LIKE TBTCJOB * Job-Liste wie mit Transaktion zur Hintergrundverwaltung * (SM37) generieren. * Beispielauswahlkriterien * JSELECT-JOBNAME = 'NAME OF JOB'. JSELECT-JOBCOUNT = '<Job-Nummer>'. JSELECT-USERNAME = SY-UNAME. CALL FUNCTION 'BP_JOB_SELECT' EXPORTING JOBSELECT_DIALOG = BTC_YES Benutzer Liste anzeigen JOBSEL_PARAM_IN = JSELECT Standardkriterien für Job-Auswahl IMPORTING JOBSEL_PARAM_OUT TABLES JOBSELECT_JOBLIST EXCEPTIONS INVALID_DIALOG_TYPE = 1 JOBNAME_MISSING = 2 NO_JOBS_FOUND = 3 SELECTION_CANCELED = 4 USERNAME_MISSING = 5 OTHERS = 99. = JSELECT Benutzerkriterien für Job-Auswahl = SEL_JOBLIST * * Der Benutzer muß einen Job aus der Liste auswählen. Der 42 April 2001