WorkflowGen 7.6.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

RuntimeServiceUpdateParticipant Method

Updates a participant. Intended for web use only. A participant's scope or process reference cannot be updated.

Namespace:  Advantys.Workflow.Web.Services.Processes.Runtime
Assembly:  Advantys.Workflow.Web.Services.Processes.Runtime (in Advantys.Workflow.Web.Services.Processes.Runtime.dll) Version: 7.6.0.0 (7.6.0.0)
Syntax
Copy
public void UpdateParticipant(
	string participantName,
	string participantDefinition
)

Parameters

participantName
Type: SystemString
Name of the participant to get.
participantDefinition
Type: SystemString
Definition of the participant to update. Element names are case sensitive.
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.

ParticipantId (int)Specifies the Id of the participant to update. Supercedes the participant name.
ProcessId (int)Specifies the Id of the process the participant is linked to for the update. Supercedes a combination of process name and process version.
ProcessName (string)Specifies the name of the process the participant is linked to for the update.
ProcessVersion (int)Specifies the version of the process the participant is linked to for the update.
IgnoreMissingAssociations (bool)Sets whether or not to return an error when an association (user, group, directory) is missing from the target. Default = true.
Sample participant definition to update a description:
Copy
<Participant>
  <Description>My new description</Description>
</Participant>
Updatable fields for a global participant (via participantName):
Copy
<Participant>
  <Name>MYGLOBALPARTICIPANT</Name>
  <Description>My desc</Description>
  <Type>HUMAN</Type>                         <!-- HUMAN, ROLE, COORDINATOR -->
  <Scope>GLOBAL</Scope>                      <!-- GLOBAL, PROCESS -->
  <Associations>
    <Users>
      <User>
        <Username>wfgen_admin</Username>
      </User>
    </Users>
    <Groups />
    <Directories />
    <Coordinators />
  </Associations>
</Participant>
Updatable fields for a process participant (via participantName, processName and processVersion):
Copy
<Participant>
  <ID>874</ID>
  <Name>MYGLOBALPARTICIPANT</Name>
  <Description>My desc</Description>
  <Type>HUMAN</Type>                                   <!-- HUMAN, ROLE, COORDINATOR -->
  <Scope>GLOBAL</Scope> <!-- not updatable -->         <!-- GLOBAL, PROCESS -->
  <Associations>
    <Users>
      <User>
        <Username>wfgen_admin</Username>
      </User>
    </Users>
    <Groups />
    <Directories />
    <Coordinators />
  </Associations>
  <Process> <!-- not updatable -->
    <Name>MYPROCESS</Name> <!-- not updatable -->
    <Version>1</Version> <!-- not updatable -->
  </Process> <!-- not updatable -->
  <Role>SUPERVISOR</Role>                                <!-- REQUESTER, ACTOR, SUPERVISOR -->
  <ViewGraphics>Y</ViewGraphics>                         <!-- Y, N -->
  <ReassignAction>Y</ReassignAction>                     <!-- Y, N -->
  <CancelRequest>Y</CancelRequest>                       <!-- Y, N -->
  <ViewStatistics>Y</ViewStatistics>                     <!-- Y, N -->
  <CommentsPermissions>RW</CommentsPermissions>          <!-- R, RW  -->
  <DatasourceQuery></DatasourceQuery>
</Participant>
Sample code:
Copy
RuntimeServiceWebService.RuntimeService myRuntimeService = new RuntimeServiceWebService.RuntimeService();
RuntimeServiceWebService.ParticipantHeader myParticipantHeader = new RuntimeServiceWebService.ParticipantHeader();
myRuntimeService.ParticipantHeaderValue = myParticipantHeader;

myParticipantHeader.ParticipantId = participantId;
myParticipantHeader.ProcessId = processId;
myParticipantHeader.IgnoreMissingAssociations = false;

myRuntimeService.UpdateParticipant(participantName, participantDefinition);

See Also