Workflow XML Reference - Action Properties

6 min

The following lists the parameters that can or must be included when defining a triggered action:

Triggered Action: EmailNotificationAction

Properties	Property Requirement	Notes
Emails or PropertyName	Required	Sends a message to the specified users about the action Users are specified either as individual email addresses or a user group name Contains the following child-element structure: <PropertyName>name of the user group</PropertyName> <Message>message sent to recipients</Message> OR <Emails> <Email>email address 1</Email> <Email>email address 2</Email> <Email>email address n</Email> </Emails> <Message>message sent to recipients</Message>
Message	Required	The message sent to specified users about the action

Triggered Action: PropertyChangeAction

Properties	Property Requirement	Notes
PropertyName	Required	The name of the standard artifact property that is changing
PropertyValue		Applies to one of the following standard artifact types: text, number, and date Replaces the existing value Contains the following child-element structure: <PropertyName>name of standard artifact property</PropertyName> <PropertyValue>its new value</PropertyValue> Date format can be one of the following: yyyy-mm-dd 0 (the date of the property change) A non-zero integer that adds or subtracts the number of days from the current date (for example, "-7" is a week before the property change) Clears the property value if entered as an empty element (<PropertyValue />)
ValidValues	- one of these three properties (PropertyValue, ValidValues, UsersGroups) is required - only one instance of these properties can be used in any given <PropertyChangeAction> block in the XML	Applies to the "choice" standard artifact type (single, or multi-choice) Replaces the existing set of choices Contains the following child-element structure: <ValidValue> <Value>NewValue1</Value> </ValidValue> <ValidValue> <Value>NewValue2</Value> </ValidValue> <ValidValue> <Value>NewValueN</Value> </ValidValue>
UsersGroups		Applies to the "user" standard artifact type Updates a user-type property with the defined users, and instance- and project-level groups Contains the following child-element structure: <UserGroup> <Name>username</Name> </UserGroup> <UserGroup IsGroup="true"> <Name>instance-level group name</Name> <GroupProjectId> <UserGroup IsGroup="true"> <Name>project-level group name</Name> <GroupProjectId>ProjectIDNumber</GroupProjectId> </UserGroup> <UserGroup IsGroup="true"> <Name>project-level group name</Name> <GroupProjectPath>Blueprint/folder/project1</GroupProjectPath> </UserGroup> When the IsGroup="true" attribute and value are used, the Name is interpreted as a group, not an individual user When the IsGroup attribute is used, and the GroupProjectId or GroupProjectPath child elements are also included, the Name is interpreted as a project-level user group; otherwise, it is an identically named instance-level group If the IncludeCurrentUser="true" attribute and value are included with the parent UsersGroups element, the current user (who has triggered the property change) is also included in the property change Note: username declarations are case-sensitive

Triggered Action: Webhook Action

Properties	Property Requirement	Notes
URL	Required	The payload will be sent to this address if the action is triggered
IgnoreInvalidSSLCertificate	Optional	False by default Controls whether the webhook should ignore an invalid SSL certificate Accepted values: true and false
HttpHeaders	Optional	The call to the specified URL will include these headers Headers can be used to include additional information when sending the webhook Contains the following child-element structure: <HttpHeaders> <Header>name1:value1</Header> <Header>name2:value2</Header> </HttpHeaders>
BasicAuth	Optional	If a username and password are specified, they are included here Contains the following child-element structure: <BasicAuth> <Username>admin-user</Username> <Password>$ecr3tP@ssw0rd</Password> </BasicAuth> Must be listed before <Signature> if both elements are provided
Signature	Optional	Has two child elements: <SecretToken> (required) and <Algorithm> (optional) Accepted values for <Algorithm> are: HMACSHA256 and HMACSHA1 If <Algorithm> value not provided, defaults to HMACSHA256 Must be listed after <BasicAuth> if both elements are provided

Triggered Action: GenerateActionType (value is "Children")

Properties	Property Requirement	Notes
ChildCount	Required	The number of child artifacts that are created Contains the following child-element structure: <GenerateActionType>Children</GenerateActionType> <ChildCount>number to create</ChildCount> <ArtifactType>standard artifact type</ArtifactType>
ArtifactType	Required	The type of standard artifact that is automatically created

Triggered Action: GenerateActionType (value is "TestCases")

Properties	Property Requirement	Notes
--	--	Contains the following child element:<GenerateActionType>TestCases</GenerateActionType>

Triggered Action: GenerateActionType (value is "UserStories")

Properties	Property Requirement	Notes
--	--	Contains the following child element:<GenerateActionType>UserStories</GenerateActionType>

Docs powered by Archbee