http://localhost/wfgen/ws/processesruntime.asmx
. See the WorkflowGen Web Services API Reference Guide for more information.CompleteActivityInstance
GetActivityInstanceContext
StartProcess
<NewDataSet>
node<NewDataSet>
node is a Dataset object that contains a set of parameters (parameter nodes) and one session information (session node).<Parameter>
node<Parameter>
node contains information about the parameter to exchange with WorkflowGen web method:<name>
<dataType>
TEXT
NUMERIC
DATETIME
FILE
<direction>
IN
OUT
INOUT
<textValue>
<numericValue>
<dateTimeValue>
xsd:dateTime
and stored in GMT (see the Time Zone IDs and GMT Values Mapping appendix)<fileName>
<fileDescription>
<fileSize>
<fileDateLastModified>
xsd:dateTime
<fileContentType>
<fileOriginalPath>
<filePath>
WorkflowGen.My.Data.ContextParameters
class:http://yourserver:port/wfgen/ws/ProcessesRuntime.asmx
.
CompleteActivityInstance
API, which is used to complete an open action.http://yourserver:port/wfgen/ws/ProcessesRuntime.asmx
) and click Add Reference. You will likely be prompted by the server to authenticate your request. Enter the appropriate username, password, and domain (if necessary). Once submitted, you should see the same screen as when you verified your access to the APIs, with a list of available APIs.
WFG_APIs
.
StartProcess
StartProcess
lets you launch a new request with context parameters from an external application via the web service API using SOAP. This web method lets you launch a new process from another application using HTTP parameters.public int StartProcess(string processName, bool test, string context)
: Returns the created request ID if successfulprocessName
test
Y
: Launch a test versionN
: Launch the active versioncontext
StartProcessHeader
)ImpersonateUsername
ProcessId
processName
and test
parameters)ProcessVersion
processName
only)SDK_CS_RemoteLaunchSOAP_v6_1.zip
, unzip it, and follow the instructions in the included setup.txt
file.StartProcess
web method supports impersonation, so an authorized user can launch a process on behalf of another user with this web method call. This impersonation feature is restricted to allowed users (defined in the ProcessesRuntimeWebServiceAllowedUsers
entry in the \wfgen\ws\web.config
file). This feature is useful when an external application doesn't have the user's credentials and wants to instantiate a process on their behalf. For more information, see the Impersonate username section below and the Web Services API: StartProcess: Launch a process on behalf of another user topic on the WorkflowGen Forum & Knowledge Base.SoapException "Security: You are not authorized to use this web service"
, it's because some WorkflowGen web service methods require an additional configuration setting to be called by a user. In the \wfgen\ws\web.config
file, you can edit the following key to authorize WorkflowGen administrators to use the secured web methods:RaiseCancelExceptionOnActivityInstance
RaiseCancelExceptionOnActivityInstanceByName
RaiseExceptionOnActivityInstance
RaiseExceptionOnActivityInstanceByName
UpdateProcessInstanceData
StartProcess
, with the ImpersonateUsername
SOAP or GET/POST parameterGetProcessInstanceList
and GetActivityInstanceList
web methods retrieve all the process data associated to the requests/actions. If you don't need process data values, you only need to add a SOAP header or query string parameter:ShowData=False
DataList
SOAP header or query string parameter:DataList=AMOUNT,APPROVAL,COMPANY
ProcessInstanceId
(these examples use request 17
).\wfgen\ws\App_Data
for the templates), you'll see a specific URL for each data file, which you can download using an HTTP GET/POST or an AJAX call from your web form.UpdateProcessInstanceData
UpdateProcessInstanceData
web method allows you to update the associated data of a request in progress from an external application. It is restricted to allowed users as defined in the ProcessesRuntimeWebServiceAllowedUsers
entry in the \wfgen\ws\web.config
file.processInstanceId
12345
activityInstanceId
2
workflowContext
MYTEXTDATA
and MYNUMDATA
are the process data names to update.ProcessesRuntimeWebServiceAllowedUsers
entry in the \wfgen\ws\web.config
file.ImpersonateUsername
value:todo
actions for jsmith
:jsmith
: