WorkflowGen 7.17.0 Web Services API
Namespaces
Advantys.Workflow.Web.Services.Processes.Runtime
RuntimeService Class
RuntimeService Methods
AddAssociationsToParticipant Method
AddDelegation Method
AddGroupsToUser Method
AddUsersToGroup Method
AssignActivityInstance Method
CanAssignActivityInstance Method
CanAssignUserToActivityInstance Method
CanCancelActivityInstanceAssignment Method
CanCancelProcessInstance Method
CancelActivityInstanceAssignment Method
CancelProcessInstance Method
CompleteActivityInstance Method
CompleteActivityInstanceFromThreadIndex Method
CompleteWebFormActivityInstance Method
CreateGlobalList Method
CreateGroup Method
CreateParticipant Method
CreateProcess Method
CreateUser Method
CreateWorkflowApplication Method
DeleteDelegation Method
DeleteGroup Method
DeleteParticipant Method
DeleteProcessInstanceComment Method
DeleteUser Method
GetActivityInstanceAssignableUserList Method
GetActivityInstanceContext Method
GetActivityInstanceContextFromThreadIndex Method
GetActivityInstanceList Method
GetActivityInstanceListCount Method
GetCommentList Method
GetCommentListCount Method
GetDelegateUserList Method
GetDelegateUserListCount Method
GetDelegationList Method
GetDelegationListCount Method
GetGlobalList Method
GetGroup Method
GetLaunchableProcessList Method
GetLaunchableProcessListCount Method
GetParticipant Method
GetPortlet Method
GetProcess Method
GetProcessInstanceCommentList Method
GetProcessInstanceCommentListCount Method
GetProcessInstanceContext Method
GetProcessInstanceFormData Method
GetProcessInstanceList Method
GetProcessInstanceListCount Method
GetUser Method
GetViewList Method
GetViewListCount Method
GetWorkflowApplication Method
NotifyDelegateUser Method
PostProcessInstanceComment Method
RaiseCancelExceptionOnActivityInstance Method
RaiseCancelExceptionOnActivityInstanceByName Method
RaiseExceptionOnActivityInstance Method
RaiseExceptionOnActivityInstanceByName Method
RemoveAssociationsFromParticipant Method
RemoveGroupsFromUser Method
RemoveUsersFromGroup Method
ReplaceProcessVersion Method
StartProcess Method
UpdateDelegation Method
UpdateGroup Method
UpdateParticipant Method
UpdateProcessInstanceComment Method
UpdateProcessInstanceData Method
UpdateUser Method
Click or drag to resize

RuntimeServiceGetProcess Method

Gets a process definition. Intended for web use only.

Namespace:  Advantys.Workflow.Web.Services.Processes.Runtime
Assembly:  Advantys.Workflow.Web.Services.Processes.Runtime (in Advantys.Workflow.Web.Services.Processes.Runtime.dll) Version: 7.17.0.0 (7.17.0.20200120)
Syntax
Copy
public string GetProcess(
	string processName
)

Parameters

processName
Type: SystemString
Name of the process to get. Can be empty if ProcessId is specified.

Return Value

Type: String
Returns the process definition as a string.
Remarks
Available since WorkflowGen version: 6.2.0

Optional Parameters.

These parameters can be used in the query string or as parameters of the Headers object in the RuntimeService class instance. See example below.

ProcessId (int)Specifies the Id of the process to get. Supercedes the Process name.
ProcessVersion (int)Specifies the version of the included ProcessName to get.
ProcessStatus (string)Specifies the status of the process to get. Gets the latest version of the process with the matching status. Accepted values: string.Empty, "DEV", "TEST", "ACTIVE"
IncludeAssociatedFiles (bool)Specifies whether or not to include associated files (e.g. FORM_HTML for form designer processes). Default = true.
Sample code:
Copy
RuntimeServiceWebService.RuntimeService myRuntimeService = new RuntimeServiceWebService.RuntimeService();
RuntimeServiceWebService.GetProcessHeader myGetProcessHeader = new RuntimeServiceWebService.GetProcessHeader();
myRuntimeService.GetProcessHeaderValue = myGetProcessHeader;

myGetProcessHeader.ProcessId = processId;
myGetProcessHeader.ProcessStatus = processStatus;
myGetProcessHeader.ProcessVersion = processVersion;
myGetProcessHeader.IncludeAssociatedFiles = includeFiles;

string myProcessDefinition = myRuntimeService.GetProcess(processName);

Possible combination of parameters are as such (in order of priority): ProcessId, ProcessName and ProcessVersion, ProcessName and ProcessStatus, ProcessName. e.g. If processName and ProcessId are included. ProcessId will be used to retrieve the process.


See Also