ExecutionContextInfo.ExecProperty (Silk Central API Specification)

java.lang.Object
- java.lang.Enum<ExecutionContextInfo.ExecProperty>
- - com.segue.tm.published.api.testlaunch.ExecutionContextInfo.ExecProperty

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ExecutionContextInfo.ExecProperty>

Enclosing interface:

ExecutionContextInfo
```
public static enum ExecutionContextInfo.ExecProperty
extends java.lang.Enum<ExecutionContextInfo.ExecProperty>
```
Enumeration of keys available in properties map returned by ExecutionContextInfo.getProperties(). The string representation of each property is set as Java system property and environment variable (toString() is "#sctm_" plus unique identifier).

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BUILD` Represents `"#sctm_build"`: The name of the build to which execution results are associated.
`DATA_DRIVEN_PARENT_TEST_ID` Represents `"#data_driven_parent_test_id"`: The numeric identifier (database key) of the parent test if this test executes a data driven row.
`DATA_DRIVEN_PARENT_TEST_NAME` Represents `"#data_driven_parent_test_name"`: The name of the parent test, if this test executes a data driven row.
`EXTERNAL_ID` Represents `"#external_id"`: The unique identifier of a test case in a test package to be executed.
`ID` Represents `"#sctm_execdef_id"`: The numeric identifier (database key) of the execution plan being executed.
`INDICATE_TESTCASE_START_FINISH` Represents `"#sctm_indicateTestCaseStartFinish"`: If true, a plugin is required to indicate beginning and ending of each sub test case, when executing multiple test cases within one test (for screen or video capturing).
`IS_TEST_PACKAGE_ROOT` Represents `"#is_test_package_root"`: If true, the test being executed is the root node of the test package (default).
`KEYWORDS` Represents `"#sctm_keywords"`: Keywords defined for this execution as comma separated list.
`NAME` Represents `"#sctm_execdef_name"`: The name of the execution plan being executed.
`PORT_TESTCASE_START_FINISH` Represents `#sctm_portTestCaseStartFinish`: The port a message must be sent to to indicate beginning and ending of each sub test case if the test runs in a separate process.
`PRODUCT` Represents `"#sctm_product"`: The name of the product as defined in the executed test container.
`REGULAR_EXECDEF_RUN_ID` Represents `"#sctm_regular_execdef_run_id"`: The numeric identifier (database key) of the regular execution plan run.
`SOURCE_ROOT_DIR` Represents the local path of the Test Container root directory, where all VCS controlled files reside.
`TEST_ID` Represents `"#sctm_test_id"`: The numeric identifier (database key) of the test being executed.
`TEST_NAME` Represents `"#sctm_test_name"`: The name of the SC test being executed.
`TEST_RESULTS_DIR` Represents `"#sctm_test_results_dir"`: The path of the directory where test result files reside.
`TUNNEL_TO_INTERNAL_PROXY` Represents `"#sctm_tunnel_to_internal_proxy"`: If true the application server has opened a tunnel to the execution server and acts as a proxy to allow testing a website in your local intranet.
`VERSION` Represents `"#sctm_version"`: The name of the version to which execution results are associated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`toString()` Returns the string representation of this property.
`static ExecutionContextInfo.ExecProperty`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static ExecutionContextInfo.ExecProperty[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - NAME
```
public static final ExecutionContextInfo.ExecProperty NAME
```
    Represents "#sctm_execdef_name": The name of the execution plan being executed. If the execution was triggered from the Planning unit, a value "Unassigned Tests" is in the properties map.
  - ID
```
public static final ExecutionContextInfo.ExecProperty ID
```
    Represents "#sctm_execdef_id": The numeric identifier (database key) of the execution plan being executed.
  - REGULAR_EXECDEF_RUN_ID
```
public static final ExecutionContextInfo.ExecProperty REGULAR_EXECDEF_RUN_ID
```
    Represents "#sctm_regular_execdef_run_id": The numeric identifier (database key) of the regular execution plan run. For setup and cleanup tests this property contains the run id of the regular run.
  - PRODUCT
```
public static final ExecutionContextInfo.ExecProperty PRODUCT
```
    Represents "#sctm_product": The name of the product as defined in the executed test container.
  - VERSION
```
public static final ExecutionContextInfo.ExecProperty VERSION
```
    Represents "#sctm_version": The name of the version to which execution results are associated.
  - BUILD
```
public static final ExecutionContextInfo.ExecProperty BUILD
```
    Represents "#sctm_build": The name of the build to which execution results are associated.
  - KEYWORDS
```
public static final ExecutionContextInfo.ExecProperty KEYWORDS
```
    Represents "#sctm_keywords": Keywords defined for this execution as comma separated list.
  - TEST_RESULTS_DIR
```
public static final ExecutionContextInfo.ExecProperty TEST_RESULTS_DIR
```
    Represents "#sctm_test_results_dir": The path of the directory where test result files reside.
  - INDICATE_TESTCASE_START_FINISH
```
public static final ExecutionContextInfo.ExecProperty INDICATE_TESTCASE_START_FINISH
```
    Represents "#sctm_indicateTestCaseStartFinish": If true, a plugin is required to indicate beginning and ending of each sub test case, when executing multiple test cases within one test (for screen or video capturing). This can be done by calling TestLaunchResultDrain.indicateTestCaseStart(String, String) and TestLaunchResultDrain.indicateTestCaseFinished(String, String, boolean). If the test runs in a separate process, messages must be sent to the port specified in the property PORT_TESTCASE_START_FINISHESTCASE_START_FINISH (see API help and TestCaseStartFinishSocketClient.indicateTestStart(java.lang.String, java.lang.String)).
  - PORT_TESTCASE_START_FINISH
```
public static final ExecutionContextInfo.ExecProperty PORT_TESTCASE_START_FINISH
```
    Represents #sctm_portTestCaseStartFinish: The port a message must be sent to to indicate beginning and ending of each sub test case if the test runs in a separate process.
  - TEST_NAME
```
public static final ExecutionContextInfo.ExecProperty TEST_NAME
```
    Represents "#sctm_test_name": The name of the SC test being executed.
  - TEST_ID
```
public static final ExecutionContextInfo.ExecProperty TEST_ID
```
    Represents "#sctm_test_id": The numeric identifier (database key) of the test being executed.
  - EXTERNAL_ID
```
public static final ExecutionContextInfo.ExecProperty EXTERNAL_ID
```
    Represents "#external_id": The unique identifier of a test case in a test package to be executed. This can act as filter if only specific test cases in a test package should be executed.
  - IS_TEST_PACKAGE_ROOT
```
public static final ExecutionContextInfo.ExecProperty IS_TEST_PACKAGE_ROOT
```
    Represents "#is_test_package_root": If true, the test being executed is the root node of the test package (default). If false, only specific test cases in a test package specified by EXTERNAL_ID should be executed.
  - DATA_DRIVEN_PARENT_TEST_NAME
```
public static final ExecutionContextInfo.ExecProperty DATA_DRIVEN_PARENT_TEST_NAME
```
    Represents "#data_driven_parent_test_name": The name of the parent test, if this test executes a data driven row.
  - DATA_DRIVEN_PARENT_TEST_ID
```
public static final ExecutionContextInfo.ExecProperty DATA_DRIVEN_PARENT_TEST_ID
```
    Represents "#data_driven_parent_test_id": The numeric identifier (database key) of the parent test if this test executes a data driven row.
  - SOURCE_ROOT_DIR
```
public static final ExecutionContextInfo.ExecProperty SOURCE_ROOT_DIR
```
    Represents the local path of the Test Container root directory, where all VCS controlled files reside.
  - TUNNEL_TO_INTERNAL_PROXY
```
public static final ExecutionContextInfo.ExecProperty TUNNEL_TO_INTERNAL_PROXY
```
    Represents "#sctm_tunnel_to_internal_proxy": If true the application server has opened a tunnel to the execution server and acts as a proxy to allow testing a website in your local intranet.
- Method Detail
  - values
```
public static ExecutionContextInfo.ExecProperty[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ExecutionContextInfo.ExecProperty c : ExecutionContextInfo.ExecProperty.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ExecutionContextInfo.ExecProperty valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - toString
```
public java.lang.String toString()
```
    Returns the string representation of this property.
    
    Overrides:
    
    toString in class java.lang.Enum<ExecutionContextInfo.ExecProperty>

Enum ExecutionContextInfo.ExecProperty

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NAME

ID

REGULAR_EXECDEF_RUN_ID

PRODUCT

VERSION

BUILD

KEYWORDS

TEST_RESULTS_DIR

INDICATE_TESTCASE_START_FINISH

PORT_TESTCASE_START_FINISH

TEST_NAME

TEST_ID

EXTERNAL_ID

IS_TEST_PACKAGE_ROOT

DATA_DRIVEN_PARENT_TEST_NAME

DATA_DRIVEN_PARENT_TEST_ID

SOURCE_ROOT_DIR

TUNNEL_TO_INTERNAL_PROXY

Method Detail

values

valueOf

toString