Entire Operations im Batch-Modus

Dieses Kapitel beschreibt die Dateien und Kommandos, die Sie für die Ausführung von Entire Operations-Funktionen im Batch-Modus aus einer Windows-Umgebung benötigen.

• Dateien für den Start von Entire Operations im Batch-Modus

• Dateien für den Start des Batch Command Client

• Kommando-Syntax für den Batch Command Client

• Kommandos für den Batch Command Client

Dateien für den Start von Entire Operations im Batch-Modus

Folgende Dateien werden für den Start von Entire Operations im Batch-Modus benötigt:

1. Eine Windows-Batch-Datei (Erweiterung: .bat)

2. Eine Kommandodatei (Erweiterung: .cmd)

3. Eine Datei mit Eingabedaten (Input Data, Erweiterung: .inp)

Im Natural-Verzeichnis SYSSATGF/RES befinden sich entsprechende Beispieldateien: exportapi.bat, exportapi.cmd und exportapi.inp

• exportapi.bat

• exportapi.cmd

• exportapi.inp

• Kommando-Syntax für EXPORT DIAGRAM

• Von dem Kommando EXPORT DIAGRAM generierte Dateien

• Entire Systems Management in Batch Mode starten

exportapi.bat

"C:\SoftwareAG\Natural\bin\nderun.exe"  BATCHMODE 
PARM=SYSESM2  CMSYNIN="C:\exportapi.cmd" CMOBJIN="C:\exportapi.inp" 
CMPRINT="C:\exportapi.out" BMSIM=MF  NATLOG=OFF

Es wird empfohlen, dass Sie nur die letzten drei Parameter ändern.

exportapi.cmd

LOGON SYSSATGF
 ESSTRPCD
 FIN

Dabei ist SYSSATGF der Name der Bibliothek, aus der Entire Operations gestartet werden soll.

Es wird empfohlen, dass Sie diesen Parameter und den Inhalt dieser Datei nicht ändern.

exportapi.inp

/* Maximum line length: 249. 
/* Blank lines are not allowed. 
/* Comment lines must begin with "/*".
/*
/* Input delimiter character (= ID parameter) separates user IDs from 
/* passwords or substitutes them. Default is ",".
/*
/* First coded line must contain: 
/* <natural-security-userid><input-delimiter-character><natural-security-password>
/* (or <input-delimiter-character> only)
/*
/* Second coded line must contain: 
/* <entirex-userid><input-delimiter-character><entirex-password>
/* (or <input-delimiter-character> only)
/*
/* Parameter definitions must conform to the direct command syntax. 
/*
/* File must end with the END statement; lines that follow are ignored.
/*
NSC-USERID,NSC-PSW-38292076742878722694553347482051
,
/*
FOCUS TO SYSOGC
/*
/*---- Start of direct commands
/*
EXPORT DIAGRAM OWNER=EXAMPLE NETWORK=B60-FLOW FORMAT=JPG PREFIX=C:\
/*
/* --- End of direct commands
/*
END

Dies ist die Hauptdatei, die Sie gemäß Ihren Erfordernissen ändern können.

Generelle Syntax-Erfordernisse:

• Die Zeilenlänge darf maximal 249 Zeichen betragen.

• Leerzeilen sind nicht zulässig.

• Kommentare müssen mit der Zeichenfolge /* beginnen.

• Parameterdefinitionen müssen der Direktkommando-Syntax entsprechen.

Syntax-Beschreibung:

,
ENTIREX-USERID,
FOCUS TO SYSOGC
...

Kommando-Syntax für EXPORT DIAGRAM

Allgemeine Syntax:

Syntax-Beschreibung:

EXAMPLE,
EX*, 
*

NET01,
NET*, 
*

23, 
*, 
12:23

vTest, 
vTe*,

Ein Platzhalterzeichen (*) ist nur zulässig in Parametern, mit denen Eigentümer, Netzwerk, Version und Lauf definiert werden. Wenn Sie mehrere solcher Parameter definieren, können Sie nur im ersten Parameter ein Platzhalterzeichen (*) benutzen (alle übrigen Platzhalterzeichen werden danach ignoriert).

Beispiele für gültige Kommandos:

Beispiele für ungültige Kommandos:

Von dem Kommando EXPORT DIAGRAM generierte Dateien

Dateinamen werden von dem Kommando EXPORT DIAGRAM gemäß der Kommandoeingabesequenz wie folgt erstellt:

prefix_owner_network_version_run.format

Regeln für Pfadnamen und Verzeichnisse

Das Standardpräfix für den Dateinamen ist: EXDIAGRAM_owner_network_version_run.format

Wird kein Präfix angegeben, dann wird standardmäßig %temp%/ verwendet.

Wenn das Präfix nicht mit einem umgekehrten Schrägstrich (\) oder einem Schrägstrich (/) endet, wird stattdessen ein Unterstrich (_) in den Pfadnamen generiert.

Eine relative Pfadangabe ist nicht zulässig.

Ein angegebenes Verzeichnis muss existieren.

Beispiele für Dateien, die von einem Kommando generiert wurden

1. EXPORT DIAGRAM OWNER=EXAMPLE network=NET01 run=23 format=JPG prefix="C:\temp\Export graphic via batch\"

   Generiert:

   C:\temp\Export graphic via batch\EXDIAGRAM_EXAMPLE_NET01_23.JPG

2. EXPORT DIAGRAM OWNER=EXAMPLE network=NET* format=JPG prefix="C:\temp\Export graphic via batch\pref"

   Generiert:

   C:\temp\Export graphic via batch\pref_EXAMPLE_NET01.JPG

   C:\temp\Export graphic via batch\pref_EXAMPLE_NET02.JPG

   C:\temp\Export graphic via batch\pref_EXAMPLE_NET03.JPG

Entire Systems Management in Batch Mode starten

Um Entire Systems Management in Batch Mode zu starten:

1. Passen Sie die Beispiel-Dateien entsprechend Ihren Erfordernissen an (SYSSATGF/RES: exportapi.bat, exportapi.cmd, exportapi.inp).

2. Starten Sie die Datei .bat.

3. Zeigen Sie die Datei .out (Datei exportapi.out) an, um die Ergebnisse und die Ausgabemeldungen sehen zu können.

Falls ein Fehler aufgetreten ist, prüfen Sie, ob Entire Systems Management mit den richtigen Parametern im Normal-Modus gestartet wurde.

Dateien für den Start des Batch Command Client

Folgende Dateien werden für den Start des Batch Command Client von Entire Systems Management benötigt:

1. Eine Windows-Batch-Datei (Erweiterung: .bat)

2. Eine Kommandodatei (Erweiterung: .cmd)

Beispieldateien batchClientCommand.bat und batchClientReports.xml befinden sich im Verzeichnis SYSSATGF/RES.

Dieser Abschnitt behandelt folgende Themen:

• batchClientCommand.bat

• batchClientReports.xml

batchClientCommand.bat

SET dirNatural=<natural-product-directory>
SET ESM_BCC_IN=<natural-fnat-directory>\SYSOGC\RES\batchClientReports.xml
SET ESM_BCC_OUT=<user-temp-directory>\batchClientReports_out.xml

"%dirNatural%\bin\nderun.exe" : PARM=SYSESM2 STACK=(LOGON SYSSATGF;ESSTBC-P;FIN)

Dabei sind:

Umgebungsvariablen:

batchClientReports.xml

<?xml version="1.0" encoding="utf-8" ?>
<ESM_Batch_Command_Client xmlns="http://www.softwareag.com/ESM/sat34">
  <RPC User="<userid>" Password="<password>"/>
  <EXX ServerName="<server-name>" ServerNode="<server-node>"/>
  <ESM ApplicationID="OP" Language="2">
    <Command Object="Reports" Name="List">
      <Parameter Name="Filter_Status">Completed</Parameter>
    </Command>
  </ESM>
</ESM_Batch_Command_Client>

Dabei ist:

Kommando-Syntax für den Batch Command Client

Der Batch Command Client von Entire Systems Management wird unter Verwendung einer XML-Datei programmiert. Die in XML-Dokumenten verwendete Syntax ist einfach und selbsterklärend:

• In der ersten Zeile steht die XML-Deklaration. Sie definiert die XML-Version (1.0) und die verwendete Codierung.

• In der zweiten Zeile wird das Root-Element des Dokuments beschrieben. Es ist das "Parent"-Element für alle anderen Elemente. Die "Child"-Elemente enthalten die Beschreibungen der weiteren Daten bzw. in diesem Fall hier Verarbeitungsdaten.

• Die letzte Zeile definiert das Ende des Root-Elements.

• Bei allen Tags und Attribute in der XML-Datei ist auf Groß-/Kleinschreibung zu achten.

Hinweise zur Codierung

• Falls keine Codierung angegeben ist, wird davon ausgegangen, dass das XML-Dokument nur Standard-ASCII-Zeichen enthält.

• Sonderzeichen wie zum Beispiel die deutschen Umlaute ü oder ä sind dann nicht gültig.

• Wenn Sie Sonderzeichen verwenden möchten, müssen Sie die entsprechende Codierung angeben.

• Benutzen Sie zum Bearbeiten einer XML-Datei einen Editor, der Codierung unterstützt. Achten Sie darauf, dass Sie bei der Bearbeitung dieselbe Codierung benutzen, die im Encoding-Attribut angegeben ist. Andernfalls kann es vorkommen, dass das Dokument nicht geladen wird oder dass Ihre Daten falsch interpretiert werden.

DTD-Eingabedatei

<!ELEMENT ESM_Batch_Command_Client (RPC, EXX?, ESM)>
<!ATTLIST ESM_Batch_Command_Client 
  xmlns             CDATA #FIXED "http://www.softwareag.com/ESM/SAT34"
>

<!ELEMENT RPC EMPTY>
<!ATTLIST RPC    
  Password          CDATA #REQUIRED
  User              CDATA #REQUIRED
>
<!ELEMENT EXX EMPTY>
<!ATTLIST EXX
  ServerName        CDATA #REQUIRED
  ServerNode        CDATA #REQUIRED
  Password          CDATA #IMPLIED
  User              CDATA #IMPLIED
>

<!ELEMENT ESM ( Command+ )>
<!ATTLIST ESM
  ApplicationID     CDATA #REQUIRED
  Language          CDATA #REQUIRED
  DeterminationDate CDATA #IMPLIED 	
  ServerLibrary     CDATA #IMPLIED
>

<!ELEMENT Command (Parameter*)>
<!ATTLIST Command 
  Object            CDATA #IMPLIED
  Name              CDATA #REQUIRED
>

<!ELEMENT Parameter (#PCDATA)>
<!ATTLIST Parameter 
  Name              CDATA #REQUIRED>

Bedeutung der Tags

Die Tags werden nachfolgend erklärt.

Anmerkung zu den Formaten

Die nachfolgenden Tabellen enthalten eine Spalte, die mit "Format" beschriftet ist. Die in dieser Spalte aufgeführten Formate basieren auf der Definition von Natural-Benutzervariablen. Zusätzlich wird das Format "enum" verwendet, wenn nur eine feste Zeichenkette aus einer Werteliste benutzt werden kann. "const" dient zur Angabe einer festen alphanumerischen Zeichenkette (Fomat A).

• Tag <Command>

• Tag <ESM_Batch_Command_Client>

• Tag <ESM>

• Tag <EXX>

• Tag <Parameter>

• Tag <RPC>

Tag <Command>

Der Tag <Command> definiert die zu verarbeitenden Kommandos. Das Element enthält das Child-Element <Parameter>.

Folgende Attribute sind verfügbar:

Beispiel:

<Command Object="Reports" Name="List"/>

Ausgabe

<Command Object="Reports" Name="List">

</Command>

Tag <ESM_Batch_Command_Client>

Der Tag <ESM_Batch_Command_Client> definiert das XML-Dokument, das alle Einstellungen und die Abfolge der zu verarbeitenden Kommandos liefert. Zurzeit ist es nur möglich, Entire Operations-Kommandos zu verarbeiten, die im Zusammenhang mit dem Erstellen von Berichten stehen. Der Standard-Namensraum ("xmlns "-Attribut) des Dokuments definiert, dass die verwendeten Elemente zur Batch Command Client-Anwendung von Entire Systems Management gehören.

Folgende Attribute sind verfügbar:

Beispiel eines XML-Dokuments mit Codierungseinstellung und Root-Element:

<?xml version="1.0" encoding="utf-8" ?>
<ESM_Batch_Command_Client xmlns="http://www.softwareag.com/ESM/SAT34">
  

</ESM_Batch_Command_Client>

Tag <ESM>

Der Tag <ESM> definiert die Einstellung für die Entire Systems Management-Anwendung.

Folgende Attribute sind verfügbar:

Beispiel:

<ESM ApplicationID="OP" Language="2"/>

Ausgabe

<?xml version="1.0" encoding="windows-1252" ?>
<Commands ApplicationID="OP" ApplicationName="Entire Operations" ApplicationLibrary="SYSOGC" ApplicationVersion="0504010000">   

</Commands>

Tag <EXX>

Der Tag <EXX> definiert die EntireX-Einstellungen. Der Server wird definiert durch die Einstellungen ServerName und ServerNode. Diese Einstellungen entsprechen den Einstellungen des Natural-Profilparameters PROFILE für Entire Systems Management (siehe Natural-Konfigurationsdatei SYSESM2).

Folgende Attribute sind verfügbar:

Beispiel:

<EXX ServerName="NOP54SRV" ServerNode="bkr034:3800:TCP"/>

Tag <Parameter>

Der Tag <Parameter> definiert einen Parameter für ein Kommando.

Folgende Attribute sind verfügbar:

Beispiel:

<Command Object="Reports" Name="List">
  <Parameter Name="Filter_Status">Completed</Parameter>
</Command>

Tag <RPC>

Der Tag <RPC> definiert die Einstellung für das Natural-RPC-Kommando.

Folgende Attribute sind verfügbar:

Beispiel:

<RPC User="<user>" Password="<password>"/>

Kommandos für den Batch Command Client

Dieser Abschnitt beschreibt die Kommandos, die beim Batch Command Client von Entire Systems Management zur Verfügung stehen.

• Verwendung von Platzhalterzeichen

• Command - Object: Reports - Name: List

• Command - Object: Reports - Name: SaveToFile

• Command - Object: CrossReferences - Name: SaveToFile

• Command - Object: Reports - Name: Add

• Command - Object: Reports - Name: Delete

• Command - Object: - Name: DeterminationDate

• Command - Object: - Name: Language

• Command - Object: - Name: Stop

• Behandlung von Variablen

• Funktionalität Relatives Datum

Verwendung von Platzhalterzeichen

Das Platzhalterzeichen muss das letzte Zeichen in einem Variablenwert sein, der einen Namensbereich definiert.

Verwendung von Platzhalterzeichen (Eigentümer, Netzwerk, Symboltabelle, Version)

Jedes Objekt wird entsprechend seiner Namensraumbestandteile referenziert. Nur der letzte Teil des Namensraums kann durch ein Platzhalterzeichen erweitert werden.

Beispiel einer gültigen Angabe

<Owner>EXAMPLE</Owner>
<Network>*</Network>

Beispiele für ungültige Angaben

<Owner>EXAMPLE</Owner>
<Network>E*</Network>
<NetworkVersion>v2*</NetworkVersion>

<Owner>EXAMPLE</Owner>
<NetworkVersion>v2*</NetworkVersion>

<Owner>E*</Owner>
<NetworkVersion>v2*</NetworkVersion>

Command - Object: Reports - Name: List

Das Kommando List wertet die Daten aus der Liste der Berichte aus. Es dient hauptsächlich für folgende Zwecke:

• Auswahl bestimmter Berichte durch Angabe von Filterkriterien, um z.B. die ausgewählten Berichte zu löschen.

• Warten auf die Beendigung einer Bericht-Generierung mit Status "abgebrochen" oder "beendet", z.B. um beendete Berichte als Datei zu speichern.

Der Tag <Parameter> definiert die Parameter für ein Kommando.

Beispiele:

<Command Object="Reports" Name="List">
  <Parameter Name="Filter_Status">Completed</Parameter>
</Command>

<Command Object="Reports" Name="List">
  <Parameter Name="WaitID ">%new_ID%</Parameter>
  <Parameter Name="AutoRefresh_Retries">20</Parameter>
  <Parameter Name="AutoRefresh_Interval">5</Parameter>
</Command>

Ausgabe:

<Command Object="Reports" Name="List">
  <Filter Name="Status">Completed"</Filter>
  <Report>
    <ID>3092265</ID>
    <Status>Completed</Status>
    <Type ShortType="LGT">Log - Terminated Jobs</Type>
    <Creation><Date Format="G">20131115</Date><Time>155134</Time></Creation>
  </Report>
  <Report>
    <ID>3092267</ID>
    <Status>Completed</Status>
    <Type ShortType="LGB">Log - Abended Jobs</Type>
    <Creation><Date Format="G">20131115</Date><Time>155136</Time></Creation>

<Command Object="Reports" Name="List">
  <Filter Name="Status">Completed"</Filter>
  <Report>
    <ID>3092265</ID>
    <Status>Completed</Status>
    <Type ShortType="LGT">Log - Terminated Jobs</Type>
    <Creation><Date Format="G">20131115</Date><Time>155134</Time></Creation>
  </Report>
  <Report>
    <ID>3092267</ID>
    <Status>Completed</Status>
    <Type ShortType="LGB">Log - Abended Jobs</Type>
    <Creation><Date Format="G">20131115</Date><Time>155136</Time></Creation>
  </Report>
  <Report>
    <ID>3092268</ID>
    <Status>Completed</Status>
    <Type ShortType="LGX">Log - Jobs not started</Type>
    <Creation><Date Format="G">20131115</Date><Time>155138</Time></Creation>
  </Report>
</Command>

<Command Object="Reports" Name="List">
  <WaitFor ID="3190047"/>
  <AutoRefresh Interval="10">
    <Retry Loop="0">07:09:51.0</Retry>
    <Retry Loop="1">07:10:01.2</Retry>
    <Retry Loop="2">07:10:13.8</Retry>
    <WaitResult Retries="2">Completed</WaitResult>
  </AutoRefresh>
</Command>

Command - Object: Reports - Name: SaveToFile

Definition und Verwendung

Das Kommando SaveToFile speichert generierte Berichte mit Status "beendet" mit verschiedenen Ausgabeformaten als Datei.

Falls die Ausgabe im Formal XML erfolgt, kann zusätzlich ein Parameter XmlStylesheet angegeben werden. Dies kann als Ersatz für die Online-Formatangabe "XML mit Stylesheet für HTML" verwendet werden. Das Stylesheet muss manuell kopiert werden. Stylesheet-Beispiele befinden sich im Verzeichnis SYSOGC/RES. Die Dateinamen sind folgendermaßen strukturiert: REPNreport-name.xsl

Der Tag <Parameter> definiert die Parameter für das Kommando.

Beispiel:

<Command Object="Reports" Name="SaveToFile">
  <Parameter Name="ID">%new_ID_ACO%</Parameter>
  <Parameter Name="OutputType">HTML</Parameter>
  <Parameter Name="FileName">C:\ACO.html</Parameter>
</Command>

Ausgabe:

<Command Object="Reports" Name="SaveToFile">
  <Report ID="3190047" ShortType="LGY" OutputType="HTML"/>
  <ExportFile>D:\ESM\Reports\LGY.html</ExportFile>
</Command>

Command - Object: CrossReferences - Name: SaveToFile

Das Kommando SaveToFile ruft für das Objekt CrossReferences die benutzerabhängige Cross-Referenzen-Generierung auf. Die Generierung wird innerhalb des Entire Operations GUI Client aufgerufen.

Cross-Referenz-Typen

Typ-Kurzbezeichnung	Cross-Referenz *	Beschreibung
JCL	Verwendung von JCL	Welche JCL-Dateien werden in welchen Netzwerken benutzt.
NDU	Verwendung von Knoten	Wo werden JCL-Knoten und Ausführungsknoten benutzt.
RES	Ressourcen-Benutzung	Liste aktiver Jobs, die zurzeit eine Ressource benutzen.
XSM	Symbol- und Symbolwertsuche	Symbole nach Wert (oder einer Teilzeichenkette des Wertes) suchen.
STU	Verwendung von Symboltabellen	Verwendung von Symboltabellen in Netzwerken und Jobs.
CSV	Liste undefinierter Objekte	Objekte auflisten, die von anderen Objekten referenziert werden, aber nicht definiert sind.
URU	Verwendung von User Exits	Anzeige der definierten Exits (alle Typen).

* Weitere Informationen siehe Abschnitt Cross-Referenzen im Benutzerhandbuch.

Parameter für das Kommando

Der Tag <Parameter> definiert die Parameter für das Kommando.

Parameter	Format	Standardwert	Wert	Beschreibung
ShortType	enum		Eine gültige Typ-Kurzbezeichnung.	Typ der Cross-Referenz-Generierung
Owner	A10	*	Name eines Eigentümers in Großbuchstaben (letzte Zeichen können Platzhalterzeichen sein)
Network	A10		Name eines Netzwerks in Großbuchstaben (letzte Zeichen können Platzhalterzeichen sein)
NetworkVersion	A10		Name einer Netzwerk-Version (letzte Zeichen können Platzhalterzeichen sein)
SymbolTable	A10		Name einer Symboltabelle in Großbuchstaben (letzte Zeichen können Platzhalterzeichen sein)
SymbolTableVersion	A10		Version einer Symboltabelle (letzte Zeichen können Platzhalterzeichen sein)
UserExitUsage	enum		IC User Exits für Eingabebedingung RM User Exits zur Master-Ressource-Bestimmung MJ Master JCL und Natural-Programme EC User Exits zur Job-Ende-Prüfung EA User Exits für Job-Ende-Aktion SC User Exits für Symbolprüfung SP User Exits für Symbolabfrage	Geben Sie den Subtyp für die User-Exit-Benutzungs-Cross-Referenz ein.
UsageInActiveJobs	L	false	false Suche erfolgt in allen Jobs. true Suche erfolgt nur in aktiven Jobs.	Bestimmt, in welchen Jobs gesucht werden soll.
JCLLocation	enum		BS2 SAM- oder ISAM-Datei EXE Ausführbares Programm LIB Librarian LMS LMS-Bibliothek MAC Natural-Source-Objekt, das ein Makro-Programm enthält. s NAT Natural-Source-Objekt PDS Partitionierter Dataset PRC Aufrufbare Prozedur RDR z/VSE Reader Queue TXT Textdatei VSE z/VSE Sublibrary	Unterstützte JCL-Speicherart Sie können die Cross-Referenz auf eine beliebige unterstützte JCL-Speicherart einschränken oder ein Leerzeichen eingeben, um alle JCL-Speicherarten zu wählen.
FileNatlib	A54		Name einer Datei oder einer Natural-Bibliothek (letzte Zeichen können Platzhalterzeichen sein)
Member	A64		Name eines Member (letzte Zeichen können Platzhalterzeichen sein)
JCLNode_OpSysClass	enum		B BS2000 M z/OS (MVS) V z/VSE W Windows X UNIX	Betriebssystem für den angegebenen JCL-Knoten
JCLNode_NodeNumber	N5		Nummer eines Knotens	JCL-Knotennummer
ExecutionNode_OpSysClass	enum		B BS2000 M z/OS (MVS) V z/VSE W Windows X UNIX	Betriebssystem für den angegebenen Ausführungsknoten
ExecutionNode_NodeNumber	N5		Nummer eines Knotens	Knotennummer des Ausführungsknotens
UsageIn	enum		A Aktive Jobs M Master-Jobs	Verwendung in Jobs Beim ShortType XSM sind mehrere Werte erlaubt (Symbolsuche nach Wert).
Symbol	A40		Name (letzte Zeichen können Platzhalterzeichen sein)	Symbolname
MultValueMinIndex	N3	1	Minimalwert: 1 Maximalwert: 100	Minimaler Indexwert eines Symbols mit mehreren Werten.
MultValueMaxIndex	N3 / A1	*	Minimalwert: 1 Maximalwert: 100 Oder: *	Maximaler Indexwert eines Symbols mit mehreren Werten.
AtPosition	enum	*	* beliebige Position 1 am Anfang E am Ende	Position, bei der im Symbolwert gesucht werden soll.
ScanFor	A80		Gesuchter Symbolwert	Zeichenkette mit bis zu 80 Zeichen, nach der im Symbolwert gesucht werden soll.
CaseSensitive	L	false	true	Geben Sie true an, wenn bei der Suche zwischen Groß- und Kleinschreibung unterschieden werden soll, oder false, wenn nicht.
			false
ObjectTypeToBeValidated	enum	*	* Alle Objekttypen (Standardwert) SM Symbole S1 Symboltabellen NM Netzwerke JM Jobs RM Ressourcen SC Zeitpläne CA Kalender	Objekttyp oder Objekttypen, nach denen gesucht werden soll.
Resource	A40		Name einer Ressource (letzte Zeichen können Platzhalterzeichen sein)
FileName	A250		Gültiger Name einer lokalen Datei für das Betriebssystem	Name eines gültigen Verzeichnispfades, der angibt, wo der Report gespeichert wird.
OutputType	enum		HTML Datei im Format HTML XML Datei im Format XML CSV Datei mit durch Kommata abgetrennten Werten	Dokument-Typ des zu erstellenden Reports. Generell stehen die Typen Extensible Markup Language (XML) und HyperText Markup Language (HTML) zur Verfügung. Manche Reports können Sie auch als Datei mit durch Kommas abgetrennten Werten (CSV = comma-separated values) abspeichern.
XmlStylesheet	A		Uniform Resource Identifier (URI) zur Angabe einer absoluten oder relativen Adresse	Wenn ein URI angegeben wird und wenn der Report-Typ XML ist, dann wird eine Verarbeitungsanweisung mit einer Referenz auf ein externes Stylesheet zu dem generierten XML-Dokument hinzugefügt. Der Browser interpretiert dann die Verarbeitungsanweisung (<?xml-stylesheet…?>) und erzeugt aus dem XML automatisch per Rendering das angeforderte Dokument, z.B. im Format HTML. Stylesheets für alle Reporttypen befinden sich im Verzeichnis SYSOGC/RES der Natural-Systemdatei FNAT.

Parameter-Verwendung in Abhängigkeit vom Cross-Referenz-Typ

Cross-Referenz-Typ	CSV	JCL	NDU	RES	STU	URU	XSM
ShortType	X	X	X	X	X	X	X
Owner	X	X	X	X	X		X
Network	X	X	X	X
NetworkVersion	X	X	X	X
SymbolTable					X		X
SymbolTableVersion					X		X
Symbol							X
UserExitUsage						X
UsageInActiveJobs					X
JCLLocation		X
FileNatlib		X
Member		X
JCLNode_OpSysClass			X
JCLNode_NodeNumber			X
ExecutionNode_OpSysClass			X
ExecutionNode_NodeNumber			X				X
UsageIn			X				X
MultValueMinIndex							X
MultValueMaxIndex							X
AtPosition							X
ScanFor							X
CaseSensitive							X
ObjectTypeToBeValidated	X
Resource				X
FileName	X	X	X	X	X	X	X
OutputType	X	X	X	X	X	X	X
XmlStylesheet	X	X	X	X	X	X	X

DTD der generierten Ausgabe

<!ELEMENT Command (((Error+, CrossReference, Owner, Network, NetworkVersion, 
JCLLocation, FileNatlib, Member) | (CrossReference, (((UserExitUsage | (XmlStylesheet, 
Owner, SymbolTable, UsageInActiveJobs)), ExportFile) | (Owner, ((SymbolTable, 
(UsageInActiveJobs | (Symbol, UsageIn, MultValueMinIndex, MultValueMaxIndex, AtPosition, 
ScanFor, CaseSensitive)), ExportFile) | (Network, ((ObjectTypeToBeValidated+, ExportFile) | 
(NetworkVersion, (((Resource | (JCLLocation, FileNatlib, Member)), ExportFile) | 
(JCLNode_OpSysClass, JCLNode_NodeNumber, ExecutionNode_OpSysClass, 
ExecutionNode_NodeNumber, UsageIn)))))))))))>
<!ATTLIST Command
	Name CDATA #REQUIRED
	Object CDATA #REQUIRED
>
<!ELEMENT CaseSensitive (#PCDATA)>
<!ELEMENT AtPosition (#PCDATA)>
<!ATTLIST AtPosition
	ShortType CDATA REQUIRED
>
<!ELEMENT XmlStylesheet (#PCDATA)>
<!ELEMENT UserExitUsage (#PCDATA)>
<!ATTLIST UserExitUsage
	ShortType CDATA REQUIRED
>
<!ELEMENT UsageInActiveJobs (#PCDATA)>
<!ELEMENT UsageIn (#PCDATA)>
<!ATTLIST UsageIn
	ShortType CDATA #REQUIRED
>
<!ELEMENT SymbolTable (#PCDATA)>
<!ELEMENT Symbol EMPTY>
<!ELEMENT ScanFor EMPTY>
<!ELEMENT Resource EMPTY>
<!ELEMENT Owner (#PCDATA)>
<!ELEMENT ObjectTypeToBeValidated (#PCDATA)>
<!ATTLIST ObjectTypeToBeValidated
	ShortType CDATA #REQUIRED
>
<!ELEMENT NetworkVersion (#PCDATA)>
<!ELEMENT Network (#PCDATA)>
<!ELEMENT MultValueMinIndex (#PCDATA)>
<!ELEMENT MultValueMaxIndex (#PCDATA)>
<!ELEMENT Member (#PCDATA)>
<!ELEMENT JCLNode_OpSysClass EMPTY>
<!ELEMENT JCLNode_NodeNumber EMPTY>
<!ELEMENT JCLLocation (#PCDATA)>
<!ATTLIST JCLLocation
	ShortType CDATA REQUIRED
>
<!ELEMENT FileNatlib (#PCDATA)>
<!ELEMENT ExportFile (#PCDATA)>
<!ELEMENT ExecutionNode_OpSysClass (#PCDATA)>
<!ELEMENT ExecutionNode_NodeNumber (#PCDATA)>
<!ELEMENT Error (#PCDATA)>
<!ATTLIST Error
	Type CDATA #REQUIRED
>
<!ELEMENT CrossReference (#PCDATA)>
<!ATTLIST CrossReference
	OutputType (XML | HTML | CSV) #REQUIRED
	ShortType CDATA #REQUIRED
>

Kommando-Beispiele für Cross Reference SavetoFile

 <Command Name="SaveToFile" Object="CrossReferences">
          <Parameter Name="ShortType">JCL</Parameter>
          <Parameter Name="Owner">INCIDENT</Parameter>
          <Parameter Name="Network">*</Parameter>
          <Parameter Name="OutputType">HTML</Parameter>
          < Parameter Name="FileName">C:\temp\G_xRef_JclUsage.html</Parameter>
</Command>

<Command Name="SaveToFile" Object="CrossReferences">
          <Parameter Name="ShortType">NDU</Parameter>
          <Parameter Name="Owner">INCIDENT</Parameter>
          <Parameter Name="Network">*</Parameter>
          <Parameter Name="OutputType">HTML</Parameter>
          <Parameter Name="FileName">C:\temp\xRef_NodeUsage.html</Parameter>
</Command>

<Command Name="SaveToFile" Object="CrossReferences">
          <Parameter Name="ShortType">RES</Parameter>
          <Parameter Name="Owner">*</Parameter>
          <Parameter Name="OutputType">XML</Parameter>
          <Parameter Name="FileName">C:\temp\xRef_Resource_Usage.xml</Parameter>
</Command>

<Command Name="SaveToFile" Object="CrossReferences">
          <Parameter Name="ShortType">XSM</Parameter>
          <Parameter Name="Owner">INCIDENT</Parameter>
          <Parameter Name="SymbolTable">*</Parameter>
          <Parameter Name="OutputType">CSV</Parameter>
          <Parameter Name="FileName">C:\temp\xref_SearchSymbolByValue.csv</Parameter>
        </Command>

<Command Name="SaveToFile" Object="CrossReferences">
          <Parameter Name="ShortType">STU</Parameter>
          <Parameter Name="Owner">INCIDENT</Parameter>
          <Parameter Name="SymbolTable">*</Parameter>
          <Parameter Name="OutputType">CSV</Parameter>
          <Parameter Name="FileName">C:\temp\xRef_SymbolTableUsage.csv</Parameter>
 </Command>

<Command Name="SaveToFile" Object="CrossReferences">
          <Parameter Name="ShortType">NDF</Parameter>
          <Parameter Name="Owner">INCIDENT</Parameter>
          <Parameter Name="Network">*</Parameter>
          <Parameter Name="ObjectTypeToBeValidated">*</Parameter>
          <Parameter Name="OutputType">HTML</Parameter>
          <Parameter Name="FileName">C:\temp\xRef_UndefinedObjects.html</Parameter>
        </Command>

 <Command Name="SaveToFile" Object="CrossReferences">
          <Parameter Name="ShortType">URU</Parameter>
          <Parameter Name="UserExitUsage">EC</Parameter>
          <Parameter Name="OutputType">XML</Parameter>
          <Parameter Name="FileName">C:\temp\xRef_UserExitUsage_EC.xml</Parameter>
</Command>

Command - Object: Reports - Name: Add

Das Kommando Add ruft die benutzerabhängige Bericht-Generierung auf. Der Aufruf der Generierung erfolgt im Entire Operations GUI Client (OGC), die Generierung selbst erfolgt asynchron im Hintergrund durch den Entire Operations-Monitor. Die mit dem Batch Command Client angelegten Berichte können über die Berichte-Funktionen des Entire Operations GUI Client eingesehen werden.

Bericht-Typen

* Weitere Informationen siehe Kapitel Berichte im Benutzerhandbuch.

Parameter für das Kommando

Der Tag <Parameter> definiert die Parameter für das Kommando.

Parameter-Verwendung in Abhängigkeit vom Bericht-Typ

DTD der generierten Ausgabe

<!ELEMENT Command (Type, DeterminationDate?,
Owner, ((Network, NetworkVersion?) | (SymbolTable, SymbolTableVersion?))?, 
(Owner2, ((Network2, NetworkVersion2?) | (SymbolTable, SymbolTableVersion2?)))?, 
Job?, (Time, Run, Date)?, ScheduleType?, ActivationType?, Show?, Email?, Report)>
<!ATTLIST Command 
  Object            CDATA #REQUIRED
  Name              CDATA #REQUIRED
>

<!ELEMENT Type (#PCDATA)>
<!ELEMENT DeterminationDate (#PCDATA)>

<!ELEMENT Owner (#PCDATA)>
<!ELEMENT Network (#PCDATA)>
<!ELEMENT NetworkVersion (#PCDATA)>
<!ELEMENT SymbolTable (#PCDATA)>
<!ELEMENT SymbolTableVersion (#PCDATA)>

<!ELEMENT Owner2 (#PCDATA)>
<!ELEMENT Network2 (#PCDATA)>
<!ELEMENT NetworkVersion2 (#PCDATA)>
<!ELEMENT SymbolTable2 (#PCDATA)>
<!ELEMENT SymbolTableVersion2 (#PCDATA)>

<!ELEMENT Time (From, Thru)>
<!ELEMENT Run (From, Thru)>
<!ELEMENT Date (From, Thru)>
<!ELEMENT From (#PCDATA)>
<!ELEMENT Thru (#PCDATA)>
<!ELEMENT ScheduleType (#PCDATA)>
<!ELEMENT ActivationType (#PCDATA)>

<!ELEMENT Show (#PCDATA)>
<!ELEMENT Email (#PCDATA)>
<!ELEMENT Report (#PCDATA)>

Beispiele für Add-Kommandos

<Command Object="Reports" Name="Add">
  <Type ShortType="LGT">Log - Terminated Jobs</Type>
  <Owner>EXAMPLE</Owner>
  <Network>*</Network>
  <Job>*</Job>
  <Time><From>000000</From><Thru>070858</Thru></Time>
  <Run><From>1</From><Thru>99999</Thru></Run>
  <Date><From>20131118</From><Thru>20131118</Thru></Date>
  <Email>noreply@softwareag.com</Email>
  <Report ID="3190043"/>
</Command>

<Command Object="Reports" Name="Add">
  <Type ShortType="NDS">Network Description (short)</Type>
  <DeterminationDate>20131118</DeterminationDate>
  <Owner>HEB</Owner>
  <Network>AA</Network>
  <NetworkVersion>*</NetworkVersion>
  <Email>noreply@softwareag.com</Email>
  <Report ID="3190050"/>
</Command>

<Command Object="Reports" Name="Add>
  <Type ShortType="NSO">Network Schedule Overview</Type>
  <Owner>EXAMPLE</Owner>
  <Network>*</Network>
  <Date><From>20131118</From><Thru>20131118</Thru></Date>
  <ScheduleType>A</ScheduleType>
  <Email>noreply@softwareag.com</Email>
  <Report ID="3190058"/>
</Command>

<Command Object="Reports" Name="Add">
  <DeterminationDate>20131118</DeterminationDate>
  <Type ShortType="ACO">Activation Overview</Type>
  <Owner>EXAMPLE</Owner>
  <Network>*</Network>
  <Date><From>20131118</From><Thru>20131118</Thru></Date>
  <ActivationType>*</ActivationType>
  <Email>noreply@softwareag.com</Email>
  <Report ID="3190060"/>
</Command>

<Command Object="Reports" Name="Add">
  <Type ShortType="CST">Compare Symbol Tables</Type>
  <Owner>EXAMPLE</Owner>
  <SymbolTable>E20-ST</SymbolTable>
  <SymbolTableVersion>*</SymbolTableVersion>
  <Owner2>EXAMPLE</Owner2>
  <SymbolTable2>E20-ST-VSE</SymbolTable2>
  <SymbolTableVersion2>*</SymbolTableVersion2>
  <Show>A</Show>
  <Email>noreply@softwareag.com</Email>
  <Report ID="3190061"/>
</Command>

<Command Object="Reports" Name="Add">
  <Type ShortType="CNV">Compare Networks</Type>
  <Owner>EXAMPLE</Owner>
  <Network>B60-FLOWFX</Network>
  <NetworkVersion>*</NetworkVersion>
  <Owner2>EXAMPLE</Owner2>
  <Network2>B60-FLOW38</Network2>
  <NetworkVersion2>*</NetworkVersion2>
  <Show>A</Show>
  <Email>noreply@softwareag.com</Email>
  <Report ID="3190068"/>
</Command>

Command - Object: Reports - Name: Delete

Das Kommando Delete löscht Berichte aus der Liste der Berichte. Das Kommando wird am Besten in Verbindung mit dem Kommando List benutzt. Das Kommando List kann benutzt werden, um ein VariableArray zu erzeugen, das die Kennungen (IDs) der Liste der Berichte enthält, die mit dem Kommando Delete gelöscht werden können.

Der Tag <Parameter> definiert die Parameter für das Kommando.

Beispiel 1:

<Command  Object="Reports" Name="Delete">
  <Parameter Name="ID">3092265</Parameter>
  <Parameter Name="ID">3092267</Parameter>
  <Parameter Name="ID">3092268</Parameter>
  <Parameter Name="ID">3092271</Parameter>
</Command>

Ausgabe:

<Command Object="Reports" Name="Delete">
  <ReportDeleted ID="3092265"/>
  <ReportDeleted ID="3092267"/>
  <ReportDeleted ID="3092268"/>
  <ReportDeleted ID="3092271"/>
</Command>

Beispiel 2:

<Command Object="Reports" Name="List">
  <Parameter Name="Filter_Status">Completed</Parameter>
  <Parameter Name="returnID">all_Completed_Reports</Parameter>
</Command>

<Command Object="Reports" Name="Delete">
  <Parameter Name="ID">%all_Completed_Reports(*)%</Parameter>
</Command>

Ausgabe:

<Command Object="Reports" Name="Delete">
  <Filter Name="Status">Completed</Filter>
  <ReportList ID="2520730">
    <Status>Completed</Status>
    <Type ShortType="NSO"> Network Schedule Overview</Type>
    <Creation><Date Format="G">20131205</Date><Time>103305</Time></Creation>
  </ReportList>
  <ReportList ID="2520731">
    <Status>Completed</Status>
    <Type ShortType="ACO"> Activation Overview</Type>
    <Creation><Date Format="G">20131205</Date><Time>103307</Time></Creation>
  </ReportList>
</Command>

<Command Object="Reports" Name="Delete">
  <ReportDeleted ID="2520730"/>
  <ReportDeleted ID="2520731"/>
</Command>

Command - Object: - Name: DeterminationDate

Das Kommando DeterminationDate ändert das Auswertungsdatum, das zum Beispiel bei der Generierung der Berichte verwendet wird.

Der Tag <Parameter> definiert den Parameter für das Kommando.

Beispiel

<Command Name="DeterminationDate">
  <Parameter Name="Date">20131126</Parameter>
</Command>

Command - Object: - Name: Language

Das Kommando Language dient dazu, die Sprache der Anwendung zu ändern. Die Sprache ist zum Beispiel dann wichtig, wenn man lokalisierte Ausgaben von Berichten erzeugen möchte.

Der Tag <Parameter> definiert den Parameter für das Kommando.

Beispiel

<Command Name="Language">
  <Parameter Name="Language">2</Parameter>
</Command>

Command - Object: - Name: Stop

Das Kommando Stop dient dazu, die Ausführung der Batch Command Client-XML-Datei zu beenden.

Sie können das Kommando Stop einmal oder mehrmals einfügen.

<Command Name="Stop"/>

Behandlung von Variablen

Der Batch Command Client bietet eine einfache Behandlung von Parametern. Parameter mit dem Präfix Return ermöglichen es, Daten als Variablen zu speichern. Diese Variablen können von anderen Kommandos benutzt werden, wenn ein Wert Daten des Typs Variable akzeptiert. Wenn ein Parameterwert aus einer Variablen abgefragt werden soll, muss am Anfang und am Ende des Variablennamens je ein Prozentzeichen % stehen. Wenn eine Variable eine Liste enthält, muss am Ende des Variablennamens ein Stern in Klammern (*) stehen.

Beispiel, um alle Berichte mit Status "beendet" aufzulisten und danach diese Berichte zu löschen:

<Command Object="Reports" Name="List">
  <Parameter Name="Filter_Status">Completed</Parameter>
  <Parameter Name="returnID">all_Completed_Reports_List</Parameter>
</Command>
		
<Command Object="Reports" Name="Delete">
  <Parameter Name="ID">%all_Completed_Reports_List(*)%</Parameter>
</Command>

Im obigen Beispiel gibt das Kommando Report - List den Parameter returnID zurück, der eine Liste mit Berichtkennungen enthält. Danach übernimmt das Kommando Delete die Liste der Berichtkennungen für den Parameter ID.

Beispiele für Erstellen eines Berichts, Warten auf Generierungsende und Speichern als Datei:

<Command Object="Reports" Name="Add">
  <Parameter Name="ShortType">LGT</Parameter>
  <Parameter Name="Owner">EXAMPLE</Parameter>
  <Parameter Name="returnID">new_ID_LGT</Parameter>
</Command>

<Command Object="Reports" Name="List">
  <Parameter Name="WaitID ">%new_ID_LGT%</Parameter>
</Command>

<Command Object="Reports" Name="SaveToFile">
  <Parameter Name="ID">%new_ID_LGT%</Parameter>
  <Parameter Name="OutputType">HTML</Parameter>
  <Parameter Name="FileName">c:\LGT.html</Parameter>
</Command>

Erläuterung:

Zuerst wird durch das Kommando Add ein Bericht des Typs LGT (Log - Beendete Jobs) erstellt. Der Parameter returnID gibt die Kennung für den Bericht zurück und füllt die Variable new_ID_LGT.

Das Kommando List benutzt den Parameter WaitID , der nötig ist, um sicherzustellen, dass der Bericht vollständig generiert wird, bevor die Daten in die Datei geschrieben werden. Der Parameter WaitID benutzt dieselbe Variable wie der Parameter returnID, um den zuvor generierten Bericht auszuwählen.

Das Kommando SaveAsFile schreibt den generierten Bericht in eine HTML-Datei. Der Parameter ID benutzt dieselbe Variable wie der Parameter returnID, um den zuvor generierten Bericht auszuwählen.

Funktionalität Relatives Datum

Bei Parametern des Typs Date steht eine spezielle Funktion zum Setzen eines relativen Zeitpunkts zur Verfügung. Diese Funktion bietet Ihnen die Möglichkeit, ausgehend vom aktuellen Datum, Datumswerte in der Vergangenheit oder in der Zukunft anzugeben.

Anstatt ein spezifisches Datum anzugeben (N8, Format YYYMMDD), kann ein Versatz von +n oder -n Tagen angegeben werden, wobei n vom Typ (I2) ist.

Beispiel

<Command Object="Reports" Name="List">
  <Parameter Name="Filter_Date">-1</Parameter>
  <Parameter Name="returnID">all_Yesterday_Reports</Parameter>
</Command>
		
<Command  Object="Reports" Name="Delete">
  <Parameter Name="ID">%all_Yesterday_Reports(*)%</Parameter>
</Command>

<Command Object="Reports" Name="Add" DeterminationDate="+7">
  <Parameter Name="ShortType">NSO</Parameter>
  <Parameter Name="Owner">EXAMPLE</Parameter>
  <Parameter Name="returnID">new_Next_Week_NSO</Parameter>
  <Parameter Name="ScheduleType">schedule network time</Parameter>
</Command>