 |
The Network Suite functionality is deprecated. We don’t recommend using it for distributed testing. Consider using a CI/CD system for managing distributed tests. See Migrating Distributed Tests to CI/CD Systems for details. In case you need to run web tests on multiple environments in parallel, you can also try using your project’s Execution Plan. |
Description
The Tag property specifies an arbitrary string associated with the given task. The string can be set from the master project before the network suite run. This can be done via a script or via the TestComplete user interface (the Tag property of the task). When the network suite is run, this property can be read, but writing to it is not allowed. To get the value associated with the task which ran the given slave project, use the NetworkSuite.Tag property in this project.
Declaration
TaskObj.Tag
| Read-Write Property | String |
| TaskObj | An expression, variable or parameter that specifies a reference to a Task object | |||
Applies To
The property is applied to the following object:
Property Value
A string associated with the task.
Example
The following example obtains a task by its name, specifies its properties, sets a tag for the task and runs the task.
JavaScript, JScript
function Test()
{
var Task, TaskName;
// Specifies the name of the task
TaskName = "MyTask";
// Obtains the task by its name
Task = NetworkSuite.Jobs.ItemByName("MyJob").Tasks.ItemByName(TaskName);
// Specifies the tag for the task
Task.Tag = "My distributed test task";
// Specifies the host on which the task will be run
Task.Host = NetworkSuite.Hosts.ItemByName("SlaveComputer1");
// Specifies the path to the project the task will run
Task.ProjectPath = "D:\\Distributed Testing\\Slave\\SlaveProject.mds";
// Specifies the test item the task will run
Task.Test = "Slave_Script\\Script\\Slave\\Main";
// Runs the task
Task.Run(true);
}
{
var Task, TaskName;
// Specifies the name of the task
TaskName = "MyTask";
// Obtains the task by its name
Task = NetworkSuite.Jobs.ItemByName("MyJob").Tasks.ItemByName(TaskName);
// Specifies the tag for the task
Task.Tag = "My distributed test task";
// Specifies the host on which the task will be run
Task.Host = NetworkSuite.Hosts.ItemByName("SlaveComputer1");
// Specifies the path to the project the task will run
Task.ProjectPath = "D:\\Distributed Testing\\Slave\\SlaveProject.mds";
// Specifies the test item the task will run
Task.Test = "Slave_Script\\Script\\Slave\\Main";
// Runs the task
Task.Run(true);
}
Python
def Test():
# Specifies the name for the task
TaskName = "MyTask"
# Obtains the task by its name
Task = NetworkSuite.Jobs.ItemByName["MyJob"].Tasks.ItemByName[TaskName]
# Specifies the tag for the task
Task.Tag = "My distributed test task"
# Specifies the host on which the task will be run
Task.Host = NetworkSuite.Hosts.ItemByName["SlaveComputer1"]
# Specifies the path to the project the task will run
Task.ProjectPath = "D:\\Distributed Testing\\Slave\\SlaveProject.mds"
# Specifies the test item the task will run
Task.Test = "Slave_Script\\Script\\Slave\\Main"
# Runs the task
Task.Run(True)VBScript
Sub Test
Dim Task, TaskName
' Specifies the name of the task
TaskName = "MyTask"
' Obtains the task by its name
Set Task = NetworkSuite.Jobs.ItemByName("MyJob").Tasks.ItemByName(TaskName)
' Specifies the tag for the task
Task.Tag = "My distributed test task"
' Specifies the host on which the task will be run
Set Task.Host = NetworkSuite.Hosts.ItemByName("SlaveComputer1")
' Specifies the path to the project the task will run
Task.ProjectPath = "D:\Distributed Testing\Slave\SlaveProject.mds"
' Specifies the test item the task will run
Task.Test = "Slave_Script\Script\Slave\Main"
' Runs the task
Task.Run(True)
End Sub
Dim Task, TaskName
' Specifies the name of the task
TaskName = "MyTask"
' Obtains the task by its name
Set Task = NetworkSuite.Jobs.ItemByName("MyJob").Tasks.ItemByName(TaskName)
' Specifies the tag for the task
Task.Tag = "My distributed test task"
' Specifies the host on which the task will be run
Set Task.Host = NetworkSuite.Hosts.ItemByName("SlaveComputer1")
' Specifies the path to the project the task will run
Task.ProjectPath = "D:\Distributed Testing\Slave\SlaveProject.mds"
' Specifies the test item the task will run
Task.Test = "Slave_Script\Script\Slave\Main"
' Runs the task
Task.Run(True)
End Sub
DelphiScript
procedure Test();
var Task, TaskName;
begin
// Specifies the name of the task
TaskName := 'MyTask';
// Obtains the task by its name
Task := NetworkSuite.Jobs.ItemByName['MyJob'].Tasks.ItemByName[TaskName];
// Specifies the tag for the task
Task.Tag := 'My distributed test task';
// Specifies the host on which the task will be run
Task.Host := NetworkSuite.Hosts.ItemByName['SlaveComputer1'];
// Specifies the path to the project the task will run
Task.ProjectPath := 'D:\Distributed Testing\Slave\SlaveProject.mds';
// Specifies the test item the task will run
Task.Test := 'Slave_Script\Script\Slave\Main';
// Runs the task
Task.Run(true);
end;
var Task, TaskName;
begin
// Specifies the name of the task
TaskName := 'MyTask';
// Obtains the task by its name
Task := NetworkSuite.Jobs.ItemByName['MyJob'].Tasks.ItemByName[TaskName];
// Specifies the tag for the task
Task.Tag := 'My distributed test task';
// Specifies the host on which the task will be run
Task.Host := NetworkSuite.Hosts.ItemByName['SlaveComputer1'];
// Specifies the path to the project the task will run
Task.ProjectPath := 'D:\Distributed Testing\Slave\SlaveProject.mds';
// Specifies the test item the task will run
Task.Test := 'Slave_Script\Script\Slave\Main';
// Runs the task
Task.Run(true);
end;
C++Script, C#Script
function Test()
{
var Task, TaskName;
// Specifies the name of the task
TaskName = "MyTask";
// Obtains the task by its name
Task = NetworkSuite["Jobs"]["ItemByName"]("MyJob")["Tasks"]["ItemByName"](TaskName);
// Specifies the tag for the task
Task["Tag"] = "My distributed test task";
// Specifies the host on which the task will be run
Task["Host"] = NetworkSuite["Hosts"]["ItemByName"]("SlaveComputer1");
// Specifies the path to the project the task will run
Task["ProjectPath"] = "D:\\Distributed Testing\\Slave\\SlaveProject.mds";
// Specifies the test item the task will run
Task["Test"] = "Slave_Script\\Script\\Slave\\Main";
// Runs the task
Task["Run"](true);
}
{
var Task, TaskName;
// Specifies the name of the task
TaskName = "MyTask";
// Obtains the task by its name
Task = NetworkSuite["Jobs"]["ItemByName"]("MyJob")["Tasks"]["ItemByName"](TaskName);
// Specifies the tag for the task
Task["Tag"] = "My distributed test task";
// Specifies the host on which the task will be run
Task["Host"] = NetworkSuite["Hosts"]["ItemByName"]("SlaveComputer1");
// Specifies the path to the project the task will run
Task["ProjectPath"] = "D:\\Distributed Testing\\Slave\\SlaveProject.mds";
// Specifies the test item the task will run
Task["Test"] = "Slave_Script\\Script\\Slave\\Main";
// Runs the task
Task["Run"](true);
}