com.microfocus.silkcentral.webservices.executionplanning

Class ExecutionPlanningService

java.lang.Object

com.microfocus.silkcentral.webservices.executionplanning.ExecutionPlanningService

public class ExecutionPlanningService
extends java.lang.Object

Provides functionality for the execution planning Web Service

 Example:
 // STEP 1: The execution planning Web Service is one of several Web Services offered by Silk Central, and you need to use
 // some of the other Web Services as well to successfully implement execution calls, for example for authentication.
 //
 // The first step is to get the service from the locator as shown below (the URL must be adapted to your environment).

 adminService = new AdministrationServiceService(new URL("http://localhost:19120/services/jaxws/administration")).getAdministrationServicePort();
 testsService = new TestsServiceService(new URL("http://localhost:19120/services/jaxws/tests")).getTestsServicePort();
 executionPlanningService = new ExecutionPlanningServiceService(new URL("http://localhost:19120/services/jaxws/executionplanning")).getExecutionPlanningServicePort();

 // STEP 2: You must login to Silk Central with valid user credentials to use any Web Service methods.
 // To login, use an existing Silk Central user account.

 sessionId = executionPlanningService.logonUser("admin", "admin");

 // STEP 3: Before you can create nodes in the execution tree, you need to specify the following:
 // You must define the project you want to work with. Use the adminService Web Service to get a project.
 // You need a root node (ID). The root node of the execution tree can be obtained from the project.
 // Each execution plan must be assigned to a test container of the planning tree, thus you need to get
 // an existing test container node ID by using the planning Web Service.

 projects = adminService.findProjects(sessionId, PROJECT_NAME);

 ExecutionNode root = executionPlanningService.getExecutionRootNode(sessionId, projects.get(0).getId());
 NamedEntity testContainer = testsService.getTestContainers(sessionId, projects.get(0).getId()).get(0);

 // STEP 4: Now you are ready to create nodes and add them to the execution tree. A node in the execution tree is of the type
 // "ExecutionNode". Define whether you want to add a "Folder" or an "Execution Plan" node by setting the "kind"
 // parameter accordingly (2 = folder, 3 = execution plan) - make sure that the root node still exists.

 int nodeId = executionPlanningService.addNode(sessionId, projects.get(0).getId(), getNewFolder("Folder1", "first folder"), root.getId());
 executionPlanningService.addNode(sessionId, projects.get(0).getId(), getNewExecutionNode("ExecDef1.1", "child execDef", BUILD, VERSION, testContainer.getId()), nodeId);
 nodeId = executionPlanningService.addNode(sessionId, projects.get(0).getId(), getNewExecutionNode("ExecDef1", "first execDef", BUILD, VERSION, testContainer.getId()), root.getId());

 // STEP 5: Assign test definitions to the execution plan.
 // Use the planning Web Service to get the planning nodes.
 // Create a comma-separated list with the IDs of the planning nodes and assign them to the execution node.

 ExecutionNode execNode = mExecutionPlannningService.getNode(getSessionId(), nodeId);
  String testIds = ...
  for (PropertyValue prop : execNode.getPropertyValues()) {
    if ("PROP_ASSIGNED_TESTDEFS".equals(prop.getPropertyID())) {
      prop.setValue(testIds);
    }
  }
  mExecutionPlannningService.updateNode(getSessionId(), nodeId);

 // STEP 6: Assign attributes to the execution plan.
 // Create a list of property values, each property containing one attribute.
 // Use the execution planning Web Service to get the execution node and assign the list of property values to the execution node.

 List<PropertyValue> properties = new ArrayList<>();
 // - Release attribute
 PropertyValue release = new PropertyValue();
 release.setPropertyTypeId("_attribute_");
 release.setPropertyId("_attribute_Release");
 release.setValue("Release 2009");
 release.setType(11); // type normal, see PropertyMetaInfo for property value types
 properties.add(release);
 // - Sprint attribute
 PropertyValue sprint = new PropertyValue();
 sprint.setPropertyTypeId("_attribute_");
 sprint.setPropertyId("_attribute_Sprint");
 sprint.setValue("Sprint 8");
 sprint.setType(11);
 properties.add(sprint);
 ExecutionNode node = executionPlanningService.getNode(sessionId, nodeId);
 node.getPropertyValues().addAll(properties);
 executionPlanningService.updateNode(getSessionId(), node);

 

Constructor Summary

Constructors

Constructor and Description
ExecutionPlanningService()

Method Summary

Modifier and Type	Method and Description
void	addAttributeOptions(java.lang.String sessionId, int projectId, java.lang.String attributeName, AttributeOption[] options) Adds attribute options to the given attribute identified by attributeName.
ProjectAttribute[]	addAttributes(java.lang.String sessionId, int projectId, ProjectAttribute[] attributes) Adds attributes to the given project identified by projectId (this allows specifying min/max/precision values when adding numeric attributes).
int	addNode(java.lang.String sessionId, int projectId, ExecutionNode node, int parentId) Adds a node to the execution tree.
void	deleteAttributeOptions(java.lang.String sessionId, int projectId, java.lang.String attributeName, AttributeOption[] options) Deletes attribute options of the given attribute identified by attributeName.
void	deleteAttributes(java.lang.String sessionId, int projectId, ProjectAttribute[] attributes) Deletes the attributes identified by their IDs for the given project identified by projectId.
void	deleteNode(java.lang.String sessionId, int nodeId) Deletes a node and all its children from the execution tree.
ManualTester[]	getAssignedManualTesters(java.lang.String sessionId, int execDefId) Retrieve assigned manual testers of an execution plan.
ProjectAttribute[]	getAttributes(java.lang.String sessionId, int projectId) Returns all attributes for the given project identified by projectId.
ExecutionNode[]	getChildNodes(java.lang.String sessionId, int parentNodeId) Gets the child nodes of a parent node in the execution tree.
int	getCleanupTestDefinition(java.lang.String sessionId, int execNodeId) Gets the ID of the test that is used for cleanup in an execution plan or in a configuration suite.
ExecutionResult	getExecutionResult(java.lang.String sessionId, ExecutionHandle handle) Returns results on a per-execution plan basis. Note: The execution must be finished to get a result, otherwise the return value will be null.
java.lang.String	getExecutionResultURL(java.lang.String sessionId, int executionDefId, long executionTimestamp, java.lang.String execServerHostName, int execServerPort) Returns a URL that can be used to access the results of a specific run on a browser.
ExecutionNode	getExecutionRootNode(java.lang.String sessionId, int projectId) Searches for the root node in the execution tree.
java.lang.String[]	getKeywords(java.lang.String sessionId, int execNodeId) Retrieves all keywords of an execution plan.
ManualTester[]	getManualTesters(java.lang.String sessionId, int projectId) Retrieve a list of manual testers available for this project.
ExecutionNode	getNode(java.lang.String sessionId, int nodeId) Gets the node, specified with the nodeId, from the execution tree.
ExecutionNode[]	getNodes(java.lang.String sessionId, int projectId, java.lang.String name) Gets an array of ExecutionNodes, specified with the name of the node.
NodeParameter[]	getParameters(java.lang.String sessionId, int execNodeId) Retrieve all parameters of an execution plan.
java.lang.String[]	getPropertyIds(java.lang.String sessionId, int kind) Gets a list of all valid properties of a node in the execution tree.
PropertyMetaInfo	getPropertyInfo(java.lang.String sessionId, int kind, java.lang.String id) Retrieves the PropertyMetaInfo for a property of a node.
int	getSetupTestDefinition(java.lang.String sessionId, int execNodeId) Gets the ID of the test that is used for setup in an execution plan or in a configuration suite.
int	getStateOfExecution(java.lang.String sessionId, ExecutionHandle handle) Gets the state of an already started execution.
java.lang.String	logonUser(java.lang.String username, java.lang.String plainPwd) Logs on with a given username and password.
void	setAssignedManualTesters(java.lang.String sessionId, int execDefId, int[] manualTesterIds) Assigns manual testers to an execution plan.
void	setCleanupTestDefinition(java.lang.String sessionId, int execNodeId, int testDefId) Sets the ID of the test that will be used for cleanup in an execution plan or in a configuration suite.
void	setKeywords(java.lang.String sessionId, int execNodeId, java.lang.String[] keywords) Sets keywords for an execution plan.
void	setParameter(java.lang.String sessionId, int execNodeId, java.lang.String parameterName, java.lang.String parameterValue) Sets a parameter for an execution plan.
void	setSetupTestDefinition(java.lang.String sessionId, int execNodeId, int testDefId) Sets the ID of the test that is used for setup in an execution plan or in a configuration suite.
ExecutionHandle[]	startExecution(java.lang.String sessionId, int nodeId) Executes the specified node (folder, configuration suite or execution plan).
ExecutionHandle[]	startExecutionWithOptions(java.lang.String sessionId, int nodeId, java.lang.String build, int option, java.lang.String sinceBuild) Executes the specified node (folder, configuration suite or execution plan).
ExecutionHandle[]	startExecutionWithOptionsInternal(java.lang.String sessionId, int nodeId, java.lang.String build, int option, java.lang.String sinceBuild, java.util.Map<java.lang.String,com.segue.tm.common.execution.parameters.ParameterData> parameters, java.lang.String sourceControlBranch)
ProjectAttribute[]	updateAttributes(java.lang.String sessionId, int projectId, ProjectAttribute[] attributes) Updates given attributes identified by their IDs for the given project identified by projectId.
void	updateNode(java.lang.String sessionId, ExecutionNode node) Updates an existing node in the execution tree.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExecutionPlanningService

public ExecutionPlanningService()

Method Detail

logonUser

public java.lang.String logonUser(java.lang.String username,
                                  java.lang.String plainPwd)
                           throws WSFaultException

Logs on with a given username and password. The returned session identifier can be used in subsequent calls. The session created with the method expires when it is not used for a period of time.
Note: When accessing Silk Central through web-service calls, Micro Focus recommends using a web-service token instead of a session identifier for authenticating. You can generate a web-service token in the Silk Central UI.

Parameters:

username - the login username

plainPwd - the password of the specified username

Returns:

a unique identifier (used as a key) identifying the session created with the method

Throws:

WSFaultException - if logon fails

getPropertyInfo

public PropertyMetaInfo getPropertyInfo(java.lang.String sessionId,
                                        int kind,
                                        java.lang.String id)
                                 throws WSFaultException

Retrieves the PropertyMetaInfo for a property of a node. Properties are used to describe the execution node in more detail. (e.g. name, node type, description... are all properties).

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

kind - a number for which can interpreted as the following:

• 0 - root node of the tree (project node)
• 2 - folder
• 3 - execution plan
• 4 - configuration suite
• 5 - testing cycle

id - The property ID. Use the getPropertyIds(java.lang.String, int) method to get a list of valid IDs for a property.

Returns:

PropertyMetaInfo.

Throws:

WSFaultException

setSetupTestDefinition

public void setSetupTestDefinition(java.lang.String sessionId,
                                   int execNodeId,
                                   int testDefId)
                            throws WSFaultException

Sets the ID of the test that is used for setup in an execution plan or in a configuration suite.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

execNodeId - the unique ID of the execution plan or the configuration suite

testDefId - the unique ID of the setup test

Throws:

WSFaultException

getSetupTestDefinition

public int getSetupTestDefinition(java.lang.String sessionId,
                                  int execNodeId)
                           throws WSFaultException

Gets the ID of the test that is used for setup in an execution plan or in a configuration suite.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

execNodeId - the unique ID of the execution plan or the configuration suite

Throws:

WSFaultException

setCleanupTestDefinition

public void setCleanupTestDefinition(java.lang.String sessionId,
                                     int execNodeId,
                                     int testDefId)
                              throws WSFaultException

Sets the ID of the test that will be used for cleanup in an execution plan or in a configuration suite.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

execNodeId - the unique ID of the execution plan or the configuration suite

testDefId - the unique ID of the cleanup test

Throws:

WSFaultException

getCleanupTestDefinition

public int getCleanupTestDefinition(java.lang.String sessionId,
                                    int execNodeId)
                             throws WSFaultException

Gets the ID of the test that is used for cleanup in an execution plan or in a configuration suite.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

execNodeId - the unique ID of the execution plan or the configuration suite

Throws:

WSFaultException

addNode

public int addNode(java.lang.String sessionId,
                   int projectId,
                   ExecutionNode node,
                   int parentId)
            throws WSFaultException

Adds a node to the execution tree. A node can be either an execution plan, a configuration suite or a folder.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project where to add the node

node - Value object of the node. See class ExecutionNode.

parentId - Parent node ID.

Returns:

Unique node ID.

Throws:

WSFaultException

getNode

public ExecutionNode getNode(java.lang.String sessionId,
                             int nodeId)
                      throws WSFaultException

Gets the node, specified with the nodeId, from the execution tree.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

nodeId - ID of the node.

Returns:

ExecutionNode. If no node is found a WSFaultException will be thrown.

Throws:

WSFaultException

getNodes

public ExecutionNode[] getNodes(java.lang.String sessionId,
                                int projectId,
                                java.lang.String name)
                         throws WSFaultException

Gets an array of ExecutionNodes, specified with the name of the node. Use the '%' as a wildcard character for searching with a fragment of the node name. Example: The call getNodes(sessionId, 0, "Silk%") will return all execution nodes of which the name starts with 'Silk'.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project from where you want to get the nodes

name - Name of the node in the execution tree

Returns:

An array of ExecutionNode or an empty array if no nodes are found.

Throws:

WSFaultException

updateNode

public void updateNode(java.lang.String sessionId,
                       ExecutionNode node)
                throws WSFaultException

Updates an existing node in the execution tree. Use case: Get a node -> modify properties -> update node. If invalid version or build information is passed then an error will be raised.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

node - Value object of the node. See class ExecutionNode.

Throws:

WSFaultException

deleteNode

public void deleteNode(java.lang.String sessionId,
                       int nodeId)
                throws WSFaultException

Deletes a node and all its children from the execution tree.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

nodeId - ID of the node.

Throws:

WSFaultException

getChildNodes

public ExecutionNode[] getChildNodes(java.lang.String sessionId,
                                     int parentNodeId)
                              throws WSFaultException

Gets the child nodes of a parent node in the execution tree.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

parentNodeId - The ID of the parent node for which you want to fetch the child nodes.

Returns:

An array of execution nodes (ExecutionNode). An ExecutionNode can be a folder, a configuration suite or an execution plan.

Throws:

WSFaultException

getPropertyIds

public java.lang.String[] getPropertyIds(java.lang.String sessionId,
                                         int kind)
                                  throws WSFaultException

Gets a list of all valid properties of a node in the execution tree.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

kind - a number for which can interpreted as the following:

• 0 - root node of the tree (project node)
• 2 - folder
• 3 - execution plan
• 4 - configuration suite
• 5 - testing cycle

Returns:

All valid properties of a node in the execution tree.

Throws:

WSFaultException

getExecutionRootNode

public ExecutionNode getExecutionRootNode(java.lang.String sessionId,
                                          int projectId)
                                   throws WSFaultException

Searches for the root node in the execution tree. If there is no root node a new one is created.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - The ID of the project of which you want to retrieve the root node.

Returns:

The root node (ExecutionNode) of the execution tree.

Throws:

WSFaultException

getStateOfExecution

public int getStateOfExecution(java.lang.String sessionId,
                               ExecutionHandle handle)
                        throws WSFaultException

Gets the state of an already started execution. To identify the execution, an ExecutionHandle is returned by startExecution(String, int).
Available states of an execution are (positive values while execution is in progress):

• DEPLOYING = 0
• UPLOAD_DATA = 1
• QUEUED = 2
• FETCHING_SOURCES = 3
• FETCH_FULL_COVERAGE = 4
• RUNNING = 5
• FETCH_CODE_COVERAGE = 6
• WAIT_FOR_MANUAL_PRE = 7
• WAIT_FOR_MANUAL = 8
• WAIT_FOR_MANUAL_POST = 9
• COLLECTING_RESULTS = 10
• CLOUD_EXECSERVER_UPGRADING = 11
• EXECSERVER_INACCESSIBLE = 12
• FINISHED = -1
• UNKNOWN = -2

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

handle - the ExecutionHandle returned by startExecution(String, int) or startExecutionWithOptions(String, int, String, int, String)

Returns:

the state of the execution

Throws:

WSFaultException - if an error occurred. An error message briefly explains the cause of the error. For detailed information, refer to the front-end server log files.

getExecutionResult

public ExecutionResult getExecutionResult(java.lang.String sessionId,
                                          ExecutionHandle handle)
                                   throws WSFaultException

Returns results on a per-execution plan basis.

Note: The execution must be finished to get a result, otherwise the return value will be null.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

handle - the ExecutionHandle returned by startExecution(String, int) or startExecutionWithOptions(String, int, String, int, String)

Returns:

an ExecutionResult

Throws:

WSFaultException - if an error occurred. An error message briefly explains the cause of the error. For detailed information, refer to the front-end server log files.

startExecutionWithOptions

public ExecutionHandle[] startExecutionWithOptions(java.lang.String sessionId,
                                                   int nodeId,
                                                   java.lang.String build,
                                                   int option,
                                                   java.lang.String sinceBuild)
                                            throws WSFaultException

Executes the specified node (folder, configuration suite or execution plan). By default an error occurs if there is no active execution server that matches the keywords configured for an execution plan. This behavior can be changed by editing the Conf\FrontendServer\SccFrontendBootConf.xml file on the server when setting Options/AllowStartRunWithNoMatchingServers to true.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

nodeId - the ID of an execution tree node

build - Optional: The name of the build to set for the started run. If the build does not exist and the started node is an execution plan it will be created.

option - controls, which tests currently assigned to the execution plan are executed.

• run all = 1
• run failed = 2
• run not executed since build = 3
• run failed and not executed since build = 4
• run with fixed issues = 5
• run not executed = 6
• run failed and not executed = 7

sinceBuild - build number since which tests have not been executed. Specify this parameter for option options 3 and 4.

Returns:

the ExecutionHandle to identify the started execution

Throws:

WSFaultException - if an error occurred. An error message briefly explains the cause of the error. For detailed information, refer to the front-end server log files.

startExecutionWithOptionsInternal

public ExecutionHandle[] startExecutionWithOptionsInternal(java.lang.String sessionId,
                                                           int nodeId,
                                                           java.lang.String build,
                                                           int option,
                                                           java.lang.String sinceBuild,
                                                           java.util.Map<java.lang.String,com.segue.tm.common.execution.parameters.ParameterData> parameters,
                                                           java.lang.String sourceControlBranch)
                                                    throws WSFaultException,
                                                           com.segue.scc.util.localizer.LocalizableException

Throws:

WSFaultException

com.segue.scc.util.localizer.LocalizableException

startExecution

public ExecutionHandle[] startExecution(java.lang.String sessionId,
                                        int nodeId)
                                 throws WSFaultException

Executes the specified node (folder, configuration suite or execution plan). By default an error occurs if there is no active execution server that matches the keywords configured for an execution plan. This behavior can be changed by editing the Conf\FrontendServer\SccFrontendBootConf.xml file on the server when setting Options/AllowStartRunWithNoMatchingServers to true.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

nodeId - the ID of an execution tree node

Returns:

the ExecutionHandle to identify the started execution

Throws:

WSFaultException - if an error occurred. An error message briefly explains the cause of the error. For detailed information, refer to the front-end server log files.

getManualTesters

public ManualTester[] getManualTesters(java.lang.String sessionId,
                                       int projectId)
                                throws WSFaultException

Retrieve a list of manual testers available for this project.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the project ID for which the possible testers should be queried

Returns:

an array of ManualTester objects

Throws:

WSFaultException

setAssignedManualTesters

public void setAssignedManualTesters(java.lang.String sessionId,
                                     int execDefId,
                                     int[] manualTesterIds)
                              throws WSFaultException

Assigns manual testers to an execution plan.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

execDefId - the unique ID of the execution plan

manualTesterIds -

Throws:

WSFaultException

getAssignedManualTesters

public ManualTester[] getAssignedManualTesters(java.lang.String sessionId,
                                               int execDefId)
                                        throws WSFaultException

Retrieve assigned manual testers of an execution plan.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

execDefId - the unique ID of the execution plan

Returns:

Throws:

WSFaultException

setParameter

public void setParameter(java.lang.String sessionId,
                         int execNodeId,
                         java.lang.String parameterName,
                         java.lang.String parameterValue)
                  throws WSFaultException

Sets a parameter for an execution plan.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

execNodeId - the unique ID of the execution plan

parameterName -

parameterValue -

Throws:

WSFaultException

getParameters

public NodeParameter[] getParameters(java.lang.String sessionId,
                                     int execNodeId)
                              throws WSFaultException

Retrieve all parameters of an execution plan.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

execNodeId - the unique ID of the execution plan

Returns:

Throws:

WSFaultException

setKeywords

public void setKeywords(java.lang.String sessionId,
                        int execNodeId,
                        java.lang.String[] keywords)
                 throws WSFaultException

Sets keywords for an execution plan.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

execNodeId - the unique ID of the execution plan

keywords -

Throws:

WSFaultException

getKeywords

public java.lang.String[] getKeywords(java.lang.String sessionId,
                                      int execNodeId)
                               throws WSFaultException

Retrieves all keywords of an execution plan.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

execNodeId - the unique ID of the execution plan

Returns:

Throws:

WSFaultException

getExecutionResultURL

public java.lang.String getExecutionResultURL(java.lang.String sessionId,
                                              int executionDefId,
                                              long executionTimestamp,
                                              java.lang.String execServerHostName,
                                              int execServerPort)
                                       throws WSFaultException

Returns a URL that can be used to access the results of a specific run on a browser.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

executionDefId - an execution plan ID identifying the execution run together with executionTimestamp

executionTimestamp - a timestamp identifying the execution run together with executionDefId

execServerHostName - not used anymore - run is identified by executionDefId and executionTimestamp

execServerPort - not used anymore - run is identified by executionDefId and executionTimestamp

Returns:

a URL the user can use to access the results of a specific run on a browser, for example: http://localhost:19120/silk/DEF/TM/Execution?nEx=65&etab=6&execRunId=4330. If the results are not (yet) available for the execution run then the URL will miss the parameter execRunId and the URL will direct to the execution plan.

Throws:

WSFaultException

getAttributes

public ProjectAttribute[] getAttributes(java.lang.String sessionId,
                                        int projectId)
                                 throws WSFaultException

Returns all attributes for the given project identified by projectId. (allows retrieving min/max/precision values for numeric attributes)

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project for which the attributes should be retrieved

Returns:

array of attribute objects for this project

Throws:

WSFaultException

addAttributes

public ProjectAttribute[] addAttributes(java.lang.String sessionId,
                                        int projectId,
                                        ProjectAttribute[] attributes)
                                 throws WSFaultException

Adds attributes to the given project identified by projectId (this allows specifying min/max/precision values when adding numeric attributes).

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project for which the attributes should be added

attributes - an array of Attribute objects that should be added

Returns:

array of attribute objects which are added by this method containing the new attribute IDs

Throws:

WSFaultException

updateAttributes

public ProjectAttribute[] updateAttributes(java.lang.String sessionId,
                                           int projectId,
                                           ProjectAttribute[] attributes)
                                    throws WSFaultException

Updates given attributes identified by their IDs for the given project identified by projectId.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project for which the attributes should be updated

attributes - an array of Attribute objects that need to be updated

Returns:

array of attribute objects which were updated by this method

Throws:

WSFaultException

deleteAttributes

public void deleteAttributes(java.lang.String sessionId,
                             int projectId,
                             ProjectAttribute[] attributes)
                      throws WSFaultException

Deletes the attributes identified by their IDs for the given project identified by projectId.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project for which the attributes should be deleted

attributes - an array of attribute objects which should be deleted

Throws:

WSFaultException

addAttributeOptions

public void addAttributeOptions(java.lang.String sessionId,
                                int projectId,
                                java.lang.String attributeName,
                                AttributeOption[] options)
                         throws WSFaultException

Adds attribute options to the given attribute identified by attributeName.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project for which the attribute options should be added

attributeName - the name of the attribute for which the attribute option should be added

options - an array of attribute options which should be added to the attribute

Throws:

WSFaultException

deleteAttributeOptions

public void deleteAttributeOptions(java.lang.String sessionId,
                                   int projectId,
                                   java.lang.String attributeName,
                                   AttributeOption[] options)
                            throws WSFaultException

Deletes attribute options of the given attribute identified by attributeName.

Parameters:

sessionId - the web-service token, generated in the Silk Central UI, or the unique ID of the session created with logonUser(String, String)

projectId - the ID of the project for which the attribute options should be deleted

attributeName - the name of the attribute for which the attribute option should be deleted

options - an array of attribute options which should be deleted from the attribute

Throws:

WSFaultException