How to launch a new request with context parameters from an external application via the web service API using SOAP


#1

This procedure lets you launch a new process from another application using HTTP parameters. It applies to WorkflowGen versions 5 and 6. Follow the instructions below for your version of WorkflowGen.

Note: For security reasons, the impersonation feature is restricted to allowed users, as defined in the ProcessesRuntimeWebServiceAllowedUsers entry in the \wfgen\ws\web.config (version 5) or \wfgen\web.config (version 6) file.

WorkflowGen version 6

Via WS API: StartProcess

Method definition

  • public int StartProcess(string processName, bool test, string context) Returns the created request ID if successful

Required parameters

  • processName Type: string Description: Name of process to launch
  • test Type: bool Description: Launch process in test mode?
  • context Type: string Description: XML structured IN/OUT parameters to send to the process start. (See Web Services API: WorkflowContext specifications and usage for instructions on how to create context parameters.)

Optional parameters (StartProcessHeader)

  • ImpersonateUsername Type: string Description: Username of impersonating user
  • ProcessId Type: int Description: Process ID

    Note: This parameter is to be used independently, without the processName and test parameters.

  • ProcessVersion
    Type: int
    Description: Process version

    Note: To be used with processName only.

Download SDK_CS_RemoteLaunchSOAP_v6_1.zip, unzip it, and follow the instructions in the included “setup.txt” file for an example of usage.

WorkflowGen version 5

Via WS API: StartProcess

Method definition

  • public int StartProcess(string processName, bool test, string context) Returns the created request ID if successful

Required parameters

  • processName Type: string Description: Name of the process to launch
  • test Type: bool Description: Launch process in test mode?
  • context Type: string Description: XML structured IN/OUT parameters to send to the process start. (See Web Services API: WorkflowContext specifications and usage for instructions on how to create context parameters.)

Optional parameter (StartProcessHeader)

  • ImpersonateUsername Type: string Description: Username of impersonating user

Download SDK_CS_RemoteLaunchSOAP_v5.zip, unzip it, and follow the instructions in the included “setup.txt” file for an example of usage.


Web Services API