The class Aia.ITP.Server.Job exposes the following properties:
The details of these properties will be discussed in the following subsections.
The property Host is a string that specifies the host name of the computer running ITP/Server. The name can be specified either in (IPv4) Internet Protocol dotted address notation (a.b.c.d), or as a resolvable host name.
The property Port is a string that specifies the port number on which the ITP/Server is running. The port can be specified either in numerical format or as a service name that is resolved through any available service databases.
The property JobID is a string that is used to identify the job on the ITP/Server. Among other things, it appears in the ITP/Server log files in all log lines that describe the job run.
The property Service is a string that specifies the name of ITP/Server service that the job should invoke.
The property Parameters is a read-only property of type List<String>. It contains the list of parameters that are passed to the ITP/Server service. To add or remove parameters, manipulate the object List<String> returned by this property, using the standard methods provided by the .NET Framework. Parameters may not be null. The empty string ("") is interpreted as if the parameter was not passed, which causes the default value to be substituted (if any).
The property SessionID is a string that specifies the ITP/Server session ID that will be associated with the submitted job. ITP/Server session IDs serve multiple purposes:
Session IDs for mutual exclusion may be specified by the calling client. Session IDs for persistent storage are always generated by ITP/Server, and must be sent to the calling client using the mechanism exchange_data. For convenience, the class Aia.ITP.Server.Job allows the ITP/Server service to pass a session ID using the mechanism exchange_data and using key "SessionID" (case insensitive). The data value of such a data exchange request will automatically be stored in the property SessionID of the object Aia.ITP.Server.Job. This functionality works regardless of whether the ExchangeData event is being handled.
Note:
Session IDs for non-ITP/OnLine jobs are only supported in ITP/Server 3.2.19 and higher. Mutual exclusion is supported in ITP/Server 3.2.19 and higher, for both ITP/OnLine and non-ITP/OnLine jobs.
For more information about the use of session IDs in ITP/Server, consult the ITP/Server Script Manual, chapter Using ITP/Server sessions.
The boolean property ConfirmCompletion specifies that the ITP/Server should not regard the job as completed until the client (i.e., the object Aia.ITP.Server.Job) has confirmed to the ITP/Server that it has received the message stating that the job has completed. This setting has no effect when the job is submitted using SubmitAsync. This property is set to false by default.
The boolean property KeepAlive specifies that the Aia.ITP.Server.Job object should send confirmation messages to the ITP/Server to indicate that it is still listening, upon request from the ITP/Server. This setting corresponds to the setting "connection verification" that can be found in the ITP/Server Administrator. This setting has no effect when the job is submitted using SubmitAsync. The property is set to false by default.
The boolean property NoDelay specifies that the underlying TCP/IP connection to the ITP/Server should not use Nagle's algorithm to put as much data as possible into a single network packet. Enabling this option significantly reduces network latency, but also leads to a significant increase in network traffic. The property is set to false by default.
The boolean property PrivateTransfer specifies that the ITP/Server load balancer should be bypassed for file transfers. Enabling this option may increase performance for large file transfers. The property is set to false by default.
The properties UserID and ApplicationID are strings that are used for the submission of ITP/OnLine Server jobs. The UserID specifies the user name of the user that is connected to ITP/OnLine Server, while the ApplicationID identifies the ITP/OnLine Server application that submits the job. It is normally not necessary to specify these properties.