Package com.uc4.api.objects

Class AttributesOS390

java.lang.Object
com.uc4.api.objects.AttributesOS390
All Implemented Interfaces:
IHostAttributes
public class AttributesOS390 extends Object implements IHostAttributes
Host attributes for OS/390.

  • Constructor Details

    • AttributesOS390

      public AttributesOS390()

  • Method Details

    • fieldCount

      public int fieldCount()
      Description copied from interface: IHostAttributes
      Returns the number of fields in the host attributes.
      Specified by:
      fieldCount in interface IHostAttributes
      Returns:
      number of fields

    • load

      public void load(com.uc4.util.XMLDocument doc, Element hostAttr, ConnectionAttributes info)
      Description copied from interface: IHostAttributes
      Loads the host attributes.
      Specified by:
      load in interface IHostAttributes
      Parameters:
      doc - XML Document containing the Job
      hostAttr - Element which contains host attributes
      info - Session details

    • name

      public String name()
      Description copied from interface: IHostAttributes
      Returns the host attributes name.
      Specified by:
      name in interface IHostAttributes
      Returns:
      name

    • isUseHighestReturncode

      public boolean isUseHighestReturncode()
      Returns:
      True if the highest return code should be used, if false the latest return code is used.

    • setUseHighestReturncode

      public void setUseHighestReturncode(boolean highest)
      Sets if the highest or latest return code should be used.
      Parameters:
      highest - True if the highest return code should be used, if false the latest return code is used.

    • store

      public void store(com.uc4.util.XMLDocument doc, Element objectElement, ConnectionAttributes info)
      Description copied from interface: IHostAttributes
      Writes the host attributes back to the XMLDocument.
      Specified by:
      store in interface IHostAttributes
      Parameters:
      doc - Document
      objectElement - ObjectElement
      info - Session details

    • getRouteMessageClass

      public String getRouteMessageClass()
      Returns:
      message classes which should be routed

    • setRouteMessageClass

      public void setRouteMessageClass(String routeMessageClass)
      Sets the message classes which should be routed.
      Parameters:
      routeMessageClass - message class(es)

    • getRelMsgClass

      public int getRelMsgClass()
      Returned values:
      • 0 ... The job log is not released for printing.
      • 1 ... The job log is released when it has been read by the Agent
      • 2 ... Whether or not the job log is deleted depends on the configuration of the Agent's INI file (Parameter relMsgClass).
      Returns:
      Job-log release for printing

    • setRelMsgClass

      public void setRelMsgClass(int relMsgClass)
      Job-log release for printing
      • 0 ... The job log is not released for printing.
      • 1 ... The job log is released when it has been read by the Agent
      • 2 ... Whether or not the job log is deleted depends on the configuration of the Agent's INI file (Parameter relMsgClass).
      Parameters:
      relMsgClass - Job-log release for printing

    • getPurgeJobLog

      public 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).
      • 1 - The job log is deleted when it has been read by the Agent.
      • 0 - The job log remains in the JES spool.
      Returns:
      Number containing how the job log is deleted.

    • setPurgeJobLog

      public void setPurgeJobLog(int purgeJobLog)
      Defines if the job log should be deleted.
      • 2 - Whether or not the job log is deleted depends on the configuration of the Agent's INI file (Parameter jobPurge).
      • 1 - The job log is deleted when it has been read by the Agent.
      • 0 - The job log remains in the JES spool.
      Parameters:
      purgeJobLog - Number containing how the job log is deleted

    • getMessageClassesReport

      public String getMessageClassesReport()
      Returns:
      Message classes which should be read and routed

    • setMessageClassesReport

      public void setMessageClassesReport(String messageClassesReport)
      Sets the message classes which should be read and routed.

      Specify one or several message classes. Examples: "A", "ABC", "X1". Any order is possible.

      The following values are also permitted: "*DEFAULT" and "*ALL"

      • *DEFAULT - The message classes which should be read depend on the configuration of the Agent's INI file (Parameter getMsgClass=). If this setting is used "*DEFAULT" must also be specified in the field "Route to message class/classes
      • *ALL" - All classes are read
      Parameters:
      messageClassesReport - message class(es)

    • getCompleteJobLog

      public int getCompleteJobLog()
      Returns the complexity of job log
      • 0 ... No - Only the JES statistics (JESMSGLG, JESJCL and JESYSMSG) are included
      • 1 ... Yes - The JES statistics and job output are stored in the job log
      • 2 ... Default - the job-log complexity depends on the configuration of the Agent's INI file (Parameter completeJobout)
      Returns:
      complexity of job log

    • setCompleteJobLog

      public void setCompleteJobLog(int completeJobLog)
      Sets the complexity of job log

      Permitted values:

      • 0 ... No - Only the JES statistics (JESMSGLG, JESJCL and JESYSMSG) are included
      • 1 ... Yes - The JES statistics and job output are stored in the job log
      • 2 ... Default - the job-log complexity depends on the configuration of the Agent's INI file (Parameter completeJobout)
      Parameters:
      completeJobLog - complexity of job log

    • getFileName

      public String getFileName()
      Returns the name of the dataset or member.
      Returns:
      File name

    • setFileName

      public void setFileName(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. Job card from OS/390"). 
       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.
      Parameters:
      fileName - File name

    • getJobParameters

      public String getJobParameters()
      Returns additional job parameters, for example "TIME=1440". Multiple job parameters are should be separated by commas.
      Returns:
      additional job parameters

    • setJobParameters

      public void setJobParameters(String jobParameters)
      Specification of additional job parameters, e.g. "TIME=1440". Multiple job parameters are should be separated by commas.
      Parameters:
      jobParameters - additional job parameters

    • getNotify

      public String getNotify()
      Returns a notify on OS/390.
      Returns:
      Notification

    • setNotify

      public void setNotify(String notify)
      Specification of a notify on OS/390. Maximum 17 characters permitted.
      Parameters:
      notify - Notification

    • getSchenv

      public String getSchenv()
      Returns a scheduling environment on OS/390.
      Returns:
      Schenv

    • setSchenv

      public void setSchenv(String schEnv)
      Specification of a scheduling environment on OS/390. Maximum 16 characters permitted.
      Parameters:
      schEnv - scheduling environment

    • getMsgClass

      public char getMsgClass()
      Returns the Job log's message class.
      Returns:
      Msgclass

    • setMsgClass

      public void setMsgClass(char msgClass)
      Sets the Job log's message class (optional).
      Parameters:
      msgClass - Msgclass

    • getMsgLevel

      public String getMsgLevel()
      Returns the trace option for the job log.
      Returns:
      Msglevel

    • setMsgLevel

      public void setMsgLevel(String msgLevel)
      Sets the trace option for the job log (optional).

      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.
      Parameters:
      msgLevel - Msglevel

    • getPriority

      public String getPriority()
      Returns the Job's priority.
      Returns:
      Priority

    • setPriority

      public void setPriority(String priority)
      Sets the Job's priority (optional). A value between "0" and "15" may be entered for priority. An empty String or null can be used to clear this field.
      Parameters:
      priority - Priority

    • getAccount

      public String getAccount()
      Returns the accounting Information on the Job.
      Returns:
      accounting Information

    • setAccount

      public void setAccount(String account)
      Sets the accounting Information on the Job. A maximum of 40 characters are allowed.
      Parameters:
      account - accounting Information

    • getProgramName

      public String getProgramName()
      Returns the program name.
      Returns:
      Program name

    • setProgramName

      public void setProgramName(String programName)
      Sets the program name. Identifies the Job's owner or its group (optional). The name is recorded in the job card of the job. Maximum 20 characters permitted.
      Parameters:
      programName - Program name

    • getJobClass

      public char getJobClass()
      Returns the Job class in which the Job should run.
      Returns:
      Job class

    • setJobClass

      public void setJobClass(char jobClass)
      Sets the Job class in which the Job should run.
      Parameters:
      jobClass - Job class

    • getJobName

      public String getJobName()
      Returns the name of the Job in the system.
      Returns:
      Job name

    • setJobName

      public void setJobName(String jobName)
      Sets the name of the Job in the system. A maximum of 8 characters is allowed. jobName is converted to uppercase.
      Parameters:
      jobName - Job name

    • isTypeJCL_JobCard

      public 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.
      Returns:
      True or False according to the description above.

    • setTypeJCL_JobCard

      public void setTypeJCL_JobCard()
      The complete JCL including the Job card is used from the dataset which has been specified in the "File name" field. Complete runtime options are not available because the definitions of the Job card apply. When generating the Job the JCL from the Pre-Script is added before the first step. The script must be empty.

    • isTypeJCL

      public boolean isTypeJCL()
      Returns true if the JCL of the Job is found in OS/390.
      Returns:
      True or False according to the description above.

    • setTypeJCL

      public void setTypeJCL()
      The JCL of the Job is found in OS/390. If this option is selected, "File Name" must be specified. the Job card is generated from the host attributes defined here. The JCL from the Pre-Script is added before the first step. The script must be empty.

    • isTypeUC4

      @Deprecated public boolean isTypeUC4()
      Deprecated.
      By rebranding UC4 to Automic, use isTypeAE() instead
      Returns true if the UC4 type is selected.
      Returns:
      True or False according to the description above.

    • setTypeUC4

      @Deprecated public void setTypeUC4()
      Deprecated.
      By rebranding UC4 to Automic, use setTypeAE() instead
      The JCL of the Job is stored in the "Pre-Script" and/or "Script" tab.

    • isTypeAE

      public boolean isTypeAE()
      Returns true if the Automation Engine (AE) type is selected.
      Returns:
      True or False according to the description above.

    • setTypeAE

      public void setTypeAE()
      The JCL of the Job is stored in the "Pre-Script" and/or "Script" tab.

    • isSysoutDatabase

      public boolean isSysoutDatabase()
      Returns whether SYSOUT protocol is saved only in the Automation Engine database.
      Returns:
      true if the SYSOUT protocol is saved in the database false otherwise

    • setSysoutDatabase

      public void setSysoutDatabase(boolean sysoutDatabase)
      Sets if the SYSOUT protocol should be transfered to the Automation Engine database.
      Parameters:
      sysoutDatabase - true if the SYSOUT protocol should be saved in the database false otherwise

    • isSysoutErrorOnly

      public boolean isSysoutErrorOnly()
      Returns whether SYSOUT protocol is saved only in case of an error.
      Returns:
      true if the SYSOUT protocol is saved only in case of an error false otherwise

    • setSysoutErrorOnly

      public 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. This is only available when "Database" and/or "File" have been selected.
      Parameters:
      sysoutErrorOnly - Save SYSOUT protocol in error case only

    • isSysoutFile

      public boolean isSysoutFile()
      Returns whether SYSOUT protocol should be available as a file.
      Returns:
      true if the SYSOUT protocol should be available as a file false otherwise

    • setSysoutFile

      public void setSysoutFile(boolean sysoutFile)
      Sets if the SYSOUT protocol should be available as a file in the target system.
      Parameters:
      sysoutFile - true if the SYSOUT protocol should be available as a file