GetTasksForWorkflow


Description

This method retrieves the list of workflow tasks for a document in the specified workflow for a company.

Parameters

Parameter

Type

Description

key

BusinessObjectKey

The business object key that specifies the document in Microsoft Dynamics GP for which workflow tasks will be returned.

associationKey

WorkflowAssociationKey

The workflow association key that specifies the workflow being examined.

includeCompleted

boolean

The value true indicates both complete and incomplete tasks will be returned. The value false indicates only incomplete tasks will be returned.


Return Value:

Value

Type

Description

GetTasksForWorkflowResult

ArrayOfWorkflowTask

A list of the workflow tasks for the specific document in the company.


Examples

The following C# example retrieves the list of tasks for the Dynamics GP Sales Quote Approval Workflow set up for the sample company. The tasks for the Sales Quote document with the document number “QTEST1032” are returned. The list of tasks is displayed in a dialog.

Be sure to use the URL and port for your workflow server.


using System;
using System.Collections.Generic;
using System.Text;
using System.Windows.Forms;
using Microsoft.Dynamics.Workflow.Proxy;

namespace WorkflowWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			WorkflowAssociationKey workflowKey;
			BusinessObjectKey key;
			KeyPart[] keyParts;
			KeyPartOfString docNumber;
			KeyPartOfString docType;
			WorkflowTask[] tasks;

			// Create an instance of the web service
			DynamicsWorkflow wsWorkflow = new DynamicsWorkflow();

			// Specify the URL used to access the Workflow web service
			wsWorkflow.Url = "http://WorkflowServer:10072/_vti_bin/WorkflowService.asmx";

			// Be sure that default credentials are being used
			wsWorkflow.UseDefaultCredentials = true;

			// Create the company key for the sample company
			companyKey = new CompanyKey();
			companyKey.Id = (-1);

			// Get the tasks for a workflow
			workflowKey = new WorkflowAssociationKey();
			workflowKey.OrganizationKey = companyKey;
			workflowKey.WorkflowName = "Dynamics GP Sales Quote Approval Workflow";

			// Specify which SOP Quote document
			key = new BusinessObjectKey();

			// Build the key parts
			// Document number
			docNumber = new KeyPartOfString();
			docNumber.Name = "SOPNUMBE";
			docNumber.PartValue = "QTEST1032";

			// Document type
			docType = new KeyPartOfString();
			docType.Name = "SOPTYPE";
			docType.PartValue = "Quote";

			// Assemble the key parts
			keyParts = new KeyPart[2];
			keyParts[0] = docNumber;
			keyParts[1] = docType;

			// Add the key parts to the key
			key.KeyParts = keyParts;

			// Get tasks for this workflow and document, including completed tasks
			tasks = wsWorkflow.GetTasksForWorkflow(key, workflowKey, true);

			// Display the list of tasks for the workflow
			StringBuilder taskList = new StringBuilder();
			foreach (WorkflowTask t in tasks)
			{
				taskList.AppendLine(t.AssignedTo + " -- " + t.Description);
		}
			MessageBox.Show(taskList.ToString());
	}
}
}


Documentation Feedback