RemoveField

Removes a field value from a Helix ALM issue.

You can use this statement to clear default field values set in an issue if the value does not apply to a specific condition that occurs when the script runs or if the field is no longer used. For example, if a custom field is set in the issue but the field is temporarily removed from Helix ALM, you can remove the field value when adding issues from scripts without changing the scripts in case the field is used again later.

Note: This statement cannot be used in load test scripts.

Syntax

RemoveField(Issue, FieldIdentifier)

Arguments

Argument Description
Issue Issue object that contains the field. Use the NewIssue statement to create the issue object.
FieldIdentifier Name of the field to remove the value from.

You can also use the field ID, which is available in the Helix ALM FLDDFNTN database table. You may want to use the ID if issue fields are frequently renamed in the Helix ALM project. Ask your Helix ALM administrator for help.

Example

issue = NewIssue()

' Uses field name to set Summary field value

SetFieldValue(issue, "Summary", "An issue occurred when exporting to XML")

' Uses field ID to remove Summary field value

RemoveField(issue, 2)

 

You can also call this statement directly on a Helix ALM issue object.

issue = NewIssue()

' Uses field name to set Summary field value

issue.SetFieldValue("Summary", "An issue occurred when exporting to XML")

' Uses field ID to remove Summary field value

issue.RemoveField(2)