› KCM ComposerUI for ASP.NET Developer's Guide › Integration › Server-side integration › Preparation services › ITPOLSSessionPrepareModelList

ITPOLSSessionPrepareModelList

Parameters 

Parameter Text User
Parameter Text Pattern = ""
Parameter Text Root = ""
Parameter Text Keys = ""
Parameter Text Extras = ""
Parameter Text ResultFileName = "Result"
Parameter Text ProcessPreviewParams = ""
Parameter Text ProcessResultParams = ""
Parameter Text ProcessConfirmParams = ""
Parameter Text Environment = ""
Parameter Text ResultFileFormat = ""
Parameter Text Preview = ""
Parameter Text PreviewFileFormat = ""
Parameter Text Confirm = ""
Parameter Text ConfirmFileFormat = ""
Parameter Text DatabaseUID = ""
Parameter Text DatabasePWD = ""
Parameter Text OnSuccessCommand = ""
Parameter Text OnFailureCommand = ""
Parameter Text PreCommand = ""
Parameter Text PostCommand = ""
Parameter Boolean UploadDataFile = False
Parameter Boolean UploadDBB_XML = False
Parameter Text DBB_XMLInput = ""
Parameter Text DBB_XMLOutput = ""
Parameter Text RedirectUrl = ""

ITPOLSSessionPrepareModelList combines the functionality of the ITPOLSSessionStart, ITPOLSSessionUploadFile and ITPOLSSessionSetModelListParams services. It allows for the definition of KCM ComposerUI Master Template run in a single call and does the following:

  • Call ITPOLSSessionStart

  • If UploadDataFile is set to True, do a ReceiveFile with the value "datafile" for the parameter Src. The location of the received data file is used as Keys, and the Keys value passed to ITPOLSSessionPrepareModelList is ignored.

  • If UploadDBB_XML is set to True, do a ReceiveFile with the value "xml-input" for the parameter Src. The received data file is stored in the session and a reference to that file ("session:xml-input.xml") is used as DBB_XMLInput value, and the DBB_XMLInput value passed to ITPOLSSessionPrepareModel is ignored.

  • Call ITPOLSSessionSetModelListParams with the passed parameters.

The UploadDataFile feature is designed for Master Templates that use an XML File connection. The uploaded file is automatically used as the XML data file by the Master Template run.

The UploadDBB_XML feature is designed for Master Templates that have a Data Backbone which should be filled by a data XML that matches the xsd of the Data Backbone.

See ITPOLSSessionSetModelListParams for detailed parameter descriptions.