Skip to main content Skip to complementary content

RunTask Method

Overloads

RunTask(Guid)

Runs a single task.

RunTask(Guid)

Runs a single task.

Declaration

      void RunTask(Guid taskID)
    

Parameters

Type Name Description
System.Guid taskID

The task ID.

Remarks

Used to initiate a specific task.

security

Requires membership of local group QlikView Management API and the role Document Folder Administrator.

Examples

The following code example starts the execution of a task, then immediately aborts it. This establishes some task log information. Then it retrieves this and any other existing information from the log into a list and displays the text entry for the first element.

The service key injection is assumed to be handled behind the scenes. For an example of how to inject the service key, see Samples.

    using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using QMSAPI;

class Program
{
    static void Main(string[] args)
    {
        try
        {
            // create a QMS API client
            IQMS apiClient = new QMSClient();

            //retrieve a time limited service key
            ServiceKeyClientMessageInspector.ServiceKey = apiClient.GetTimeLimitedServiceKey();        

            Guid taskId = new Guid("28a4fae4-8e75-4681-8ddc-751b7664a025");
            apiClient.RunTask(taskId); // A service call to initiate the execution of a task.
            Thread.Sleep(20*1000); //Wait for 20 seconds so that the task has time to start.
            apiClient.AbortTask(taskId); // A service call to end the execution of the same task.
            TaskStatus taskStatus = apiClient.GetTaskStatus(taskId,TaskStatusScope.All); // A service call to retrieve the task status.
            Console.WriteLine(taskStatus.Extended.LastLogMessages); // Displays the last log messages.   
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadLine();
    }
}   
  

See Also

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Join the Analytics Modernization Program

Remove banner from view

Modernize without compromising your valuable QlikView apps with the Analytics Modernization Program. Click here for more information or reach out: ampquestions@qlik.com