set_value Method

Visual Basic
Public Function set_value( _ ByVal prm_name As String, _ ByVal Value As String _ ) As Long

prm_name: The name of the parameter to be set. Not case-sensitive.
Value: The value to be set. Not case-sensitive.

S_OK if the call succeeds, otherwise S_FALSE.

Before running a test, the testing tool needs information from ALM, including the name of the test, the database to which the test belongs, and other test-related information. This information enables the testing tool to retrieve data from the ALM database, run tests, and return the test results to ALM.

Supported Parameter Names

Parameter Name	Description
database_name	The name of the active ALM database.
domain_name	The name of the ALM domain in which test and result information is stored.
host_name	The name of the host on which the remote agent test type is run.
password	The user’s password.
pinned_baseline_id	The ID of the baseline to which the current test set is pinned.
plann_status	The planning mode status of the test.
project_name	The name of the ALM project in which test and result information is stored.
responsible	The name of the user responsible for the project.
runner_result_dir	The name of the test run results directory.
scheduler_version	The software version number of the scheduler.
subject	The subject folder to which the test belongs in the test plan tree.
sys_computer_name	The name of the PC on which the ALM client is running.
sys_user_name	The login user name for the user logged in on the ALM client PC.
TDAPI_host_name	The name of the host on which the ALM Platform is running.
test_id	The ID of the test to be run.
test_name	The name of the test to be run.
test_path	The full path of the test to be run.
test_set	A string of form: {test_set: "" testcycle_id: "148~1"}
test_set_id	The ID of the test set to which the test belongs.
test_set_end	A value of Y indicates that the last test in the test set run finished. This does not indicate success or failure of tests, only the end of the run. See also, parameter test_set_start.
test_set_start	A value of Y indicates that a test set run has started. To enable remote agents to receive test_set_start and test_set_end information, add the SUPPORT_TESTSET_END configuration parameter in the Site Administration UI and set it to Y. Respond with a value of Y to get_value calls for both parameters.
test_set_user1...99	The value of a user field in the Test in the Test Set table.
test_type	The custom test type.
test_user1...99	The value of a user field in the Tests table. test_instance
testcycle_id	The ID of the test.
tester_name	The name of the tester assigned to run the test.
tstest_name	The name of the test to be run with a "[1]" instance prefix.
user_name	The name of the user running the test.

RemoteAgent Object

set_value Method

Syntax

Parameters

Return Type

Remarks

Supported Parameter Names

See Also