The Aia.ITP.OnLine.Model class exposes the following properties:
The details of these properties will be discussed in the following sections.
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 SessionID is a string that specifies the ITP/Server session ID that will be associated with the submitted job. ITP/Server session IDs serve several purposes:
During ITP/OnLine Server runs of interactive ITP Models, the session ID is used for both these purposes. If no session ID is provided, ITP/OnLine Server will automatically assign a session ID to the model run during the method Start. This session ID will be automatically retrieved, and will be stored in the property SessionID.
Note:
Mutual exclusion is only supported in ITP/Server 3.2.19 and higher. In earlier versions, multiple jobs for the same session could be handled in parallel by multiple Document Processors.
The property UserID represents the Microsoft Windows user ID of the user who is doing this request. If this property is not set, the API will default to using the user ID that the calling application is running as.
The property ApplicationID is used to store additional accounting information. It is normally not necessary to set this property; it is used by ITP/OnLine.
The property Environment specifies the environment that the model runs in. If not set, the default environment will be used (if configured).
The properties DBUserID and DBPassword specify credentials to override the database credentials that have been configured in the ITP/Server environnment configuration. The password will always be transferred in encrypted form.
The boolean property History specifies that a list of all form answers should be returned together with the result document. This information is stored in an XML format, in the file specified by the property InfoFile. The default value for the property History is false.
The property DataFile specifies the file path to an XML data file. This file is used in conjunction with the ITP XML File Connection, and specifies the XML file that is used as input for the model run. If the property DataFile is not set and the ITP Model requires an XML data file, an XML form will be sent by ITP/Server, asking the user to upload an XML file.
If the property DataFileOnServer is enabled, then the file path will be interpreted as a path accessible from ITP/Server. If the property DataFileOnServer is disabled, then the .NET API will upload the file to ITP/Server from the specified local path. The default value for the property DataFileOnServer is false.
The property InfoFile specifies the path to the file in which all XML data will be returned. Its contents will depend on the specific method that is called, and on the return value of the method. Among the possible contents are:
InfoFile; when a Start or Continue call returns Model.ResultCode.Ready, and the property History is enabled.Start or Continue call returns Model.ResultCode.Interact.Start or Continue call returns Model.ResultCode.Error.The property ResultDocument specifies the file path which is used to store the final result document. It contains the last value that was passed through the resultDocument argument to the method Start. The result document will be written when a Start or Continue call returns Model.ResultCode.Done. If the property ResultDocumentAllowOverwrite is disabled and the file with the specified path already exists, an error code will be returned instead. The default value for the property ResultDocumentAllowOverwrite is true.
If the property ResultDocumentOnServer is enabled, then the file path will be interpreted as a path accessible from ITP/Server. If the property ResultDocumentOnServer is disabled, then the .NET API will download the file from ITP/Server to the specified local path. The default value for the property ResultDocumentOnServer is false.
The property ResultDocumentFormat is a string that specifies the file format in which the result document will be generated. This format can be either "native" or "PDF" (case insensitive). The default is "native", which means that the word processor format of the model itself gets generated.
The property PreviewDocument specifies the file path which is used to store preview documents. If this property is empty, then no preview documents will be generated.If a file path is specified, then ITP/Server will generate a preview document when the model run is interrupted for user interaction i.e., when a Start or Continue call returns Model.ResultCode.Interact. The preview document will be generated in the format specified by the property PreviewDocumentFormat. It is allowed to use the same path for both the preview document and the final result document.
If the property PreviewDocumentOnServer is enabled, then the file path will be interpreted as a path accessible from ITP/Server. If the property PreviewDocumentOnServer is disabled, then the .NET API will download the file from ITP/Server to the specified local path. The default value for the property PreviewDocumentOnServer is false.
The property PreviewDocumentFormat specifies the file format in which the preview document will be generated. This format can be either "native" or "PDF" (case insensitive). The default is "native", which means that the word processor format of the model itself gets generated.
The property ResultDocumentFileType is a read-only string property which specifies the file type of the result document. Possible values are;
unknown: unable to determine the type of the file.doc: Microsoft Word document.docx: Microsoft Word Open XML document.ps: PostScript file.pdf: PDF document.sxw: OpenOffice.org / StarOffice document.odt: OpenOffice.org 2.2 document.lwp: WordPro document.wpd: WordPerfect document.The property ProcessPreviewParams specifies a string that will be passed to the exit point ProcessPreview in ITP/Server. This can be used freely to pass information to the exit point, for example to specify which action it should take. This property is only supported by ITP/Server version 3.1.9 or higher.
The property ProcessResultParams specifies a string that will be passed to the exit point ProcessResult in ITP/Server. This can be used freely to pass information to the exit point, for example to specify which action it should take. This property is only supported by ITP/Server version 3.1.9 or higher.
The property FormVersion specifies the maximum XML Forms feature level that is supported by the client of the API. This allows clients to protect themselves against new features in the form XMLs returned by ITP/Server. If a FORM statement in an interactive ITP Model uses features that are not supported by the client, ITP/Server will abort the model run with an error. The default value for the property FormVersion is "0", which indicates that only basic XML forms are supported. This property is only supported by ITP/Server version 3.1.11 or higher.