<jobdata> Platform-specific Elements
Theme: Configure
Who Is It For? System Administrator, Automation Engineer
What Is It?
The <jobdata> element in SMA Dynamic Data Input holds platform-specific fields that vary by job type. Each platform — Windows, UNIX, IBM i, SAP, SQL, z/OS, and others — has its own set of child elements that map to the corresponding job task detail fields in OpCon.
- Container Job Element Structure
- File Transfer Job Element Structure
- IBM i Job Element Structure
- Java Job Element Structure
- MCP Job Elements
- OpenVMS Job Element Structure
- OS 2200 Job Elements
- SAP R/3 and CRM Job Element Structure
- SAP BW Job Element Structure
- SQL Job Element Structure
- Tuxedo ART Job Element Structure
- UNIX Job Element Structure
- Windows Job Elements
- z/OS Job Elements
Container Job Element Structure
Enter either new_master or new_daily for the msgtype. For Detailed information on each field for this job type, refer to Container Job Type in the Concepts online help.
<jobdata>
<cntnr_subskd></cntnr_subskd>
</jobdata>
Element Definitions
<cntnr_subskd></cntnr_subskd
Defines the schedule that will run as a SubSchedule under the control of the container job.
- Requirements: Required
- EM field label: Schedule to run as Sub-Schedule
- Valid Values: Valid data for this element contains the schedule the user has privileges to that has the SubSchedule flag marked True in their schedule definition except the current schedule. Valid data for this element is the name of any schedule, except the schedule identified by the <skdname> element that is allowed as a subschedule. A schedule must have the SubSchedule indicator set to be allowed as a SubSchedule.
File Transfer Job Element Structure
Enter either new_master or new_daily for the msgtype. For detailed Information on each field for this job type, refer to File Transfer Job Details in the Concepts online help.
<jobdata>
<host_name></host_name>
<ft_src_user></ft_src_user>
<ft_src_file></ft_src_file>
<ft_dest_user></ft_dest_user>
<ft_dest_file></ft_user_file>
<ft_xqt_mach></ft_xqt_mach>
<ft_mode></ft_mode>
<ft_compress></ft_compress>
<ft_encrypt></ft_encrypt>
<ft_overwrt></ft_overwrt>
<ft_failpref></ft_failpref>
<ft_bandwidth></ft_bandwidth>
<dest_mach></dest_mach>
<ft_dest_dt></ft_dest_dt>
<ft_tls_override></ft_tls_override>
</jobdata>
Element Definitions
<host_name></host_name>
Defines the Source Machine for the transfer. To qualify as a machine for this field, a machine must be enabled for File transfer in the File Transfer Settings category in The Machine's advanced settings.
- Requirements: Required
- EM field label: Machine
- Valid Values:
- Characters: 1-24
- Invalid Characters: ' (single quote), ~ (tilde), `(grave accent)
<ft_src_user></ft_src_user>
Contains the user name for the Source user If the platform requires a user name. If the platform does not require a User name, specify N/A.
- Requirements: Required
- EM field label: User
- Valid Values:
- Characters: 1-60
<ft_src_file></ft_src_file>
Contains the full path and the file name of The source file to be transferred.
- Requirements: Required
- EM field label: File
- Valid Values:
- Characters: 1-512
<ft_dest_user></ft_dest_user>
Contains the user name for the destination User if the platform requires a user name. If the platform does not Require a user name, specify N/A.
- Requirements: Required
- EM field label: User
- Valid Values:
- Characters: 1-60
<ft_dest_file></ft_dest_file>
Contains the full path and file name of the Destination file to be transferred to.
- Requirements: Required
- EM field label: File
- Valid Values:
- Characters: 1-512
<FT_xqt_mach></FT_xqt_mach>
Defines which machine will initiate the File Transfer communication.
- Requirements: This is an Optional Field. If not specified, the value defaults to Destination.
- EM field label: Start Transfer On
- Valid Values: Destination, Source
<ft_mode></ft_mode>
Defines the Source Data Type of the file to Transfer.
- Requirements: Required
- Valid Values: ASCII, Binary, Default Text, EBCDIC
If Binary is used for the source data type, it WILL also be used for the destination data type as well, regardless of the value specified for the <ft_dest_dt> tag. If the Destination Data Type is Binary and the Source Data Type is not Binary, errors will display.
<ft_compress></ft_compress>
Allows selecting compression Options.
- Requirements: Required
- Valid Values: None, Required, Preferred
<ft_encrypt></ft_encrypt>
Specifies if this field must be used, is not Used, or use is preferred.
- Requirements: Required
- Valid Values: <none>, Required, Preferred
<ft_overwrt></ft_overwrt>
Specifies what the user wants to do if the File already exists on the destination machine.
- Requirements: Required
- Valid Values: Do Not overwrite, Overwrite, Backup then Overwrite, Append, Backup then Append.
<FT_delsrcfile></FT_delsrcfile>
Determines if the source file will be Deleted after the SMAFT process completes successfully.
- Requirements: Required, and if data is not provided it will be set to "No".
- EM field label: Delete Source File
- Valid Values: No, Required, Preferred
<ft_failpref></ft_failpref>
Allows an FT job return a fail code if the "Preferred" Encryption and Compression settings are not met.
- Requirements: Required
- EM field label: Fails if preferred settings not satisfied
- Valid Values: Yes, No
<ft_bandwidth></ft_bandwidth>
Sets the transfer rate of the file and Allows the user to "throttle back" bandwidth usage.
- Requirements: Required
- Valid Values: 64, 128, 256, 512, 1024, 2048, >2048
<dest_mach></dest_mach>
Defines the name of the destination machine For the file transfer. In order to qualify as a machine for this field, A machine must be enabled for file transfer in the File Transfer Settings category in The Machine's advanced settings.
- Requirements: Required
- EM field label: Machine
- Valid Values:
- Characters: 1-24
- Invalid Characters: ' (single quote), ~ (tilde), `(grave accent)
<ft_dest_dt></ft_dest_dt>
Defines the type of the file (ASCII, Binary, Default Text, or EBCDIC) to receive.
- Requirements: Required
- Valid Values: ASCII, Binary, Default Text, EBCDIC
If Binary is used for the source data type, it WILL also be used for the destination data type as well, regardless of the value specified for the <ft_dest_dt> tag. If the Destination Data Type is Binary and the Source Data Type is not Binary, errors will display.
<ft_tls_override></ft_tls_override>
Specifies whether the file transfer Should take place over a secure connection if possible, must take place Over a secure connection, or must not take place over a secure Connection.
- Requirements: Optional
- Valid Values: Preferred, Required, None
IBM i Job Element Structure
The following sample code contains the structure for defining every Possible element for IBM i Primary Job Elements. For detailed Information on each field for this job type, refer to IBM i Job Details in The Concepts online help.
<msg>
<msgtype> </msgtype>
<schedule>
<job>
<jobdata>
------Job Information Element Definitions------
<job_type></job_type>
<i5_userid></i5_userid>
<job_q_pri></job_q_pri>
<job_date></job_date>
<acct_code></acct_code>
<curr_lib></curr_lib>
<init_lib></init_lib>
<job_desc_name></job_desc_name>
<job_desc_lib></job_desc_lib>
<batchq_name></batchq_name>
<batchq_lib></batchq_lib>
<outputq_name></outputq_name>
<outputq_lib></outputq_lib>
------Call Information Element Definitions------
<i5os_prerun></i5os_prerun>
<call_script></call_script>
<ftp_remtsys></ftp_remtsys>
<ftp_act></ftp_act>
<ftp_tfr></ftp_tfr>
<ftp_user></ftp_user>
<ftp_lclfn></ftp_lclfn>
<ftp_lcldir></ftp_lcldir>
<ftp_rmtfn></ftp_rmtfn>
<ftp_rmtdir></ftp_rmtdir>
------File Arrival Element Definitions------
<ibmi_cfa_read></ibmi_cfa_read>
<ibmi_cfa_write></ibmi_cfa_write>
<ibmi_cfa_exec></ibmi_cfa_exec>
<ibmi_chk_file_lck_db2></ibmi_chk_file_lck_db2>
<ibmi_file_2_watch></ibmi_file_2_watch>
<ibmi_file_start_watch></ibmi_file_start_watch>
<ibmi_file_end_watch></ibmi_file_end_watch>
<ibmi_file_stable></ibmi_file_stable>
<ibmi_filearrival_failcode></ibmi_filearrival_failcode>
<ibmi_dynvar_filename></ibmi_dynvar_filename>
<ibmi_dynvar_reccnt></ibmi_dynvar_reccnt>
------Log Information Element Definitions------
<log_lvl></log_lvl>
<sev_lvl></sev_lvl>
<txt_opt></txt_opt>
<cl_log></cl_log>
<inq_msg></inq_msg>
<joblogs_keep_occur> </joblogs_keep_occur>
<joblogs_keep_days> </joblogs_keep_days>
------Message Element Definitions------
<msg_info>
<msg_id></msg_id>
<msg_cmpdata></msg_cmpdata>
<msg_pos></msg_pos>
<msg_sev></msg_sev>
<msg_actn></msg_actn>
<msg_reply></msg_reply>
<msg_endjob></msg_endjob>
<msg_events></msg_events>
</msg_info>
------Spools Element Definitions------
<spl_info>
<spl_name></spl_name>
<spl_user></spl_user>
<spl_outq_name></spl_outq_name>
<spl_outq_lib></spl_outq_lib>
<spl_copies></spl_copies>
<spl_hld></spl_hld>
<spl_save></spl_save>
</spl_info>
------Variables Element Definitions------
<ibmi_agent_var_info>
<ibmi_agent_var></ibmi_agent_var>
<ibmi_agent_var_val></ibmi_agent_var_val>
</ibmi_agent_var_info>
</jobdata>
</job>
</schedule>
</msg>
Job Information Element Definitions
<JOB_TYPE></JOB_TYPE>
Defines the IBM i job type.
- Requirements: Required for IBM i <jobdata>
- EM field label: Job Type
- Valid Values: The following values are provided in a list of available options: Batch Job, Tracked Job, Queued Job, Operator Replay Job, Restricted Mode, and FTP.
<I5_USERID></I5_USERID>
Defines the name of the IBM i user profile under which the job should be Submitted.
- Requirements: Required for IBM i <jobdata>
- EM field label: User ID
- Valid Values: All values from the Batch User Privileges screen that the user has privileges to.
<JOB_Q_PRI></JOB_Q_PRI>
Defines the job queue scheduling priority.
- Requirements: Required for IBM i <jobdata>
- EM field label: JobQ Priority
- Valid Values: *, 1, 2, 3, 4, 5, 6, 7, 8, 9
- Values range from 1 through 9, where 1 is the highest priority and 9 is the lowest.
- If an asterisk (*) is specified, the default value specified in the SMA system parameters for the agent will be used.
- The specification *JOBD is not supported
<JOB_DATE></JOB_DATE>
Defines the calendar date for the job to be associated with.
- Requirements: Required for IBM i <jobdata>
- EM field label: Job Date
- Valid Values: *JOBD, *SYSVAL, *SCHEDULE DATE, or a User-defined calendar date. User-defined dates must follow these requirements:
- The date must be entered in either the CCYYMMDD format, or the Short Date format recognized by the OpCon server's Regional Settings.
- Characters: 1-20
- Valid Characters: Numeric Characters (0 - 9), slash (/), dash (-), period (.), comma (,) space ( ).
- Invalid Character: asterisk (*). An asterisk (*) can be selected from a box, but it cannot be typed.
<ACCT_CODE></ACCT_CODE>
Specifies the accounting code that is used when logging system resource Use.
- Requirements: Optional for IBM i <jobdata>
- EM field label: Accounting Code
- Valid Values:
- Characters: 0-15
<CURR_LIB></CURR_LIB>
Defines the name of the current library associated with the job being run. The actual library name may be specified.
- Requirements: Required for IBM i <jobdata>
- EM field label: Current
- Valid Values: *, *CRTDFT, *USRPRF, or a User-defined library name.
- If an asterisk (*) is specified, the default value specified in the SMA system parameters for the agent is used.
- User-defined library name:
- Characters: 1-10
<INIT_LIB></INIT_LIB>
Defines the initial user part of the library list that is used to search for any Objects without a library. The individual library names are not Supported.
- Requirements: Required for IBM i <jobdata>
- EM field label: Init Lib List
- Valid Values: *, *JOBD, *NONE, *SYSVAL, *CURRENT, or a User-defined library name.
- If an asterisk (*) is specified, the default value specified in the SMA system parameters for the agent is used.
- User-defined library name:
- Characters: 1-10
<JOB_DESC_NAME></JOB_DESC_NAME>
Defines the simple name of the job description used with the job. The Actual job description name may be specified.
- Requirements: Required for IBM i <jobdata>
- EM field label: Name
- Valid Values: *, *USRPRF, or the actual job description name
- If an asterisk (*) is specified, the default value specified in the SMA system parameters for the agent is used.
- User-defined library name:
- Characters: 1-10
<JOB_DESC_LIB></JOB_DESC_LIB>
Defines the library associated with the job description name.
- Requirements: Required for IBM i <jobdata>
- EM field label: Library
- Valid Values: *, *LIBL, *CURLIB, or the User-defined name of the library associated with the job description name.
- The library name:
- Characters: 1-10
<BATCHQ_NAME></BATCHQ_NAME>
Defines the name of the job queue in which this job is placed. The Actual job queue name may be specified.
- Requirements: Required for IBM i <jobdata>
- EM field label: Name
- Valid Values: *, *JOBD, or the actual job queue name
- If an asterisk (*) is specified, the default value specified in the SMA system parameters for the agent is used.
- The job queue name:
- Characters: 1-10
<BATCHQ_LIB></BATCHQ_LIB>
Defines the library associated with the batch queue name.
- Requirements: Required for IBM i <jobdata>
- EM field label: Library
- Valid Values: *, *LIBL, *CURLIB, or the User-defined name of the library associated with the batch queue name.
- If an asterisk (*) is specified, the default value specified in the SMA system parameters for the agent is used.
- The library name:
- Characters: 1-10
<OUTPUTQ_NAME></OUTPUTQ_NAME>
Defines the output queue used for spooled files. The actual output queue Name may be specified.
- Requirements: Required for IBM i <jobdata>
- EM field label: Name
- Valid Values: *, *CURRENT, *USRPRF, *DEV, *JOBD, or the actual output queue name.
- If an asterisk (*) is specified, the default value specified in the SMA system parameters for the agent is used.
- The library name:
- Characters: 1-10
<OUTPUTQ_LIB></OUTPUTQ_LIB>
Defines the library associated with the Output Queue name.
- Requirements: Required for IBM i <jobdata>
- EM field label: Library
- Valid Values: *, *LIBL, *CURLIB, or the User-defined name of the library associated with the output queue name.
- If an asterisk (*) is specified, the default value specified in the SMA system parameters for the agent is used.
- The library name:
- Characters: 1-10
Call Information Element Definitions
<i5os_prerun></i5os_prerun>
Allows specifying an IBM i job to be Run immediately before the initiation of the job specified in the Call/Script Name field. If the Prerun job terminates with an error, it Will be rescheduled at a user-defined interval. The Prerun job will Continue to run at the user-defined interval until it succeeds, Allowing the job within the Job Information elements to process. The Purpose of a Prerun is to test any required preconditions to job Execution.
- Requirements: Optional
- EM field label: Prerun
- Valid Values: CHKDTAARA, CHKFILE, or a User-defined prerun value.
- Characters: 0-255
<CALL_SCRIPT></CALL_SCRIPT>
For a Batch Job, enter the program name using the CALL command or enter A command name. Do not use the SMBJOB command. If the SMBJOB command is Used, the agent will not be able to track the job for failure. Include Parameters in this field as desired. For an Operator Replay Job or Restricted Mode Job, enter the script name.
- Requirements: Required for IBM i <jobdata>
- EM field label: Call
- Valid Values: User-defined call/script name
- Characters: 1-2000
<FTP_REMTSYS></FTP_REMTSYS>
Sets the name of the remote system.
- Requirements: Required only when the job type is FTP for IBM i <jobdata>.
- EM field label: Remote System
- Valid Values:
- Characters: 1-255
<FTP_ACT></FTP_ACT>
Sets the FTP command to use.
- Requirements: Required only when the job type is FTP for IBM i <jobdata>.
- EM field label: Action Type
- Valid Values: PUT, MPUT, GET, MGET, DEL, MDEL
<FTP_TFR></FTP_TFR>
Sets the type of transfer for binary or ASCII.
- Requirements: Required only when the job type is FTP for IBM i <jobdata>.
- EM field label: Transfer Type
- Valid Values: BIN, ASCII, EBCDIC
<ftp_user></ftp_user>
Defines the FTP users for connecting to the remote system. If not specified, the agent will use the default user from the agent parameters.
- Requirements: Required for IBM i <jobdata>
- EM field label: User
- Valid Values: All values from the Batch User Privileges definitions
- Characters: 1-128
<FTP_LCLFN></FTP_LCLFN>
Defines the name for the file once it reaches the local machine.
- Requirements: Required only when the job type is FTP for IBM i <jobdata>.
- EM field label: Local File Name
- Valid Values: User-defined value
- This field is enabled for all action types, except MGET, DEL, and MDEL.
- Characters: 1-128
<FTP_LCLDIR></FTP_LCLDIR>
Defines the library or directory on the local machine.
- Requirements: Required only when the job type is FTP for IBM i <jobdata>.
- EM field label: Local Library or Directory
- Valid Values: User-defined value
- Characters: 1-512
<FTP_RMTFN></FTP_RMTFN>
Defines the file name once it reaches the remote machine.
- Requirements: Required only when the job type is FTP for IBM i <jobdata>.
- EM field label: Remote File Name
- Valid Values: *LCLFILNAM or a user-defined value
- This field is enabled for all action types, except MPUT
- Characters: 1-128
<FTP_RMTDIR></FTP_RMTDIR>
Defines the library or directory on the remote machine.
- Requirements: Required only when the job type is FTP for IBM i <jobdata>.
- EM field label: Remote Library or Directory
- Valid Values: User-defined value
- Characters: 1-512
File Arrival Element Definitions
<ibmi_cfa_read></ibmi_cfa_read>
Defines that the read type of object Authority should be verified for the named User ID.
- Requirements: Optional when the job type is File Arrival for IBM i <jobdata>.
- EM field label: Read
- Valid Values: True, False
<ibmi_cfa_write></ibmi_cfa_write>
Defines that the write type of object Authority should be verified for the named User ID.
- Requirements: Optional when the job type is File Arrival for IBM i <jobdata>.
- EM field label: Write
- Valid Values: True, False
<ibmi_cfa_exec></ibmi_cfa_exec>
Defines that the run type of object Authority should be verified for the named User ID.
- Requirements: Optional when the job type is File Arrival for IBM i <jobdata>.
- EM field label: Run
- Valid Values: True, False
<ibmi_chk_file_lck_db2></ibmi_chk_file_lck_db2>
Defines whether to request Verification that there are no in-use locks on any DB2 database files
- Requirements: Optional when the job type is File Arrival for IBM i <jobdata>.
- EM field label: Check Lock on DB2 File
- Valid Values: True, False
<ibmi_file_2_watch></ibmi_file_2_watch>
Defines the file path and name of the File to detect.
- Requirements: Required only when the job type is File Arrival for IBM i <jobdata>.
- EM field label: File Name
- Valid Values: User-defined value
- Characters: 1-4000
<ibmi_file_start_watch></ibmi_file_start_watch>
Defines the start of the time Frame that the program uses to watch for the arrival of the file.
- Requirements: Required only when the job type is File Arrival for IBM i <jobdata>.
- EM field label: Start Time
- Valid Values: a number of days and time from 0 -- 999 in Microsoft-formatted date time (e.g., 25.50 represents 1 day at 1:30 AM), or a Token.
<ibmi_file_end_watch></ibmi_file_end_watch>
Defines the end of the time frame That the program uses to watch for the arrival of the file.
- Requirements: Required only when the job type is File Arrival for IBM i <jobdata>.
- EM field label: End Time
- Valid Values: a number of days and time from 0 -- 999 in Microsoft-formatted date time (e.g., 25.50 represents 1 day at 1:30 AM), or a Token.
<ibmi_file_stable></ibmi_file_stable>
Defines the amount of time the file Size has remained stable to indicate the file has finished arriving.
- Requirements: Required only when the job type is File Arrival for IBM i <jobdata>.
- EM field label: File Size Stable Duration (in secs)
- Valid Values: a number of seconds from 0 - 999, or a Token.
<ibmi_filearrival_failcode></ibmi_filearrival_failcode>
Defines the action to take Based on the job failure or success status.
- Requirements: Required only when the job type is File Arrival for IBM i <jobdata>.
- EM field label: Failure Condition
- Valid Values: Always Succeed, Fail If File Contains Zero Records or Zero Bytes, Fail On Error, or Fail On Error Except Reached End Time.
<ibmi_dynvar_filename></ibmi_dynvar_filename>
Defines the root name of the file (including an extension, if any, from an IFS stream file) that is Stored, similar to the OpCon system property $ARRIVED FILE SHORT NAME.
- Requirements: Optional when the job type is File Arrival for IBM i <jobdata>.
- EM field label: File Name Variable
- Valid Values: User-defined value
- Characters: 1-12
<ibmi_dynvar_reccnt></ibmi_dynvar_reccnt>
Defines the number of records (for DB2 files/tables), or the number of data bytes (for IFS non-DB2 file Systems) is stored when a file is found.
- Requirements: Optional when the job type is File Arrival for IBM i <jobdata>.
- EM field label: Record Count Variable
- Valid Values: User-defined value
- Characters: 1-12