SubmitJob

The SubmitJob method allows a user to remotely submit files to their Connect Workflow from a SOAP client. The SOAP client has the option to wait for a response file from Connect Workflow SOAP server.

Syntax

SubmitJob (File, SubmitJobInfStruc , ReturnJobFile, user name, Password) : SubmitJobResult

Arguments

  • File – base64Binary. This is an array of byte base64 encoded (see http://en.wikipedia.org/wiki/Base64).
  • SubmitJobInfStruc – Structure containing any required information to prepare the file for a valid insertion into a Connect Workflow process (see SubmitJobInfStruc).
  • ReturnJobFile – Boolean value. When true, Connect Workflow SOAP server returns the job file. When false, there no file is returned to the SOAP client. (For example: when submitting a job for print, there is no need to return a file)
  • user name: String containing the user name.
  • Password: String containing the password. This is case sensitive.

Return Value

SubmitJobResult: Structure containing the following information:

  • Success: Integer indicating the Success/Error level of the operation. A result of 0 means the operation was successful.
  • Message: String containing text information about the Success/Failure status.
  • SubmitJobInfStruc: Structure containing any required information to prepare the file for a valid insertion into a Connect Workflow process (see SubmitJobInfStruc).
  • ResultFile: base64Binary. If Success is different than 0 or the ReturnJobFile was set to False in the initial call, no file is returned. Otherwise, ResultFile contains the job file, as it existed at the completion of the Connect Workflow process (for instance, if the process creates a PDF and sets it as the current job file, the PDF is the file that gets returned to the calling SOAP client).

Note:  

  • The SubmitJob method only returns a file if the Connect Workflow process contains a SOAP Input task.
  • If ReturnJobFile is set to true, the schedule options of the process should be set to a pooling lower than four seconds, so the client application gets a timely response.
  • To return the file, the process must be completed before the timeout of the server occurs. The Timeout option can be set in your Connect Workflow preferences.