public class AttributesOS390 extends java.lang.Object implements IHostAttributes
Constructor and Description |
---|
AttributesOS390() |
Modifier and Type | Method and Description |
---|---|
int |
fieldCount()
Returns the number of fields in the host attributes.
|
java.lang.String |
getAccount()
Returns the accounting Information on the Job.
|
int |
getCompleteJobLog()
Returns the complexity of job log
0 ...
|
java.lang.String |
getFileName()
Returns the name of the dataset or member.
|
char |
getJobClass()
Returns the Job class in which the Job should run.
|
java.lang.String |
getJobName()
Returns the name of the Job in the system.
|
java.lang.String |
getJobParameters()
Returns additional job parameters, for example "TIME=1440".
|
java.lang.String |
getMessageClassesReport() |
char |
getMsgClass()
Returns the Job log's message class.
|
java.lang.String |
getMsgLevel()
Returns the trace option for the job log.
|
java.lang.String |
getNotify()
Returns a notify on OS/390.
|
java.lang.String |
getPriority()
Returns the Job's priority.
|
java.lang.String |
getProgramName()
Returns the program name.
|
int |
getPurgeJobLog()
Returned values:
2 - Whether or not the job log is deleted depends on the configuration of the Agent's INI file (Parameter
jobPurge).
|
int |
getRelMsgClass()
Returned values:
0 ...
|
java.lang.String |
getRouteMessageClass() |
boolean |
isSysoutDatabase()
Returns whether SYSOUT protocol is saved only in the Automation Engine database.
|
boolean |
isSysoutErrorOnly()
Returns whether SYSOUT protocol is saved only in case of an error.
|
boolean |
isSysoutFile()
Returns whether SYSOUT protocol should be available as a file.
|
boolean |
isTypeAE()
Returns
true if the Automation Engine (AE) type is selected. |
boolean |
isTypeJCL_JobCard()
Returns
true if the complete JCL including the Job card is used from the dataset which has been
specified in the "File name" field. |
boolean |
isTypeJCL()
Returns
true if the JCL of the Job is found in OS/390. |
boolean |
isTypeUC4()
Deprecated.
By rebranding UC4 to Automic, use
isTypeAE() instead |
boolean |
isUseHighestReturncode() |
void |
load(com.uc4.util.XMLDocument doc,
org.w3c.dom.Element hostAttr)
Loads the host attributes.
|
java.lang.String |
name()
Returns the host attributes name.
|
void |
setAccount(java.lang.String account)
Sets the accounting Information on the Job.
|
void |
setCompleteJobLog(int completeJobLog)
Sets the complexity of job log
|
void |
setFileName(java.lang.String fileName)
Sets the name of the dataset or member which contains
the JCL of the Job (Option "JCL from OS/390") or
the JCL and the Job card of the Job (Option "JCL incl.
|
void |
setJobClass(char jobClass)
Sets the Job class in which the Job should run.
|
void |
setJobName(java.lang.String jobName)
Sets the name of the Job in the system.
|
void |
setJobParameters(java.lang.String jobParameters)
Specification of additional job parameters, e.g.
|
void |
setMessageClassesReport(java.lang.String messageClassesReport)
Sets the message classes which should be read and routed.
|
void |
setMsgClass(char msgClass)
Sets the Job log's message class (optional).
|
void |
setMsgLevel(java.lang.String msgLevel)
Sets the trace option for the job log (optional).
|
void |
setNotify(java.lang.String notify)
Specification of a notify on OS/390.
|
void |
setPriority(java.lang.String priority)
Sets the Job's priority (optional).
|
void |
setProgramName(java.lang.String programName)
Sets the program name.
|
void |
setPurgeJobLog(int purgeJobLog)
Defines if the job log should be deleted.
|
void |
setRelMsgClass(int relMsgClass)
Job-log release for printing
0 ...
|
void |
setRouteMessageClass(java.lang.String routeMessageClass)
Sets the message classes which should be routed.
|
void |
setSysoutDatabase(boolean sysoutDatabase)
Sets if the SYSOUT protocol should be transfered to the Automation Engine database.
|
void |
setSysoutErrorOnly(boolean sysoutErrorOnly)
In case of Job interruption, the SYSOUT protocol is saved in
the Automation Engine database and/or a file in the target system.
|
void |
setSysoutFile(boolean sysoutFile)
Sets if the SYSOUT protocol should be available as a file in the target system.
|
void |
setTypeAE()
The JCL of the Job is stored in the "Pre-Script" and/or "Script" tab.
|
void |
setTypeJCL_JobCard()
The complete JCL including the Job card is used from the dataset which has been
specified in the "File name" field.
|
void |
setTypeJCL()
The JCL of the Job is found in OS/390.
|
void |
setTypeUC4()
Deprecated.
By rebranding UC4 to Automic, use
setTypeAE() instead |
void |
setUseHighestReturncode(boolean highest)
Sets if the highest or latest return code should be used.
|
void |
store(com.uc4.util.XMLDocument doc,
org.w3c.dom.Element objectElement)
Writes the host attributes back to the
XMLDocument . |
public int fieldCount()
IHostAttributes
fieldCount
in interface IHostAttributes
public void load(com.uc4.util.XMLDocument doc, org.w3c.dom.Element hostAttr)
IHostAttributes
load
in interface IHostAttributes
doc
- XML Document containing the JobhostAttr
- Element which contains host attributespublic java.lang.String name()
IHostAttributes
name
in interface IHostAttributes
public boolean isUseHighestReturncode()
public void setUseHighestReturncode(boolean highest)
highest
- True if the highest return code should be used, if false the
latest return code is used.public void store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element objectElement)
IHostAttributes
XMLDocument
.store
in interface IHostAttributes
doc
- DocumentobjectElement
- ObjectElementpublic java.lang.String getRouteMessageClass()
public void setRouteMessageClass(java.lang.String routeMessageClass)
routeMessageClass
- message class(es)public int getRelMsgClass()
public void setRelMsgClass(int relMsgClass)
relMsgClass
- Job-log release for printingpublic int getPurgeJobLog()
public void setPurgeJobLog(int purgeJobLog)
purgeJobLog
- Number containing how the job log is deletedpublic java.lang.String getMessageClassesReport()
public void setMessageClassesReport(java.lang.String messageClassesReport)
Specify one or several message classes. Examples: "A", "ABC", "X1". Any order is possible.
The following values are also permitted: "*DEFAULT" and "*ALL"
messageClassesReport
- message class(es)public int getCompleteJobLog()
public void setCompleteJobLog(int completeJobLog)
Permitted values:
completeJobLog
- complexity of job logpublic java.lang.String getFileName()
public void setFileName(java.lang.String fileName)
Example: SYSS.UC4.JCL.JOB1 or SYSS.UC4.JCLLIB(UC4JOB1)Jobs can also come from the source administration system Librarian. The following syntax applies:
*LIBRARIAN(Dataset, Member).A maximum of 225 characters are allowed.
fileName
- File namepublic java.lang.String getJobParameters()
public void setJobParameters(java.lang.String jobParameters)
jobParameters
- additional job parameterspublic java.lang.String getNotify()
public void setNotify(java.lang.String notify)
notify
- Notificationpublic char getMsgClass()
public void setMsgClass(char msgClass)
msgClass
- Msgclasspublic java.lang.String getMsgLevel()
public void setMsgLevel(java.lang.String msgLevel)
Possibly a numerical value for command and message separated by a comma. Permitted formats: "Command,Message", ",Message" or "Command" Permitted values for outputting commands:
"0" - Output only commands. "1" - All job commands, JES2 or JES3 control commands, procedure commands and all IEF653I messages. "2" - Only all job commands (JCL) and the JES2 or JES3 control commands.Permitted value for outputting messages:
"0" - Only JCL messages. For cancels, also JES control commands and operator messages. For SMS errors, also the corresponding messages. "1" - All JCL, JES, operator and SMS messages.
msgLevel
- Msglevelpublic java.lang.String getPriority()
public void setPriority(java.lang.String priority)
null
can be used to clear this field.priority
- Prioritypublic java.lang.String getAccount()
public void setAccount(java.lang.String account)
account
- accounting Informationpublic java.lang.String getProgramName()
public void setProgramName(java.lang.String programName)
programName
- Program namepublic char getJobClass()
public void setJobClass(char jobClass)
jobClass
- Job classpublic java.lang.String getJobName()
public void setJobName(java.lang.String jobName)
jobName
is converted to uppercase.jobName
- Job namepublic boolean isTypeJCL_JobCard()
true
if the complete JCL including the Job card is used from the dataset which has been
specified in the "File name" field.public void setTypeJCL_JobCard()
public boolean isTypeJCL()
true
if the JCL of the Job is found in OS/390.public void setTypeJCL()
@Deprecated public boolean isTypeUC4()
isTypeAE()
insteadtrue
if the UC4 type is selected.@Deprecated public void setTypeUC4()
setTypeAE()
insteadpublic boolean isTypeAE()
true
if the Automation Engine (AE) type is selected.public void setTypeAE()
public boolean isSysoutDatabase()
true
if the SYSOUT protocol is saved in the database false
otherwisepublic void setSysoutDatabase(boolean sysoutDatabase)
sysoutDatabase
- true
if the SYSOUT protocol should be saved in the database false
otherwisepublic boolean isSysoutErrorOnly()
true
if the SYSOUT protocol is saved only in case of an
error false
otherwisepublic void setSysoutErrorOnly(boolean sysoutErrorOnly)
sysoutErrorOnly
- Save SYSOUT protocol in error case onlypublic boolean isSysoutFile()
true
if the SYSOUT protocol should be available as a file false
otherwisepublic void setSysoutFile(boolean sysoutFile)
sysoutFile
- true
if the SYSOUT protocol should be available as a file