StringTransformAction Class Reference

The following string transform actions are available: More...

Inherits IntegrationAction.

Properties
DataTarget	Source [get, set]
	Specifies the source of the content to use for the text transform. More...
SerializableString	SearchText [get, set]
	Specifies the string or characters to search for. Not valid for InsertBeforeStartAction and InsertAfterEndAction. More...
SerializableString	NewText [get, set]
	Specifies the new string for the operation. Not valid for SearchAndDeleteAction, SearchAndDeleteEverythingBeforeAction, and SearchAndDeleteEverythingAfterAction. More...
StringTransformSearchSyntax	SearchSyntax [get, set]
	Specifies the search method. Not valid for InsertBeforeStartAction and InsertAfterEndAction. The following options are available: More...
int	MaxOccurrences [get, set]
	Specifies the number of occurrences for which a search takes place: all occurrences, first occurrence only, or a specified number of occurrences. Not valid for InsertBeforeStartAction and InsertAfterEndAction. A value of 0 means that the search takes place for all occurrences of the specified string or characters. The default value is 0. More...
bool	AllowSearchTextVariables [get, set]
	Specifies that the search text contains one or more variables or expressions, in which case the variables or expressions are processed in the search text before the operation runs. The default value is true. More...
bool	AllowNewTextVariables [get, set]
	Specifies that if NewText contains variables, the string is replaced literally without substitution. The default value is true. More...
string	OutputVariableName [get, set]
	Specifies the name of the variable to save the transform result to. More...
CommonActionProperties
Describes the common action properties for Actions and ActionGroups.
string	Name [get, set]
	Specifies the name. This property cannot be empty and must be unique in the YAML script. More...
string	Description [get, set]
	Specifies the description. The default value is "". More...
ActionRunType	RunType [get, set]
	Runs the action by using one of the following types: More...
bool	IgnoreErrors [get, set]
	Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false. More...
int	FailureRetries [get, set]
	Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0. More...
int	RetryInterval [get, set]
	Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000. More...

Detailed Description

The following string transform actions are available:

• SearchAndReplaceAction: Searches for specific text or characters in the contents and replaces it with the specified text.
• SearchAndInsertBeforeAction: Searches for specific text or characters in the contents and inserts it before the specified text.
• SearchAndInsertAfterAction: Searches for specific text or characters in the contents and inserts it after the specified text.
• SearchAndDeleteAction: Searches for specific text or characters in the contents and deletes it.
• SearchAndDeleteEverythingBeforeAction: Searches for specific text or characters in the contents and deletes everything before it.
• SearchAndDeleteEverythingAfterAction: Searches for specific text or characters in the contents and deletes everything after it.
• InsertBeforeStartAction: Inserts specific text or characters before the contents starts.
• InsertAfterEndAction: Inserts specific text or characters at the end of the contents.

Example:

Actions:   
- SearchAndReplaceAction:
  Source: '%EventData%'
  SearchText: Apple*
  NewText: Orange
  MaxOccurrences: 1
  OutputVariableName: TransformResult
  Name: Search And Replace
  # And more common action properties
    ...
- SearchAndDeleteAction:
  Source: 
    File: C:\MyFolder\File.xml
  SearchText: ^<\?xml.+?\?>\s*
  SearchSyntax: RegularExpression
  Name: Search and Delete
  # And more common action properties
    ...
- InsertAfterEndAction
  Source: '%EventData%'
  NewText: end of message!
  OutputVariableName: NewEventData
  Name: Insert After End
  # And more common action properties
    ...

Property Documentation

Source

DataTarget Source

getset

Specifies the source of the content to use for the text transform.

SearchText

SerializableString SearchText

getset

Specifies the string or characters to search for. Not valid for InsertBeforeStartAction and InsertAfterEndAction.

NewText

SerializableString NewText

getset

Specifies the new string for the operation. Not valid for SearchAndDeleteAction, SearchAndDeleteEverythingBeforeAction, and SearchAndDeleteEverythingAfterAction.

SearchSyntax

StringTransformSearchSyntax SearchSyntax

getset

Specifies the search method. Not valid for InsertBeforeStartAction and InsertAfterEndAction.
The following options are available:

• Literal
• Wildcards (default)
• RegularExpression

MaxOccurrences

int MaxOccurrences

getset

Specifies the number of occurrences for which a search takes place: all occurrences, first occurrence only, or a specified number of occurrences. Not valid for InsertBeforeStartAction and InsertAfterEndAction. A value of 0 means that the search takes place for all occurrences of the specified string or characters. The default value is 0.

AllowSearchTextVariables

bool AllowSearchTextVariables

getset

Specifies that the search text contains one or more variables or expressions, in which case the variables or expressions are processed in the search text before the operation runs. The default value is true.

AllowNewTextVariables

bool AllowNewTextVariables

getset

Specifies that if NewText contains variables, the string is replaced literally without substitution. The default value is true.

OutputVariableName

string OutputVariableName

getset

Specifies the name of the variable to save the transform result to.

Name

string Name

getsetinherited

Specifies the name. This property cannot be empty and must be unique in the YAML script.

Description

string Description

getsetinherited

Specifies the description. The default value is "".

RunType

ActionRunType RunType

getsetinherited

Runs the action by using one of the following types:

• Always (default)
• Never

IgnoreErrors

bool IgnoreErrors

getsetinherited

Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.

FailureRetries

int FailureRetries

getsetinherited

Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0.

RetryInterval

int RetryInterval

getsetinherited

Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000.

---

The documentation for this class was generated from the following file:

• StringTransformAction.Properties.cs