Using Entire Operations in Batch Mode

This section describes the files and commands required to perform Entire Operations functions in batch mode from a Windows environment.

• Files Needed to Start Entire Operations in Batch

• Files Needed to Start the Batch Command Client

• Command Syntax for the Batch Command Client

• Commands for the Batch Command Client

Files Needed to Start Entire Operations in Batch

The following files are required to start Entire Operations in batch mode:

1. A windows batch file (.bat)

2. A command file (.cmd)

3. A file with input data (.inp)

Examples of such files are contained in the Natural directory SYSSATGF/RES: exportapi.bat, exportapi.cmd and exportapi.inp.

• exportapi.bat

• exportapi.cmd

• exportapi.inp

• EXPORT DIAGRAM Command Syntax

• Files Generated from EXPORT DIAGRAM Command

• Starting Entire Systems Management in Batch Mode

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

We recommend that you only change the last three parameters.

exportapi.cmd

LOGON SYSSATGF
 ESSTRPCD
 FIN

SYSSATGF is the name of the library from which Entire Operations should be launched.

We recommend that you do not change this parameter and file.

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

This is the main file you can modify as required.

General Syntax Requirements:

• A maximum of 249 characters is allowed per line.

• Blank lines are not allowed.

• Comment lines must begin with the symbol sequence /*.

• Any parameters definitions must comply with the direct command syntax.

The syntax of the exportapi.inp file is as follows:

,
ENTIREX-USERID,
FOCUS TO SYSOGC
...

EXPORT DIAGRAM Command Syntax

General Syntax:

Syntax Description:

A wildcard (*) is only allowed in a parameter that defines an owner, network, version or run. When you define several of these parameters, you can only use a wildcard in the first parameter (all other wildcards are then ignored).

Examples of valid commands:

Examples of Invalid Commands:

Files Generated from EXPORT DIAGRAM Command

Files names are generated from the EXPORT DIAGRAM command according to the command input sequence in the following way:

prefix_owner_network_version_run.format

Rules for Path Names and Directories

• The default prefix for file name is : EXDIAGRAM_owner_network_version_run.format

• If prefix is not specified, the default value %temp%/ is used.

• For a prefix that does not end with a backslash or slash an underscore (_) is generated instead into the path name.

• A relative path specification is not allowed.

• A specified directory must exist.

Examples of Files generated from a Command

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

   generates:

   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"

   generates:

   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

Starting Entire Systems Management in Batch Mode

To launch Entire Systems Management in batch mode

1. Adapt the example files according to your requirements (Natural directory SYSSATGF/RES: exportapi.bat, exportapi.cmd and exportapi.inp).

2. Launch the .bat file.

3. View the .out file (exportapi.out file) to see the results and output messages.

If an error occurs, ensure that Entire Systems Management was launched in normal mode using the correct parameters.

Files Needed to Start the Batch Command Client

The following files are required to start the batch command client of Entire Systems Management:

1. A Windows batch file (.bat)

2. An XML batch file (.xml)

Examples of such files are located in the Natural SYSSATGF/RES directory: batchClientCommand.bat and batchClientReports.xml.

• 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)

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>

Command Syntax for the Batch Command Client

The batch command client of Entire Systems Management is programmed with an XML file.

XML documents use a self-describing and simple syntax. The first line is the XML declaration. It defines the XML version (1.0) and the encoding used. The second line describes the root element of the document. It is the parent element of all other elements. These child elements contain the description of the further on data or in our case processing. The last line defines the end of the root element. All tags and attributes used inside the xml file are case sensitive.

Encoding

If no encoding is given it is supposed that the XML document only contains standard ASCII characters. Special characters like the German ü or ä are not valid. If you want to use this kind of characters you have to use the encoding setting. For editing an xml file use an editor that supports encoding. Make sure that you use the same encoding during editing that is specified at the encoding attribute. Otherwise, your document may not load or your data is misinterpreted.

DTD Input File

<!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>

Tag Reference

Tag	Explanation
<ESM_Batch_Command_Client>	The <ESM_Batch_Command_Client> tells the processor of the batch command client of Entire Systems Management the remote environment to be used and the commands to be processed.
<RPC>	Defines the Natural RPC connection with user and password.
<EXX>	Defines the EntireX remote server and service and if necessary user and password.
<ESM>	Defines the Entire Systems Management application and additional settings such as language or determination date.
<Command>	Defines a single command which should be processed.
<Parameter>	Defines a parameter of a command.

The tags are explained in the following section.

• <Command> Tag

• <ESM_Batch_Command_Client> Tag

• <ESM> Tag

• <EXX> Tag

• <Parameter> Tag

• <RPC> Tag

<Command> Tag

The <Command> tag defines the commands that should be processed. The element contains the child element <Parameter>.

The following attributes are available:

Example:

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

Output:

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

</Command>

<ESM_Batch_Command_Client> Tag

The <ESM_Batch_Command_Client> tag defines the xml document that provides all settings and the sequence of the commands to be processed. At the moment only report generation related commands of Entire Operations can be processed. The default namespace (xmlns attribute) of the document defines that the used elements belongs to the batch command client application of Entire Systems Management.

The following attributes are available:

Example of an XML document with encoding setting and root element:

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

</ESM_Batch_Command_Client>

<ESM> Tag

The <ESM> tag defines settings for the Entire Systems Management application.

The following attributes are available:

Example:

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

Output:

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

</Commands>

<EXX> Tag

The <EXX> tag defines EntireX settings. The server is defined by a ServerName and the ServerNode settings. The settings are equal to the Natural profile parameter for Entire Systems Management (see the Natural SYSESM2 configuration file).

The following attributes are available:

Example:

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

<Parameter> Tag

The <Parameter> tag defines parameter for a command.

The following attributes are available:

Example:

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

<RPC> Tag

The <RPC> tag defines setting for the Natural RPC command.

The following attributes are available:

Example:

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

Commands for the Batch Command Client

This section describes the commands provided by the batch command client of Entire Systems Management.

• Wildcard Usage

• Command - Object: Reports - Name: List

• Command - Object: Reports - Name: SaveToFile

• Command - Object: Reports - Name: Add

• Command - Object: Reports - Name: Delete

• Command - Object: CrossReferences - Name: SaveToFile

• Command - Object: - Name: DeterminationDate

• Command - Object: - Name: Language

• Command - Object: - Name: Stop

• Variable Handling

• Relative Date Feature

Wildcard Usage

The wildcard character has to be the last character in a variable value that defines a range of names.

Wildcard Usage (Owner, Network, Symbol Table, Version)

Every object is referenced according his namespace parts. Only the last part of the namespace can be extended with a wildcard.

Valid Specification

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

Invalid Specifications

<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

The List command evaluates data from the Reports list. This command provides major usages:

• Find reports of a specific kind by specifying filters e.g. to delete this reports or

• Wail until a report generation has been ended with the status Aborted or Completed e.g. to save Completed reports as file.

The <Parameter> tag defines the parameters for the command.

Examples:

<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>

Output:

<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

The SaveToFile command saves completed report generations with different output formats as file.

If the output type is XML an additional XmlStylesheet parameter can be provided. This can be used as replacement of the online type "XML with style sheet for HTML". The style sheet has to be copied manually. Examples of style sheets can be found in the Natural SYSOGC/RES directory. The files are named REPreport-name.xsl.

The <Parameter> tag defines the parameters for the command.

Example:

<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>

Output:

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

Command - Object: Reports - Name: Add

The Add command invokes the user-dependent report generation. The generation is invoked within the Entire Operations GUI Client whereas the reports themselves are generated asynchronously in the background via the Entire Operations Monitor. Reports added with the batch command client of Entire Systems Management can be seen by performing the report functions of the Entire Operations GUI Client.

Report Types

Short Type	Report *	Description
ACC	Job Accounting Data	Information on job elapsed times and CPU times of previous network executions.
ACO	Activation Overview	An overview of network activations.
CNV	Compare Networks	Compare a network with another network.
CST	Compare Symbol Tables	Compare a symbol table with other symbol tables.
LGB	Log - Abended Jobs	Information on jobs, which is extracted from the Entire Operations log.
LGN	Log - Networks not activated
LGT	Log - Terminated Jobs
LGX	Log - Jobs not started
LGY	Log - Jobs with permanent errors
NDD	Network Description (detailed)	Displays the same information as the short version, but includes all prose descriptions defined at the network, job or event level using the Editor facility.
NDS	Network Description (short)	Displays information on networks and jobs as defined on the master database, including scheduling information, prerequisites and End-of-Job checking and actions.
NOD	Node Overview	Displays an overview of node reports.
NSO	Network Schedule Overview	An overview of scheduled and/or not yet executed, system-wide network activations.
NSS	Network Start Summary	A status report of all network starts for a given day.
SCJ	Schedule of Jobs	Displays a job schedule for a specific date range.
XRF	Subnetwork Usage	Lists networks and related subnetworks.
BC1	Network Start Overview (Bar Chart)	Displays the network start and end times of a previous network execution as a bar chart.
BC3	Network Schedule Overview (Bar Chart)	Displays the schedule selection of a network as a bar chart.
BC4	Network and Job Start Overview (Bar Chart)	Displays the network and job starts as a bar chart.
AC1	Monitor Tasks and Functions Overview	Displays data collected from performed Monitor tasks and called Monitor functions.
AC2	Monitor Tasks and Exits Overview	Displays data collected from performed Monitor tasks and called Monitor exits.

* For further information, see Reporting in the User's Guide.

Command Parameters

The <Parameter> tag defines the parameters for the command:

Parameter	Format	Default	Value	Explanation
ShortType	enum		A valid short type	Report generation type.
Owner	A10		Uppercase name (may be terminated with wildcard characters)
Network	A10		Uppercase name (may be terminated with wildcard characters)
NetworkVersion	A10		Name (may be terminated with wildcard characters)
Job	A10	*	Uppercase name (may be terminated with wildcard characters)
Date_From	D	current date	A valid date with format YYYYMMDD	Specify the start date and time for displaying the messages.
Date_Thru	D	current date	A valid date with format YYYYMMDD	Specify the start date and time for displaying the messages.
Time_From	T	000000	A valid date with format HHIISS
Time_Thru	T	current time	A valid date with format HHIISS
Run_From	N5	1	Positive numeric
Run_Thru	N5	99999	Positive numeric
ScheduleType	enum	SNT	SNT Schedule, sorted by network, time ONT Only sorted by network, time OT Only sorted by time STN Schedule, sorted by time, network
ActivationType	enum	All types	All types Manual Recovery API EOJ Scheduled	Specifies the activation type. Can be specified multiple times. Note: All types cannot be used with other activation types.
Email	A98			Enter an e-mail address if you want to send a notification when the report generation has been completed.
Owner2	A10		Uppercase name (may be terminated with wildcard characters)
Network2	A10		Uppercase name (may be terminated with wildcard characters)
NetworkVersion2	A10		Version (may be terminated with wildcard characters)
Job2	A10	*	Uppercase name (may be terminated with wildcard characters)
Node_From	N5	1	A positive numeric value
Node_Thru	N5	1	A positive numeric value
SymbolTable	A10		Uppercase name (may be terminated with wildcard characters)
SymbolTableVersion	A10		Version (may be terminated with wildcard characters)
SymbolTable2	A10		Uppercase name (may be terminated with wildcard characters)
SymbolTableVersion2	A10		Version (may be terminated with wildcard characters)
Show	enum	All	All Differences
returnID	A		VariableName

Use of Parameters Dependent on Report Type

Parameter /Report Type	ACC	ACO	CNV	CST	LGB	LGN	LGT	LGX	LGY	NDD	NDS	NOD	NSO	NSS	SCJ	XRF	BC1	BC3	BC4	AC1	AC2
ShortType	X	X	X	X	X	X	X	X	X	X	X		X	X	X	X	X	X	X
Owner	X	X	X	X	X	X	X	X	X	X	X		X	X	X	X	X	X	X
Network	X	X	X		X	X	X	X	X	X	X		X	X	X	X	X	X	X
NetworkVersion	X	X	X		X	X	X	X	X	X	X		X	X	X	X	X	X	X
SymbolTable				X
SymbolTableVersion				X
Job	X				X	X	X	X	X							X
Date_From	X	X			X	X	X	X	X				X	X	X		X	X	X	X	X
Date_Thru	X	X			X	X	X	X	X				X	X	X		X	X	X	X	X
Time_From	X	X			X	X	X	X	X											X	X
Time_Thru	X	X			X	X	X	X	X											X	X
Run_From	X	X			X	X	X	X	X
Run_Thru	X	X			X	X	X	X	X
ScheduleType													X
ActivationType		X
Email	X	X	X	X	X	X	X	X	X	X	X		X	X	X
Owner2			X	X												X
Network2			X													X
NetworkVersion2			X													X
Node_From												X
Node_Thru												X
SymbolTable2				X
SymbolTableVersion2				X
Job2																X
Show				X
returnID	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X

DTD of the Generated Output

<!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)>

Examples of Add Commands

<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

The Delete command remove reports from the report list. Command is best used in conjunction with the List command. The List can be used to generate a VariableArray that contains the IDs of the report list which can be deleted with the Delete command.

The <Parameter> tag defines the parameter for the command:

Example 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>

Output:

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

Example 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>

Output:

<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: CrossReferences - Name: SaveToFile

The SaveToFile command for Object="CrossReferences" generates a list of cross-referenced objects. The types of cross-references that can be generated are listed in the following table. They are further explained in Types of Cross-Reference Reports in the section Cross-References.

Types of Cross-References

Cross-Reference Type	Short Type
JCL usage	JCL
Node usage	NDU
Undefined objects	NDF
Resource usage	RES
Symbol table usage	STU
User exit usage	URU
Symbol search by value	XSM

Command Parameters

The <Parameter> tag defines the parameters for the command:

Parameter	Format	Description
ShortType	enum	Type of cross-reference generation Specify a valid short type.
Owner	A10	Uppercase name of an owner or a range of names¹ Default value: * (all owners)
Network	A10	Uppercase name of a network or a range of names¹
NetworkVersion	A10	Name of a network version or a range of names¹
SymbolTable	A10	Uppercase name of a symbol table or a range of names¹
SymbolTableVersion	A10	Version of a symbol table or a range of names¹
UserExitUsage	enum	Type of user exit Valid values: IC Input condition user exits RM Resource master determination exits MJ Master JCL and Natural programs EC End-of-Job check user exits EA End-of-Job action user exits SC Symbol check user exits SP Symbol prompt user exits
UsageInActiveJobs	L	Determines the jobs in which to search Valid values: false Searches in all jobs (default) true Searches in active jobs only
JCLLocation	enum	Supported JCL location Valid values: blank A blank character selects all JCL locations. BS2 SAM or ISAM file EXE Executable program LIB Librarian LMS LMS library MAC Natural source object containing a macro program NAT Natural source object PDS Partitioned data set PRC Callable procedure RDR z/VSE reader queue TXT Text file VSE z/VSE sublibrary
FileNatlib	A54	Name of a file or Natural library or a range of names¹
Member	A64	Name of a member or a range of names¹
JCLNode_OpSysClass	enum	Operating system for specified JCL node Valid values: B BS2000 M z/OS (MVS) V z/VSE W Windows X UNIX
JCLNode_NodeNumber	N5	Number of a node
ExecutionNode_OpSysClass	enum	Operating system for specified execution node Valid values: B BS2000 M z/OS (MVS) V z/VSE W Windows X UNIX
ExecutionNode_NodeNumber	N5	Number of a node
UsageIn	enum	Jobs for which to search Valid values: A Active jobs M Job masters Multiple values are allowed for ShortType XSM (symbol search by value).
Symbol	A40	Name of a symbol or a range of names¹
MultValueMinIndex	N3	Minimum index value of a multiple-value symbol Valid values: 1 to 100 Default value: 1
MultValueMaxIndex	N3 or A1	Minimum index value of a multiple-value symbol Valid values: 1 to 100 or 1 to * (all multiple values) Default value: *
AtPosition	enum	Position at which to search within the symbol value Valid values: * Anywhere within the symbol value (default) 1 At the beginning of the symbol value E At the end of the symbol value
ScanFor	A80	String of up to 80 characters for which to search within the symbol value
CaseSensitive	L	Specify true to perform a case-sensitive search or false (default) for a case-insensitive search.
ObjectTypeToBeValidated	enum	Type(s) of objects for which to search Valid values: * All types of objects (default) SM Symbols S1 Symbol tables NM Networks JM Jobs RM Resources SC Schedules CA Calendars
Resource	A40	Name of a resource or a range of names¹
FileName	A250	Name of a valid directory path where the report is saved
OutputType	enum	Type of the report file to generate Valid values: HTML HTML-formatted file XML XML-formatted file CSV Comma-separated value file
XmlStylesheet	A	Uniform Resource Identifier (URI) to specify an absolute or a relative address If an URI is specified for OutputType XML, a processing instruction with a reference to an external style sheet is added to the generated XML file. The browser then interprets this instruction (<?xml-stylesheet…?>) and renders the requested file form, for example, HTML. You can find style sheets for all report types in the SYSOGC/RES directory of the Natural FNAT system file.

¹ You can specify a range of names by using an asterisk (*) to determine a start value or to select all names available (see also Valid Name Specifications in Direct Commands).

The command only processes a single range definition and ignores any additional definitions. If more than one range is defined in a command, the parameters are processed in the following order of precedence (from highest to lowest): Owner, Network, NetworkVersion, SymbolTable, SymbolTableVersion. For example: If ranges are specified for Owner, Network and SymbolTable, only the range specified for Owner (highest priority) is processed.

Use of Parameters Dependent on Cross-Reference Type

Cross-Reference Type	JCL	NDF	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 of the Generated Output

<!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
>

Examples of Cross-Reference SavetoFile Commands

<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">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">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">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">URU</Parameter>
  <Parameter Name="UserExitUsage">EC</Parameter>
  <Parameter Name="OutputType">XML</Parameter>
  <Parameter Name="FileName">C:\temp\xRef_UserExitUsage_EC.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 - Object: - Name: DeterminationDate

The DeterminationDate command modifies the determination date e.g. used during the reports generation.

The <Parameter> tag defines the parameter for the command:

Example:

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

Command - Object: - Name: Language

The Language command set the new application language. The language is e.g. important during report generation to get localized reports.

The <Parameter> tag defines the parameter for the command.

Example:

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

Command - Object: - Name: Stop

The Stop command is used to terminate the execution of the batch client command xml file.

One or more Stop commands may be inserted.

Example:

<Command Name="Stop"/>

Variable Handling

The batch command client provides a simple parameter handling. Parameters with the prefix return provide the option to save the data as a variable. These variables can be used by other commands if a value accepts data from the type variable. If a parameter value is retrieved from a variable, the name of the variable has to be enclosed in percent (%) signs. If a variable contains a list, the variable name must end with (*).

Example to list all reports with status Completed and then delete all these reports:

<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>

In the example above, the command List uses the parameter returnID to return a list of report IDs. The command Delete accepts the list of report IDs for the ID parameter.

Example to add a report, wait for generation completion and save as file:

<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>

Explanation:

1. The command Add creates a report of the type LGT for the owner EXAMPLE. The parameter returnID returns the ID for the report and fills the variable new_ID_LGT.

2. The command List uses the parameter WaitID required to ensure that the report is completely generated before the data is written to the file. WaitID uses the same variable as returnID to select the previously generated report.

3. The command SaveAsFile writes the generated report to an HTML file. The parameter ID uses the same variable as returnID to select the same report previously generated.

Relative Date Feature

For parameters of type date a special feature for relative time setting is available. Based on the current date, the relative date feature gives you the possibility to specify dates in past or future.

Instead of specifying a specific date (N8, Format YYYMMDD) an offset +n or -n days can be specified, where n is of type (I2).

Example:

<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>