Actions YAML Reference
Properties | List of all members
TransformTextToRecordSetAction Class Reference

Transforms text or a text file to a record set. More...

Inherits IntegrationAction.

Properties

DataTarget ConnectionSetup [get, set]
 Specifies the database connection setup that is generated by the Database Setup wizard as DataTarget. More...
 
DataTarget Text [get, set]
 Specifies the source of the text for the record set. This text must use the same format as the Text database that was configured in the Database Setup wizard.
Example: More...
 
string RecordSetVariableName [get, set]
 Specifies the name of the variable to save the transformed record set 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

Transforms text or a text file to a record set.

For common action properties, see IntegrationAction.
Example:

Actions:
- TransformTextToRecordSetAction:
File: C:\MyFolder\MyTextFileDB.xml
Text: |
ID,Name,Age
1,Steven,25
2,Sam,33
RecordSetVariableName: MyRecordset
Name: Transform Text To Record Set
# And more common action properties
...
DataTarget Text
Specifies the source of the text for the record set. This text must use the same format as the Text d...
Definition: TransformTextToRecordSetAction.Properties.cs:103
DataTarget ConnectionSetup
Specifies the database connection setup that is generated by the Database Setup wizard as DataTarget.
Definition: TransformTextToRecordSetAction.Properties.cs:78
string RecordSetVariableName
Specifies the name of the variable to save the transformed record set to.
Definition: TransformTextToRecordSetAction.Properties.cs:110
string Name
Specifies the name. This property cannot be empty and must be unique in the YAML script.
Definition: IntegrationAction.Properties.cs:87

Property Documentation

◆ ConnectionSetup

DataTarget ConnectionSetup
getset

Specifies the database connection setup that is generated by the Database Setup wizard as DataTarget.

Example in which the database connection setup from the XML generated by the Database Setup wizard is used.

<?xml version="1.0" encoding="utf-8"?>
<DatabaseSetup xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
...
</DatabaseSetup>

Example in which the database connection setup from a file in the temporary storage:

File: MyMSSQL.xml

Example in which the database connection setup from a local file or a Librarian file is used:

File: lib://MyMSSQL.xml

Example in which the database connection setup from a could file is used:

File: dropbox://mydropbox/Folder/MyMSSQL.xml

◆ Text

DataTarget Text
getset

Specifies the source of the text for the record set. This text must use the same format as the Text database that was configured in the Database Setup wizard.
Example:

Text: %EventData%

Example:

File: lib://SecretFolder/data.txt

Example:

Text: |
ID,Name,Age
1,Steven,25
2,Sam,33

◆ RecordSetVariableName

string RecordSetVariableName
getset

Specifies the name of the variable to save the transformed record set 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: