AS/400; TCP/IP

The ITP/Server e-Server Iseries Connection distribution includes the Submit ITP/Server Job (SBMITPJOB) command (in library ITPCOM31):

>>-SBMITPJOB---------------------------------------------------------->

>--SERVICE(--Name of the Service called--)---------------------------->

>-+------------------------------------+------------------------------>

  |        .------------------------.  |

  |        V                   (3)  |  |

  '--PARS(----script-parameter------+-)'

>-HOST(--+-hostname--+--)--PORT(--+-service-name-+--)----------------->

         '-ip-number-'            '-port-number--'

>--JOBID(--job-identifier--)-------+--------------------+------------->

                                   |        .-*NO--.    |

                                   '-SYNC(--+-*YES-+--)-'

(4)

>--+----------------------------+------------------------------------->

   | (1)            .-*NO--.    |
   '------CONFIRM(--+-*YES-+--)-'

>--+----------------------------+--+-------------------------+-------->

   | (1)            .-*NO--.    |  | (1)         .-*NO--.    |

   '------RECEIVE(--+-*YES-+--)-'  '------SEND(--+-*YES-+--)-'

>--+--------------------+--+-------------------+--------------------->

   |        .-*YES-.    |  |       .-*NO--.    |

   '-MSG-(--+-*NO--+--)-'  '-LOG(--+-*YES-+--)-'

>--+----------------------------------------------+------------------>

   | (1)           .-*LIBL/-------.               |

   '------XCHFIL(--+--------------+--file-name--)-'

                   '-library-name/'

>--+-------------------------------------------------+--------------->

   | (1)           .-*LIBL/-------.                  |

   '------XCHPGM(--+--------------+--program-name--)-'

                   '-library-name/'

>--+-----------------------+--+--------------------------+----------->

   |           .-*DNS-.    |  |            .-*MAP---.    |

   '-RESOLVE(--+-*IP--+--)-'  '-CODEPAGE(--+-*HEX---+--)-'

                                           +-*JOB---+

                                           '-number-'

Notes

(1) This functionality is only supported by the client if SYNC(*YES) is specified.

(2) This functionality is only supported by the client if either RECEIVE(*YES) or
SEND(*YES) is specified.

(3) Up to 32 parameters of up to 4095 characters can be specified.

(4) Parameters past this point are not prompted by default.

Purpose

The Submit ITP/Server Job (SBMITPJOB) command is used to submit a request to a remote ITP/Server Service.

Parameters

SERVICE

• Required
• Specifies the name of the Service the job is submitted to.

PARS

• Optional
• Specifies up to 32 parameters for the job. Every parameter can contain up to 4095 characters.

HOST

• Required
• Specifies the hostname of the remote host running the ITP/Server.

PORT

• Required
• Specifies the ITP/Server port number or port name.

JOBID

• Required
• The Job ID used to identify the job in the ITP/Server queue. This parameter cannot be blank.

SYNC

• Optional
• Specifies whether the command will wait until the ITP/Server has processed the job.
  *YES: Wait until the job is completed.
  *NO: Terminate after the server has acknowledged receipt of the job.

CONFIRM

• Optional
• Specifies whether or not the client must confirm termination of the job back to the ITP/Server before the job is considered to be completed successful.
  *YES: Require confirmation.
  *NO: Do not require confirmation.
• This option is only used if SYNC(*YES) is specified.

RECEIVE

• Optional
• Specifies whether or not the client is allowed to receive files from the ITP/Server.
  *YES: The client is allowed to receive files.
  *NO: The client is not allowed to receive files. Any attempts to use the SendFile command in an ITP/Server script will fail.
• This option is only used if SYNC(*YES) is specified.

SEND

• Optional
• Specifies whether or not the client is allowed to send files to the ITP/Server.
  *YES: The client is allowed to send files.
  *NO: The client is not allowed to send files. Any attempts to use the ReceiveFile command in an ITP/Server script will fail.
• This option is only used if SYNC(*YES) is specified.

MSG

• Optional
• Specifies if the command will send progress messages to its caller.
  *YES: Send messages to the caller.
  *NO: No messages are sent.

LOG

• Optional
• Specifies if the command will log messages in the REQHST file.
  *YES: All messages are logged.
  *NO: No messages are logged.

XCHGFIL

• Optional
• Specifies to which file the client writes the data sent with the exchange_data function. If this parameter is not specified data will not be written to a file.
• The SBMITPJOB will send an empty response back to the ITP/Server unless the XCHGPGM parameter is also specified. In that case the response of the XCHGPGM exit program will be sent back.
• Refer to below for a description of the EXCHANGE file format.

XCHGPGM

• Optional
• Specifies which exit program the client will call if data is sent with the exchange_data function. If this parameter is not specified no exit programs will be called.
• The SBMITPJOB will send an empty response back to the ITP/Server unless the XCHGPGM parameter is specified. In that case the response of the XCHGPGM exit program will be sent back.
• Refer to below for a description of the XCHGPGM exit program.

RESOLVE

• Optional
• Specifies in which order the host name specified with the HOST(...) parameter is resolved.
• *DNS: First attempt to resolve the hostname through any configured DNS server, and then attempt to translate the address as a numerical IP address.
• *IP: First attempt to translate the address as a numerical IP address and then attempt to resolve the hostname through any configured DNS server.

CODEPAGE

• Optional
• Specifies how the client should send its codepage back to the ITP/Server if the script requires a client codepage.
  *MAP: Attempt to map all characters to Unicode and send this mapping to the ITP/Server.
  *HEX: Do not perform a codepage translation.
  *JOB: Send the codepage of the job. If the job uses CCSID *HEX, the system codepage is sent. If the system also uses CCSID *HEX no codepage translation is performed.
  number: Send a specific codepage number to the server. This option requires that the codepage translation table must be available to ITP/Server.

Remarks

The exchange_data function call in an ITP/Server script will fail unless the SBMITPJOB specified either a XCHGPGM or XCHGFIL parameter.

Error messages

Message	Type	Description
Description
IDS0001	*COMP	Request &1 has been completed successfully.
IDS0002	*INFO	File &1 has been sent successfully.
The SBMITPJOB command has sent the file &1 from the Integrated File System (IFS) to the ITP/Server.
IDS0003	*INFO	File &1 has been received successfully.
The SBMITPJOB command has received a file from the ITP/Server and stored this file as &1 in the Integrated File System (IFS).
IDS0004	*INFO	&1
This progress message is sent by the ITP/Server script for informational purposes.
IDS1000	*ESCAPE	Request &1 failed: &2
ITP/Server reported an error while executing the request. This error is caused by either a failed instruction in the script or an explicit Shutdown or ThrowError statement. Resolve the cause of the error and submit the request again.
IDS1001	*ESCAPE	Wrong number of parameters (&1)
The SBMITPJOB has been called with the wrong number of parameters in the call. The Service called determines the number of parameters needed.
IDS1002	*ESCAPE	Unable to resolve hostname &1.
SBMITPJOB was unable to determine an IP address for host &1. Either the hostname has been misspelled or there is an error in the DNS configuration.
IDS1003	*ESCAPE	Unable to resolve port name &1.
SBMITPJOB was unable to determine a number for port &1.
IDS1004	*ESCAPE	&1
SBMITPJOB was unable to allocate a TCP/IP network socket for a connection to the ITP/Server. Resolve the cause of this error and try again.
IDS1005	*ESCAPE	&2
SBMITPJOB was unable to connect to the ITP/Server. Resolve the cause of this problem and try again. For more information refer to Known Issues below: AS/400 integration; SBMITPJOB fails with IDS1005, Address not available due to security policies.
IDS1006	*ESCAPE	&2
SBMITPJOB failed to send data to the ITP/Server. Resolve the cause of this error and try again.
IDS1007	*ESCAPE	&2
SBMITPJOB failed to receive data from the ITP/Server. Resolve the cause of this error and try again.
IDS1008	*ESCAPE	&1
An error occurred during the retrieval of the client codepage for the ConvertCodepage command.
IDS1009	*ESCAPE	&1
An error occurred during the execution of the SendFile command.
IDS1010	*ESCAPE	&1
An error occurred during the execution of the ReceiveFile command.
IDS1011	*ESCAPE	&1
An error occurred during the execution of the exchange_data function.
IDS1100	*ESCAPE	ITP/Server is shut down by an operator.
The job has been cancelled because ITP/Server has been shut down by an operator or by the Shutdown command. Wait until ITP/Server is restarted and submit the request again.
IDS1101	*ESCAPE	Request is not understood by ITP/Server.
The ITP/Server is not able to handle a request sent. The version of SBMITPJOB is newer than the version of ITP/Server installed on the server.
IDS1102	*ESCAPE	Job has been aborted by operator.
The ITP/Server request has been cancelled by an operator.
IDS1103	*ESCAPE	Redirect Service required a destination Service.
The ITP/Server request has been submitted to a Redirect Service. This service requires the request contains at least one parameter, which is used as the name of the destination Service. Specify a valid queue name as the first parameter and try again.
IDS1104	*ESCAPE	Cannot redirect a request to another Redirect Service.
The ITP/Server request has been submitted to a Redirect Service but contains another destination Service as the destination. This indirection is not supported. Specify the final destination Service as the first parameter and try again.
IDS1105	*ESCAPE	Service must exist.
The ITP/Server request has been submitted to a Redirect Service. The destination Service does not exist. Specify a valid destination Service service as the first parameter and try again.
IDS1106	*ESCAPE	Cannot redirect a request to a disabled Service.
The ITP/Server request has been submitted to a Redirect Service. The destination Service has been disabled in the ITP/Server configuration. Either enable the Service or select a valid destination Service.
IDS1107	*ESCAPE	Cannot redirect a request to a mis-configured Service.
The ITP/Server request has been submitted to a Redirect Service. The destination Service has been disabled due to configuration errors in the ITPDP.INI file. Either correct the errors or select a valid destination Service.
IDS1108	*ESCAPE	Lost synchronization with ITP/Server.
IDS1999	*ESCAPE	&1
Internal error in the SBMITPJOB command. Resolve the cause of the problem. If the problem persists, contact your helpdesk. Please include a complete job log in your report

Compatibility

The SBMITPJOB client shipped with ITP/Server is not backward compatible with ITP/Document Services (ITP/DS) 2.0 servers.

The generic CPF9898 message that was sent by the ITP/DS 2.0 SBMIDSJOB on any error conditions has been replaced by specific error messages.

Example

SBMITPJOB

	SERVICE ('a service')

	PARS('key info' 34)

	HOST('10.0.0.11')

	PORT(3001)

	JOBID('AS/400 Job')

	SYNC(*YES)

This command will send a request to the Service 'a service' configured in ITP/Server that runs on 10.0.0.11 with external port 3001. The job has Job ID 'AS/400 Job' and two parameters ('key info' and 34). The SBMITPJOB command will wait until the request has been processed.