Action variables

Action variables

Action Help

This help text explains the actions, grouped by category.

Flow

If

Compares two variables or sources.

If the comparison succeeds, the script actions between the If and End If script lines are executed. The If action can also be used in combination with an Else action.

Tip: The wildcard '*' can be used in a string compare.

Action variables
Variable1:Text, Number, List, Date variables or Text source, Web Page source to be compared.
Operator:Determines how variable 1 and variable 2 are compared, i.e. "Variable1 Is Not Equal to Variable2".
Variable2:Text, Number, List, Date variables or Text source, Web Page source to be compared with the first variable.


Structure example:

If ...
... do actions ...
End If

If Condition

Test a "Variable" against a certain condition, like Is Empty, Contains Text, Equal To, Exists in List, etc.

If the comparison succeeds, the script actions between the If Condition and End If script lines are executed. The If Condition action can also be used in combination with an Else action.

Tip: Use this action to verify if a variable is empty, or a file exists or is a positive number, etc.

Action variables
Operator:Select a condition to which the variable should be tested.
Variable:Text, Number, List or Date variables, Text source or Web Page source can be tested.


Structure example:

If Condition ....
 ... do actions ...
End If

If Case

Test the script against certain conditions, like Is Online, Is Compiled Script, etc.

If the comparison succeeds, the script actions between the If Case and End If script lines are executed. The If Case action can also be used in combination with an Else action.

Tip: Use this action to verify if the computer executing the script has an active Internet connection.

Action variables
Operator:Select a condition to which should be tested.


Structure example:

If Case ....
 ... do actions ...
End If

Else

The Else action can be used in conjunction with an If or If Condition action.

When the If action fails, the lines between Else and End If are executed.

Action variables
Comment text:Optional comment text to improve script reading.


Structure example:

If ...
... do actions ...
Else
... do actions ...
End If

End If

The End If action closes an If, If Case or If Condition block.

Action variables
Comment text:Optional comment text to improve script reading.


Structure example:

If ...
... do actions ...
Else
... do actions ...
End If

Go to Label

Jumps to a Label action in the script and executes lines from there until a Return from Label action is encountered.

The "Label name" property value should match the exact name of the label to jump to. Use the Return from Label action to jump back to the script position where Go to Label was called.

Note: A Stop Script Execution action may be needed to prevent the script from running into a label without being called by a Go to Label action.

Action variables
Label name:The (exact) name of the label to jump to.


Labels are typically used if a script has a block of actions that are repeated two or more times in a script.

Structure example:

If Condition
Go to Label GetData
else
Go to Label UpdateLogFile
End If
Stop Script Execution
Label GetData
... actions ...
Return from Label
Label UpdateLogFile
... actions ...
Return from Label

Tip: Labels can be nested in the script logic.

Label

The Label action is used as a marker in combination with the Go to Label action.

The Go to Label action can be used to jump to a Label action and resume execution from there.

Use the Return from Label action to jump back to the script position where Go to label was called.

Note: Make sure the names in both actions match exactly else the action will be ignored.

Action variables
Label name:The name of the label.


Structure example:

If Condition
Go to Label GetData
else
Go to Label UpdateLogFile
End If
Stop Script Execution
Label GetData
... actions ...
Return from Label
Label UpdateLogFile
... actions ...
Return from Label

Tip: Labels can be nested in the script logic.

Return from Label

Use the Return from Label action to indicate the end of label and jump back to position where the Label was called with a Go to label action.

Tip: When using labels as procedures its better to use the procedure action.

Action variables
Comment text:Optional comment text to improve script reading.

Procedure

The Procedure action is used as a marker in combination with the Execute Procedure action.

Use an End Procedure action to jump back to the script position where Execute Procedure was called.

Note: A procedure in the script logic is ignored during script run, unless it has been called by the Execute Procedure action.

Action variables
Procedure name:The name of the procedure.


Procedures are typically used if a script has a block of actions that are repeated two or more times in a script. By using the procedure method the number of script lines can be reduced and the script logic will improve.
... actions ...
Loop

Execute Procedure GetPriceInformation
Execute Procedure ComparePrices
Execute Procedure SaveResults
End Loop

Procedure GetPriceInformation
... actions ...
End Procedure

Procedure ComparePrices
... actions ...
End Procedure

Procedure SaveResults
... actions ...
End Procedure

Tip: Procedures can be nested in the script logic.

End Procedure

Use the End Procedure action to indicate the end of a procedure and jump back to position where the Procedure was called with a Execute Procedure action

Action variables
Comment text:Optional comment text to improve script reading.

Execute Procedure

Jumps to a Procedure action in the script and executes lines from there until a End Procedure action is encountered.

The "Procedure" property value should match the exact name of the procedure to jump to.

Note: A procedure in the script logic is ignored during script run, unless it has been called by the Execute Procedure action.

Action variables
Procedure name:The name of the procedure to execute.


Procedures are typically used if a script has a block of actions that are repeated two or more times in a script. By using the procedure method the number of script lines can be reduced and the script logic will improve.

... actions ...
Loop

Execute Procedure GetPriceInformation
Execute Procedure ComparePrices
Execute Procedure SaveResults
End Loop

Procedure GetPriceInformation
... actions ...
End Procedure

Procedure ComparePrices
... actions ...
End Procedure

Procedure SaveResults
... actions ...
End Procedure

Tip: Procedures can be nested in the script logic.

Loops

Loop

The Loop action is a simple infinite loop until the action Exit Loop is called.

All actions between the begin of the loop and end of the loop are processed infinitely.

Note: An End Loop action is needed to close the loop script logic and an Exit Loop to exit the loop.

Action variables
Comment text:Optional comment text to improve script reading.



Structure example:

Loop
 ... actions ...
  If Condition ...
   Exit Loop
  End If
End Loop


Tip: To exit a simple loop use an If or If Condition action combined with the Exit Loop action to exit the loop.

Loop While

The While Loop will loop actions while a specified condition is valid and exits automatically when the condition is invalid.

Note: An End Loop action is needed to close the loop in the script logic.

Action variables
Variable1:Text, Number or Date variable to be compared.
Operator:Determines how Variable1 and Variable2 are compared, i.e. "Variable1 Is Not Equal to Variable2".
Variable2:Text, Number or Date variables to be compared with the first variable.


Structure example:

Loop While ...
... actions ...
End Loop

Tip: Force a loop exit by using the Exit Loop action in the script logic.

Loop Condition

The Condition Loop will repeat actions in the loop while a specified condition is valid and automatically exit the loop when the condition is invalid.

Note: An End Loop action is needed to close the loop in the script logic.

Action variables
Operator:Determines how the variable should be tested, for example Is Empty, File Exists.
Variable:Text, Number and Date variables can be tested to a condition.


Structure example:

Loop Condition ...
... actions ...
End Loop

Loop Range

Loops through a preset numerical range.

The looping process starts with Start Value and will stop when it reaches the Stop Value. With each loop, the Start Value gets incremented by the Step property. The Current Value variable returns the current step value.  If Start Value is larger then Stop Value, the loop will count down.

Note: An End Loop action is needed to close the loop in the script logic.

Action variables
Start Value:The numerical value to start the loop.
Stop Value:The numerical value to end the looping process.
Current Value:A variable containing the current numerical value used in the loop.
Step:With each loop the Start Value is incremented by Step. If the Step property is not given, a value of 1 is assumed.


Examples:
Start=1 Stop=4. Loop goes through Current Values 1,2,3,4.
Start=7 Stop=3. Loop goes through Current Values 7,6,5,4,3.
Start=2 Stop=8. Step=2. Loop goes through Current Values 2,4,6,8.

Structure example:

Loop Range ...
... actions using the Current Value property variable...
End Loop


Tip: Force a loop exit by using the Exit Loop action in the script logic.

Loop Files

Loops file names in a directory and returns found file names in the "File name variable". Looping continues until no more files are found.

Note: An End Loop action is needed to close the loop in the script logic.

Action variables
Root Folder:The root directory to search for files.
Variable holding Filename:A variable in which found files names are returned during the loop.
Recurse Sub Directories:Select Yes to recurse subdirectories from the root directory.
File Mask:Specify an optional file mask. For example "*.txt" to loop only files with the extension txt.


Structure example:

Loop Files
 ... actions using the File name property variable ...
End Loop


Tip: Force a loop exit by using the Exit Loop action in the script logic.

Loop Folders

Loops folder names in a directory and returns found folder names in the "Folder name" variable. Looping continues until no more folders are found.

Action variables
Root Folder:The root directory to search for sub folders.
Folder Name:A variable in which  found folder names are passed to during the loop.
Recurse Sub Directories:Select Yes to recurse subdirectories from the root directory.
Folder Mask:Specify an optional folder mask. For example "My*" to loop only folders staring with My in the folder name.


Structure example:

Loop Folders
... actions using the Folder name property variable ...
End Loop


Tip: Force a loop exit by using the Exit Loop action in the script logic.

Loop List

Loops all items in a List variable and passes them on to a Text variable.

The loop starts with the first item in the List and stops at the last item.

Tip: To loop a sorted list, use the Sort List action before the loop.

Action variables
List variable:The List variable containing list items.
Return variable for item:With each pass of the loop, the result variable is filled with the current item content.
Total number of items:The total number of items in the list.


Structure example:

Loop List
 ... actions using the Item property variable ...
End Loop

Loop Data Grid Rows

Loops through all the rows in a data grid.  The first row in a data grid has the number 1. 

The "Current Row" variable returns the current row number, and can be used in actions like Get Date Cell Value to get the content of data grid fields.

Tip: To loop a sorted data grid, use the Sort Data Grid action before the loop.

Action variables
Data Grid source:The data grid to use.
Current Row variable:A variable containing the current row number used in the loop.
Total number of rows:Total number of rows in the data grid.


Tip: When searching only a single row in a Date Grid, the Find in Data Grid action is much faster then a loop over all grid rows. Structure example:

Loop Data Grid Rows
... actions like Get Date Cell Value ...
End Loop

Loop Data Grid Columns

Loops through all the columns in a data grid. The first column in a data grid is has the number 1.

The "Current Column" variable returns the current column number, and can be used in actions like Get Date Cell Value to get the content of data grid fields.

Action variables
Data Grid source:The data grid to use.
Current Column variable:A variable containing the current column number used in the loop.


Structure example:

Loop Data Grid Columns
 ... actions like Get Date Cell Value ...
End Loop

Loop XML Nodes

Loops nodes in a XML tree from a specific start point. Optionally returns only nodes with a specific name or path.

Tip: The "Look for" property can be a Node name or (partial) Node path. Path notation is with forward slashes like: 'books/book'.

Action variables
XML Document source:The XML Document source to be used.
Start at (Node):The starting point from which to start searching in the XML tree.
Look for (node name or path):The path or the name of the node(s) to be looked for.
Result Node:XML node variables that are found are passed on to this XML Node variable.
Success variable:Indicates "Yes" when at least one node was found, else "No" is returned.


If the complete XML tree is to be looped, use the root node as starting node.

When "Look for" is defined as 'book' the loop will pass all nodes named 'book' to the "Result Node" variable, regardless of where they are from the starting point in the tree.

When "Look for" is defined as 'books/book' all "book" nodes will be returned that reside directly under a parent node named 'books'.

Loop XML Child Nodes

Loops child nodes in the XML tree from a specific start point (not recursively, only the child nodes under the starting point).

Optionally returns only nodes with a specific name. If the Name property is not specified, all child nodes are returned.

Action variables
XML Document source:The XML Document source to be used.
Start at (Node):The starting point from which to start searching in the XML tree.
Look for (node name):The name of the node(s) to look for.
Result Node:XML nodes that are found are passed on to this XML Node variable.
Success variable:Indicates "Yes" when at least one node was found.

Loop RegEx

Loops through all the matches of a regular expression and with each loop a match result is returned in the "Returned Match" variable. If there is no more match the loop ends.

This action is using the Perl regular expression syntax with Unicode support.

Note: When sub expressions are used in the regular expression, a sub expression number should be specified for the returned match variable. 0 means the complete match.

Action variables
Regular Expression:The regular expression used to match text in the Source Text.
Source Text:The text to be used as input.
Returned Match:The matched text is returned via this variable in each pass of the loop.
Return Sub Expression Nr:Returns only a specific sub expression found in the regular expression. 0 means complete match.
Match Success variable:Indicates whether the last match has succeeded or failed by returning "Yes" or "No".


Structure example:

Loop Matched Text
 ... actions using the Returned Match property variable ...
End Loop


More on regular expressions can be found at:
- http://en.wikipedia.org/wiki/Regular_expression
- http://regexlib.com

Loop Text File Lines

Reads a text file in a text source and loops though all the lines. With each pass the "Read Line" variable returns a line that was read from the file. An "End Loop" action is needed to close the loop in the script logic.

Note: For performance reasons the content of the Text File source is not shown in the Text Viewer.

Action variables
Text File: A Text File source.
File name with path:The full path and name of the file to be used as text source.
Read Line variable:Contains the line content of the file with each pass of the loop.
Encoding:Encoding type of the file.


Structure example:

Loop Text File Lines
 ... actions using the Read Line variable ...
End Loop

Loop Records

Loops all records in a record set related to a SQL database connection. This action needs to be combined with the SQL Query action and a select statement.

The loop starts with the first record in the record set and exits the loop when the last record is reached.

Note: When the loop finishes it will apply any changes made in the record set to the database automatically.

Action variables
Database source:The database connection to use.


When using a record set, use the following basic structure:

SQL Connect
SQL Query with a select statement
Loop Records
... actions like Get Field Value...
End Loop
SQL Disconnect

End Loop

Each Loop action needs an End Loop action to indicate the end of the loop.

Action variables
Comment text:Optional comment text to improve script reading.


Structure example:

Loop While ...
 ... actions ...
End Loop

Exit Loop

Forces an exit in a loop and is often used in combination with an If or If Condition action.

Action variables
Comment text:Optional comment text to improve script reading.


Structure example:

Loop
 ... actions ...
  If Condition ...
   Exit Loop
  End If
End Loop

Script Control

Comment

Comments are used to place notes in a script and make a script more readable.

Tip: Use empty comments to separate blocks of code for clarity.

Note: A Comment action is excluded from the script action execute count.

Action variables
Comment text:A text or leave it empty for a script line separator.

Wait

Pauses the execution of the script for a number of milliseconds.

Property "ms" should contain the number of milliseconds the script should pause.

Action variables
Wait time in ms:A number or variable with milliseconds.


Tip: When requesting a lot of pages from a web server it can get stressed. Use a Wait action with 2000 milliseconds before requesting each Web Page to relief the web server from stress.

Suppress Errors and Dialogs

Suppresses all error dialogs and show message dialogs. All feedback to the user in the form of message dialogs that halt the execution of the script are suppressed.

This action is typically used in compiled executable scripts that run on stand alone servers.

Note: The Show Errors and Dialogs action will re-enable dialogs again.

Action variables
No variables need to be set for this action.

Show Errors and Dialogs

Enables all error dialogs and user dialogs after a Suppress Errors and Dialogs action.

No variables need to be set for this action.

On Error Go To

Jumps to a specified label or procedure when the script encounters an error.

Tip: When the Suppress Errors & Dialogs action is used this action can be used to catch and handle script errors.

Action variables
Procedure or Label Name:The label or procedure the script should go to when an error is encountered.

Get Last Error

Fills the "Last Error variable" with a description of the last encountered error.

Tip: When the Suppress Errors & Dialogs action is used this action can be used to catch and handle script errors.

Action variables
Error Text:Variable with a description of the last encountered error.
Error Number:Variable with the last encountered error number.
Line Number:The script line number that encountered the last error.
Action Name:The script action name that encountered the last error.
No of actions executed so far:The number of actions executed before the last error.
Run Time (s):The script run time in seconds before the last error.

Clear Last Error

Clears the error text found by the "Get Last Error" action.

Action variables
No variables need to be set for this action.

Stop Script Execution

Stops the execution of the script.

Action variables
Exit code:The exit code passed to the operating system.

Pause Script Execution

Pauses the execution of the script and continues in step mode. This action is typically used in a debug situation.

Note: In a compiled script this action is ignored.

Action variables
No variables need to be set for this action.


Tip: Inspect the content of variables and sources when paused by clicking the Step button. The script can be resumed with the Resume button in the menu bar controls.

Get Script Properties

Returns various script properties like the script path, script name, build version. It also reveals information about the Djuggler version and edition used to create the script.

Action variables
Script Path:Returns the file path where the Djuggler script is located, including a trailing backslash.
Script Name:Returns the name as saved on disk, without the extension.
Script Build Number:Returns the build number that increases with one, each time the script is saved.
Created by Djuggler Version:Returns the Djuggler version used to create the script.
Created by Djuggler Edition:Returns the Djuggler edition used to create the script.
Designed with IE version:Returns the Internet Explorer version used when creating the script.

Show Web Viewer

Shows or hides up Djuggler's internal web viewer.

Note: Using a viewer will reduce the execution speed of the script.

Action variables
Web Page source:The web page source to show or hide in the viewer.
Visibility:Show or Hide the viewer.
Viewer Height:The viewer height in pixels.
Viewer Width:The viewer width in pixels.
Viewer Top:Position of the viewer from the top of the screen in pixels.
Viewer Left:Position of the viewer from the left of the screen in pixels.
Show source:Show the HTML source in the viewer.

Show Grid Viewer

Shows or hides up Djuggler's internal grid viewer.

Note: Using a viewer will reduce the execution speed of the script.

Action variables
Data Grid source:The data grid source to show or hide in the viewer.
Visibility:Show or Hide the viewer.
Viewer Height:The viewer height in pixels.
Viewer Width:The viewer width in pixels.
Viewer Top:Position of the viewer from the top of the screen in pixels.
Viewer Left:Position of the viewer from the left of the screen in pixels.

Show Text Viewer

Shows or hides up Djuggler's internal text viewer.

Note: Using a viewer will reduce the execution speed of the script.

Action variables
TextFile/XMLDoc source:The text file or XML source to show or hide in the viewer.
Visibility:Show or Hide the viewer.
Viewer Height:The viewer height in pixels.
Viewer Width:The viewer width in pixels.
Viewer Top:Position of the viewer from the top of the screen in pixels.
Viewer Left:Position of the viewer from the left of the screen in pixels.

Show SQL DB Viewer

Shows or hides a database viewer. The viewer will be cleared when the connection to the database is closed.

Note: Using a viewer will reduce the execution speed of the script.

Action variables
Database source:The SQL database source to show or hide in the viewer.
Visibility:Show or Hide the viewer.
Viewer Height:The viewer height in pixels.
Viewer Width:The viewer width in pixels.
Viewer Top:Position of the viewer from the top of the screen in pixels.
Viewer Left:Position of the viewer from the left of the screen in pixels.

Write To Log

Appends a text line to a log file, including a date time stamp.

Note: This action is typically used in a debug situation.

Action variables
File name with path:File and path for the log file.
Log line text:Text line to be added to the log.
Date/Time stamp:Prefix the log line with a current date time stamp.

Missing action

When a script is loaded that is created by a more recent version of Djuggler a missing action statement will replace all unknown actions from the new Djuggler version.

Action variables
Comment:Comment text about the action that is missing.

Dialogs

Show Message

Displays a text message in a message box.

Note: The Script will be paused until a user presses the OK button in the message box.

Action variables
Prompt text:Text to be displayed.

Input Dialog

Presents an input box with a single text line.

The "Answer" variable will contain the answer the user has typed in in the input box.

Action variables
Prompt text:Text to be displayed to the user in the input dialog.
Answer variable:Contains the answer from the user.
Default value:A default value for input dialog.

Choice Dialog

Presents the user with an dialog for Yes or No.

The "Answer" variable will contain the answer Yes or No.

Note: When using a If action to verify the "Answer" variable, compare to 'Yes' or 'No' (case sensitive).

Action variables
Prompt text:Text to be displayed to the user in the input dialog.
Answer variable:Contains the answer from the user, Yes or No.

Open File Dialog

Shows an open file dialog asking the user to choose a file.

The file will be passed on to the "Answer" variable and contains the fully qualified path with directory and File name.

Action variables
Dialog Title:The title for the dialog.
Answer variable:Return variable where the file path gets returned. If the dialog was cancelled, the value will be empty.
Initial Folder:The initial starting folder from where the user will be able to browse directories.
File extension:The default file extension for the file.

Save File Dialog

Shows a save file dialog asking the user to choose a file.

The file will be passed on to the "Answer" variable and contains the fully qualified path with directory and File name.

Action variables
Answer variable:Return variable for the file path. If the dialog was cancelled, the value will be empty.
Dialog Title:The title for the dialog.
Initial Folder:The initial starting folder from where the user will be able to browse directories.
File extension:The default file extension for the file.

Open Folder Dialog

Shows a dialog asking the user to choose a directory.

The directory path will be passed on to the "Answer" variable. It will contain a fully qualified directory, trailed by a backslash ("\").

Action variables
Answer variable:A variable where the directory path gets returned. If the dialog was cancelled, the value will be empty.
Dialog Title:The title for the dialog.
Initial Folder:The initial starting folder from where the user will be able to browse directories.
File extension:The default file extension for the file.

Deployment

Progress Dialog

Shows a dialog with an optional progress bar.

This action is typically used for compiled executable scripts.

Tip: The Loop rows action contains a property Total number of rows that can be used for Maximum Value property in this action.

Action variables
Visibility:Shows or hides the dialog.
Title:Dialog title
Message:The text content of the dialog.
Maximum Value:Maximum value for the progress bar.
Current Value:Current value for the progress bar.
Show Stop Button:Displays a stop script button in the dialog.
Position:Screen position of the dialog.
Display Progress Bar:Show or hide the progress bar.
Left:Screen left position in pixels when using a custom screen position.
Top: Screen top position in pixels when using a custom screen position.

Show HTML Dialog

A custom dialog in HTML used for advanced input controls or as a HTML viewer.

Note: Only a HTML form submit will close the dialog and continue the script when the mode is set to INPUT. All form values are returned in a List variable. The post url for the form can be anything like "#" or leave it empty like "".

Tip
: Use the Get Name Value from List action to access individual values from the form post data.

Action variables
HTML:A HTML text, a variable with a HTML form or a file name that should be loaded.
Visibility:Hide or show the dialog.
Mode:Viewer mode will always continue the script, Input mode will wait for input from a user by a FORM post.
List for Form result:List variable that returns the form post data on a form submit.
Width:The dialog width in pixels.
Height:The dialog height in pixels.
Title:The dialog title.


Example HTML form:

<FORM action="#" method="post">
 <LABEL for="name">Name: </LABEL>
 <INPUT type="text" name="name"><BR>
 <INPUT type="radio" name="gender" value="Male"> Male<BR>
 <INPUT type="radio" name="gender" value="Female"> Female<BR>
 <INPUT type="submit" value="Submit">
</FORM>


When John Doe is entered as name and gender mail is selected with this HTML form example, the list variable with the form post data would contain 2 items:

name=John Doe
gender=Male


With the action Get Name Value from List  using "gender" for example, the value "Male" would be returned to a Text variable.

Debug Trace

Starts a trace containing all executed action and variables. Typically used to debug a deployed script.

Action variables
Tracing enabled:Enables or disables the tracing.
Filename:File name and path for the trace file.
Nr of actions in trace file:The number of actions recorded in the trace file.

Variables

Set Variable

Replaces the current content of a variable.

Action variables
Variable:The variable to place content in.
Content:The content to fill the Variable with.

Add to Variable

Adds to the content to a variable.

Adding is done differently for each variable type. If the variable is text, the content is appended to the current text in "Variable". If the variable is a number, the content is added arithmetically.

Action variables
Variable:The variable to add content to.
Content:The content to add to the variable.
Extra Content 1..6:Extra content to be added to the variable.

Subtract from Variable

Subtracts from a variable.

Subtracts are done differently for each variable type. If the variable is text, the content is subtracted from the current text in "Variable". If the variable is a number, the content is subtracted arithmetically.

Action variables
Variable:The variable to add content to.
Content:The content to add to the Variable.

Convert Variable

Converts one variable type to another, like a number variable to a text variable.

Tip: A cursor position can only be remembered in source, like a Web Page or Text Source. Use this action to convert a Text variable to a Text Source.

Action variables
Input variable:The variable for conversion.
Output variable:The result variable after conversion.

Clear Variables

Clears the content of one ore more variables.

Note: Number variables will be set to 0, date variables will get the date 12/30/1899 when cleared.

Action variables
Variable 1-12:The variable that should be cleared.

Validate

Validate the content of a variable to meet specific conditions, like is a number or is not empty, or matches a regular expression, etc.


When the validation fails the action can jump to a Label/Procedure or write to a log file.

Action variables
Variable:The variable to be validated.
Test:The basic test to perform, like is a number or is not empty.
Validated:Variable holding the validation result as Yes or No.
Contains text:Additional validation test (optional).
Matches regex:Additional validation test (optional).
Min length:Additional validation test (optional).
Max length:Additional validation test (optional).
Does not contain text:Additional validation test (optional).
Line number:The line number of the action in the script.
On invalid data go to label:Specify a Label where the script should jump to when data is not validated.
Log file name:When specified a line will be added to the log file when data is not validated.
Custom error text:A custom error text that should be used in the log file or assigned to the Error Text Variable.
Error Text Variable:A text variable that holds the Custom Error Text property of this action. Typically also used in combination with On invalid data go to label property of this action.


Tip: Use this action to validate the content of variables or the success variable of other actions.

Generate a Random Number

Returns a random number within a certain range.

When the range is set to a minimum 1 and the maximum to 5, the action chooses a number randomly between 1 and 5.

Action variables
Result variable:The variable in which the random number is returned.
Range Minimum:The lower limit of the range.
Range Maximum:The upper limit of the range.

Create Guid

Returns a Globally Unique Identifier as a text variable.

Tip: Guid's are typically used to create a unique identifier in a Data Grid or as file name for example.

Action variables
Result variable:The variable in which the GUID is returned.

Math Expression

This action can be used for mathematical calculations.

A few examples of valid expressions: "4+2", "sqrt(9)", "(4+2)/sqrt(9)".

Action variables
Math Expression:The mathematical expression.
Result variable:A variable that holds the result of the expression.


Within the expression, Djuggler variables can be used by putting the variable name between square brackets.
Example: if the script contains a number variable named "Number1", it can be used in the expression like "(4+2)/sqrt([Number1])".

Operators that can be used:
+ : Addition
- : Subtraction
* : Multiplication
/ : Division
^ : Exponential (only positive numbers for the base)
( : Open parenthesis
) : Close parenthesis

Functions that can be used:
ABS (Range: -1e4932..1e4932)
ATAN (Range: -1e4932..1e4932)
COS (Range: -1e18..1e18)
EXP (Range: -11356..11356)
LN (Range: 0..1e4932)
ROUND (Range: -1e9..1e9)
SIN (Range: -1e18..1e18)
SQRT (Range: 0..1e4932)
SQR (Range: -1e2446..1e2446)
TRUNC (Range: -1e9..1e9)

Lists

Open List

Reads a Text file and places the content of each text line as a collection item in the "List variable".

Action variables
List variable:The List to put the items in from the text file.
File name with path:The file where the list items should be read from.
Encoding:Encoding type of the file.

Save List

Stores the items of the "List variable" in a text file.

Note: Each item is stored on a new line in the text file.

Action variables
List variable:The List that should be saved.
File name with path:The file including the file path in which the list items should be saved.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.
Encoding:Encoding type of the file.

Add Item to List

Adds an item to a "List variable". New items will be placed at the end of the list.

Action variables
List variable:The List to be used.
Item:The value to be stored as an item in the list.

Get Item from List

Get an item from a "List variable" by the item number.

Note
: The first item in the list has the number 1.

Action variables
List variable:The List to be used.
Item number:The number of the item to be retrieved.
Result variable:A Text variable for the item content.


This action enables a quick access to the content of an item in a list when the item number is known. The alternative is looping all items in the list with the Loop List action.

Get Name Value from List

Gets the value part based on the name part of a item from a List variable

When list items are stored as a name-value combination separated by an equal sign, like for example: "color=red", color is the name part and red is the value part.

Action variables
List variable:The list to be used.
Item name:The name part of the item to be retrieved.
Result variable:A text variable for the result value.
Decode text:Decode HTML form values to text.
Default Value:A default value in case the result is empty.


This action will return the value part when the name part is given and is typically used in combination with an Advanced HTML dialog action.

Remove Item from List

Removes an item from a "List variable".

Note: If there are more than one matches to the item, only the first occurring item in the list is removed!

Action variables
List variable:The List to be used.
Item:The item to be removed.

Remove Duplicates from List

Removes duplicated items from a List.

After executing this action, only unique items remain.

Action variables
List variable:The List to remove duplicates from.

Clear List

Removes all the items from a List.

After executing this action, the list will be empty.

Action variables
List variable:The List to clear.

Sort List

Sort the items in a List.

Lists can be sorted ascending or descending, depending on the value set in the "Direction" property.

Action variables
List variable:The List to sort.
Direction:Sets the sort direction: ascending or descending.

Text Files

Open Text File

Opens a "Text file" and places the content in the Text source.

Action variables
Text File source:The Text source to use.
File name with path:The file where the content should be read from.
Encoding:Encoding type of the file.

Save Text File

Saves a "Text File" source to a file.

A Text File source can be manipulated by Text Manipulation and Source Text Manipulation actions.

Action variables
Text File source:The Text source to use.
File name with path:The file in which the content should be saved.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.
Encoding:Encoding type of the file.

Append Line to Text File

Appends a line to a text file.

The property "Text" is written to the end of the file. This action works directly on the file, there is no need to use the Open Text File first.

Note: Use the Append to Text File action to append text without a new line.

Action variables
File name with path:The name of the file to write to.
Text line:Text line to be written to the end of the file.
Encoding:Encoding type of the file.
Success variable:Returns a variable indicating if the operation was successful with "Yes" or "No".


Tip: This action is typically used to create a log files.

Append to Text File

Appends the property "Text" to a text file.

The text is appended to the end of the file without a new line. This action works directly on the file, there is no need to use the Open Text File first.

Action variables
File name with path:The name of the file to write to.
Append text:Text to be written to the end of the file.
Encoding:Encoding type of the file.
Success variable:Returns a variable indicating if the operation was successful with "Yes" or "No".

XML

Create XML Document

Create a new "XML Document" in memory that can be saved later.

Provide a document source as reference to the XML document. If the "Root Name" property is set, the document root node will have that name, else "XML" will be used.

When a XML node variable is provided in the "Result Node" property it can be used as a reference node to do further processing, like adding a node to the root node.

Action variables
XML Document source:The XML Document source to use.
Root Name:The name for the XML root node ("XML" by default).
Result Node:A XML Node variable as reference to the root for further processing.

Open XML Document

Opens an XML Document from a file.

The XML file is opened into the "XML Document source".

Action variables
XML Document source:The XML Document source that will hold the XML loaded from file.
File name with path:The file where the XML file is located.

Save XML Document

Saves an XML Document source to a file.

Action variables
XML Document source:The XML Document source to be saved.
File name with path:The File name and path where the XML file will be saved.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.

Get XML Root Node

Returns the root of the "XML document" in a XML node variable.

Tip: Use the found root node in combination with the Add XML node action to add a new node under the root node for example.

Action variables
XML Document source:The XML Document source to be used.
Root Node:An XML Node variable in which a reference to the root node will be returned.

Find XML Node

Finds a single XML node in the XML tree from a specific start point based on Node name or Node path.

The "Look for" property can be a Node name or (partial) Node path. Path notation is with forward slashes like: 'books/book'.

Action variables
XML Document source:The XML Document source to be used.
Start at (Node):The starting point from which to start searching in the XML tree.
Look for (node path or name):The path or the name of the node to be looked for.
Result Node:The found Node is returned in this XML Node variable.
Success variable:Indicates "Yes" when a node was found.


Tip: If the complete XML tree is to be looped, use the root node as starting node.

When "Look for" is defined as 'book' the loop will pass all nodes named 'book' to the "Result Node" variable, regardless of where they are from the starting point in the tree.

When "Look for" is defined as 'books/book' all "book" nodes will be returned that reside directly under a parent node named 'books'.

Get XML Node Value

Returns the value of a XML node in a text variable.

Action variables
XML Node:The XML node from which the value will be obtained.
Value:Text variable where the node value will be returned.

Set XML Node Value

Sets the value of an XML node, optionally as CDATA.

Note: When setting a value in default format special characters as '>' will be translated automatically.

Action variables
XML Node:The XML node for which the value will be set.
Value:The variable containing the value to store in the node.
Data Format:Choose between default (string) or as CDATA.

Get XML Child Node Value

Returns the value of a child node from an XML parent node in a text variable.

Tip: Use this action in combination with the Find XML node to set the parent node for example.

Action variables
Parent Node:The parent node of the child.
Child Name:The name for the child node from which the value will be obtained.
Value:Text variable where the value will be returned.

Set XML Child Node Value

Sets the value of a child node from a parent XML node, optionally in CDATA.

Action variables
Parent Node:The parent node of the child.
Child Name:The name for the child node in which the value will be set.
Value:The variable containing the value to be returned.
Data Format:Choose between default (string) or as CDATA.

Get XML Node Attribute Value

Returns an attribute value of a XML node.

Action variables
XML Node:The node from which the attribute value will be obtained.
Attribute Name:The attribute name from which the value should be read.
Attribute Value:Text variable where the attribute value will be returned.

Set XML Node Attribute Value

Sets an attribute value of a XML node.

Action variables
XML Node:The node for which the attribute value will be set.
Attribute Name:The attribute name where the value should be set.
Attribute Value:The attribute value to be set.
Data Format:Choose between default (string) or as CDATA.

Add XML Node

Adds a new XML node to a parent XML node and returns the added node in a XML node variable.

Action variables
XML Document source:The XML Document source and viewer to be updated after the action.
Parent Node:The parent node where the new node will be added.
Node Name:The of the node to add.
Node Value:The node value to be set (optional).
Data Format:Choose between default (string) or as CDATA.
Result node:An XML node variable that holds the created new node.

Delete XML Node

Deletes an XML node.

Action variables
XML Document source:The XML Document source and viewer to be updated after the action.
XML Node:The XML node to be deleted.

Do SOAP request

Sends a SOAP request to a server and waits for the SOAP response in XML format.

Action variables
URL:URL to be used for the SOAP request.
SOAP Action:SOAP action to be performed.
SOAP Message:XML for the SOAP message.
SOAP Response:XML for the SOAP response.
User Name:User name when authentication is required.
Password:Password when authentication is required.
Time-out:Time-out for SOAP request in milliseconds.

Web Pages

Get Web Page

Get the content of a URL as DOM or the raw HTML source and puts it a Web Page variable.

The DOM source enables interaction like the Click Form Tag action. The HTML source is the raw html as served by a web server.

Tip: To inspect the DOM, HTML source and frames, use the Djuggler Inspector from the menu.

Action variables
Web Page:The Web Page source variable to be used.
URL:The URL to use including prefixes like "http://"
Source type:Select between the DOM (HTML interpreted by Internet Explorer) or HTML source as served by the web server.
Wait for:Page load or after load in case a page has script events when the load is complete.
Browse Silently:Option for fast page loading the DOM source without load pictures and suppressing pop-up's and page error messages.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
Time-out (sec):After the time out the script will resume, regardless of the HTML returned.
Execute scripts:When set to No the execution of JavaScript will be suppressed when DOM source is selected.
Proxy Address:Address used for a proxy.
Proxy Port:Port for a proxy address.
Extra headers:Supply extra http headers like: user-agent: DjugglerBot.
Timed-out?:A variable that will contain Yes if the page has timed out within the specified seconds.


HTML source is faster then the DOM source because it only requests the source from a web server without pictures, style sheets, etc. Note that the DOM source and HTML source have minor differences in the HTML like the usage of quotes and the tag attribute order.

Note: When the source type is set to HTML, properties like browse silently, execute scripts are ignored.

Post Web Page

Opens a Web Page by the Post method and returns the HTML in a Web Page source.

The Post Data property should contain variables separated by ampersands like: "age=28&gender=male".

Tip: When the post data contains special characters like spaces, the post data should be URL encoded with the Convert Text action.

Action variables
Web Page:The Web Page source to be used.
URL:The URL to use including prefixes like "http://".
Source type:Select between the DOM (HTML interpreted by Internet Explorer) or as HTML source served by the web server.
Wait for:Page load or after load in case a page has script events when the load is complete.
Post-Data:a string of form variables and their values like "name=John%20Doe&age=25".
Browse Silently:Option for fast page loading the DOM source without load pictures and suppressing pop-up's and page error messages.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
Time-out (sec):After the time out the script will resume, regardless of the HTML returned.
Execute scripts:When set to No the execution of JavaScript will be suppressed when DOM source is selected.
Proxy Address:Address used for a proxy.
Proxy Port:Port for a proxy address.
Extra headers:Supply extra http headers like: user-agent: DjugglerBot.
Timed-out?:A variable that will contain Yes if the page has timed out within the specified seconds.

Download File

Downloads a file, document, image or Web Page source and saves it to disk.

Note: When a non existing file is specified, the browser source returned by the server will be downloaded as document, typically 404 information. Use the Get URL status code action to verify if a file really exists.

Action variables
URL:The URL to the file, document or image.
Folder:The folder path where the file should be saved.
Filename:Specify a specific File name, when omitted the original File name from the download is used.
Success variable:On a successful download the variable will contain Yes, else it will be No.
User Agent:Specify a specific User Agent that is used to identify the browser to the web server.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.

Read Next Link

Reads the next hyperlink ('A' tag) in a Web Browser source and returns the "URL" and "Title" of the hyperlink.

Note: This action moves the source cursor position in the Web Page source like the Source Text Manipulation actions.

Action variables
Web Page:The Web Page source to be used.
URL:Text variable where the URL of the link is returned. Is no more link is found, an empty value is returned.
Title:Text variable where the title of the link is returned. Is no more link is found, an empty value is returned.


Tip: Use this action in a loop to collect all hyperlinks in a Web Page.

Read Next Link by Title

Searches for a text in a Web Page source and returns the nearest URL in a variable.

Tip: Use this action to find a typical 'Next page' link by searching for a text like 'Next >'.

Action variables
Web Page:The Web Page source to be used.
Text:Search text that should be part of the link.
URL:Text variable where the URL of the link is returned. Is no link is found, an empty value is returned.


Structure example:

Get Web page
Loop
  Read Next Link by Title
  If Condition aLink is Empty
    Exit Loop
  End Loop
 ... actions ...
End Loop

Read Next Image

Searches a "Web Page" source for the next image and returns it as "Image" variable.

The Save Image action can save the image variable. The name of the found image is returned in the "Image Name" variable.

Note
: This action moves the source cursor position in the Web Page source like the Source Text Manipulation actions.

Action variables
Web Page:The Web Page source to be used.
Image:Image variable where the image is returned. (Use the Save Image action to store it on disk.)
Image Name:Text variable where the name of the image is returned. If no more images are found, an empty value is returned.


Tip: Use this action in a loop to collect all images in a Web Page.

Save Image

Save an Image variable to disk. Typically used in combination with the Read Next Image action.

Note: When the filename property is not specified, the filename from the downloaded image is used.

Action variables
Image:Image variable to be saved.
Folder:A folder where the image should be saved.
Filename:The filename that should be used.
Success variable:Return variable that will contain contain Yes if the action was successful else it will be No.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.

Get Table Content

Puts data from a HTML table in a "Data Grid" source variable, based on table number or a specific text string.

For example when the property Table Number is set to 3,  data from the third <TABLE> tag found in the HTML will put in the Data Grid source.

Note: This action uses the DOM source and won't work on a Get Web Page by HTML source!

Action variables
Web page source:The source (Web Page or Text File) containing the HTML and table to be extracted.
Data Grid source:Data Grid variable where the table data will be stored.
Table Number:Use a table found by it's order number in the HTML.
Table Contains text:Use a table that contains a unique text string.
Start Row:Indicate at which row to start reading data. The first row has number "1".
End Row:Indicate at which row to stop reading data.
Start Column:Indicate at which column to start reading data. The first column has number "1".
End Column:Indicate at which column to stop reading data.
Strip HTML:When set to Yes, the HTML formatting will be stripped from the result, leaving the text only.

Get URL status code

Returns the status code of a URL. For example 404 if the page can not be found.

The "Is URL valid" property can be used to verify if a URL has a valid syntax.

Action variables
URL:The URL to verify.
Status code:Return variable for the status code returned by the server hosting the URL.
Is URL valid:Return variable that contains Yes if the syntax is correct, else No is returned.

Web Pages Advanced

Wait for Content

Refresh the browser source until content appears or disappears. This action is typically needed after an AJAX event.

Note: Either the appear text or disappear text can be set, but don't set both at the same time.

Action variables
Web Page:The Web Page source to be used.
Wait to appear:The text that should be in the source before the script continues.
Wait to disappear:The text that should be disappeared in the source before the script continues.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
Success:Return variable containing Yes if the content appeared/disappeared within the time-out and No when it did not.
Time-out (sec):Time out for the action in seconds, after which the script will continue.


An AJAX event requests a partial update of a webpage from the web server that will alter the source after the complete page has been requested.

The Wait for Content action assists in detecting when the AJAX event has completed by waiting until a know text has appeared or disappeared in the browser source.

Refresh Browser Source

Get the Web Page's source after a delay without reloading the Web Page.

Tip: As an alternative the Wait for Content action can be used to refresh the browser source after an AJAX event.

Use this action to obtain any changed HTML source due to dynamic reloading of the Web Page after an AJAX event for example.

Action variables
Web Page:The Web Page source to be used.
Delay (ms):The number of milliseconds to wait before refreshing the source.
Result current URL:The current URL after the refresh, for example after a redirect.

Clear IE Cache

Clears the Internet Explorer Cache.

Note: This action will also clear the cache for the regular IE browser.

Action variables
Web Page:The Web Page source to be used.

Clear IE Cookies

Clears all Internet Explorer Cookies.

Note: This action will also clear the cookies for the regular IE browser.

Action variables
No variables need to be set for this action.

Reset Web Page

Resets a webpage source by creating a new web page source instance.

Tip: Use this action to clear a server side session with a Web Page source.

Action variables
Web Page:The Web Page source to be used.

Get Frame Source

Put the source of a HTML frame in a text source variable.

Tip: Use this action to retrieve the raw HTML of a specific frame in the HTML source to process with Text Manipulation actions.

Action variables
Web Page:The Web Page source to be used.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
Text source:Return variable with the raw HTML from the specified frame number.

Get IE Version

Returns the Internet Explorer version in a text variable.

Tip: IE6 and IE7+ have a different DOM source. Scripts that work in IE7+ will not necessarily work in IE6. Verify the IE version with this action when creating scripts for others.

Action variables
Internet Explorer Version:Returns the IE version used on the computer running the script.
Major version:Returns the IE Major version used on the computer running the script.

Execute JavaScript

Executes JavaScript in a Web Page source.

Tip: The Execute JavaScript is used in combination with the Refresh Browser Source or Wait for Content action to handle AJAX enabled web sites.

Action variables
Web Page:The Web Page source to use.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
JavaScript code:The code or existing function in the HTML source to be executed.
Error msg:Return variable containing the error message when the execution was not successful.
Success:Return variable containing Yes if the code execution was successful and No when it failed.

Strip HTML Tags

Removes all HTML tags from a text or variable with only the actual readable text as result.

Tip: To remove all tags from a HTML source, convert the Web Page source to a text variable by using the Convert Variable action.

Action variables
Text:The text or variable that should be stripped from HTML tags.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.

Complete Page Links

Completes hyperlinks to a full path in a web page source.

Example: A link like "./support/index.htm"; would be translated into something like "http://www.mysite.com/support/index.htm".

Action variables
Web Page:The Web Page source where links should be completed.


Tip: When calling the Get Web Page action after a Complete Page Links action, the Complete Page Links action needs to be called again.

Complete Relative URL

Completes a variable with a relative URL to a full path.

Example: "./support.asp" is completed to "http://www.djuggler.com/support.asp".

Note: Completion of a URL depends on the Web Page source where it was obtained from.

Action variables
Web Page:The Web Page source used to complete the relative URL.
URL variable:The variable with a relative URL to be completed.

Web Page DOM

Find Tag

Finds the first matching tag in the DOM tree and returns the DOM node.

This action remembers the DOM node position and can be used to find the next Node relative to the previous found Node.

Note: Attribute names and values are case sensitive. Values support a wildcard.

Action variables
Web Page:The Web Page source used for this action.
Tag name:The node tag name, like A or DIV.
Result DOM node:The DOM node variable that will hold the found result.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
Search direction:The search direction in the DOM tree.
Attribute name:Optional name for an attribute that should be part of the match.
Attribute value:Optional value for the attribute name that should be part of the match.
2nd Attribute name:Optional name for an second attribute that should be part of the match.
2nd Attribute value:Optional value for the second attribute name that should be part of the match.
3rd Attribute name:Optional name for an third attribute that should be part of the match.
3rd Attribute value:Optional value for the third attribute name that should be part of the match.
Containing text:Optional value for a text that should be present in the innerHTML of the node.
Success:Return variable containing Yes if tag was found and No when it failed.


The DOM result node can be used in other DOM actions for getting or setting values in the DOM.

Tip: For the best solid match use the attribute name and value properties when available to identify the node that is being searched for.

Find Tag Child

Finds a child tag of a parent DOM node and returns the found DOM node.

The action remembers the DOM node position and can be used to find the next Node relative to the previous found Node.

Note: Attribute names and values are case sensitive. Values support a wildcard.

Action variables
Web Page:The Web Page source used for this action.
Parent DOM node:The parent node that should contain the child tag.
Tag name:The node tag name, like A or DIV.
Result: DOM node:The DOM node variable that will hold the found result.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
Search direction:The search direction in the DOM tree.
Attribute name:Optional name for an attribute that should be part of the match.
Attribute value:Optional value for the attribute name that should be part of the match.
2nd Attribute name:Optional name for an second attribute that should be part of the match.
2nd Attribute value:Optional value for the second attribute name that should be part of the match.
3rd Attribute name:Optional name for an third attribute that should be part of the match.
3rd Attribute value:Optional value for the third attribute name that should be part of the match.
Containing text:Optional value for a text that should be present in the innerHTML of the node.
Success:Return variable containing Yes if tag was found and No when it failed.


The DOM result node can be used in other DOM actions for getting or setting values in the DOM.

Tip: For the best solid match use the attribute name and value properties when available to identify the node that is being searched for.

Loop Tags

Loops specified tags in the DOM and returns a current result DOM node.

The DOM result node can be used in other DOM actions for getting or setting values in the DOM.

Note: Attribute names and values are case sensitive. Values support a wildcard.

Action variables
Web Page:The Web Page source used for this action.
Tag name:The node tag name, like A or DIV.
Attribute name:Optional name for an attribute that should be part of the match.
Attribute value:Optional value for the attribute name that should be part of the match.
Current result DOM node:The DOM node variable that will hold the found result.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
2nd Attribute name:Optional name for an second attribute that should be part of the match.
2nd Attribute value:Optional value for the second attribute name that should be part of the match.
3rd Attribute name:Optional name for an third attribute that should be part of the match.
3rd Attribute value:Optional value for the third attribute name that should be part of the match.
Containing text:Optional value for a text that should be present in the innerHTML of the node.
Success:Return variable containing Yes if one or more tags were found and No when it failed.

Loop Tag Children

Loops specified tags within the innerHTML of a parent node in the DOM and returns a current result DOM node.

The DOM result node can be used in other DOM actions for getting or setting values in the DOM.

Note: Attribute names and values are case sensitive. Values support a wildcard.

Action variables
Web Page:The Web Page source used for this action.
Parent DOM node:The parent node that should contain the child tags.
Tag name:The node tag name, like A or DIV.
Attribute name:Optional name for an attribute that should be part of the match.
Attribute value:Optional value for the attribute name that should be part of the match.
Current result DOM node:The DOM node variable that will hold the found result.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
2nd Attribute name:Optional name for an second attribute that should be part of the match.
2nd Attribute value:Optional value for the second attribute name that should be part of the match.
3rd Attribute name:Optional name for an third attribute that should be part of the match.
3rd Attribute value:Optional value for the third attribute name that should be part of the match.
Containing text:Optional value for a text that should be present in the innerHTML of the node.

Get Tag InnerHTML

Get the InnerHTML of a DOM node.

The Find Tag or Loop Tags actions can be used to identify the DOM node from which the values should be retrieved.

Action variables
DOM Node:The DOM Node variable used in this action.
InnerHTML:Return variable with the InnerHTML of the DOM node.
Error message:Return variable with an error messages if the action did not complete successfully.

Get Tag OuterHTML

Get the OuterHTML of a DOM node.

The Find Tag or Loop Tags actions can be used to identify the DOM node from which the values should be retrieved.

Action variables
DOM Node:The DOM Node variable used in this action.
OuterHTML:Return variable with the OuterHTML of the DOM node.
Error message:Return variable with an error messages if the action did not complete successfully.

Get Tag Attribute Value

Get the attribute value of a tag in a DOM node.

The Find Tag or Loop Tags actions can be used to identify the DOM node from which the values should be retrieved.

Note: Attribute names and values are case sensitive. Values support a wildcard.

Action variables
DOM Node:The DOM Node variable used in this action.
Attribute name:The name of the attribute from which the value should be retrieved.
Attribute value:A variable that will return the attribute value.
Error message:Return variable with an error messages if the action did not complete successfully.

Get Tag Text

Get the Text value of a tag in a DOM node.

The Find Tag or Loop Tags actions can be used to identify the DOM node from which the values should be retrieved.

Note: Attribute names and values are case sensitive. Values support a wildcard.

Action variables
DOM Node:The DOM Node variable used in this action.
Text:A variable that will return the text from the DOM Node.
Error message:Return variable with an error messages if the action did not complete successfully.

Set Tag InnerHTML

Set the InnerHTML of a DOM node.

The Find Tag or Loop Tags actions can be used to identify the DOM node from which the values should be retrieved.

Note: Attribute names and values are case sensitive. Values support a wildcard.

Action variables
DOM Node:The DOM Node variable used in this action.
InnerHTML:The InnerHTML that should be set in the DOM Node.
Error message:Return variable with an error messages if the action did not complete successfully.

Set Tag Attribute Value

Set the attribute value of a tag in a DOM node.

The Find Tag or Loop Tags actions can be used to identify the DOM node from which the values should be retrieved.

Note: Attribute names and values are case sensitive. Values support a wildcard.

Action variables
DOM Node:The DOM Node variable used in this action.
Attribute name:The name of the attribute from which the value should be set.
Attribute value:The content for the attribute value.
Error message:Return variable with an error messages if the action did not complete successfully.

Click Tag

Perform a mouse click on a tag in the DOM.

The Find Tag or Loop Tags actions can be used to identify the DOM node from which the values should be retrieved.

Note: Attribute names and values are case sensitive. Values support a wildcard.

Action variables
DOM Node:The DOM Node variable on which a click should be performed.
Success:Return variable containing Yes if the click was successful and No when it failed.

Get Tag Properties

Returns the name and/or id from a tag in the DOM.

This action is typically used when looping DOM nodes with Loop Tags action to identify the found tags.

Action variables
DOM Node:The DOM Node variable on which a click should be performed.
Tag Name:Return variable with the Name value of the DOM node, when specified in the DOM.
Tag Id:Return variable with the ID value of the DOM node, when specified in the DOM.
Success:Return variable containing Yes if the action was successful and No when it failed.

Reset DOM Node Pointer

Set the DOM node position at the first node in the source.

Action variables
Web page:The web page source in which the DOM node position should be reset.

Web Page Forms

Get Form Tag Value

Returns the innerHTML of a specified tag within a HTML form.

Note: If more than one tag matches the specifications, the value of the first matching tag is returned.

Action variables
Web Page:The Web Page source used to retrieve the tag.
Element Tag Name:The tag name to retrieve.
Form Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Form Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Result Variable:The variable used to return the Tag content (innerHTML) in.
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not complete successfully.


Example:

The HTML contains a tag "<form name="form1"><textarea rows="2" cols="20">a text line</textarea></form>".

To retrieve this tag's content, you should specify the Tag Name as "textarea", Form Attribute Name as "name" and Form Attribute Value as "form1", Attribute Name as "rows" and Attribute Value as "2".

In the Result Variable, "a text line" will be returned.

Get Form Tag Attribute Value

Returns an attribute value of a specified tag within a HTML form.

Note: If more than one tag matches the specifications, the value of the first matching tag is returned.

Action variables
Web Page:The Web Page source used to retrieve the tag.
Form Attribute Name:The Attribute Name used to match a tag.
Form Attribute Value:The Attribute Value used to match a tag.
Element Tag Name:The tag name to retrieve.
Attribute Name:The Attribute Name used to match a tag.
Attribute Value:The Attribute Value used to match a tag.
Result Attribute Name:The Attribute Value used to match a tag.
Result Variable:The variable used to return the Tag content (innerHTML) in.
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not complete successfully.


Example:

The HTML contains <form id="form1"><input type=text id="firstname" value="John"></form>.

To retrieve the input value John, properties should be used like:

Form Attribute Name
with "id" and Form Attribute Value with "form1", Tag Name with "input", Attribute Name with "id", Attribute Value with "firstname" and Result Attribute Name with "value".

In the Result Variable, "John" will be returned.

Set Form Tag Value

Sets the innerHTML of a specified tag within a HTML form.

Action variables
Web Page:The Web Page source used to set the tag.
Element Tag Name:The tag name to set.
Form Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Form Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Content:The value or variable for the innerHTML of the specified tag.
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not complete successfully.


Example:

The HTML contains a tag "<form name="form1"><textarea rows="2" cols="20">a text line</textarea></form>".

To retrieve this tag's content, you should specify the Tag Name as "textarea", Form Attribute Name as "name" and Form Attribute Value as "form1", Attribute Name as "rows" and Attribute Value as "2" and the Result Variable with "new line".

The HTML in the web document will be changed to "<form name="form1"><textarea rows="2" cols="20">new line</textarea></form>".

Set Form Tag Attribute Value

Sets an attribute value of a specified tag within a HTML form.

Action variables
Web Page:The Web Page source used to retrieve the tag.
Element Tag Name:The tag name to retrieve.
Form Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Form Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Attribute Name to set:The attribute name to set.
Content:The value or variable content to be set as value of of the specified attribute.
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not complete successfully.


Example:

The HTML contains a tag "<form name="form1"><input type=text id="firstname" value="John"></form>".

To retrieve this tag's content, you should fill in the Tag Name with "input", Form Attribute Name with "name" and Form Attribute Value with "form1", Attribute Name with "rows", Attribute Value with "2", Attribute Name to set with "firstname" and the Result Variable with "Simon".

The HTML in the web document will be changed to read: "<form name="form1"><input type=text id="firstname" value="Simon"></form>".

Click Form Tag

Performs a mouse click on a specified tag.

Tip: Use the Djuggler Inspector from the menu to inspect the tag information needed for this action.

Action variables
Web Page:The Web Page source to use.
Form Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Form Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Element Tag Name:The type of the tag to be clicked, for example the INPUT tag.
Element Name:The name attribute of the tag.
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not complete successfully.

Get Select Options

Return all options from a SELECT tag in a list variable.

Action variables
Web Page:The Web Page source to use.
SELECT Name:The value of the name attribute of the SELECT tag.
Option List:List variable to store option values in.
Description List:list variable to store option descriptions in.


Example:
<select name="cardropdown">
  <option value="1">Volvo</option>
  <option value="2">Saab</option>
  <option value="3">Mercedes</option>
  <option value="4">Audi</option>
</select>

To get all options, fill in SELECT Name with "cardropdown". Two list will be returned: Option List containing "1,2,3,4" and Description List containing "Volvo,Saab,Mercedes,Audi".

Set Select Option

Select an option from a SELECT tag.

Use either the option value or the option description to indicate which option you wish to select.

Action variables
Web Page:The Web Page source to use.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
SELECT Name:The value of the name attribute of the SELECT tag.
Option Value:the option value to select (optional).
Option Description:the option description to set (optional).


Example:
<select name="cardropdown">
  <option value="1">Volvo</option>
  <option value="2">Saab</option>
  <option value="3">Mercedes</option>
  <option value="4">Audi</option>
</select>

To select an option, fill in SELECT Name with "cardropdown" and set Option Value to "2".

The SELECT dropdown will be set to "Saab". Alternatively, you can set Option Description to "Saab" with the same effect.

Data Grid

Get Data Cell Value

Copy the value of a Data Grid cell into a variable.

Note: Rows and Column numbers start at "1".

Action variables
Data Grid source:The Data Grid source to use.
Value:Text variable where the cell content should be returned.
Row:Indicates the cell row number.
Column:Indicates the cell column number.


Use the Row and Column variables to specify the cell.

For example, using Row:2 and Column:3 would get the content from the cell located at the second horizontal row and the third vertical column.

Set Data Cell Value

Copy the value of a variable into a Data Grid cell.

Note: Rows and Column numbers start at "1".

Action variables
Data Grid source:The Data Grid source to use.
Value:Variable the content should be copied from.
Row:Indicates the cell row number.
Column:Indicates the cell column number.


Use the Row and Column variables to specify the cell.

For example, using Row:2 and Column:3 would get the content from the cell located at the second horizontal row and the third vertical column.

Store Variable(s) in Grid

Stores one or more variables in a Data Grid source. The variable name is used as field name.

If a field name already exists, the corresponding column is used to store the variables data. If the field name is new, a new data column is used.

Action variables
Data Grid source:The Data Grid source to use.
Where to store:Select between a new row or append to the current row.
Variable:The variable you would like to store in the data grid.
Variable 2-6:Additional variables to store in the data grid.


If more then 6 variables need to be stored in on a single row in the Grid, use a second action and set the Where to Store property to Use current row.

Store Value(s) in Grid

Stores one or more literal values into a Data Grid.

Note: When more then 10 values need to be set, use a second action and set the property Where to store to: Use current Row and Start at column nr 11.

Action variables
Data Grid source:The Data Grid source to use.
Where to store:Select between a new row or append to the current row.
Start at column nr.:The column number to be used for the first value.
Value 1-10:The values to be stored in the Data Grid.


Tip: This action is typically used to create a row header in a Data Grid.

Retrieve Value(s) from Grid

Retrieve one or more values from a Data Grid source.

Note: Rows and Column numbers start at "1".

Action variables
Data Grid source:The Data Grid source to use.
Retrieve from row nr.:The first row number that is used for retrieving values.
Start at column nr.:The column number to be used for the first value.
Value 1-10:The values to be assigned to variables.

Clear Data Grid

Clears the Data Grid.

Note: Data Grids are only limited in data capacity by the available memory in the computer.

Action variables
Data Grid source:The Data Grid source to be cleared.


Tip:When using the Show Grid Viewer action on a large data grid, performance of the script will be greatly reduced due to the limitation of screen/graphics memory.

Delete Data Grid Row(s)

Deletes row(s) from a Data Grid. The Row variable determines which row(s) to delete.

Example: "1,2" deletes rows 1 and 2 and "2-4" deletes rows 2,3 and 4.

Note: Always keep numbers in succession, from low to high.

Action variables
Data Grid source:The Data Grid used for the action.
Row:The row(s) to delete.

The Row property indicates the row number that must be deleted. "2" means the second row in the Data Grid will be deleted.

Multiple rows can be deleted like: "1-4" will delete row 1 through 4 in the Data Grid. "1,2,3,4" does the same.

Example: "1,2,4-6" deletes rows 1, 2, 4, 5 and 6.
Example: "1-2,7-8" deletes rows 1, 2, 7 and 8.

Delete Data Grid Column(s)

Deletes column(s) from a Data Grid. The Column variable determines which column(s) to delete.

Example: "1,2" deletes columns 1 and 2 and "2-4" would delete columns 2, 3 and 4.

Note: Always keep numbers in succession, from low to high.

Action variables
Data Grid source:The Data Grid used for the action.
Column:The column(s) to delete.


The Column property indicates the column number that must be deleted. "2" means the second column in the Data Grid will be deleted.

Multiple columns can be deleted like: "1-4" will delete column 1 through 4 in the Data Grid. "1,2,3,4" does the same.

Example: "1,2,4-6" deletes columns 1, 2, 4, 5 and 6.
Example: "1-2,7-8" deletes columns 1, 2, 7 and 8.

Example: "1,2,4-6" deletes columns 1, 2, 4, 5 and 6.6.
Example: "1-2,7-8" deletes columns 1, 2, 7 and 8.

Append Another Data Grid

Appends one Data Grid to the other.

The "Data Grid to append" property indicates the grid that gets appended to the "Data Grid" variable.

Note: The data is appended at the end of the Data Grid.

Action variables
Data Grid source:The Data Grid source to use.
Data Grid to append:The Data Grid that will be appended.

Sort Data Grid

Sorts the data grid using the column number indicated.

Note: When a data grid has a header row it will not be excluded in the sort.

Action variables
Data Grid source:The Data Grid source to use.
Sort using column number:The column number used to sort the rows in the grid.

Find in Data Grid

Search a string in a Data Grid column and return the row number.

If a match could not be found, "0" (zero) is returned. If there are more than one rows containing a match, the first matching row is returned.

Action variables
Data Grid source:The Data Grid source to use.
Text to find:The text to search in the grid.
Seek in column number:The column number to seek the text in.
Result Row:The row number where the text was found is returned here.
Match kind:"Match whole" matches whole strings only, fails otherwise. "Match Part" succeeds when Text To Find partly or completely matches the text in the column.


Note: The data grid is sorted at the indicated column before the search is done.

Compare Grids

Compares one Data Grid to another and returns the desired set of results in a Resulting Data Grid property.

Text in the grid is compared at the indicated column number.

Action variables   "Difference between grids": returns all rows which are present in one grid, but not in the other  "Similarity between grid": returns all rows that are present in both grids   "Occurrences in grid 1 missing in grid 2": returns rows occurring in grid 1 that are not found in grid 2   "Occurrences in grid 2 missing in grid 1": returns rows occurring in grid 2 that are not found in grid 1.
Data Grid 1:The first Data Grid source to use.
Data Grid 2:The second Data Grid source to use.
Compare rows at column number:The column used to compare the grids.
Result Contains:
Resulting Data Grid:Return Data Grid with the result set.

The Result Contains property determines the resulting set after comparing the grids.

Note: The grids are sorted before the data grids are compared.

Remove Duplicates from Data Grid

Removes duplicates from the data grid using the column number indicated.

Note: The grid is sorted before duplicates are removed.

Action variables
Data Grid source:The Data Grid source to use.
Compare on column number:The column number used to seek duplicates.

SQL Database

SQL Connect

Opens a connection to a SQL database, like MS SQL, MySQL, Orcale or SQLite.

Use the SQL Query action for direct SQL update and insert statements, or use the Loop Records action to loop through a record set after a SQL Query with a select statement.

Action variables
Database source:The SQL Database source to use.
SQL Type:The SQL provider to use.
Host Name:The Database host name.
User Name:The user name used to connect to the database.
Password:The password used to connect to the database.
Database Name:The name of the database your data is stored in.
Port:The port used for the connection.
Optional Params:Extra parameters for the connection, for example: servercharset=utf8 and useunicode=true for Unicode MySQL.
Success variable:Returns a variable indicating if the operation was successful with "Yes" or "No".


When using a record set, use the following basic structure:

SQL Connect
SQL Query .. select ...
... do actions like Move to Next Record ...
SQL Disconnect


When connecting to a database with direct SQL actions, use the following basic structure:

... do actions...
SQL Connect
SQL Query ... insert, update ...
SQL Disconnect

SQL Disconnect

Close a connection to a SQL database.

Note: When closing a connection the database viewer is also disconnected.

Action variables
Database source:The SQL Database source connection that should be closed.
Success variable:Returns a variable indicating if the operation was successful with "Yes" or "No".

SQL Query

Execute a SQL query on a database source.

Note: For the loop records action a SQL Query action is needed to select the record set.

Action variables
Database source:The SQL Database source to query.
Query:The SQL query (for example "UPDATE Persons SET Address='[txtAddress]', City='[txtCity]' WHERE LastName='Tjessem' AND FirstName='Jakob'").
Rows affected:Returns a number variable with the number of rows affected by the query.


When connecting to a database to run a "SQL Query " action, use the following basic structure:

... do actions...
SQL Connect
SQL Query
SQL Disconnect

Append Record

Append a record to the end of the current record set.

The appended record becomes the active, current record, and can directly be used with a Set Field action.

Note: Changes will be applied to the database after a Commit Transaction action, or when a Loop Records has finished.

Action variables
Database source:The SQL Database source connection to use.

Delete Record

Remove the active, current record from the record set.

Action variables
Database source:The SQL Database source connection to use.

Get Field Value

Get the value of a field from the active, current record in the record set and copy it to a variable.

Use the "Field Name or Column number" property to indicate which field in the record is to be used.

Action variables
Database source:The SQL Database source connection to use.
Field Name or Column Number:The exact field name as in the database or the column number (first column in the record is zero).
Content:The variable to be used for coping the field value from the record.

Set Field Value

Set the value of a field in the active, current record in the record set.

Use the "Field Name or Column number" property to indicate which field in the record is to be used.

Action variables
Database source:The SQL Database source connection to use.
Field Name or Column Number:The exact field name as in the database or the column number (first column in the record is zero).
Content:The field value to be set.

Move to First Record

Move the current record pointer to the first record in the active record set.

Action variables
Database source:The SQL Database source connection to use.

Move to Last Record

Move the current record pointer to the last record in the active record set.

Action variables
Database source:The SQL Database source connection to use.

Move to Next Record

Move the current record pointer to the next record in the active record set.

If the last record is reached, the "Last Record Reached" variable will be set to "Yes".

Tip: Use the "Last Record Reached" variable to exit a simple Loop action when not using the Loop Records action.

Action variables
Database source:The SQL Database source connection to use.
Last Record Reached:Variable that will be set to "Yes" when the last record in the set is reached.

Move to Previous Record

Move the current record pointer to the previous record in the active record set.

If the first record is reached, the "First Record Reached" variable will be set to "Yes".

Tip: Use the "First Record Reached" variable to exit a simple Loop action when not using the Loop Records action.

Action variables
Database source:The SQL Database source connection to use.
First Record Reached:Variable that will be set to "Yes" when the first record in the set is reached.

Start Transaction

Set a start transaction marker in the database.

Action variables
Database source:The SQL Database source connection to use.

RollBack Transaction

RollBack the last transaction.

Action variables
Database source:The SQL Database source connection to use.

Commit Transaction

Commit a transaction to the database.

Action variables
Database source:The SQL Database source connection to use.

Copy Records to Data Grid

Copy the complete content of an active record set into a Data Grid source.

Action variables
Database source:The SQL Database source connection to use.
Data Grid source:The Data Grid source used to put the data in.

Source Text Manipulation

Find Text in Source

Finds a text string in the content of source and sets the source cursor to a new position.

Tip: This actions supports one or more asterix ('*') wildcard for a search text like '<TR*>*Name:'. Line breaks in a source must also be matched with '#13#' or by a wildcard '*'.

Action variables
Source text:The source to use.
Text To Find:Text to find in the source content.
Search Direction:Set to a forward or backward search direction.
Cursor Placement:When a text is found, set the cursor position before or after the found text.
Case Sensitive:Indicates if the action should be performed case sensitive or not.
Success variable:Indicates whether the action was successful, returns either 'Yes' or 'No'.


The Find Text in Source action, like Copy Text from Source and Insert Text in Source are Source Text Manipulation actions with a cursor position, while normal Text Manipulation actions like Copy Text do also work with sources but without a cursor position.

Tip: Use #13# for new line or #9# for a tab or any other ASCII character between pound signs when manipulating text.

Copy Text from Source

Read from the current cursor position until the text in "Read Until" property is found. The read text is returned in the assigned "Found Text" variable. If no text was not found the Found Text will be empty.

Tip: This actions supports one or more asterix ('*') wildcard for a copy like read until '<TR*><TABLE*>'.

Action variables
Source text:The source to use.
Read until:Text to find in the source content.
Result variable:Variable to hold the copied text.
Cursor Placement:When a text is found, set the cursor position before or after the found text.
Case Sensitive:Indicates if the action should be performed case sensitive or not.
Text Processing:Options for processing the text result.


Note: Source Text Manipulation actions always keep an internal cursor position in the source for reference, while Text Manipulation actions don't have a cursor position.

Tip:
Use #13# for new line or #9# for a tab or any other ASCII character between pound signs when manipulating text.

Copy Text from Source Between

Gets text between the "From Text" and a "To Text" property from the current cursor position in a source and returns the copied text in a variable.

Tip: This actions supports one or more asterix ('*') wildcard for a copy like from '<TR*>*Name:' to '</TR>'. Line breaks in a source must also be marched with '#13#' or by a wildcard '*'.

Action variables
Source text:The source to use.
From Text:Start text match for the copy.
To Text:Start text match for the copy (To Text is not included in the copied text).
Result variable:Variable to hold the copied text.
Cursor Placement:When a text is found, set the cursor position before or after the found text.
Case Sensitive:Indicates if the action should be performed case sensitive or not.
Text Processing:Options for processing the text result.


Note: Source Text Manipulation actions always keep an internal cursor position in the source for reference, while Text Manipulation actions don't have a cursor position.

Tip: Use #13# for new line or #9# for a tab or any other ASCII character between pound signs when manipulating text.

Insert Text in Source

Inserts a text at the current cursor position in the source.

Action variables
Source text:The source to use.
Text to Insert:Text to be inserted at the current cursor position.
Cursor Placement:Set the cursor position before or after the inserted text.
Success variable:Indicates whether the action was successful, returns either 'Yes' or 'No'.


Note: Source Text Manipulation actions always keep an internal cursor position in the source for reference, while Text Manipulation actions don't have a cursor position.

Tip: Use #13# for new line or #9# for a tab or any other ASCII character between pound signs when manipulating text.

Replace Text in Source

Replace one of all occurrences of a text from the current cursor position in the source with a new text.

Action variables
Source text:The source to use.
Look for:Text to be found and replaced or use the content of a variable.
Replace with:Replacement text or use the content of a variable.
First occurrence only:Select Yes to replace only the first occurrence, select No to replace all occurrences.
Cursor Placement:When a text is found, set the cursor position before or after the found text.
Case Sensitive:Indicates if the action should be performed case sensitive or not.
Success variable:Indicates whether the action was successful, returns either 'Yes' or 'No'.


Tip: Use #13# for new line or #9# for a tab or any other ASCII character between pound signs when manipulating text.

Match Text in Source

Matches a regular expression in a source from the current cursor position.

Tip: More info on regular expressions can be found at: http://www.regular-expressions.info.

Action variables
Source text:The source to use.
Regular Expression:The regular expression to be used.
Matched Text:A variable that holds the matched text.
Match Success variable:Indicates whether the match was successful, returns either 'Yes' or 'No'.
Return Sub Expression Nr:When using sub expressions indicate the number of the sub expression. Number 1 is the first sub expressions, zero is the complete expression.


Note: Source Text Manipulation actions always keep an internal cursor position in the source for reference, while Text Manipulation actions don't have a cursor position.

Reset Text Position Cursor

Set the text position cursor at the start position in the source.

Action variables
Source text:The source in which the cursor position should be reset.

Text Manipulation

Replace Text

Replace a single or all occurrences of a text with another text in a source or variable.

Note: This action is case sensitive.

Action variables
Source Text:A source or variable to use for this action.
Look for:Text to be replaced.
Replace with:Text to replace the old text with.
First occurrence only:Select Yes to replace only the first occurrence, select No to replace all occurrences.
Case Sensitive:Indicates if the action should be performed case sensitive or not.


Tip: Use #13# for new line or #9# for a tab or any other ASCII character between pound signs when manipulating text.

Find Text from Position

Find a text string in the content of source or variable and returns the position of the found text as a number variable.

Tip: This actions supports one or more asterix ('*') wildcard for a search text like '<TR*>*Name:'.

Action variables
Source text:A source or variable to use for this action.
Text To Find:Text to find in the source text. (supports the wildcard '*')
Start Position:A number or variable indicating from which position to start searching within the content.
Result Position:A number or variable indicating the position where Text To Find has been found in the content.
Search Direction:Select to search for Text To Find in forward or backward direction.
Case Sensitive:Indicates if the action should be performed case sensitive or not.


Tip: Use #13# for new line or #9# for a tab or any other ASCII character between pound signs when manipulating text.

Copy Text from Position

Copy text from a source or variable, starting at "Start Position" and copying until the "End Position" is reached.

The copied text is returned in the "Copied Text".

Tip: This actions supports one or more asterix ('*') wildcard for a search text like '<TR*>*Name:'.

Action variables
Source text:A source or variable to use for this action.
Start Position:A number or variable indicating the position to start copying.
End Position:A number or variable indicating the position where to stop copying.
Result variable:The result variable where the copied text is returned.
Text Processing:Options for processing the text result.

Copy Text Between

Copy text from a source or variable between two strings. Text is copied from the "From Text" property value until "To Text" property value.

The copied text is returned in the "Copied Text" property as variable.

Tip: This actions supports one or more asterix ('*') wildcard for a search text like '<TR*>*Name:'.

Action variables
Source text:A source or variable to use for this action.
From Text:A string or variable indicating the position to start copying.
To Text:A string or variable indicating the position where to stop copying.
Result variable:The result variable where the copied text is returned.
Case Sensitive:Indicates if the action should be performed case sensitive or not.
Text Processing:Options for processing the text result.


Tip: Use #13# for new line or #9# for a tab or any other ASCII character between pound signs when manipulating text.

Insert Text at Position

Insert a string in a source or variable at specific position.

A 'position' is the index position of a character or string. Example: The 'q' in the string 'The quick brown fox' has a position 5. The first character is always 1.

Action variables
Source text:A source or variable to use for this action.
Position:A number or variable indicating the position to insert text.
Text to Insert:The text to insert at the given position.


Tip: Use #13# for new line or #9# for a tab or any other ASCII character between pound signs when manipulating text.

Split Right

Splits a text variable and returns the right part of the split text.

Example: On the text 'abcdef' with 'cd' as "Split Characters"; 'ef' will be returned as "Split Text".

Note: When the "Split Characters" are not found the complete content of "Text" will be returned in "Split Text".

Action variables
Source text:A text variable to use for this action.
Result variable:The variable in which the right part of the text that was split is returned.
Split Character(s):The characters to split the text at.

Split Left

Splits a text variable and returns the left part of the split text.

Example: On the text 'abcdef' with 'cd' as "Split Characters"; 'ab' will be returned as "Split Text".

Note: When the "Split Characters" are not found the complete content of "Text" will be returned in "Split Text".

Action variables
Source text:A text variable to use for this action.
Result variable:The variable in which the left part of the text that was split is returned.
Split Character(s):The characters to split the text at.

Trim

Trims leading and trailing spaces of the content in a text variable.

Action variables
Text variable:The text variable that should be trimmed from leading and trailing spaces.

Upper Case

Converts all characters in the content of a text variable to upper case.

Action variables
Text variable:A text variable in which all characters should to be converted to uppercase.

Lower Case

Converts all characters in the content of a text variable to lower case.

Action variables
Text variable:A text variable in which all characters should be converted to lowercase.

Upper Case First Letter

Converts the first character in the content of a text variable to upper case.

Action variables
Text variable:A text variable to use for this action.

Strip HTML Tags

Strips all HTML tags from the content of a text variable.

Action variables
Text variable:A text variable that should have all HTML tags removed.


Example: '<B>Hello <I>World</I></B>' would become 'Hello World'.

Text Formatting

Format Number

Formats a number variable.

The formatting syntax is %[Index:][-][Width][.Precision]Type
Example padding: %.6d will format 1234 to 001234 by padding zero's to the length of 6.
Example money: %m will format 1234.9 to $ 1,234.90.
Example rounding: %d will format 1234.95 to 1235.
Example precision: %.2f will format 1234.95345 to 1234.95

Action variables
Number variable:The number variable to be formatted.
Format Specifications:The formatting syntax to be used.
Resulting text:The text variable with the formatting result.


The Formatting string can comprise a mix of ordinary characters (that are passed unchanged to the result string), and data formatting characters. This formatting is best explained by the example code.

In simple terms, each data formatting substring starts with a % and ends with a data type indicator :

d = Decimal
n = Number
e = Scientific
f = Fixed
m = Money

The general format of each formatting substring is as follows:

%[Index:][-][Width][.Precision]Type

where the square brackets refer to optional parameters, and the : . - characters are literals, the first 2 of which are used to identify two of the optional arguments.

Convert Text

Convert text of one format to another format.

Supported conversions are UTF-8 to ASCII and vise versa.
And special HTML characters to ASCII. For example '&nbsp' to a space.

Action variables
Source text:A source or variable to use for this action.
Conversion:Select the format the text is to be converted to.


The Convert Text action offers the following Conversion options for character encoding.

UTF-8 to ASCII
Converts UTF-8 encoded (extended) character sets to plain ASCII.

Special HTML characters to ASCII
Equal to HTML encoded to text. See remarks there.

Text to MIME
Converts ASCII text to MIME encoded text.

MIME to Text
Converts MIME encoded text to ASCII text.

Text to URL Encoded
Converts UTF-8 text to %-encoded text. Variable byte length encoded (extended) characters are supported. Special characters used in URL's are NOT translated (":/?#[]@!$&'()*,;="). "%" and "+" are always translated. Space is encoded as "%20". Typically used to encode URL's. Special chars are not interpreted but left un-encoded.
Example: "& ? f ? ?" encodes as "&%20%E2%82%AC%20%CF%86%20%D0%B4%20%E8%81%94"
More info: http://en.wikipedia.org/wiki/URL_encoding

URL Encoded to Text
Converts %-encoded text to UTF-8 text. Variable byte length encoded (extended) characters are supported. "+" gets converted to space.
Example: "&%20%E2%82%AC%20%CF%86%20%D0%B4%20%E8%81%94" decodes as "& ? f ? ?"

Text to HTML encoded
Converts UTF-8 to &-encoded text. "&"<>'" are translated to their entity names (&amp;); all other characters are encoded using the hexadecimal ampersand format (&#xHHHH;).
Example: "& ? f ? ?" encodes to "&amp; &#x20AC; &#x03C6; &#x0434; &#x8054;"
More info: http://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references

HTML encoded to Text
Converts &-encoded and entity name encoded text (&#NNNN; or &#xHHHH; or &name;) to UTF-8. Variable byte length encoded (extended) characters are supported.
Example: "&amp; &#x20AC; &#x03C6; &#x0434; &#x8054;" decodes to "& ? f ? ?"

HTTP encoded to Text
Converts UTF-8 text to %-encoded text. Variable byte length encoded (extended) characters are supported. Special characters used in URL's ARE translated, "%" and "+" are also translated. Space is encoded as "+". Typically used to encode HTML FORM input. Special chars used in URL's are not interpreted but all encoded.
Example: "& ? f ? ?" encodes as "%26+%E2%82%AC+%CF%86+%D0%B4+%E8%81%94"
More info: http://en.wikipedia.org/wiki/URL_encoding

Text to HTTP decoded
Converts %-encoded text to UTF-8 text. Variable byte length encoded (extended) characters are supported. "+" gets converted to space.
Example: "%26%20%E2%82%AC+%CF%86+%D0%B4+%E8%81%94" decodes as "& ? f ? ?"

Locale Settings

Set the default format settings for decimal, date and time separators and the currency symbol used in the script.

Tip: This action will force a specific format settings, regardless of the computer locale settings when using formatting actions.

Action variables
Decimal separator:Type of decimal separator to be used.
Date separator:Type of date separator to be used.
Time separator:Type of time separator to be used.
Currency:Currency symbol to be used in the script.
Short Date format:Short date format to be used.

Convert to Number

Convert a Text variable to a Number variable.

Action variables
Text:Text or variable to be used.
Format:Number format settings for decimal separator.
Resulting number:Number variable for the result.

Convert to Date-Time

Convert a Text variable to a Date Time variable.

Tip: See the more help for formatting syntax options.

Action variables
Text:Text or variable to be used.
Format:Format syntax that is used in the text.
Resulting Date-Time:Number variable for the result.


Format syntax:

y = Year last 2 digits
yy = Year last 2 digits
yyyy = Year as 4 digits
m = Month number no-leading 0
mm = Month number as 2 digits
mmm = Month using ShortDayNames (Jan)
mmmm = Month using LongDayNames (January)
d = Day number no-leading 0
dd = Day number as 2 digits
ddd = Day using ShortDayNames (Sun)
dddd = Day using LongDayNames (Sunday)
ddddd = Day in ShortDateFormat
dddddd = Day in LongDateFormat

c = Use ShortDateFormat + LongTimeFormat
h = Hour number no-leading 0
hh = Hour number as 2 digits
n = Minute number no-leading 0
nn = Minute number as 2 digits
s = Second number no-leading 0
ss = Second number as 2 digits
z = Milli-sec number no-leading 0s
zzz = Milli-sec number as 3 digits
t = Use ShortTimeFormat
tt = Use LongTimeFormat

am/pm = Use after h : gives 12 hours + am/pm
a/p = Use after h : gives 12 hours + a/p
ampm = As a/p but TimeAMString,TimePMString
/ = Substituted by DateSeparator value
: = Substituted by TimeSeparator value

d/m/y = 5/6/00
dd/mm/yy = 05/06/00
ddd d of mmm yyyy = Mon 5 of Jun 2000
dddd d of mmmm yyyy = Monday 5 of June 2000
ddddd = 05/06/2000
dddddd = 05 June 2000
c = 05/06/2000 01:02:03

Create Hash

Creates a hash value from one or more variables.

Tip: For usage of hashes see: http://en.wikipedia.org/wiki/Hash_function

Action variables
Input Text:A text that should be hashed.
Hash value:A variable to which the hash value will be assigned.
Algorithm:The hash algorithm to be used.

Text Matching

Match RegEx

Matches a regular expression in a variable or source. The result is returned in the "Returned Match" variable.

Action variables
Source text:A source or variable to use for this action.
Regular Expression:The regular expression used in the match.
Returned Match:Returns the actual text matched by the regular expression.
Return Sub Expression Nr:If sub-expressions are used, the expression number will indicate which sub-expression should be returned to the Matched Text property. Zero means the complete match.
Match Success variable:If a match was successful, this variable is set to "Yes". If it was unsuccessful, it is set to "No".


This action is using the Perl regular expression syntax with Unicode support.

Tip: More information on regular expressions can be found at: http://www.regular-expressions.info

Match and Replace RegEx

Matches a regular expression in a variable or source and replaces all occurrences of the matches. When sub expressions are used they can be indicated in the Replace Text Property with $1, $2, etc. Open the example script for a demo.

Action variables
Source Text:A source or variable to use for this action.
Regular Expression:the regular expression used in the match.
Replace Text:Returns the actual text matched by the regular expression.


This action is using the Perl regular expression syntax with Unicode support.

Tip: More info on regular expressions can be found at: http://www.regular-expressions.info

Fuzzy Compare

Compares one string to another and gives back a match score as a number.

The score is used to determine how similar or dissimilar one string is compared to another.

Action variables
Text1:First text string.
Text2:second text string to compare the first one with.
Algorithm:The algorithm to use in the comparison.
Score:A number indicating how well Text1 matches Text2.
Replacement List:A list variable with replacements like "3d=3 doors" to perform on Text1 before comparison.


The action will compare a text string in the "Text1" property with a text string in the "Text2" property. It will provide a score as a result in the "Score" property. The Score is a measure of how much the two strings are alike. The Score depends on which algorithm you choose for comparison.

Algorithms: The algorithm determines how strings are compared to each other. Different algorithms have different applications, so it depends on the matching task you have which one is best for you.

DA1. Djuggler native fuzzy string comparison algorithm. In addition to comparing words, it also does a good job comparing "sentences" (strings of words). The lower the Score the better the match. A Score of -300 is a better match than a Score of -50 or 200. Score can be negative as well as positive. For example: compare "Nokia E66" with "Nokia E66" (Score:-300), "Nokia E65" (-279) and "Samsung Soul" (200). From these three strings, Nokia E66 is the best match, while Nokia E65 doesn't do bad either. Samsung Soul compares much worse to Nokia E66. Although not fool proof, negative scores can be considered good matches, while positive scores can be considered bad ones.

Levenshtein. The Levenshtein fuzzy string comparison algorithm. This algorithm calculates the difference between two strings (edit distance). The more differences are found, the higher the Score. A perfect match gets a Score of 0; less perfect matches get a higher score. Score is a positive number starting at zero.

Jaro-Winkler. The Jaro-Winkler fuzzy string comparison algorithm. This algorithm calculates the similarity between two strings. The more similarities are found, the higher the Score. A perfect match gets a Score of 1; the lowest score is 0. Score is a positive number between zero and one. 

Replacement List: you can provide a list variable here containing string replacements. These replacements are performed before the comparison is done. This allows you to correct for different spellings of a word (for example "3rd" and "third") before you compare strings, enhancing the match score. Each replacement is a separate item in the list, separated by an "=". To replace "3rd" with "third", add an item "3rd=third" to the list.

Fuzzy Best Match in List

Finds the best (fuzzy) match of a string in a list variable.

The best matching string in the list is returned.

Action variables
Input text:a text string.
Compare List:a list to compare the text string with.
Algorithm:The algorithm to use in the comparison.
Best match:The best found match within the list of strings.
Best score:A number indicating how well the found string matches Text.
Replacement List:A list variable with replacements like "3d=3 doors" to perform on Text1 before comparison.


The action will compare a text string in the "Text" property with a list of strings in the "List" property. It will return the string from the list that best matches the string in the Text property. The Score is a measure of how much the two strings are alike. The score depends on which algorithm you choose for comparison.

Algorithms: The algorithm determines how strings are compared to each other. Different algorithms have different applications, so it depends on the matching task you have which one is best for you.

DA1. Djuggler native fuzzy string comparison algorithm. In addition to comparing words, it also does a good job comparing "sentences" (strings of words). The lower the Score the better the match. A Score of -300 is a better match than a Score of -50 or 200. Score can be negative as well as positive. For example: compare "Nokia E66" with "Nokia E66" (Score:-300), "Nokia E65" (-279) and "Samsung Soul" (200). From these three strings, Nokia E66 is the best match, while Nokia E65 doesn't do bad either. Samsung Soul compares much worse to Nokia E66. Although not fool proof, negative scores can be considered good matches, while positive scores can be considered bad ones.

Levenshtein. The Levenshtein fuzzy string comparison algorithm. This algorithm calculates the difference between two strings (edit distance). The more differences are found, the higher the Score. A perfect match gets a Score of 0; less perfect matches get a higher score. Score is a positive number starting at zero.

Jaro-Winkler. The Jaro-Winkler fuzzy string comparison algorithm. This algorithm calculates the similarity between two strings. The more similarities are found, the higher the Score. A perfect match gets a Score of 1; the lowest score is 0. Score is a positive number between zero and one. 

Replacement List: you can provide a list variable here containing string replacements. These replacements are performed before the comparison is done. This allows you to correct for different spellings of a word (for example "3rd" and "third") before you compare strings, enhancing the match score. Each replacement is a separate item in the list, separated by an "=". To replace "3rd" with "third", add an item "3rd=third" to the list.

Fuzzy Best Match in Data Grid

Finds the best (fuzzy) match in a data grid column.

The best matching string in the list is returned.

Action variables
Input text:A text string.
Data Grid source:A Grid to compare the text string with.
Column Number:A Data Grid Column number to use for comparison.
Algorithm:The algorithm to use in the comparison.
Best Match row:The row number containing the best match.
Replacement List:A list variable with replacements like "3d=3 doors" to perform on Text1 before comparison.
Best Score:A number indicating how well the found string matches Text.


The action will compare a text string in the "Text" property with a list of strings in the "List" property. It will return the string from the list that best matches the string in the Text property. The Score is a measure of how much the two strings are alike. The score depends on which algorithm you choose for comparison.

Algorithms: The algorithm determines how strings are compared to each other. Different algorithms have different applications, so it depends on the matching task you have which one is best for you.

DA1. Djuggler native fuzzy string comparison algorithm. In addition to comparing words, it also does a good job comparing "sentences" (strings of words). The lower the Score the better the match. A Score of -300 is a better match than a Score of -50 or 200. Score can be negative as well as positive. For example: compare "Nokia E66" with "Nokia E66" (Score:-300), "Nokia E65" (-279) and "Samsung Soul" (200). From these three strings, Nokia E66 is the best match, while Nokia E65 doesn't do bad either. Samsung Soul compares much worse to Nokia E66. Although not fool proof, negative scores can be considered good matches, while positive scores can be considered bad ones.

Levenshtein. The Levenshtein fuzzy string comparison algorithm. This algorithm calculates the difference between two strings (edit distance). The more differences are found, the higher the Score. A perfect match gets a Score of 0; less perfect matches get a higher score. Score is a positive number starting at zero.

Jaro-Winkler. The Jaro-Winkler fuzzy string comparison algorithm. This algorithm calculates the similarity between two strings. The more similarities are found, the higher the Score. A perfect match gets a Score of 1; the lowest score is 0. Score is a positive number between zero and one. 

Replacement List: you can provide a list variable here containing string replacements. These replacements are performed before the comparison is done. This allows you to correct for different spellings of a word (for example "3rd" and "third") before you compare strings, enhancing the match score. Each replacement is a separate item in the list, separated by an "=". To replace "3rd" with "third", add an item "3rd=third" to the list.

Date and Time

Set Date-Time

Set the value of a Date-Time variable, based on values for a day, month, year, hours, minutes and seconds.

Action variables
Date-Time variable:The variable that needs to be set.
Day:Day value.
Month:Month value.
Year:Year value
Hours:Hour value.
Minutes:Minute value.
Seconds:Seconds value.
Milliseconds:Milliseconds value.

Get current Date-Time

Returns the current date and time in a variable.

Tip: Use the "Date from Date variable to Text" or "Time from Date variable to Text" or "Extract from Date-Time" actions to convert dates and times.

Action variables
Result variable:The variable that will hold the current Date.

Format Date-Time

Formats a Date variable in a specific format.

Examples:
d/m/y = 5/6/00
dd/mm/yy = 05/06/00
ddd d of mmm yyyy = Mon 5 of Jun 2000
dddd d of mmmm yyyy = Monday 5 of June 2000
ddddd = 05/06/2000
dddddd = 05 June 2000
c = 05/06/2000 01:02:03

Action variables
Date-Time variable:A Date Time variable to be used.
Format specifications:Format syntax.
Resulting Text:Text variable for the formatted date time.


y = Year last 2 digits
yy = Year last 2 digits
yyyy = Year as 4 digits
m = Month number no-leading 0
mm = Month number as 2 digits
mmm = Month using ShortDayNames (Jan)
mmmm = Month using LongDayNames (January)
d = Day number no-leading 0
dd = Day number as 2 digits
ddd = Day using ShortDayNames (Sun)
dddd = Day using LongDayNames (Sunday)
ddddd = Day in ShortDateFormat
dddddd = Day in LongDateFormat

c = Use ShortDateFormat + LongTimeFormat
h = Hour number no-leading 0
hh = Hour number as 2 digits
n = Minute number no-leading 0
nn = Minute number as 2 digits
s = Second number no-leading 0
ss = Second number as 2 digits
z = Milli-sec number no-leading 0s
zzz = Milli-sec number as 3 digits
t = Use ShortTimeFormat
tt = Use LongTimeFormat

am/pm = Use after h : gives 12 hours + am/pm
a/p = Use after h : gives 12 hours + a/p
ampm = As a/p but TimeAMString,TimePMString
/ = Substituted by DateSeparator value
: = Substituted by TimeSeparator value

Extract from Date-Time

Returns the day, month, year, hour, minutes and seconds as variables from a date variable.

Tip: Use this action to convert a date variable independent of the computer locale.

Action variables
Input Date-Time variable:The date that will be split into day, month, year, hour, minutes and seconds.
Day:The day number as variable.
Month:The month number as variable.
Year:The year number as variable.
Hour:The hour number as variable.
Minutes:The minutes number as variable.
Seconds:The seconds number as variable.

Add to Date-Time

Adds days, months, years, minutes and/or seconds to a Date-Time variable.

Action variables
Date-Time variable:The variable that will be increased in value.
Day:A number of days to add.
Month:A number of months to add.
Year:A number of years to add.
Hour:A number of hours to add.
Minutes:A number of minutes to add.
Seconds:A number of seconds to add.
Milliseconds:A number of milliseconds to add.

Subtract from Date-Time

Subtract days, months, years, minutes and/or seconds from a Date-Time variable.

Action variables
Date-Time variable:The variable that will be decreased in value.
Day:A number of days to subtract.
Month:A number of months to subtract.
Year:A number of years to subtract.
Hour:A number of hours to subtract.
Minutes:A number of minutes to subtract.
Seconds:A number of seconds to subtract.
Milliseconds:A number of millisecondsto subtract.

Date-Time Span

Returns the time span in days, months, years, minutes and seconds from two Date-Time variables.

Action variables
Date-Time 1:The first Date-Time variable to use.
Date-Time 2:The second Date-Time variable to use.
Years:The span in years.
Months:The span in months.
Days:The span in days.
Hours:The span in hours.
Minutes:The span in minutes.
Seconds:The span in seconds.
Milliseconds:The span in milliseconds.


Note: The span returns an approximation based on an assumption of 365.25 days per year. Fractional years are not counted. Thus, for example, the span reports the difference between Jan 1 and Dec 31 as 0 on non-leap years and 1 on leap years.

Date-Time Fractional Span

Returns the time span with a fraction in days, months, years, minutes and seconds from two Date-Time variables.

Note: The span returns an approximation based on an assumption of 365.25 days per year.

Action variables
Date-Time 1:The first Date-Time variable to use.
Date-Time 2:The second Date-Time variable to use.
Years:The span in years.
Months:The span in months.
Days:The span in days.
Hours:The span in hours.
Minutes:The span in minutes.
Milliseconds:The span in milliseconds.

Day of the week

Returns the day name and day number in the week of a given Date-Time.

Action variables
Date-Time variable:The Date-Time variable to use.
Day number:Returns the day number in the week.
Day name:Returns the day name.
Week starts at:Choose between ISO standard Monday or Sunday.

Day of the month

Returns the day name and day number of the month of a given Date-Time.

Action variables
Date-Time variable:The Date-Time variable to use.
Day number:Returns the day number in the month.
Day name:Returns the day name.

Day of the year

Returns the day name and day number of the year of a given Date-Time.

Action variables
Date-Time variable:The Date-Time variable to use.
Day number:Returns the day number in the year.
Day name:Returns the day name.

Month of the year

Returns the month name and month number of the year of a given Date-Time.

Action variables
Date-Time variable:The Date-Time variable to use.
Month number:Returns the month number in the year.
Month name:Returns the month name.

Import & Export

Import CSV

Import an Comma Separated Values file and put the contents in a Data Grid source.

Action variables
File name with path:The path and name of the file containing the data.
Data Grid source:The Data Grid source where the data will be copied to.
Separator:The separator used to separate the data columns.
Encoding:Encoding type of the file.

Export to CSV

Export a Data Grid source to a Comma Separated Values (CSV) file.

Action variables
File name with path:The path and name of the file where the data should be saved in.
Data Grid source:The Data Grid source where the data will be copied from.
Separator:The separator used to separate different data columns in one line of the (text) file.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.
Encoding:Encoding type of the file.

Write Line to CSV

Very fast method to append CSV records to a text file.

Tip: When writing lots of data to disk, this is the fastest way to create a CSV file without keeping data in memory and the best disk performance.

Action variables
File name with path:The path and name of the file where the data should be saved in.
Separator:The separator used to separate different data columns in the CSV.
Append new line (CR+LF):Select 'Yes' to close the line with a carriage return. Select 'No' if you use this action a few times in a row to append more then 9 values to a CSV line.
Value 1-9:Variables or text values to write to the CSV separated by the separator property.
Encoding:Encoding type of the file.

Import Excel

Imports an Excel file and puts the contents in a Data Grid source.

Action variables
File name with path:The path and name of the file containing the data.
Data Grid source:The Data Grid source where the data will be copied to.
Sheet Name:Sheet name to import, when left empty the first sheet will be imported.

Export to Excel

Export data from a Data Grid source to an Excel 2000/2003 compatible file.

Action variables
File name with path:The path and name of the file where the data should be saved.
Data Grid source:The Data Grid source where the data will be copied from.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.

Import Excel 2007

Imports an Excel file from MS Office 2007 and puts the contents in a Data Grid source.

Action variables
File name with path:The path and name of the file containing the data.
Data Grid source:The Data Grid source where the data will be copied to.
Sheet Name:The name of the Excel sheet in the workbook that contains the data. When left empty, the first sheet is used.

Export to Excel 2007

Export data from a Data Grid source to an Excel file in Excel format.

Action variables
File name with path:The path and name of the file where the data should be saved in.
Data Grid source:The Data Grid source where the data will be copied from.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.

Import Access

Import an Access 2000/2003 compatible file and put the content in a Data Grid source.

Action variables
File name with path:The path and name of the file containing the data.
Data Grid source:The Data Grid source where the data will be copied to.
Table name:The name of the Table in the database that contains the data that must be loaded.
Password:Fill in your password if your database is protected by a password.

Export to Access

Export data from a Data Grid source to an Access 2000/2003 compatible file.

Action variables
File name with path:The path and name of the file where the data should be saved in.
Data Grid source:The Data Grid source where the data will be copied from.
Table Name:The table name that should be used. If left empty, the name "Export Result" is used.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.

Import DBF or FoxPro

Import a DBF file and put the contents in a Data Grid source.

Action variables
File name with path:The path and name of the file containing the data.
Data Grid source:The Data Grid source where the data will be copied to.

Export to DBF

Export data from a Data Grid source to a DBF file.

Action variables
File name with path:The path and name of the file where the data should be saved in.
Data Grid source:The Data Grid source where the data will be copied from.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.

Export to SQL Script

Export a Data Grid source to SQL Script text file.

Action variables
File name with path:The path and name of the file where the data should be saved in.
Data Grid source:The Data Grid source where the data will be copied from.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.

File System

Copy File(s)

Copies one or more files to another location.

Tip: Indicate multiple files by using wildcards like: c:\myfiles\*.*.

Action variables
Source:The file(s) that should be copied.
Destination Folder:The folder where the file(s) should be copied to.
Silent:Set silent to 'Yes' to suppress confirmation and error prompts.

Move File(s)

Moves one or more files to another location.

Tip: Indicate multiple files by using wildcards like: c:\myfiles\*.*.

Action variables
Source:The file(s) that should be moved.
Destination Folder:The folder where the file(s) should be moved to.
Silent:Set silent to 'Yes' to suppress confirmation and error prompts.

Delete File

Deletes a file.

Action variables
File name with path:The file (path and File name) that should be deleted.
Silent:Set silent to 'Yes' to suppress confirmation and error prompts.

Rename File or Folder

Change the name of a file or folder.

Action variables
Old Filename:The existing file or folder that should be renamed.
New Filename:The new File name or folder name.
Silent:Set silent to 'Yes' to suppress confirmation and error prompts.

Create Folder

Create a new folder.

Tip: You can create several nested folders at once, i.e. "c:\folder1\folder2" creates the full path indicated including 'folder1' if it did not exist already.

Action variables
Folder Name:The folder (path) that should be created.
Silent:Set silent to 'Yes' to suppress confirmation and error prompts.

Copy Folder

Copies a folder including files to another location.

Action variables
Source Folder:The folder that should be copied.
Destination Folder:The destination to copy the folder to.
Silent:Set silent to 'Yes' to suppress confirmation and error prompts.

Move Folder

Moves a folder including files to another location.

Action variables
Source Folder:The folder that should be moved.
Destination Folder:The destination to move the folder to.
Silent:Set silent to 'Yes' to suppress confirmation and error prompts.

Delete Folder

Deletes an existing folder.

Action variables
Folder Name:The folder (path) that should be deleted.
Silent:Set silent to 'Yes' to suppress confirmation and error prompts.

Get File Information

Retrieves various information about a given file, like: size, creation date, etc.

Action variables
File name with path:The File name that should be analyzed.
Display Name:The File name as displayed by the file system.
File Type:The type as displayed by the file system, like 'Word document'.
Attributes:A string containing the attributes of the file, like: 'A' from the archive attribute.
Attribute code:A number that represents the active attributes of a file.
File size:A number containing the file size of a file in bytes.
File size description:A string that displays the file size rounded to kb, MB or GB.
Creation time:The creation Date of a file.
Last access time:The Date when the file was last accessed.
Last write time:The Date when the file was last modified.
File age in days:The number of days since the file was created and today.
Associated Executable:The executable associated with the extension in Windows.

Get File Path Information

Retrieves various information about a the path of a given file, like drive, file extension, etc.

Action variables
File name with path:The File name that should be analyzed.
File drive:The file drive where the file is located.
Dir:The directory the file is located.
Path:The file path to a file.
Short path:The short path (path without spaces and in 8.3 notation) of the full path.
Filename:The file name without the file path.
File extension:The file extension of a file, including the dot.

Email

Send Mail Direct

Deliver mail directly at the receiver's mail server without relaying through an SMTP host.

Tip: Read the more help for embedding images in HTML email.

Action variables
To:The address of the recipient.
From:The sender's e-mail address.
Subject:The e-mail subject.
Body:The plain text body of the e-mail. Can be either text or a local File name.
Result variable:The result of the action (mail sent, any errors) is written to this variable.
DNS:The DNS used to auto resolve the MX records.
HTML Body:HTML part of the message, either text or a local File name.
Attachments:Comma separated attachment list of local File names.


The minimum properties required to send an e-mail are the "To", "From", "Subject" and "Body" properties.

The "To" property can only be a single email address, valid notations are 'john.doe@someplace.com' or 'John <john.doe@someplace.com>' or '"John Doe" <john.doe@someplace.com>'.

The "Body" property is the plain text part of the message, this can be either plain text or a File name that should be loaded as the body text.

The "HTML Body" property is the HTML part of the message that will be included and can either be HTML text or a local File name.

If the HTML contains pictures (GIF, JPG or PNG) with a local reference, they will be embedded inline.
Example: '<img scr="c:\mypicture.jpg">' will be embedded inline because is has a local reference; '<img scr="http://somedomain/mypicture.jpg">' will NOT be embedded inline.

The "Attachments" property is a comma separated list of local File names, e.g. 'c:\myfile.doc, c:\myfile2.txt'.

If the "DNS" property is given, that DNS is used to auto resolve the MX records, otherwise the first DNS from the local system will be used.

The "Result" property contains the result of the action, a message with a specific error or success message.

Send Mail by SMTP

Send Mail by SMTP will send a plain text or html e-mail via an SMTP host.

Tip: Read the more help for embedding images in HTML email.

Action variables
To:The address of the recipient. Multiple addresses are separated by a comma.
From:The sender's e-mail address.
Subject:The e-mail subject.
Body:The plain text body of the e-mail. Can be either text or a local File name.
Host:SMTP server that should be used for the outgoing e-mail.
Result variable:The result of the action (mail sent, any errors) is written to this variable.
CC:Carbon copy recipients. Multiple addresses are separated by a comma.
BCC:Blind carbon copy recipients. Multiple addresses are separated by a comma.
Port:Specific SMTP port that should be used for the connection.
Host username:Username for basic SMTP authentication.
Host password:Password for basic SMTP authentication.
HTML Body:HTML part of the message, either text or a local File name.
Attachments:Comma separated attachment list of local File names.


The "To", "CC" and "BCC" properties can be a single email address or multiple e-mail addresses separated by a comma, valid notations are 'john.doe@someplace.com, jane.doe@someplace.com' or 'John <john.doe@someplace.com>' or  '"John Doe" <john.doe@someplace.com>, "Jane Doe" <jane.doe@someplace.com>'.

The "Body" property is the plain text part of the message, this can be either plain text or a File name that should be loaded as the body text.

The "HTML Body" property is the HTML part of the message that will be included and can either be HTML text or a local File name.

If the HTML contains pictures (GIF, JPG or PNG) with a local reference, they will be embedded inline.
Example: '<img scr="c:\mypicture.jpg">' will be embedded inline because is has a local reference; '<img scr="http://somedomain/mypicture.jpg">' will NOT be embedded inline.

The "Attachments" property is a comma separated list of local File names, e.g. 'c:\myfile.doc, c:\myfile2.txt'.

If the "DNS" property is given, that DNS is used to auto resolve the mx records, otherwise the first DNS from the local system will be used.

The "Result" property contains the result of the action, a message with a specific error or success message.

Optionally a specific SMTP "Port", "Username" and "Password" can be specified for the SMTP connection.

Send Mail Raw

Send a raw e-mail message file to a SMTP host.

Action variables
Host:SMTP server that should be used for the outgoing e-mail.
Raw message file:A file path to a text file containing the raw message.
Result variable:The result of the action (mail sent, any errors) is written to this variable.
Port:Specific SMTP port that should be used for the connection.
Host username:Username for basic SMTP authentication.
Host password:Password for basic SMTP authentication.


A raw e-mail message file is a text file that contains headers, addresses and content for an e-mail message.
These files are typically found in message queues of mail servers and used by programs as the Microsoft SMTP service.

A simple and minimal raw message file may look like:

TO: john.doe@someplace.com
FROM: jane.doe@someplace.com
SUBJECT: message from jane

Hello John,
Bye Jane.

System

Run shell command

This action executes a shell command.

For example, using 'notepad.exe' as "Command" property value will bring up Windows notepad editor.

Note: Use quotes when File names or parameters contain spaces.

Action variables
Command:The shell command to execute.
Parameters:Any parameters you want to feed to the shell command.
Show Window:Set the window state of the executing command shell.
Working folder:The working folder for the command that is executed. When ommited the current directory is used.
Wait until finished:Set to Yes or No. On Yes the script will wait until the started process is finished and then continue.

Pipe DOS Application

This action allows you to run a DOS application and catch its output in a variable.

Example: 'ipconfig.exe /all' as "Command line" property value will catch ip information output in a variable.

Note: Use quotes when File names or parameters contain spaces.

Action variables
Command line:The DOS application including command line parameters.
Output (stdOutOutput):The standard output of the DOS application is returned in text variable.
Errors (stdOutError):The standard error output of the DOS application is returned in text variable.
Show Window:Set the window state of the executing command shell.
Time-out (seconds):When the application is not finished by the time-out it will be killed automatically. '0' means wait for ever.
Success variable:Returns 'Yes' when the application has finished before the time-out, otherwise it will return 'No'.

Get Parameter Value

A Djuggler compiled script can be called with parameters. This action reads a parameter and assigns it to a text variable to be used in the script.

Example: Set "Param name" to '/log' and call the compiled script as 'myscript.exe /log=c:\temp\mylogfile.txt'.

Tip: Use the "Default value" property value to test the parameter when not running as a compiled script.

Action variables
Param name:The parameter name to use, like '/input'. Call it on the command line with '/input=test'
Param value:A text variable that holds the parameter value given on the command line.
Default value:When no parameter is given on the command line, this value will be used as Param value.

Close Window

Close a Windows Window by it's dialog title.

This action is typically used to close a dialog outside the Djuggler environment.

Action variables
Window title:The title of the Window dialog.
Success variable:Yes is returned when a dialog with the given title is found, else No is returned.

Get System Folder

Returns the path to the special Windows folders, like the Temp folder or My Documents (Personal folder), etc as a text variable.

Action variables
System Folder Kind:Specify a special folder.
Result variable:A text variable with the complete folder path.

Get System Information

Returns various system information, like Computer name, User name, IP Address, etc as a text variable.

Action variables
System Information:Specify the system information.
Result variable:A text variable with the system information.

Windows Clipboard

Get or set a value in the Windows clipboard.

Action variables
Text to clipboard:The variable or source from which the content should be copied to the clipboard.
Text from clipboard:The variable or source in which clipboard content as text should be placed.

Get Registry Data

Returns a registry value as a text variable.

Action variables
Hive Key:Select the hive key to use.
Key:The registry key value to use.
Value:The registry value to use.
Result variable:Return variable that holds the registry data.
Success variable:When the registry could be read 'Yes' will be returned otherwise 'No'.

Deprecated

Open Web Page source

This is a deprecated action, use the Get Web Page action.

Opens a Web Page and puts the HTML source as in the IE 'view source' option in the content in the Web Page source.

Note: This is not the DOM source as shown in the Djuggler Web Inspector. This is the source as served by a web server without interpretation of Internet Explorer.

Action variables
Web Page:The Web Page source to be used.
URL:The URL to use including prefixes like http:// or https://.

Get Table

This action is deprecated, use the Get Table Content action instead.

Collects all data from a HTML table to a "Data Grid" source.

The "Table Number" variable to indicates the HTML table to use. For example Table Number 3 will collect data from the third <TABLE> tag found in the HTML.

Tip: Use the Web Page viewer (F3) to inspect the table number in a Web Page.

Action variables
Source:The source (Web Page or Text File) containing the HTML and table you want to extract.
Data Grid source:The Data Grid variable where the table data will be returned.
Table Number:Tells the action which table to extract. Search for "<TABLE" in the HTML source, and count occurrences until you reach the table you are after.
Start Row:Indicate at which row to start reading data. The first row has number "1".
End Row:Indicate at which row to stop reading data.
Start Column:Indicate at which column to start reading data. The first column has number "1".
End Column:Indicate at which column to stop reading data.
Strip HTML:Indicates whether the action will strip the data from HTML tags, thus automatically cleaning the data.

Read Tag Content

This action is deprecated, use the Web Page DOM actions instead.

Reads the content from a HTML tag.

Action variables
Source:The source (Web Page or Text File) containing the HTML and tag(s) you want to extract.
Tag:The name of the tag to read, like "TD".
Attribute Name:Optional name of the attribute to further specify the tag you need.
Attribute Value:Optional value of the attribute you use to specify the tag.
Content:Any content found is placed here.
Strip HTML:Indicates wether the action will strip the data from HTML tags, thus automatically cleaning the data.


The action looks for the tag specified in the Tag property. If you set Attribute Name and Value, only tags are matched where the tag attribute contain the set value.

For example, say you want to read the content of a html tag specified by the following html: "<TD class='myclass'>some content here...</TD>". Fill in "TD" as Tag, "class" as Attribute and "myclass" as Value. The action will now seek through the html and return the content of the first found tag in the Content property.

Fill Form Field

This action is deprecated, use the Set Form Element Value action instead.

Fills a field in a form on a Web Page. Typically used for form automation, like a login to a web site.

Action variables
Web Page:The Web Page source to be used.
Field Name:Field name that should be filled. This is the name attribute of the INPUT tag.
Value:The value to be pasted in to the form's field.

Date to Text

This action is deprecated, use the Convert Variable action instead.

Returns the date part from a Date variable as a Text variable.

Action variables
Date variable:The Date to obtain the date from.
Result variable:The text variable to be filled with the date form the Date variable.

Time to Text

This action is deprecated, use the Convert Variable action instead.

Returns the time part from a Date variable as a Text variable.

Action variables
Date variable:The Date to obtain the time from.
Result variable:The text variable to be filled with the time form the Date variable.

Convert Source Text to Variable

This action is deprecated, use the Convert Variable action instead.

Copies the content of the Source to a Variable.

Action variables
Variable:The variable to place the source text in. This should be a Text Variable.
Source:The source to copy the text from.

Convert Variable to Source Text

This action is deprecated, use the Convert Variable action instead.

Copies the content of the Variable to the Source.

Action variables
Variable:The Variable to copy the text from.
Source:The Source to place the source text in.


Tip: This action is often used to convert a variable to a Text source and save it to disk.

Get Element Value

This action is deprecated, use the Web Page DOM actions instead.

Retrieves the value (innerHTML) of a specified HTML tag. You can specify tag attribute/value combinations to indicate a specific tag.

Action variables
Web Page:The Web Page source used to retrieve the tag.
Tag Name:The tag name to retrieve.
Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Result Variable:The variable used to return the Tag content (innerHTML).
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not complete successfully.


Example:
The HTML contains a tag "<TD width=36><b>some content</b></TD>".
To retrieve this tag's content, you should specify the Tag Name as "TD", Attribute Name as "width" and Attribute Value as "36". In the Result Variable, "<b>some content</b>" will be returned.

Get Element Text

This action is deprecated, use the Web Page DOM actions instead.

Retrieves the value (innerText) of a specified HTML tag. All HTML within the tag's content is stripped. You can specify tag attribute/value combinations to indicate a specific tag.

Action variables
Web Page:The Web Page source used to retrieve the tag.
Tag Name:The tag name to retrieve.
Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Result Variable:The variable used to return the Tag content (innerHTML) in.
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not complete successfully.


Example:
The HTML contains a tag "<TD width=36><b>some content</b></TD>".
To retrieve the tag's content, specify the Tag Name as "TD", Attribute Name as "width" and Attribute Value as "36". In the Result Variable, "some content" will be returned.

Get Element Attribute Value

This action is deprecated, use the Web Page DOM actions instead.

Retrieves an attribute value of a HTML element.

Action variables
Web Page:The Web Page source used to retrieve the tag.
Tag Name:The tag name to retrieve.
Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Result Attribute Name:The attribute name that should be used to return the attribute value content from.
Result Variable:The variable used to return the attribute value in.
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not complete successfully.


Example:
The HTML contains a tag "<table id=table1 width=300>".

To retrieve the attribute width value, specify the Tag Name as "TABLE", Attribute Name as "id" and Attribute Value as "table1". Result Attribute Name as "width" and in the Result Variable, "300" will be returned.

Set Element Value

This action is deprecated, use the Web Page DOM actions instead.

Searches the first tag that matches the Tag Name, Attribute Name and Attribute Value. With the found tag, the value (innerHTML) is set.

Action variables
Web Page:The Web Page source used to set the tag.
Tag Name:The tag name to search.
Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Content:The variable used to set the Tag content (innerHTML) in.
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not compleet successfully.


Example:
The HTML contains a tag "<TD width=36><b>some content</b></TD>".

To set this tag's content, you should specify the Tag Name as "TD", Attribute Name as "width" and Attribute Value as "36". In Content you could set "other content", and the tag will then read "<TD width=36><b>other content</b></TD>".

Set Element Attribute Value

This action is deprecated, use the Web Page DOM actions instead.

Searches the first tag that matches the Tag Name, Attribute Name and Attribute Value. Optionally, a 2nd and 3rd Attribute Name and Value is matched as well.

Action variables
Web Page:The Web Page source used to set the tag.
Tag Name:The tag name to search.
Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Attribute Name to set content for:The attribute name to set the content for.
Content:The variable used to set the Tag content (attribute value) in.
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not compleet successfully.


You can also leave empty the first Attribute Name and Attribute Value just to match on Tag Name.

Example:
The HTML contains a tag "<TD width=36 height=3><b>some content</b></TD>".
To set this tag's content, you should specify the Tag Name as "TD", Attribute Name as "width" and Attribute Value as "36". If you set Attribute Name to set content for to "height" and Content to "6", and the tag will then read "<TD width=36 height=6><b>other content</b></TD>".

Click Element

This action is deprecated, use the Web Page DOM actions instead.

Searches the first tag that matches the Tag Name, Attribute Name and Attribute Value. Optionally, a 2nd and 3rd Attribute Name and Value is matched as well.

Action variables
Web Page:The Web Page source used to perform the click on.
Tag Name:The tag name to search.
Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not compleet successfully.

Connect to MSSQL

This action is deprecated, use the SQL Connect action instead.

Open a connection to a Microsoft SQL database.

Action variables
Database source:The SQL Database source to use.
Host Name:The Database host name.
User Name:The user name used to connect to the database.
Password:The password used to connect to the database.
Database Name:The name of the database your data is stored in.
Port:The port used for the connection.


When connecting to a database to run "SQL Query Direct" action, use the following basic structure:

... do actions...
Connect
SQL Query Direct
Disconnect

Connect to MySQL

This action is deprecated, use the SQL Connect action instead.

Open a connection to a MySQL database.

Action variables
Action variables:
Database source:The SQL Database source to use.
Host Name:The Database host name or ip address.
User Name:A user name used to connect to the database.
Password:A password used to connect to the database.
Database Name:The name of the database to be used.
Port:The port used for the connection.


When connecting to a database to run "SQL Query Direct" action, use the following basic structure:

... do actions...
Connect
SQL Query Direct
Disconnect

Connect to Oracle

This action is deprecated, use the SQL Connect action instead.

Open a connection to a Oracle database.

Action variables
Database source:The SQL Database source to use.
Host Name:The Database host name.
User Name:The user name used to connect to the database.
Password:The password used to connect to the database.
Database Name:The name of the database to be used.
Port:The port used for the connection.


When connecting to a database to run "SQL Query Direct" action, use the following basic structure:

... do actions...
Connect
SQL Query Direct
Disconnect

SQL Query for Records

This action is deprecated, use the SQL Query action instead.

Execute a SQL query and returns a record set in memory linked to the database connection.

Action variables
Database source:The SQL Database source to query.
Query:The SQL query (for example "select * from table1").


When using a record set, use the following basic structure:

Connect
SQL Query for Records
... do actions like Loop Data Grid Rows...
Disconnect


First use the Connect action to connect to the server.
Next run a SQL Query for Records and create a result set of records in memory, linked to the SQL database connection.
Next use actions like Get Field or Delete Record.
Changes in the records set will not be saved to the database until Commit Changes is used or the Disconnect action is called.

Action Help

This help text explains the actions, grouped by category.

Flow

If

Compares two variables or sources.

If the comparison succeeds, the script actions between the If and End If script lines are executed. The If action can also be used in combination with an Else action.

Tip: The wildcard '*' can be used in a string compare.

Action variables
Variable1:Text, Number, List, Date variables or Text source, Web Page source to be compared.
Operator:Determines how variable 1 and variable 2 are compared, i.e. "Variable1 Is Not Equal to Variable2".
Variable2:Text, Number, List, Date variables or Text source, Web Page source to be compared with the first variable.


Structure example:

If ...
... do actions ...
End If

If Condition

Test a "Variable" against a certain condition, like Is Empty, Contains Text, Equal To, Exists in List, etc.

If the comparison succeeds, the script actions between the If Condition and End If script lines are executed. The If Condition action can also be used in combination with an Else action.

Tip: Use this action to verify if a variable is empty, or a file exists or is a positive number, etc.

Action variables
Operator:Select a condition to which the variable should be tested.
Variable:Text, Number, List or Date variables, Text source or Web Page source can be tested.


Structure example:

If Condition ....
 ... do actions ...
End If

If Case

Test the script against certain conditions, like Is Online, Is Compiled Script, etc.

If the comparison succeeds, the script actions between the If Case and End If script lines are executed. The If Case action can also be used in combination with an Else action.

Tip: Use this action to verify if the computer executing the script has an active Internet connection.

Action variables
Operator:Select a condition to which should be tested.


Structure example:

If Case ....
 ... do actions ...
End If

Else

The Else action can be used in conjunction with an If or If Condition action.

When the If action fails, the lines between Else and End If are executed.

Action variables
Comment text:Optional comment text to improve script reading.


Structure example:

If ...
... do actions ...
Else
... do actions ...
End If

End If

The End If action closes an If, If Case or If Condition block.

Action variables
Comment text:Optional comment text to improve script reading.


Structure example:

If ...
... do actions ...
Else
... do actions ...
End If

Go to Label

Jumps to a Label action in the script and executes lines from there until a Return from Label action is encountered.

The "Label name" property value should match the exact name of the label to jump to. Use the Return from Label action to jump back to the script position where Go to Label was called.

Note: A Stop Script Execution action may be needed to prevent the script from running into a label without being called by a Go to Label action.

Action variables
Label name:The (exact) name of the label to jump to.


Labels are typically used if a script has a block of actions that are repeated two or more times in a script.

Structure example:

If Condition
Go to Label GetData
else
Go to Label UpdateLogFile
End If
Stop Script Execution
Label GetData
... actions ...
Return from Label
Label UpdateLogFile
... actions ...
Return from Label

Tip: Labels can be nested in the script logic.

Label

The Label action is used as a marker in combination with the Go to Label action.

The Go to Label action can be used to jump to a Label action and resume execution from there.

Use the Return from Label action to jump back to the script position where Go to label was called.

Note: Make sure the names in both actions match exactly else the action will be ignored.

Action variables
Label name:The name of the label.


Structure example:

If Condition
Go to Label GetData
else
Go to Label UpdateLogFile
End If
Stop Script Execution
Label GetData
... actions ...
Return from Label
Label UpdateLogFile
... actions ...
Return from Label

Tip: Labels can be nested in the script logic.

Return from Label

Use the Return from Label action to indicate the end of label and jump back to position where the Label was called with a Go to label action.

Tip: When using labels as procedures its better to use the procedure action.

Action variables
Comment text:Optional comment text to improve script reading.

Procedure

The Procedure action is used as a marker in combination with the Execute Procedure action.

Use an End Procedure action to jump back to the script position where Execute Procedure was called.

Note: A procedure in the script logic is ignored during script run, unless it has been called by the Execute Procedure action.

Action variables
Procedure name:The name of the procedure.


Procedures are typically used if a script has a block of actions that are repeated two or more times in a script. By using the procedure method the number of script lines can be reduced and the script logic will improve.
... actions ...
Loop

Execute Procedure GetPriceInformation
Execute Procedure ComparePrices
Execute Procedure SaveResults
End Loop

Procedure GetPriceInformation
... actions ...
End Procedure

Procedure ComparePrices
... actions ...
End Procedure

Procedure SaveResults
... actions ...
End Procedure

Tip: Procedures can be nested in the script logic.

End Procedure

Use the End Procedure action to indicate the end of a procedure and jump back to position where the Procedure was called with a Execute Procedure action

Action variables
Comment text:Optional comment text to improve script reading.

Execute Procedure

Jumps to a Procedure action in the script and executes lines from there until a End Procedure action is encountered.

The "Procedure" property value should match the exact name of the procedure to jump to.

Note: A procedure in the script logic is ignored during script run, unless it has been called by the Execute Procedure action.

Action variables
Procedure name:The name of the procedure to execute.


Procedures are typically used if a script has a block of actions that are repeated two or more times in a script. By using the procedure method the number of script lines can be reduced and the script logic will improve.

... actions ...
Loop

Execute Procedure GetPriceInformation
Execute Procedure ComparePrices
Execute Procedure SaveResults
End Loop

Procedure GetPriceInformation
... actions ...
End Procedure

Procedure ComparePrices
... actions ...
End Procedure

Procedure SaveResults
... actions ...
End Procedure

Tip: Procedures can be nested in the script logic.

Loops

Loop

The Loop action is a simple infinite loop until the action Exit Loop is called.

All actions between the begin of the loop and end of the loop are processed infinitely.

Note: An End Loop action is needed to close the loop script logic and an Exit Loop to exit the loop.

Action variables
Comment text:Optional comment text to improve script reading.



Structure example:

Loop
 ... actions ...
  If Condition ...
   Exit Loop
  End If
End Loop


Tip: To exit a simple loop use an If or If Condition action combined with the Exit Loop action to exit the loop.

Loop While

The While Loop will loop actions while a specified condition is valid and exits automatically when the condition is invalid.

Note: An End Loop action is needed to close the loop in the script logic.

Action variables
Variable1:Text, Number or Date variable to be compared.
Operator:Determines how Variable1 and Variable2 are compared, i.e. "Variable1 Is Not Equal to Variable2".
Variable2:Text, Number or Date variables to be compared with the first variable.


Structure example:

Loop While ...
... actions ...
End Loop

Tip: Force a loop exit by using the Exit Loop action in the script logic.

Loop Condition

The Condition Loop will repeat actions in the loop while a specified condition is valid and automatically exit the loop when the condition is invalid.

Note: An End Loop action is needed to close the loop in the script logic.

Action variables
Operator:Determines how the variable should be tested, for example Is Empty, File Exists.
Variable:Text, Number and Date variables can be tested to a condition.


Structure example:

Loop Condition ...
... actions ...
End Loop

Loop Range

Loops through a preset numerical range.

The looping process starts with Start Value and will stop when it reaches the Stop Value. With each loop, the Start Value gets incremented by the Step property. The Current Value variable returns the current step value.  If Start Value is larger then Stop Value, the loop will count down.

Note: An End Loop action is needed to close the loop in the script logic.

Action variables
Start Value:The numerical value to start the loop.
Stop Value:The numerical value to end the looping process.
Current Value:A variable containing the current numerical value used in the loop.
Step:With each loop the Start Value is incremented by Step. If the Step property is not given, a value of 1 is assumed.


Examples:
Start=1 Stop=4. Loop goes through Current Values 1,2,3,4.
Start=7 Stop=3. Loop goes through Current Values 7,6,5,4,3.
Start=2 Stop=8. Step=2. Loop goes through Current Values 2,4,6,8.

Structure example:

Loop Range ...
... actions using the Current Value property variable...
End Loop


Tip: Force a loop exit by using the Exit Loop action in the script logic.

Loop Files

Loops file names in a directory and returns found file names in the "File name variable". Looping continues until no more files are found.

Note: An End Loop action is needed to close the loop in the script logic.

Action variables
Root Folder:The root directory to search for files.
Variable holding Filename:A variable in which found files names are returned during the loop.
Recurse Sub Directories:Select Yes to recurse subdirectories from the root directory.
File Mask:Specify an optional file mask. For example "*.txt" to loop only files with the extension txt.


Structure example:

Loop Files
 ... actions using the File name property variable ...
End Loop


Tip: Force a loop exit by using the Exit Loop action in the script logic.

Loop Folders

Loops folder names in a directory and returns found folder names in the "Folder name" variable. Looping continues until no more folders are found.

Action variables
Root Folder:The root directory to search for sub folders.
Folder Name:A variable in which  found folder names are passed to during the loop.
Recurse Sub Directories:Select Yes to recurse subdirectories from the root directory.
Folder Mask:Specify an optional folder mask. For example "My*" to loop only folders staring with My in the folder name.


Structure example:

Loop Folders
... actions using the Folder name property variable ...
End Loop


Tip: Force a loop exit by using the Exit Loop action in the script logic.

Loop List

Loops all items in a List variable and passes them on to a Text variable.

The loop starts with the first item in the List and stops at the last item.

Tip: To loop a sorted list, use the Sort List action before the loop.

Action variables
List variable:The List variable containing list items.
Return variable for item:With each pass of the loop, the result variable is filled with the current item content.
Total number of items:The total number of items in the list.


Structure example:

Loop List
 ... actions using the Item property variable ...
End Loop

Loop Data Grid Rows

Loops through all the rows in a data grid.  The first row in a data grid has the number 1. 

The "Current Row" variable returns the current row number, and can be used in actions like Get Date Cell Value to get the content of data grid fields.

Tip: To loop a sorted data grid, use the Sort Data Grid action before the loop.

Action variables
Data Grid source:The data grid to use.
Current Row variable:A variable containing the current row number used in the loop.
Total number of rows:Total number of rows in the data grid.


Tip: When searching only a single row in a Date Grid, the Find in Data Grid action is much faster then a loop over all grid rows. Structure example:

Loop Data Grid Rows
... actions like Get Date Cell Value ...
End Loop

Loop Data Grid Columns

Loops through all the columns in a data grid. The first column in a data grid is has the number 1.

The "Current Column" variable returns the current column number, and can be used in actions like Get Date Cell Value to get the content of data grid fields.

Action variables
Data Grid source:The data grid to use.
Current Column variable:A variable containing the current column number used in the loop.


Structure example:

Loop Data Grid Columns
 ... actions like Get Date Cell Value ...
End Loop

Loop XML Nodes

Loops nodes in a XML tree from a specific start point. Optionally returns only nodes with a specific name or path.

Tip: The "Look for" property can be a Node name or (partial) Node path. Path notation is with forward slashes like: 'books/book'.

Action variables
XML Document source:The XML Document source to be used.
Start at (Node):The starting point from which to start searching in the XML tree.
Look for (node name or path):The path or the name of the node(s) to be looked for.
Result Node:XML node variables that are found are passed on to this XML Node variable.
Success variable:Indicates "Yes" when at least one node was found, else "No" is returned.


If the complete XML tree is to be looped, use the root node as starting node.

When "Look for
" is defined as 'book' the loop will pass all nodes named 'book' to the "Result Node" variable, regardless of where they are from the starting point in the tree.

When "Look for" is defined as 'books/book' all "book" nodes will be returned that reside directly under a parent node named 'books'.

Loop XML Child Nodes

Loops child nodes in the XML tree from a specific start point (not recursively, only the child nodes under the starting point).

Optionally returns only nodes with a specific name. If the Name property is not specified, all child nodes are returned.

Action variables
XML Document source:The XML Document source to be used.
Start at (Node):The starting point from which to start searching in the XML tree.
Look for (node name):The name of the node(s) to look for.
Result Node:XML nodes that are found are passed on to this XML Node variable.
Success variable:Indicates "Yes" when at least one node was found.

Loop RegEx

Loops through all the matches of a regular expression and with each loop a match result is returned in the "Returned Match" variable. If there is no more match the loop ends.

This action is using the Perl regular expression syntax with Unicode support.

Note: When sub expressions are used in the regular expression, a sub expression number should be specified for the returned match variable. 0 means the complete match.

Action variables
Regular Expression:The regular expression used to match text in the Source Text.
Source Text:The text to be used as input.
Returned Match:The matched text is returned via this variable in each pass of the loop.
Return Sub Expression Nr:Returns only a specific sub expression found in the regular expression. 0 means complete match.
Match Success variable:Indicates whether the last match has succeeded or failed by returning "Yes" or "No".


Structure example:

Loop Matched Text
 ... actions using the Returned Match property variable ...
End Loop


More on regular expressions can be found at:
- http://en.wikipedia.org/wiki/Regular_expression
- http://regexlib.com

Loop Text File Lines

Reads a text file in a text source and loops though all the lines. With each pass the "Read Line" variable returns a line that was read from the file. An "End Loop" action is needed to close the loop in the script logic.

Note: For performance reasons the content of the Text File source is not shown in the Text Viewer.

Action variables
Text File: A Text File source.
File name with path:The full path and name of the file to be used as text source.
Read Line variable:Contains the line content of the file with each pass of the loop.
Encoding:Encoding type of the file.


Structure example:

Loop Text File Lines
 ... actions using the Read Line variable ...
End Loop

Loop Records

Loops all records in a record set related to a SQL database connection. This action needs to be combined with the SQL Query action and a select statement.

The loop starts with the first record in the record set and exits the loop when the last record is reached.

Note: When the loop finishes it will apply any changes made in the record set to the database automatically.

Action variables
Database source:The database connection to use.


When using a record set, use the following basic structure:

SQL Connect
SQL Query with a select statement
Loop Records
... actions like Get Field Value...
End Loop
SQL Disconnect

End Loop

Each Loop action needs an End Loop action to indicate the end of the loop.

Action variables
Comment text:Optional comment text to improve script reading.


Structure example:

Loop While ...
 ... actions ...
End Loop

Exit Loop

Forces an exit in a loop and is often used in combination with an If or If Condition action.

Action variables
Comment text:Optional comment text to improve script reading.


Structure example:

Loop
 ... actions ...
  If Condition ...
   Exit Loop
  End If
End Loop

Script Control

Comment

Comments are used to place notes in a script and make a script more readable.

Tip: Use empty comments to separate blocks of code for clarity.

Note: A Comment action is excluded from the script action execute count.

Action variables
Comment text:A text or leave it empty for a script line separator.

Wait

Pauses the execution of the script for a number of milliseconds.

Property "ms" should contain the number of milliseconds the script should pause.

Action variables
Wait time in ms:A number or variable with milliseconds.


Tip: When requesting a lot of pages from a web server it can get stressed. Use a Wait action with 2000 milliseconds before requesting each Web Page to relief the web server from stress.

Suppress Errors and Dialogs

Suppresses all error dialogs and show message dialogs. All feedback to the user in the form of message dialogs that halt the execution of the script are suppressed.

This action is typically used in compiled executable scripts that run on stand alone servers.

Note: The Show Errors and Dialogs action will re-enable dialogs again.

Action variables
No variables need to be set for this action.

Show Errors and Dialogs

Enables all error dialogs and user dialogs after a Suppress Errors and Dialogs action.

No variables need to be set for this action.

On Error Go To

Jumps to a specified label or procedure when the script encounters an error.

Tip: When the Suppress Errors & Dialogs action is used this action can be used to catch and handle script errors.

Action variables
Procedure or Label Name:The label or procedure the script should go to when an error is encountered.

Get Last Error

Fills the "Last Error variable" with a description of the last encountered error.

Tip: When the Suppress Errors & Dialogs action is used this action can be used to catch and handle script errors.

Action variables
Error Text:Variable with a description of the last encountered error.
Error Number:Variable with the last encountered error number.
Line Number:The script line number that encountered the last error.
Action Name:The script action name that encountered the last error.
No of actions executed so far:The number of actions executed before the last error.
Run Time (s):The script run time in seconds before the last error.

Clear Last Error

Clears the error text found by the "Get Last Error" action.

Action variables
No variables need to be set for this action.

Stop Script Execution

Stops the execution of the script.

Action variables
Exit code:The exit code passed to the operating system.

Pause Script Execution

Pauses the execution of the script and continues in step mode. This action is typically used in a debug situation.

Note: In a compiled script this action is ignored.

Action variables
No variables need to be set for this action.


Tip: Inspect the content of variables and sources when paused by clicking the Step button. The script can be resumed with the Resume button in the menu bar controls.

Get Script Properties

Returns various script properties like the script path, script name, build version. It also reveals information about the Djuggler version and edition used to create the script.

Action variables
Script Path:Returns the file path where the Djuggler script is located, including a trailing backslash.
Script Name:Returns the name as saved on disk, without the extension.
Script Build Number:Returns the build number that increases with one, each time the script is saved.
Created by Djuggler Version:Returns the Djuggler version used to create the script.
Created by Djuggler Edition:Returns the Djuggler edition used to create the script.
Designed with IE version:Returns the Internet Explorer version used when creating the script.

Show Web Viewer

Shows or hides up Djuggler's internal web viewer.

Note: Using a viewer will reduce the execution speed of the script.

Action variables
Web Page source:The web page source to show or hide in the viewer.
Visibility:Show or Hide the viewer.
Viewer Height:The viewer height in pixels.
Viewer Width:The viewer width in pixels.
Viewer Top:Position of the viewer from the top of the screen in pixels.
Viewer Left:Position of the viewer from the left of the screen in pixels.
Show source:Show the HTML source in the viewer.

Show Grid Viewer

Shows or hides up Djuggler's internal grid viewer.

Note: Using a viewer will reduce the execution speed of the script.

Action variables
Data Grid source:The data grid source to show or hide in the viewer.
Visibility:Show or Hide the viewer.
Viewer Height:The viewer height in pixels.
Viewer Width:The viewer width in pixels.
Viewer Top:Position of the viewer from the top of the screen in pixels.
Viewer Left:Position of the viewer from the left of the screen in pixels.

Show Text Viewer

Shows or hides up Djuggler's internal text viewer.

Note: Using a viewer will reduce the execution speed of the script.

Action variables
TextFile/XMLDoc source:The text file or XML source to show or hide in the viewer.
Visibility:Show or Hide the viewer.
Viewer Height:The viewer height in pixels.
Viewer Width:The viewer width in pixels.
Viewer Top:Position of the viewer from the top of the screen in pixels.
Viewer Left:Position of the viewer from the left of the screen in pixels.

Show SQL DB Viewer

Shows or hides a database viewer. The viewer will be cleared when the connection to the database is closed.

Note: Using a viewer will reduce the execution speed of the script.

Action variables
Database source:The SQL database source to show or hide in the viewer.
Visibility:Show or Hide the viewer.
Viewer Height:The viewer height in pixels.
Viewer Width:The viewer width in pixels.
Viewer Top:Position of the viewer from the top of the screen in pixels.
Viewer Left:Position of the viewer from the left of the screen in pixels.

Write To Log

Appends a text line to a log file, including a date time stamp.

Note: This action is typically used in a debug situation.

Action variables
File name with path:File and path for the log file.
Log line text:Text line to be added to the log.
Date/Time stamp:Prefix the log line with a current date time stamp.

Missing action

When a script is loaded that is created by a more recent version of Djuggler a missing action statement will replace all unknown actions from the new Djuggler version.

Action variables
Comment:Comment text about the action that is missing.

Dialogs

Show Message

Displays a text message in a message box.

Note: The Script will be paused until a user presses the OK button in the message box.

Action variables
Prompt text:Text to be displayed.

Input Dialog

Presents an input box with a single text line.

The "Answer" variable will contain the answer the user has typed in in the input box.

Action variables
Prompt text:Text to be displayed to the user in the input dialog.
Answer variable:Contains the answer from the user.
Default value:A default value for input dialog.

Choice Dialog

Presents the user with an dialog for Yes or No.

The "Answer" variable will contain the answer Yes or No.

Note: When using a If action to verify the "Answer" variable, compare to 'Yes' or 'No' (case sensitive).

Action variables
Prompt text:Text to be displayed to the user in the input dialog.
Answer variable:Contains the answer from the user, Yes or No.

Open File Dialog

Shows an open file dialog asking the user to choose a file.

The file will be passed on to the "Answer" variable and contains the fully qualified path with directory and File name.

Action variables
Dialog Title:The title for the dialog.
Answer variable:Return variable where the file path gets returned. If the dialog was cancelled, the value will be empty.
Initial Folder:The initial starting folder from where the user will be able to browse directories.
File extension:The default file extension for the file.

Save File Dialog

Shows a save file dialog asking the user to choose a file.

The file will be passed on to the "Answer" variable and contains the fully qualified path with directory and File name.

Action variables
Answer variable:Return variable for the file path. If the dialog was cancelled, the value will be empty.
Dialog Title:The title for the dialog.
Initial Folder:The initial starting folder from where the user will be able to browse directories.
File extension:The default file extension for the file.

Open Folder Dialog

Shows a dialog asking the user to choose a directory.

The directory path will be passed on to the "Answer" variable. It will contain a fully qualified directory, trailed by a backslash ("\").

Action variables
Answer variable:A variable where the directory path gets returned. If the dialog was cancelled, the value will be empty.
Dialog Title:The title for the dialog.
Initial Folder:The initial starting folder from where the user will be able to browse directories.
File extension:The default file extension for the file.

Deployment

Progress Dialog

Shows a dialog with an optional progress bar.

This action is typically used for compiled executable scripts.

Tip: The Loop rows action contains a property Total number of rows that can be used for Maximum Value property in this action.

Action variables
Visibility:Shows or hides the dialog.
Title:Dialog title
Message:The text content of the dialog.
Maximum Value:Maximum value for the progress bar.
Current Value:Current value for the progress bar.
Show Stop Button:Displays a stop script button in the dialog.
Position:Screen position of the dialog.
Display Progress Bar:Show or hide the progress bar.
Left:Screen left position in pixels when using a custom screen position.
Top: Screen top position in pixels when using a custom screen position.

Show HTML Dialog

A custom dialog in HTML used for advanced input controls or as a HTML viewer.

Note: Only a HTML form submit will close the dialog and continue the script when the mode is set to INPUT. All form values are returned in a List variable. The post url for the form can be anything like "#" or leave it empty like "".

Tip
: Use the Get Name Value from List action to access individual values from the form post data.

Action variables
HTML:A HTML text, a variable with a HTML form or a file name that should be loaded.
Visibility:Hide or show the dialog.
Mode:Viewer mode will always continue the script, Input mode will wait for input from a user by a FORM post.
List for Form result:List variable that returns the form post data on a form submit.
Width:The dialog width in pixels.
Height:The dialog height in pixels.
Title:The dialog title.


Example HTML form:

<FORM action="#" method="post">
 <LABEL for="name">Name: </LABEL>
 <INPUT type="text" name="name"><BR>
 <INPUT type="radio" name="gender" value="Male"> Male<BR>
 <INPUT type="radio" name="gender" value="Female"> Female<BR>
 <INPUT type="submit" value="Submit">
</FORM>


When John Doe is entered as name and gender mail is selected with this HTML form example, the list variable with the form post data would contain 2 items:

name=John Doe
gender=Male


With the action Get Name Value from List  using "gender" for example, the value "Male" would be returned to a Text variable.

Debug Trace

Starts a trace containing all executed action and variables. Typically used to debug a deployed script.

Action variables
Tracing enabled:Enables or disables the tracing.
Filename:File name and path for the trace file.
Nr of actions in trace file:The number of actions recorded in the trace file.

Variables

Set Variable

Replaces the current content of a variable.

Action variables
Variable:The variable to place content in.
Content:The content to fill the Variable with.

Add to Variable

Adds to the content to a variable.

Adding is done differently for each variable type. If the variable is text, the content is appended to the current text in "Variable". If the variable is a number, the content is added arithmetically.

Action variables
Variable:The variable to add content to.
Content:The content to add to the variable.
Extra Content 1..6:Extra content to be added to the variable.

Subtract from Variable

Subtracts from a variable.

Subtracts are done differently for each variable type. If the variable is text, the content is subtracted from the current text in "Variable". If the variable is a number, the content is subtracted arithmetically.

Action variables
Variable:The variable to add content to.
Content:The content to add to the Variable.

Convert Variable

Converts one variable type to another, like a number variable to a text variable.

Tip: A cursor position can only be remembered in source, like a Web Page or Text Source. Use this action to convert a Text variable to a Text Source.

Action variables
Input variable:The variable for conversion.
Output variable:The result variable after conversion.

Clear Variables

Clears the content of one ore more variables.

Note: Number variables will be set to 0, date variables will get the date 12/30/1899 when cleared.

Action variables
Variable 1-12:The variable that should be cleared.

Validate

Validate the content of a variable to meet specific conditions, like is a number or is not empty, or matches a regular expression, etc.


When the validation fails the action can jump to a Label/Procedure or write to a log file.

Action variables
Variable:The variable to be validated.
Test:The basic test to perform, like is a number or is not empty.
Validated:Variable holding the validation result as Yes or No.
Contains text:Additional validation test (optional).
Matches regex:Additional validation test (optional).
Min length:Additional validation test (optional).
Max length:Additional validation test (optional).
Does not contain text:Additional validation test (optional).
Line number:The line number of the action in the script.
On invalid data go to label:Specify a Label where the script should jump to when data is not validated.
Log file name:When specified a line will be added to the log file when data is not validated.
Custom error text:A custom error text that should be used in the log file or assigned to the Error Text Variable.
Error Text Variable:A text variable that holds the Custom Error Text property of this action. Typically also used in combination with On invalid data go to label property of this action.


Tip: Use this action to validate the content of variables or the success variable of other actions.

Generate a Random Number

Returns a random number within a certain range.

When the range is set to a minimum 1 and the maximum to 5, the action chooses a number randomly between 1 and 5.

Action variables
Result variable:The variable in which the random number is returned.
Range Minimum:The lower limit of the range.
Range Maximum:The upper limit of the range.

Create Guid

Returns a Globally Unique Identifier as a text variable.

Tip: Guid's are typically used to create a unique identifier in a Data Grid or as file name for example.

Action variables
Result variable:The variable in which the GUID is returned.

Math Expression

This action can be used for mathematical calculations.

A few examples of valid expressions: "4+2", "sqrt(9)", "(4+2)/sqrt(9)".

Action variables
Math Expression:The mathematical expression.
Result variable:A variable that holds the result of the expression.


Within the expression, Djuggler variables can be used by putting the variable name between square brackets.
Example: if the script contains a number variable named "Number1", it can be used in the expression like "(4+2)/sqrt([Number1])".

Operators that can be used:
+ : Addition
- : Subtraction
* : Multiplication
/ : Division
^ : Exponential (only positive numbers for the base)
( : Open parenthesis
) : Close parenthesis

Functions that can be used:
ABS (Range: -1e4932..1e4932)
ATAN (Range: -1e4932..1e4932)
COS (Range: -1e18..1e18)
EXP (Range: -11356..11356)
LN (Range: 0..1e4932)
ROUND (Range: -1e9..1e9)
SIN (Range: -1e18..1e18)
SQRT (Range: 0..1e4932)
SQR (Range: -1e2446..1e2446)
TRUNC (Range: -1e9..1e9)

Lists

Open List

Reads a Text file and places the content of each text line as a collection item in the "List variable".

Action variables
List variable:The List to put the items in from the text file.
File name with path:The file where the list items should be read from.
Encoding:Encoding type of the file.

Save List

Stores the items of the "List variable" in a text file.

Note: Each item is stored on a new line in the text file.

Action variables
List variable:The List that should be saved.
File name with path:The file including the file path in which the list items should be saved.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.
Encoding:Encoding type of the file.

Add Item to List

Adds an item to a "List variable". New items will be placed at the end of the list.

Action variables
List variable:The List to be used.
Item:The value to be stored as an item in the list.

Get Item from List

Get an item from a "List variable" by the item number.

Note
: The first item in the list has the number 1.

Action variables
List variable:The List to be used.
Item number:The number of the item to be retrieved.
Result variable:A Text variable for the item content.


This action enables a quick access to the content of an item in a list when the item number is known. The alternative is looping all items in the list with the Loop List action.

Get Name Value from List

Gets the value part based on the name part of a item from a List variable

When list items are stored as a name-value combination separated by an equal sign, like for example: "color=red", color is the name part and red is the value part.

Action variables
List variable:The list to be used.
Item name:The name part of the item to be retrieved.
Result variable:A text variable for the result value.
Decode text:Decode HTML form values to text.
Default Value:A default value in case the result is empty.


This action will return the value part when the name part is given and is typically used in combination with an Advanced HTML dialog action.

Remove Item from List

Removes an item from a "List variable".

Note: If there are more than one matches to the item, only the first occurring item in the list is removed!

Action variables
List variable:The List to be used.
Item:The item to be removed.

Remove Duplicates from List

Removes duplicated items from a List.

After executing this action, only unique items remain.

Action variables
List variable:The List to remove duplicates from.

Clear List

Removes all the items from a List.

After executing this action, the list will be empty.

Action variables
List variable:The List to clear.

Sort List

Sort the items in a List.

Lists can be sorted ascending or descending, depending on the value set in the "Direction" property.

Action variables
List variable:The List to sort.
Direction:Sets the sort direction: ascending or descending.

Text Files

Open Text File

Opens a "Text file" and places the content in the Text source.

Action variables
Text File source:The Text source to use.
File name with path:The file where the content should be read from.
Encoding:Encoding type of the file.

Save Text File

Saves a "Text File" source to a file.

A Text File source can be manipulated by Text Manipulation and Source Text Manipulation actions.

Action variables
Text File source:The Text source to use.
File name with path:The file in which the content should be saved.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.
Encoding:Encoding type of the file.

Append Line to Text File

Appends a line to a text file.

The property "Text" is written to the end of the file. This action works directly on the file, there is no need to use the Open Text File first.

Note: Use the Append to Text File action to append text without a new line.

Action variables
File name with path:The name of the file to write to.
Text line:Text line to be written to the end of the file.
Encoding:Encoding type of the file.
Success variable:Returns a variable indicating if the operation was successful with "Yes" or "No".


Tip: This action is typically used to create a log files.

Append to Text File

Appends the property "Text" to a text file.

The text is appended to the end of the file without a new line. This action works directly on the file, there is no need to use the Open Text File first.

Action variables
File name with path:The name of the file to write to.
Append text:Text to be written to the end of the file.
Encoding:Encoding type of the file.
Success variable:Returns a variable indicating if the operation was successful with "Yes" or "No".

XML

Create XML Document

Create a new "XML Document" in memory that can be saved later.

Provide a document source as reference to the XML document. If the "Root Name" property is set, the document root node will have that name, else "XML" will be used.

When a XML node variable is provided in the "Result Node" property it can be used as a reference node to do further processing, like adding a node to the root node.

Action variables
XML Document source:The XML Document source to use.
Root Name:The name for the XML root node ("XML" by default).
Result Node:A XML Node variable as reference to the root for further processing.

Open XML Document

Opens an XML Document from a file.

The XML file is opened into the "XML Document source".

Action variables
XML Document source:The XML Document source that will hold the XML loaded from file.
File name with path:The file where the XML file is located.

Save XML Document

Saves an XML Document source to a file.

Action variables
XML Document source:The XML Document source to be saved.
File name with path:The File name and path where the XML file will be saved.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.

Get XML Root Node

Returns the root of the "XML document" in a XML node variable.

Tip: Use the found root node in combination with the Add XML node action to add a new node under the root node for example.

Action variables
XML Document source:The XML Document source to be used.
Root Node:An XML Node variable in which a reference to the root node will be returned.

Find XML Node

Finds a single XML node in the XML tree from a specific start point based on Node name or Node path.

The "Look for" property can be a Node name or (partial) Node path. Path notation is with forward slashes like: 'books/book'.

Action variables
XML Document source:The XML Document source to be used.
Start at (Node):The starting point from which to start searching in the XML tree.
Look for (node path or name):The path or the name of the node to be looked for.
Result Node:The found Node is returned in this XML Node variable.
Success variable:Indicates "Yes" when a node was found.


Tip: If the complete XML tree is to be looped, use the root node as starting node.

When "Look for" is defined as 'book' the loop will pass all nodes named 'book' to the "Result Node" variable, regardless of where they are from the starting point in the tree.

When "Look for" is defined as 'books/book' all "book" nodes will be returned that reside directly under a parent node named 'books'.

Get XML Node Value

Returns the value of a XML node in a text variable.

Action variables
XML Node:The XML node from which the value will be obtained.
Value:Text variable where the node value will be returned.

Set XML Node Value

Sets the value of an XML node, optionally as CDATA.

Note: When setting a value in default format special characters as '>' will be translated automatically.

Action variables
XML Node:The XML node for which the value will be set.
Value:The variable containing the value to store in the node.
Data Format:Choose between default (string) or as CDATA.

Get XML Child Node Value

Returns the value of a child node from an XML parent node in a text variable.

Tip: Use this action in combination with the Find XML node to set the parent node for example.

Action variables
Parent Node:The parent node of the child.
Child Name:The name for the child node from which the value will be obtained.
Value:Text variable where the value will be returned.

Set XML Child Node Value

Sets the value of a child node from a parent XML node, optionally in CDATA.

Action variables
Parent Node:The parent node of the child.
Child Name:The name for the child node in which the value will be set.
Value:The variable containing the value to be returned.
Data Format:Choose between default (string) or as CDATA.

Get XML Node Attribute Value

Returns an attribute value of a XML node.

Action variables
XML Node:The node from which the attribute value will be obtained.
Attribute Name:The attribute name from which the value should be read.
Attribute Value:Text variable where the attribute value will be returned.

Set XML Node Attribute Value

Sets an attribute value of a XML node.

Action variables
XML Node:The node for which the attribute value will be set.
Attribute Name:The attribute name where the value should be set.
Attribute Value:The attribute value to be set.
Data Format:Choose between default (string) or as CDATA.

Add XML Node

Adds a new XML node to a parent XML node and returns the added node in a XML node variable.

Action variables
XML Document source:The XML Document source and viewer to be updated after the action.
Parent Node:The parent node where the new node will be added.
Node Name:The of the node to add.
Node Value:The node value to be set (optional).
Data Format:Choose between default (string) or as CDATA.
Result node:An XML node variable that holds the created new node.

Delete XML Node

Deletes an XML node.

Action variables
XML Document source:The XML Document source and viewer to be updated after the action.
XML Node:The XML node to be deleted.

Do SOAP request

Sends a SOAP request to a server and waits for the SOAP response in XML format.

Action variables
URL:URL to be used for the SOAP request.
SOAP Action:SOAP action to be performed.
SOAP Message:XML for the SOAP message.
SOAP Response:XML for the SOAP response.
User Name:User name when authentication is required.
Password:Password when authentication is required.
Time-out:Time-out for SOAP request in milliseconds.

Web Pages

Get Web Page

Get the content of a URL as DOM or the raw HTML source and puts it a Web Page variable.

The DOM source enables interaction like the Click Form Tag action. The HTML source is the raw html as served by a web server.

Tip: To inspect the DOM, HTML source and frames, use the Djuggler Inspector from the menu.

Action variables
Web Page:The Web Page source variable to be used.
URL:The URL to use including prefixes like "http://"
Source type:Select between the DOM (HTML interpreted by Internet Explorer) or HTML source as served by the web server.
Wait for:Page load or after load in case a page has script events when the load is complete.
Browse Silently:Option for fast page loading the DOM source without load pictures and suppressing pop-up's and page error messages.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
Time-out (sec):After the time out the script will resume, regardless of the HTML returned.
Execute scripts:When set to No the execution of JavaScript will be suppressed when DOM source is selected.
Proxy Address:Address used for a proxy.
Proxy Port:Port for a proxy address.
Extra headers:Supply extra http headers like: user-agent: DjugglerBot.
Timed-out?:A variable that will contain Yes if the page has timed out within the specified seconds.


HTML source is faster then the DOM source because it only requests the source from a web server without pictures, style sheets, etc. Note that the DOM source and HTML source have minor differences in the HTML like the usage of quotes and the tag attribute order.

Note: When the source type is set to HTML, properties like browse silently, execute scripts are ignored.

Post Web Page

Opens a Web Page by the Post method and returns the HTML in a Web Page source.

The Post Data property should contain variables separated by ampersands like: "age=28&gender=male".

Tip: When the post data contains special characters like spaces, the post data should be URL encoded with the Convert Text action.

Action variables
Web Page:The Web Page source to be used.
URL:The URL to use including prefixes like "http://".
Source type:Select between the DOM (HTML interpreted by Internet Explorer) or as HTML source served by the web server.
Wait for:Page load or after load in case a page has script events when the load is complete.
Post-Data:a string of form variables and their values like "name=John%20Doe&age=25".
Browse Silently:Option for fast page loading the DOM source without load pictures and suppressing pop-up's and page error messages.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
Time-out (sec):After the time out the script will resume, regardless of the HTML returned.
Execute scripts:When set to No the execution of JavaScript will be suppressed when DOM source is selected.
Proxy Address:Address used for a proxy.
Proxy Port:Port for a proxy address.
Extra headers:Supply extra http headers like: user-agent: DjugglerBot.
Timed-out?:A variable that will contain Yes if the page has timed out within the specified seconds.

Download File

Downloads a file, document, image or Web Page source and saves it to disk.

Note: When a non existing file is specified, the browser source returned by the server will be downloaded as document, typically 404 information. Use the Get URL status code action to verify if a file really exists.

Action variables
URL:The URL to the file, document or image.
Folder:The folder path where the file should be saved.
Filename:Specify a specific File name, when omitted the original File name from the download is used.
Success variable:On a successful download the variable will contain Yes, else it will be No.
User Agent:Specify a specific User Agent that is used to identify the browser to the web server.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.

Read Next Link

Reads the next hyperlink ('A' tag) in a Web Browser source and returns the "URL" and "Title" of the hyperlink.

Note: This action moves the source cursor position in the Web Page source like the Source Text Manipulation actions.

Action variables
Web Page:The Web Page source to be used.
URL:Text variable where the URL of the link is returned. Is no more link is found, an empty value is returned.
Title:Text variable where the title of the link is returned. Is no more link is found, an empty value is returned.


Tip: Use this action in a loop to collect all hyperlinks in a Web Page.

Read Next Link by Title

Searches for a text in a Web Page source and returns the nearest URL in a variable.

Tip: Use this action to find a typical 'Next page' link by searching for a text like 'Next >'.

Action variables
Web Page:The Web Page source to be used.
Text:Search text that should be part of the link.
URL:Text variable where the URL of the link is returned. Is no link is found, an empty value is returned.


Structure example:

Get Web page
Loop
  Read Next Link by Title
  If Condition aLink is Empty
    Exit Loop
  End Loop
 ... actions ...
End Loop

Read Next Image

Searches a "Web Page" source for the next image and returns it as "Image" variable.

The Save Image action can save the image variable. The name of the found image is returned in the "Image Name" variable.

Note
: This action moves the source cursor position in the Web Page source like the Source Text Manipulation actions.

Action variables
Web Page:The Web Page source to be used.
Image:Image variable where the image is returned. (Use the Save Image action to store it on disk.)
Image Name:Text variable where the name of the image is returned. If no more images are found, an empty value is returned.


Tip: Use this action in a loop to collect all images in a Web Page.

Save Image

Save an Image variable to disk. Typically used in combination with the Read Next Image action.

Note: When the filename property is not specified, the filename from the downloaded image is used.

Action variables
Image:Image variable to be saved.
Folder:A folder where the image should be saved.
Filename:The filename that should be used.
Success variable:Return variable that will contain contain Yes if the action was successful else it will be No.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.

Get Table Content

Puts data from a HTML table in a "Data Grid" source variable, based on table number or a specific text string.

For example when the property Table Number is set to 3,  data from the third <TABLE> tag found in the HTML will put in the Data Grid source.

Note: This action uses the DOM source and won't work on a Get Web Page by HTML source!

Action variables
Web page source:The source (Web Page or Text File) containing the HTML and table to be extracted.
Data Grid source:Data Grid variable where the table data will be stored.
Table Number:Use a table found by it's order number in the HTML.
Table Contains text:Use a table that contains a unique text string.
Start Row:Indicate at which row to start reading data. The first row has number "1".
End Row:Indicate at which row to stop reading data.
Start Column:Indicate at which column to start reading data. The first column has number "1".
End Column:Indicate at which column to stop reading data.
Strip HTML:When set to Yes, the HTML formatting will be stripped from the result, leaving the text only.

Get URL status code

Returns the status code of a URL. For example 404 if the page can not be found.

The "Is URL valid" property can be used to verify if a URL has a valid syntax.

Action variables
URL:The URL to verify.
Status code:Return variable for the status code returned by the server hosting the URL.
Is URL valid:Return variable that contains Yes if the syntax is correct, else No is returned.

Web Pages Advanced

Wait for Content

Refresh the browser source until content appears or disappears. This action is typically needed after an AJAX event.

Note: Either the appear text or disappear text can be set, but don't set both at the same time.

Action variables
Web Page:The Web Page source to be used.
Wait to appear:The text that should be in the source before the script continues.
Wait to disappear:The text that should be disappeared in the source before the script continues.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
Success:Return variable containing Yes if the content appeared/disappeared within the time-out and No when it did not.
Time-out (sec):Time out for the action in seconds, after which the script will continue.


An AJAX event requests a partial update of a webpage from the web server that will alter the source after the complete page has been requested.

The Wait for Content action assists in detecting when the AJAX event has completed by waiting until a know text has appeared or disappeared in the browser source.

Refresh Browser Source

Get the Web Page's source after a delay without reloading the Web Page.

Tip: As an alternative the Wait for Content action can be used to refresh the browser source after an AJAX event.

Use this action to obtain any changed HTML source due to dynamic reloading of the Web Page after an AJAX event for example.

Action variables
Web Page:The Web Page source to be used.
Delay (ms):The number of milliseconds to wait before refreshing the source.
Result current URL:The current URL after the refresh, for example after a redirect.

Clear IE Cache

Clears the Internet Explorer Cache.

Note: This action will also clear the cache for the regular IE browser.

Action variables
Web Page:The Web Page source to be used.

Clear IE Cookies

Clears all Internet Explorer Cookies.

Note: This action will also clear the cookies for the regular IE browser.

Action variables
No variables need to be set for this action.

Reset Web Page

Resets a webpage source by creating a new web page source instance.

Tip: Use this action to clear a server side session with a Web Page source.

Action variables
Web Page:The Web Page source to be used.

Get Frame Source

Put the source of a HTML frame in a text source variable.

Tip: Use this action to retrieve the raw HTML of a specific frame in the HTML source to process with Text Manipulation actions.

Action variables
Web Page:The Web Page source to be used.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
Text source:Return variable with the raw HTML from the specified frame number.

Get IE Version

Returns the Internet Explorer version in a text variable.

Tip: IE6 and IE7+ have a different DOM source. Scripts that work in IE7+ will not necessarily work in IE6. Verify the IE version with this action when creating scripts for others.

Action variables
Internet Explorer Version:Returns the IE version used on the computer running the script.
Major version:Returns the IE Major version used on the computer running the script.

Execute JavaScript

Executes JavaScript in a Web Page source.

Tip: The Execute JavaScript is used in combination with the Refresh Browser Source or Wait for Content action to handle AJAX enabled web sites.

Action variables
Web Page:The Web Page source to use.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
JavaScript code:The code or existing function in the HTML source to be executed.
Error msg:Return variable containing the error message when the execution was not successful.
Success:Return variable containing Yes if the code execution was successful and No when it failed.

Strip HTML Tags

Removes all HTML tags from a text or variable with only the actual readable text as result.

Tip: To remove all tags from a HTML source, convert the Web Page source to a text variable by using the Convert Variable action.

Action variables
Text:The text or variable that should be stripped from HTML tags.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.

Complete Page Links

Completes hyperlinks to a full path in a web page source.

Example: A link like "./support/index.htm"; would be translated into something like "http://www.mysite.com/support/index.htm".

Action variables
Web Page:The Web Page source where links should be completed.


Tip: When calling the Get Web Page action after a Complete Page Links action, the Complete Page Links action needs to be called again.

Complete Relative URL

Completes a variable with a relative URL to a full path.

Example: "./support.asp" is completed to "http://www.djuggler.com/support.asp".

Note: Completion of a URL depends on the Web Page source where it was obtained from.

Action variables
Web Page:The Web Page source used to complete the relative URL.
URL variable:The variable with a relative URL to be completed.

Web Page DOM

Find Tag

Finds the first matching tag in the DOM tree and returns the DOM node.

This action remembers the DOM node position and can be used to find the next Node relative to the previous found Node.

Note: Attribute names and values are case sensitive. Values support a wildcard.

Action variables
Web Page:The Web Page source used for this action.
Tag name:The node tag name, like A or DIV.
Result DOM node:The DOM node variable that will hold the found result.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
Search direction:The search direction in the DOM tree.
Attribute name:Optional name for an attribute that should be part of the match.
Attribute value:Optional value for the attribute name that should be part of the match.
2nd Attribute name:Optional name for an second attribute that should be part of the match.
2nd Attribute value:Optional value for the second attribute name that should be part of the match.
3rd Attribute name:Optional name for an third attribute that should be part of the match.
3rd Attribute value:Optional value for the third attribute name that should be part of the match.
Containing text:Optional value for a text that should be present in the innerHTML of the node.
Success:Return variable containing Yes if tag was found and No when it failed.


The DOM result node can be used in other DOM actions for getting or setting values in the DOM.

Tip: For the best solid match use the attribute name and value properties when available to identify the node that is being searched for.

Find Tag Child

Finds a child tag of a parent DOM node and returns the found DOM node.

The action remembers the DOM node position and can be used to find the next Node relative to the previous found Node.

Note: Attribute names and values are case sensitive. Values support a wildcard.

Action variables
Web Page:The Web Page source used for this action.
Parent DOM node:The parent node that should contain the child tag.
Tag name:The node tag name, like A or DIV.
Result: DOM node:The DOM node variable that will hold the found result.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
Search direction:The search direction in the DOM tree.
Attribute name:Optional name for an attribute that should be part of the match.
Attribute value:Optional value for the attribute name that should be part of the match.
2nd Attribute name:Optional name for an second attribute that should be part of the match.
2nd Attribute value:Optional value for the second attribute name that should be part of the match.
3rd Attribute name:Optional name for an third attribute that should be part of the match.
3rd Attribute value:Optional value for the third attribute name that should be part of the match.
Containing text:Optional value for a text that should be present in the innerHTML of the node.
Success:Return variable containing Yes if tag was found and No when it failed.


The DOM result node can be used in other DOM actions for getting or setting values in the DOM.

Tip: For the best solid match use the attribute name and value properties when available to identify the node that is being searched for.

Loop Tags

Loops specified tags in the DOM and returns a current result DOM node.

The DOM result node can be used in other DOM actions for getting or setting values in the DOM.

Note: Attribute names and values are case sensitive. Values support a wildcard.

Action variables
Web Page:The Web Page source used for this action.
Tag name:The node tag name, like A or DIV.
Attribute name:Optional name for an attribute that should be part of the match.
Attribute value:Optional value for the attribute name that should be part of the match.
Current result DOM node:The DOM node variable that will hold the found result.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
2nd Attribute name:Optional name for an second attribute that should be part of the match.
2nd Attribute value:Optional value for the second attribute name that should be part of the match.
3rd Attribute name:Optional name for an third attribute that should be part of the match.
3rd Attribute value:Optional value for the third attribute name that should be part of the match.
Containing text:Optional value for a text that should be present in the innerHTML of the node.
Success:Return variable containing Yes if one or more tags were found and No when it failed.

Loop Tag Children

Loops specified tags within the innerHTML of a parent node in the DOM and returns a current result DOM node.

The DOM result node can be used in other DOM actions for getting or setting values in the DOM.

Note: Attribute names and values are case sensitive. Values support a wildcard.

Action variables
Web Page:The Web Page source used for this action.
Parent DOM node:The parent node that should contain the child tags.
Tag name:The node tag name, like A or DIV.
Attribute name:Optional name for an attribute that should be part of the match.
Attribute value:Optional value for the attribute name that should be part of the match.
Current result DOM node:The DOM node variable that will hold the found result.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
2nd Attribute name:Optional name for an second attribute that should be part of the match.
2nd Attribute value:Optional value for the second attribute name that should be part of the match.
3rd Attribute name:Optional name for an third attribute that should be part of the match.
3rd Attribute value:Optional value for the third attribute name that should be part of the match.
Containing text:Optional value for a text that should be present in the innerHTML of the node.

Get Tag InnerHTML

Get the InnerHTML of a DOM node.

The Find Tag or Loop Tags actions can be used to identify the DOM node from which the values should be retrieved.

Action variables
DOM Node:The DOM Node variable used in this action.
InnerHTML:Return variable with the InnerHTML of the DOM node.
Error message:Return variable with an error messages if the action did not complete successfully.

Get Tag OuterHTML

Get the OuterHTML of a DOM node.

The Find Tag or Loop Tags actions can be used to identify the DOM node from which the values should be retrieved.

Action variables
DOM Node:The DOM Node variable used in this action.
OuterHTML:Return variable with the OuterHTML of the DOM node.
Error message:Return variable with an error messages if the action did not complete successfully.

Get Tag Attribute Value

Get the attribute value of a tag in a DOM node.

The Find Tag or Loop Tags actions can be used to identify the DOM node from which the values should be retrieved.

Note: Attribute names and values are case sensitive. Values support a wildcard.

Action variables
DOM Node:The DOM Node variable used in this action.
Attribute name:The name of the attribute from which the value should be retrieved.
Attribute value:A variable that will return the attribute value.
Error message:Return variable with an error messages if the action did not complete successfully.

Get Tag Text

Get the Text value of a tag in a DOM node.

The Find Tag or Loop Tags actions can be used to identify the DOM node from which the values should be retrieved.

Note: Attribute names and values are case sensitive. Values support a wildcard.

Action variables
DOM Node:The DOM Node variable used in this action.
Text:A variable that will return the text from the DOM Node.
Error message:Return variable with an error messages if the action did not complete successfully.

Set Tag InnerHTML

Set the InnerHTML of a DOM node.

The Find Tag or Loop Tags actions can be used to identify the DOM node from which the values should be retrieved.

Note: Attribute names and values are case sensitive. Values support a wildcard.

Action variables
DOM Node:The DOM Node variable used in this action.
InnerHTML:The InnerHTML that should be set in the DOM Node.
Error message:Return variable with an error messages if the action did not complete successfully.

Set Tag Attribute Value

Set the attribute value of a tag in a DOM node.

The Find Tag or Loop Tags actions can be used to identify the DOM node from which the values should be retrieved.

Note: Attribute names and values are case sensitive. Values support a wildcard.

Action variables
DOM Node:The DOM Node variable used in this action.
Attribute name:The name of the attribute from which the value should be set.
Attribute value:The content for the attribute value.
Error message:Return variable with an error messages if the action did not complete successfully.

Click Tag

Perform a mouse click on a tag in the DOM.

The Find Tag or Loop Tags actions can be used to identify the DOM node from which the values should be retrieved.

Note: Attribute names and values are case sensitive. Values support a wildcard.

Action variables
DOM Node:The DOM Node variable on which a click should be performed.
Success:Return variable containing Yes if the click was successful and No when it failed.

Get Tag Properties

Returns the name and/or id from a tag in the DOM.

This action is typically used when looping DOM nodes with Loop Tags action to identify the found tags.

Action variables
DOM Node:The DOM Node variable on which a click should be performed.
Tag Name:Return variable with the Name value of the DOM node, when specified in the DOM.
Tag Id:Return variable with the ID value of the DOM node, when specified in the DOM.
Success:Return variable containing Yes if the action was successful and No when it failed.

Reset DOM Node Pointer

Set the DOM node position at the first node in the source.

Action variables
Web page:The web page source in which the DOM node position should be reset.

Web Page Forms

Get Form Tag Value

Returns the innerHTML of a specified tag within a HTML form.

Note: If more than one tag matches the specifications, the value of the first matching tag is returned.

Action variables
Web Page:The Web Page source used to retrieve the tag.
Element Tag Name:The tag name to retrieve.
Form Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Form Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Result Variable:The variable used to return the Tag content (innerHTML) in.
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not complete successfully.


Example:

The HTML contains a tag "<form name="form1"><textarea rows="2" cols="20">a text line</textarea></form>".

To retrieve this tag's content, you should specify the Tag Name as "textarea", Form Attribute Name as "name" and Form Attribute Value as "form1", Attribute Name as "rows" and Attribute Value as "2".

In the Result Variable, "a text line" will be returned.

Get Form Tag Attribute Value

Returns an attribute value of a specified tag within a HTML form.

Note: If more than one tag matches the specifications, the value of the first matching tag is returned.

Action variables
Web Page:The Web Page source used to retrieve the tag.
Form Attribute Name:The Attribute Name used to match a tag.
Form Attribute Value:The Attribute Value used to match a tag.
Element Tag Name:The tag name to retrieve.
Attribute Name:The Attribute Name used to match a tag.
Attribute Value:The Attribute Value used to match a tag.
Result Attribute Name:The Attribute Value used to match a tag.
Result Variable:The variable used to return the Tag content (innerHTML) in.
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not complete successfully.


Example:

The HTML contains <form id="form1"><input type=text id="firstname" value="John"></form>.

To retrieve the input value John, properties should be used like:

Form Attribute Name
with "id" and Form Attribute Value with "form1", Tag Name with "input", Attribute Name with "id", Attribute Value with "firstname" and Result Attribute Name with "value".

In the Result Variable, "John" will be returned.

Set Form Tag Value

Sets the innerHTML of a specified tag within a HTML form.

Action variables
Web Page:The Web Page source used to set the tag.
Element Tag Name:The tag name to set.
Form Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Form Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Content:The value or variable for the innerHTML of the specified tag.
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not complete successfully.


Example:

The HTML contains a tag "<form name="form1"><textarea rows="2" cols="20">a text line</textarea></form>".

To retrieve this tag's content, you should specify the Tag Name as "textarea", Form Attribute Name as "name" and Form Attribute Value as "form1", Attribute Name as "rows" and Attribute Value as "2" and the Result Variable with "new line".

The HTML in the web document will be changed to "<form name="form1"><textarea rows="2" cols="20">new line</textarea></form>".

Set Form Tag Attribute Value

Sets an attribute value of a specified tag within a HTML form.

Action variables
Web Page:The Web Page source used to retrieve the tag.
Element Tag Name:The tag name to retrieve.
Form Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Form Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Attribute Name to set:The attribute name to set.
Content:The value or variable content to be set as value of of the specified attribute.
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not complete successfully.


Example:

The HTML contains a tag "<form name="form1"><input type=text id="firstname" value="John"></form>".

To retrieve this tag's content, you should fill in the Tag Name with "input", Form Attribute Name with "name" and Form Attribute Value with "form1", Attribute Name with "rows", Attribute Value with "2", Attribute Name to set with "firstname" and the Result Variable with "Simon".

The HTML in the web document will be changed to read: "<form name="form1"><input type=text id="firstname" value="Simon"></form>".

Click Form Tag

Performs a mouse click on a specified tag.

Tip: Use the Djuggler Inspector from the menu to inspect the tag information needed for this action.

Action variables
Web Page:The Web Page source to use.
Form Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Form Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Element Tag Name:The type of the tag to be clicked, for example the INPUT tag.
Element Name:The name attribute of the tag.
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not complete successfully.

Get Select Options

Return all options from a SELECT tag in a list variable.

Action variables
Web Page:The Web Page source to use.
SELECT Name:The value of the name attribute of the SELECT tag.
Option List:List variable to store option values in.
Description List:list variable to store option descriptions in.


Example:
<select name="cardropdown">
  <option value="1">Volvo</option>
  <option value="2">Saab</option>
  <option value="3">Mercedes</option>
  <option value="4">Audi</option>
</select>

To get all options, fill in SELECT Name with "cardropdown". Two list will be returned: Option List containing "1,2,3,4" and Description List containing "Volvo,Saab,Mercedes,Audi".

Set Select Option

Select an option from a SELECT tag.

Use either the option value or the option description to indicate which option you wish to select.

Action variables
Web Page:The Web Page source to use.
Frame Number:If a web page has frames, indicate the frame number to use. Frame 0 is the main document.
SELECT Name:The value of the name attribute of the SELECT tag.
Option Value:the option value to select (optional).
Option Description:the option description to set (optional).


Example:
<select name="cardropdown">
  <option value="1">Volvo</option>
  <option value="2">Saab</option>
  <option value="3">Mercedes</option>
  <option value="4">Audi</option>
</select>

To select an option, fill in SELECT Name with "cardropdown" and set Option Value to "2".

The SELECT dropdown will be set to "Saab". Alternatively, you can set Option Description to "Saab" with the same effect.

Data Grid

Get Data Cell Value

Copy the value of a Data Grid cell into a variable.

Note: Rows and Column numbers start at "1".

Action variables
Data Grid source:The Data Grid source to use.
Value:Text variable where the cell content should be returned.
Row:Indicates the cell row number.
Column:Indicates the cell column number.


Use the Row and Column variables to specify the cell.

For example, using Row:2 and Column:3 would get the content from the cell located at the second horizontal row and the third vertical column.

Set Data Cell Value

Copy the value of a variable into a Data Grid cell.

Note: Rows and Column numbers start at "1".

Action variables
Data Grid source:The Data Grid source to use.
Value:Variable the content should be copied from.
Row:Indicates the cell row number.
Column:Indicates the cell column number.


Use the Row and Column variables to specify the cell.

For example, using Row:2 and Column:3 would get the content from the cell located at the second horizontal row and the third vertical column.

Store Variable(s) in Grid

Stores one or more variables in a Data Grid source. The variable name is used as field name.

If a field name already exists, the corresponding column is used to store the variables data. If the field name is new, a new data column is used.

Action variables
Data Grid source:The Data Grid source to use.
Where to store:Select between a new row or append to the current row.
Variable:The variable you would like to store in the data grid.
Variable 2-6:Additional variables to store in the data grid.


If more then 6 variables need to be stored in on a single row in the Grid, use a second action and set the Where to Store property to Use current row.

Store Value(s) in Grid

Stores one or more literal values into a Data Grid.

Note: When more then 10 values need to be set, use a second action and set the property Where to store to: Use current Row and Start at column nr 11.

Action variables
Data Grid source:The Data Grid source to use.
Where to store:Select between a new row or append to the current row.
Start at column nr.:The column number to be used for the first value.
Value 1-10:The values to be stored in the Data Grid.


Tip: This action is typically used to create a row header in a Data Grid.

Retrieve Value(s) from Grid

Retrieve one or more values from a Data Grid source.

Note: Rows and Column numbers start at "1".

Action variables
Data Grid source:The Data Grid source to use.
Retrieve from row nr.:The first row number that is used for retrieving values.
Start at column nr.:The column number to be used for the first value.
Value 1-10:The values to be assigned to variables.

Clear Data Grid

Clears the Data Grid.

Note: Data Grids are only limited in data capacity by the available memory in the computer.

Action variables
Data Grid source:The Data Grid source to be cleared.


Tip:When using the Show Grid Viewer action on a large data grid, performance of the script will be greatly reduced due to the limitation of screen/graphics memory.

Delete Data Grid Row(s)

Deletes row(s) from a Data Grid. The Row variable determines which row(s) to delete.

Example: "1,2" deletes rows 1 and 2 and "2-4" deletes rows 2,3 and 4.

Note: Always keep numbers in succession, from low to high.

Action variables
Data Grid source:The Data Grid used for the action.
Row:The row(s) to delete.

The Row property indicates the row number that must be deleted. "2" means the second row in the Data Grid will be deleted.

Multiple rows can be deleted like: "1-4" will delete row 1 through 4 in the Data Grid. "1,2,3,4" does the same.

Example: "1,2,4-6" deletes rows 1, 2, 4, 5 and 6.
Example: "1-2,7-8" deletes rows 1, 2, 7 and 8.

Delete Data Grid Column(s)

Deletes column(s) from a Data Grid. The Column variable determines which column(s) to delete.

Example: "1,2" deletes columns 1 and 2 and "2-4" would delete columns 2, 3 and 4.

Note: Always keep numbers in succession, from low to high.

Action variables
Data Grid source:The Data Grid used for the action.
Column:The column(s) to delete.


The Column property indicates the column number that must be deleted. "2" means the second column in the Data Grid will be deleted.

Multiple columns can be deleted like: "1-4" will delete column 1 through 4 in the Data Grid. "1,2,3,4" does the same.

Example: "1,2,4-6" deletes columns 1, 2, 4, 5 and 6.
Example: "1-2,7-8" deletes columns 1, 2, 7 and 8.

Example: "1,2,4-6" deletes columns 1, 2, 4, 5 and 6.6.
Example: "1-2,7-8" deletes columns 1, 2, 7 and 8.

Append Another Data Grid

Appends one Data Grid to the other.

The "Data Grid to append" property indicates the grid that gets appended to the "Data Grid" variable.

Note: The data is appended at the end of the Data Grid.

Action variables
Data Grid source:The Data Grid source to use.
Data Grid to append:The Data Grid that will be appended.

Sort Data Grid

Sorts the data grid using the column number indicated.

Note: When a data grid has a header row it will not be excluded in the sort.

Action variables
Data Grid source:The Data Grid source to use.
Sort using column number:The column number used to sort the rows in the grid.

Find in Data Grid

Search a string in a Data Grid column and return the row number.

If a match could not be found, "0" (zero) is returned. If there are more than one rows containing a match, the first matching row is returned.

Action variables
Data Grid source:The Data Grid source to use.
Text to find:The text to search in the grid.
Seek in column number:The column number to seek the text in.
Result Row:The row number where the text was found is returned here.
Match kind:"Match whole" matches whole strings only, fails otherwise. "Match Part" succeeds when Text To Find partly or completely matches the text in the column.


Note: The data grid is sorted at the indicated column before the search is done.

Compare Grids

Compares one Data Grid to another and returns the desired set of results in a Resulting Data Grid property.

Text in the grid is compared at the indicated column number.

Action variables   "Difference between grids": returns all rows which are present in one grid, but not in the other  "Similarity between grid": returns all rows that are present in both grids   "Occurrences in grid 1 missing in grid 2": returns rows occurring in grid 1 that are not found in grid 2   "Occurrences in grid 2 missing in grid 1": returns rows occurring in grid 2 that are not found in grid 1.
Data Grid 1:The first Data Grid source to use.
Data Grid 2:The second Data Grid source to use.
Compare rows at column number:The column used to compare the grids.
Result Contains:
Resulting Data Grid:Return Data Grid with the result set.

The Result Contains property determines the resulting set after comparing the grids.

Note: The grids are sorted before the data grids are compared.

Remove Duplicates from Data Grid

Removes duplicates from the data grid using the column number indicated.

Note: The grid is sorted before duplicates are removed.

Action variables
Data Grid source:The Data Grid source to use.
Compare on column number:The column number used to seek duplicates.

SQL Database

SQL Connect

Opens a connection to a SQL database, like MS SQL, MySQL, Orcale or SQLite.

Use the SQL Query action for direct SQL update and insert statements, or use the Loop Records action to loop through a record set after a SQL Query with a select statement.

Action variables
Database source:The SQL Database source to use.
SQL Type:The SQL provider to use.
Host Name:The Database host name.
User Name:The user name used to connect to the database.
Password:The password used to connect to the database.
Database Name:The name of the database your data is stored in.
Port:The port used for the connection.
Optional Params:Extra parameters for the connection, for example: servercharset=utf8 and useunicode=true for Unicode MySQL.
Success variable:Returns a variable indicating if the operation was successful with "Yes" or "No".


When using a record set, use the following basic structure:

SQL Connect
SQL Query .. select ...
... do actions like Move to Next Record ...
SQL Disconnect


When connecting to a database with direct SQL actions, use the following basic structure:

... do actions...
SQL Connect
SQL Query ... insert, update ...
SQL Disconnect

SQL Disconnect

Close a connection to a SQL database.

Note: When closing a connection the database viewer is also disconnected.

Action variables
Database source:The SQL Database source connection that should be closed.
Success variable:Returns a variable indicating if the operation was successful with "Yes" or "No".

SQL Query

Execute a SQL query on a database source.

Note: For the loop records action a SQL Query action is needed to select the record set.

Action variables
Database source:The SQL Database source to query.
Query:The SQL query (for example "UPDATE Persons SET Address='[txtAddress]', City='[txtCity]' WHERE LastName='Tjessem' AND FirstName='Jakob'").
Rows affected:Returns a number variable with the number of rows affected by the query.


When connecting to a database to run a "SQL Query " action, use the following basic structure:

... do actions...
SQL Connect
SQL Query
SQL Disconnect

Append Record

Append a record to the end of the current record set.

The appended record becomes the active, current record, and can directly be used with a Set Field action.

Note: Changes will be applied to the database after a Commit Transaction action, or when a Loop Records has finished.

Action variables
Database source:The SQL Database source connection to use.

Delete Record

Remove the active, current record from the record set.

Action variables
Database source:The SQL Database source connection to use.

Get Field Value

Get the value of a field from the active, current record in the record set and copy it to a variable.

Use the "Field Name or Column number" property to indicate which field in the record is to be used.

Action variables
Database source:The SQL Database source connection to use.
Field Name or Column Number:The exact field name as in the database or the column number (first column in the record is zero).
Content:The variable to be used for coping the field value from the record.

Set Field Value

Set the value of a field in the active, current record in the record set.

Use the "Field Name or Column number" property to indicate which field in the record is to be used.

Action variables
Database source:The SQL Database source connection to use.
Field Name or Column Number:The exact field name as in the database or the column number (first column in the record is zero).
Content:The field value to be set.

Move to First Record

Move the current record pointer to the first record in the active record set.

Action variables
Database source:The SQL Database source connection to use.

Move to Last Record

Move the current record pointer to the last record in the active record set.

Action variables
Database source:The SQL Database source connection to use.

Move to Next Record

Move the current record pointer to the next record in the active record set.

If the last record is reached, the "Last Record Reached" variable will be set to "Yes".

Tip: Use the "Last Record Reached" variable to exit a simple Loop action when not using the Loop Records action.

Action variables
Database source:The SQL Database source connection to use.
Last Record Reached:Variable that will be set to "Yes" when the last record in the set is reached.

Move to Previous Record

Move the current record pointer to the previous record in the active record set.

If the first record is reached, the "First Record Reached" variable will be set to "Yes".

Tip: Use the "First Record Reached" variable to exit a simple Loop action when not using the Loop Records action.

Action variables
Database source:The SQL Database source connection to use.
First Record Reached:Variable that will be set to "Yes" when the first record in the set is reached.

Start Transaction

Set a start transaction marker in the database.

Action variables
Database source:The SQL Database source connection to use.

RollBack Transaction

RollBack the last transaction.

Action variables
Database source:The SQL Database source connection to use.

Commit Transaction

Commit a transaction to the database.

Action variables
Database source:The SQL Database source connection to use.

Copy Records to Data Grid

Copy the complete content of an active record set into a Data Grid source.

Action variables
Database source:The SQL Database source connection to use.
Data Grid source:The Data Grid source used to put the data in.

Source Text Manipulation

Find Text in Source

Finds a text string in the content of source and sets the source cursor to a new position.

Tip: This actions supports one or more asterix ('*') wildcard for a search text like '<TR*>*Name:'. Line breaks in a source must also be matched with '#13#' or by a wildcard '*'.

Action variables
Source text:The source to use.
Text To Find:Text to find in the source content.
Search Direction:Set to a forward or backward search direction.
Cursor Placement:When a text is found, set the cursor position before or after the found text.
Case Sensitive:Indicates if the action should be performed case sensitive or not.
Success variable:Indicates whether the action was successful, returns either 'Yes' or 'No'.


The Find Text in Source action, like Copy Text from Source and Insert Text in Source are Source Text Manipulation actions with a cursor position, while normal Text Manipulation actions like Copy Text do also work with sources but without a cursor position.

Tip: Use #13# for new line or #9# for a tab or any other ASCII character between pound signs when manipulating text.

Copy Text from Source

Read from the current cursor position until the text in "Read Until" property is found. The read text is returned in the assigned "Found Text" variable. If no text was not found the Found Text will be empty.

Tip: This actions supports one or more asterix ('*') wildcard for a copy like read until '<TR*><TABLE*>'.

Action variables
Source text:The source to use.
Read until:Text to find in the source content.
Result variable:Variable to hold the copied text.
Cursor Placement:When a text is found, set the cursor position before or after the found text.
Case Sensitive:Indicates if the action should be performed case sensitive or not.
Text Processing:Options for processing the text result.


Note: Source Text Manipulation actions always keep an internal cursor position in the source for reference, while Text Manipulation actions don't have a cursor position.

Tip:
Use #13# for new line or #9# for a tab or any other ASCII character between pound signs when manipulating text.

Copy Text from Source Between

Gets text between the "From Text" and a "To Text" property from the current cursor position in a source and returns the copied text in a variable.

Tip: This actions supports one or more asterix ('*') wildcard for a copy like from '<TR*>*Name:' to '</TR>'. Line breaks in a source must also be marched with '#13#' or by a wildcard '*'.

Action variables
Source text:The source to use.
From Text:Start text match for the copy.
To Text:Start text match for the copy (To Text is not included in the copied text).
Result variable:Variable to hold the copied text.
Cursor Placement:When a text is found, set the cursor position before or after the found text.
Case Sensitive:Indicates if the action should be performed case sensitive or not.
Text Processing:Options for processing the text result.


Note: Source Text Manipulation actions always keep an internal cursor position in the source for reference, while Text Manipulation actions don't have a cursor position.

Tip: Use #13# for new line or #9# for a tab or any other ASCII character between pound signs when manipulating text.

Insert Text in Source

Inserts a text at the current cursor position in the source.

Action variables
Source text:The source to use.
Text to Insert:Text to be inserted at the current cursor position.
Cursor Placement:Set the cursor position before or after the inserted text.
Success variable:Indicates whether the action was successful, returns either 'Yes' or 'No'.


Note: Source Text Manipulation actions always keep an internal cursor position in the source for reference, while Text Manipulation actions don't have a cursor position.

Tip: Use #13# for new line or #9# for a tab or any other ASCII character between pound signs when manipulating text.

Replace Text in Source

Replace one of all occurrences of a text from the current cursor position in the source with a new text.

Action variables
Source text:The source to use.
Look for:Text to be found and replaced or use the content of a variable.
Replace with:Replacement text or use the content of a variable.
First occurrence only:Select Yes to replace only the first occurrence, select No to replace all occurrences.
Cursor Placement:When a text is found, set the cursor position before or after the found text.
Case Sensitive:Indicates if the action should be performed case sensitive or not.
Success variable:Indicates whether the action was successful, returns either 'Yes' or 'No'.


Tip: Use #13# for new line or #9# for a tab or any other ASCII character between pound signs when manipulating text.

Match Text in Source

Matches a regular expression in a source from the current cursor position.

Tip: More info on regular expressions can be found at: http://www.regular-expressions.info.

Action variables
Source text:The source to use.
Regular Expression:The regular expression to be used.
Matched Text:A variable that holds the matched text.
Match Success variable:Indicates whether the match was successful, returns either 'Yes' or 'No'.
Return Sub Expression Nr:When using sub expressions indicate the number of the sub expression. Number 1 is the first sub expressions, zero is the complete expression.


Note: Source Text Manipulation actions always keep an internal cursor position in the source for reference, while Text Manipulation actions don't have a cursor position.

Reset Text Position Cursor

Set the text position cursor at the start position in the source.

Action variables
Source text:The source in which the cursor position should be reset.

Text Manipulation

Replace Text

Replace a single or all occurrences of a text with another text in a source or variable.

Note: This action is case sensitive.

Action variables
Source Text:A source or variable to use for this action.
Look for:Text to be replaced.
Replace with:Text to replace the old text with.
First occurrence only:Select Yes to replace only the first occurrence, select No to replace all occurrences.
Case Sensitive:Indicates if the action should be performed case sensitive or not.


Tip: Use #13# for new line or #9# for a tab or any other ASCII character between pound signs when manipulating text.

Find Text from Position

Find a text string in the content of source or variable and returns the position of the found text as a number variable.

Tip: This actions supports one or more asterix ('*') wildcard for a search text like '<TR*>*Name:'.

Action variables
Source text:A source or variable to use for this action.
Text To Find:Text to find in the source text. (supports the wildcard '*')
Start Position:A number or variable indicating from which position to start searching within the content.
Result Position:A number or variable indicating the position where Text To Find has been found in the content.
Search Direction:Select to search for Text To Find in forward or backward direction.
Case Sensitive:Indicates if the action should be performed case sensitive or not.


Tip: Use #13# for new line or #9# for a tab or any other ASCII character between pound signs when manipulating text.

Copy Text from Position

Copy text from a source or variable, starting at "Start Position" and copying until the "End Position" is reached.

The copied text is returned in the "Copied Text".

Tip: This actions supports one or more asterix ('*') wildcard for a search text like '<TR*>*Name:'.

Action variables
Source text:A source or variable to use for this action.
Start Position:A number or variable indicating the position to start copying.
End Position:A number or variable indicating the position where to stop copying.
Result variable:The result variable where the copied text is returned.
Text Processing:Options for processing the text result.

Copy Text Between

Copy text from a source or variable between two strings. Text is copied from the "From Text" property value until "To Text" property value.

The copied text is returned in the "Copied Text" property as variable.

Tip: This actions supports one or more asterix ('*') wildcard for a search text like '<TR*>*Name:'.

Action variables
Source text:A source or variable to use for this action.
From Text:A string or variable indicating the position to start copying.
To Text:A string or variable indicating the position where to stop copying.
Result variable:The result variable where the copied text is returned.
Case Sensitive:Indicates if the action should be performed case sensitive or not.
Text Processing:Options for processing the text result.


Tip: Use #13# for new line or #9# for a tab or any other ASCII character between pound signs when manipulating text.

Insert Text at Position

Insert a string in a source or variable at specific position.

A 'position' is the index position of a character or string. Example: The 'q' in the string 'The quick brown fox' has a position 5. The first character is always 1.

Action variables
Source text:A source or variable to use for this action.
Position:A number or variable indicating the position to insert text.
Text to Insert:The text to insert at the given position.


Tip: Use #13# for new line or #9# for a tab or any other ASCII character between pound signs when manipulating text.

Split Right

Splits a text variable and returns the right part of the split text.

Example: On the text 'abcdef' with 'cd' as "Split Characters"; 'ef' will be returned as "Split Text".

Note: When the "Split Characters" are not found the complete content of "Text" will be returned in "Split Text".

Action variables
Source text:A text variable to use for this action.
Result variable:The variable in which the right part of the text that was split is returned.
Split Character(s):The characters to split the text at.

Split Left

Splits a text variable and returns the left part of the split text.

Example: On the text 'abcdef' with 'cd' as "Split Characters"; 'ab' will be returned as "Split Text".

Note: When the "Split Characters" are not found the complete content of "Text" will be returned in "Split Text".

Action variables
Source text:A text variable to use for this action.
Result variable:The variable in which the left part of the text that was split is returned.
Split Character(s):The characters to split the text at.

Trim

Trims leading and trailing spaces of the content in a text variable.

Action variables
Text variable:The text variable that should be trimmed from leading and trailing spaces.

Upper Case

Converts all characters in the content of a text variable to upper case.

Action variables
Text variable:A text variable in which all characters should to be converted to uppercase.

Lower Case

Converts all characters in the content of a text variable to lower case.

Action variables
Text variable:A text variable in which all characters should be converted to lowercase.

Upper Case First Letter

Converts the first character in the content of a text variable to upper case.

Action variables
Text variable:A text variable to use for this action.

Strip HTML Tags

Strips all HTML tags from the content of a text variable.

Action variables
Text variable:A text variable that should have all HTML tags removed.


Example: '<B>Hello <I>World</I></B>' would become 'Hello World'.

Text Formatting

Format Number

Formats a number variable.

The formatting syntax is %[Index:][-][Width][.Precision]Type
Example padding: %.6d will format 1234 to 001234 by padding zero's to the length of 6.
Example money: %m will format 1234.9 to $ 1,234.90.
Example rounding: %d will format 1234.95 to 1235.
Example precision: %.2f will format 1234.95345 to 1234.95

Action variables
Number variable:The number variable to be formatted.
Format Specifications:The formatting syntax to be used.
Resulting text:The text variable with the formatting result.


The Formatting string can comprise a mix of ordinary characters (that are passed unchanged to the result string), and data formatting characters. This formatting is best explained by the example code.

In simple terms, each data formatting substring starts with a % and ends with a data type indicator :

d = Decimal
n = Number
e = Scientific
f = Fixed
m = Money

The general format of each formatting substring is as follows:

%[Index:][-][Width][.Precision]Type

where the square brackets refer to optional parameters, and the : . - characters are literals, the first 2 of which are used to identify two of the optional arguments.

Convert Text

Convert text of one format to another format.

Supported conversions are UTF-8 to ASCII and vise versa.
And special HTML characters to ASCII. For example '&nbsp' to a space.

Action variables
Source text:A source or variable to use for this action.
Conversion:Select the format the text is to be converted to.


The Convert Text action offers the following Conversion options for character encoding.

UTF-8 to ASCII
Converts UTF-8 encoded (extended) character sets to plain ASCII.

Special HTML characters to ASCII
Equal to HTML encoded to text. See remarks there.

Text to MIME
Converts ASCII text to MIME encoded text.

MIME to Text
Converts MIME encoded text to ASCII text.

Text to URL Encoded
Converts UTF-8 text to %-encoded text. Variable byte length encoded (extended) characters are supported. Special characters used in URL's are NOT translated (":/?#[]@!$&'()*,;="). "%" and "+" are always translated. Space is encoded as "%20". Typically used to encode URL's. Special chars are not interpreted but left un-encoded.
Example: "& ? f ? ?" encodes as "&%20%E2%82%AC%20%CF%86%20%D0%B4%20%E8%81%94"
More info: http://en.wikipedia.org/wiki/URL_encoding

URL Encoded to Text
Converts %-encoded text to UTF-8 text. Variable byte length encoded (extended) characters are supported. "+" gets converted to space.
Example: "&%20%E2%82%AC%20%CF%86%20%D0%B4%20%E8%81%94" decodes as "& ? f ? ?"

Text to HTML encoded
Converts UTF-8 to &-encoded text. "&"<>'" are translated to their entity names (&amp;); all other characters are encoded using the hexadecimal ampersand format (&#xHHHH;).
Example: "& ? f ? ?" encodes to "&amp; &#x20AC; &#x03C6; &#x0434; &#x8054;"
More info: http://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references

HTML encoded to Text
Converts &-encoded and entity name encoded text (&#NNNN; or &#xHHHH; or &name;) to UTF-8. Variable byte length encoded (extended) characters are supported.
Example: "&amp; &#x20AC; &#x03C6; &#x0434; &#x8054;" decodes to "& ? f ? ?"

HTTP encoded to Text
Converts UTF-8 text to %-encoded text. Variable byte length encoded (extended) characters are supported. Special characters used in URL's ARE translated, "%" and "+" are also translated. Space is encoded as "+". Typically used to encode HTML FORM input. Special chars used in URL's are not interpreted but all encoded.
Example: "& ? f ? ?" encodes as "%26+%E2%82%AC+%CF%86+%D0%B4+%E8%81%94"
More info: http://en.wikipedia.org/wiki/URL_encoding

Text to HTTP decoded
Converts %-encoded text to UTF-8 text. Variable byte length encoded (extended) characters are supported. "+" gets converted to space.
Example: "%26%20%E2%82%AC+%CF%86+%D0%B4+%E8%81%94" decodes as "& ? f ? ?"

Locale Settings

Set the default format settings for decimal, date and time separators and the currency symbol used in the script.

Tip: This action will force a specific format settings, regardless of the computer locale settings when using formatting actions.

Action variables
Decimal separator:Type of decimal separator to be used.
Date separator:Type of date separator to be used.
Time separator:Type of time separator to be used.
Currency:Currency symbol to be used in the script.
Short Date format:Short date format to be used.

Convert to Number

Convert a Text variable to a Number variable.

Action variables
Text:Text or variable to be used.
Format:Number format settings for decimal separator.
Resulting number:Number variable for the result.

Convert to Date-Time

Convert a Text variable to a Date Time variable.

Tip: See the more help for formatting syntax options.

Action variables
Text:Text or variable to be used.
Format:Format syntax that is used in the text.
Resulting Date-Time:Number variable for the result.


Format syntax:

y = Year last 2 digits
yy = Year last 2 digits
yyyy = Year as 4 digits
m = Month number no-leading 0
mm = Month number as 2 digits
mmm = Month using ShortDayNames (Jan)
mmmm = Month using LongDayNames (January)
d = Day number no-leading 0
dd = Day number as 2 digits
ddd = Day using ShortDayNames (Sun)
dddd = Day using LongDayNames (Sunday)
ddddd = Day in ShortDateFormat
dddddd = Day in LongDateFormat

c = Use ShortDateFormat + LongTimeFormat
h = Hour number no-leading 0
hh = Hour number as 2 digits
n = Minute number no-leading 0
nn = Minute number as 2 digits
s = Second number no-leading 0
ss = Second number as 2 digits
z = Milli-sec number no-leading 0s
zzz = Milli-sec number as 3 digits
t = Use ShortTimeFormat
tt = Use LongTimeFormat

am/pm = Use after h : gives 12 hours + am/pm
a/p = Use after h : gives 12 hours + a/p
ampm = As a/p but TimeAMString,TimePMString
/ = Substituted by DateSeparator value
: = Substituted by TimeSeparator value

d/m/y = 5/6/00
dd/mm/yy = 05/06/00
ddd d of mmm yyyy = Mon 5 of Jun 2000
dddd d of mmmm yyyy = Monday 5 of June 2000
ddddd = 05/06/2000
dddddd = 05 June 2000
c = 05/06/2000 01:02:03

Create Hash

Creates a hash value from one or more variables.

Tip: For usage of hashes see: http://en.wikipedia.org/wiki/Hash_function

Action variables
Input Text:A text that should be hashed.
Hash value:A variable to which the hash value will be assigned.
Algorithm:The hash algorithm to be used.

Text Matching

Match RegEx

Matches a regular expression in a variable or source. The result is returned in the "Returned Match" variable.

Action variables
Source text:A source or variable to use for this action.
Regular Expression:The regular expression used in the match.
Returned Match:Returns the actual text matched by the regular expression.
Return Sub Expression Nr:If sub-expressions are used, the expression number will indicate which sub-expression should be returned to the Matched Text property. Zero means the complete match.
Match Success variable:If a match was successful, this variable is set to "Yes". If it was unsuccessful, it is set to "No".


This action is using the Perl regular expression syntax with Unicode support.

Tip: More information on regular expressions can be found at: http://www.regular-expressions.info

Match and Replace RegEx

Matches a regular expression in a variable or source and replaces all occurrences of the matches. When sub expressions are used they can be indicated in the Replace Text Property with $1, $2, etc. Open the example script for a demo.

Action variables
Source Text:A source or variable to use for this action.
Regular Expression:the regular expression used in the match.
Replace Text:Returns the actual text matched by the regular expression.


This action is using the Perl regular expression syntax with Unicode support.

Tip: More info on regular expressions can be found at: http://www.regular-expressions.info

Fuzzy Compare

Compares one string to another and gives back a match score as a number.

The score is used to determine how similar or dissimilar one string is compared to another.

Action variables
Text1:First text string.
Text2:second text string to compare the first one with.
Algorithm:The algorithm to use in the comparison.
Score:A number indicating how well Text1 matches Text2.
Replacement List:A list variable with replacements like "3d=3 doors" to perform on Text1 before comparison.


The action will compare a text string in the "Text1" property with a text string in the "Text2" property. It will provide a score as a result in the "Score" property. The Score is a measure of how much the two strings are alike. The Score depends on which algorithm you choose for comparison.

Algorithms: The algorithm determines how strings are compared to each other. Different algorithms have different applications, so it depends on the matching task you have which one is best for you.

DA1. Djuggler native fuzzy string comparison algorithm. In addition to comparing words, it also does a good job comparing "sentences" (strings of words). The lower the Score the better the match. A Score of -300 is a better match than a Score of -50 or 200. Score can be negative as well as positive. For example: compare "Nokia E66" with "Nokia E66" (Score:-300), "Nokia E65" (-279) and "Samsung Soul" (200). From these three strings, Nokia E66 is the best match, while Nokia E65 doesn't do bad either. Samsung Soul compares much worse to Nokia E66. Although not fool proof, negative scores can be considered good matches, while positive scores can be considered bad ones.

Levenshtein. The Levenshtein fuzzy string comparison algorithm. This algorithm calculates the difference between two strings (edit distance). The more differences are found, the higher the Score. A perfect match gets a Score of 0; less perfect matches get a higher score. Score is a positive number starting at zero.

Jaro-Winkler. The Jaro-Winkler fuzzy string comparison algorithm. This algorithm calculates the similarity between two strings. The more similarities are found, the higher the Score. A perfect match gets a Score of 1; the lowest score is 0. Score is a positive number between zero and one. 

Replacement List: you can provide a list variable here containing string replacements. These replacements are performed before the comparison is done. This allows you to correct for different spellings of a word (for example "3rd" and "third") before you compare strings, enhancing the match score. Each replacement is a separate item in the list, separated by an "=". To replace "3rd" with "third", add an item "3rd=third" to the list.

Fuzzy Best Match in List

Finds the best (fuzzy) match of a string in a list variable.

The best matching string in the list is returned.

Action variables
Input text:a text string.
Compare List:a list to compare the text string with.
Algorithm:The algorithm to use in the comparison.
Best match:The best found match within the list of strings.
Best score:A number indicating how well the found string matches Text.
Replacement List:A list variable with replacements like "3d=3 doors" to perform on Text1 before comparison.


The action will compare a text string in the "Text" property with a list of strings in the "List" property. It will return the string from the list that best matches the string in the Text property. The Score is a measure of how much the two strings are alike. The score depends on which algorithm you choose for comparison.

Algorithms: The algorithm determines how strings are compared to each other. Different algorithms have different applications, so it depends on the matching task you have which one is best for you.

DA1. Djuggler native fuzzy string comparison algorithm. In addition to comparing words, it also does a good job comparing "sentences" (strings of words). The lower the Score the better the match. A Score of -300 is a better match than a Score of -50 or 200. Score can be negative as well as positive. For example: compare "Nokia E66" with "Nokia E66" (Score:-300), "Nokia E65" (-279) and "Samsung Soul" (200). From these three strings, Nokia E66 is the best match, while Nokia E65 doesn't do bad either. Samsung Soul compares much worse to Nokia E66. Although not fool proof, negative scores can be considered good matches, while positive scores can be considered bad ones.

Levenshtein. The Levenshtein fuzzy string comparison algorithm. This algorithm calculates the difference between two strings (edit distance). The more differences are found, the higher the Score. A perfect match gets a Score of 0; less perfect matches get a higher score. Score is a positive number starting at zero.

Jaro-Winkler. The Jaro-Winkler fuzzy string comparison algorithm. This algorithm calculates the similarity between two strings. The more similarities are found, the higher the Score. A perfect match gets a Score of 1; the lowest score is 0. Score is a positive number between zero and one. 

Replacement List: you can provide a list variable here containing string replacements. These replacements are performed before the comparison is done. This allows you to correct for different spellings of a word (for example "3rd" and "third") before you compare strings, enhancing the match score. Each replacement is a separate item in the list, separated by an "=". To replace "3rd" with "third", add an item "3rd=third" to the list.

Fuzzy Best Match in Data Grid

Finds the best (fuzzy) match in a data grid column.

The best matching string in the list is returned.

Action variables
Input text:A text string.
Data Grid source:A Grid to compare the text string with.
Column Number:A Data Grid Column number to use for comparison.
Algorithm:The algorithm to use in the comparison.
Best Match row:The row number containing the best match.
Replacement List:A list variable with replacements like "3d=3 doors" to perform on Text1 before comparison.
Best Score:A number indicating how well the found string matches Text.


The action will compare a text string in the "Text" property with a list of strings in the "List" property. It will return the string from the list that best matches the string in the Text property. The Score is a measure of how much the two strings are alike. The score depends on which algorithm you choose for comparison.

Algorithms: The algorithm determines how strings are compared to each other. Different algorithms have different applications, so it depends on the matching task you have which one is best for you.

DA1. Djuggler native fuzzy string comparison algorithm. In addition to comparing words, it also does a good job comparing "sentences" (strings of words). The lower the Score the better the match. A Score of -300 is a better match than a Score of -50 or 200. Score can be negative as well as positive. For example: compare "Nokia E66" with "Nokia E66" (Score:-300), "Nokia E65" (-279) and "Samsung Soul" (200). From these three strings, Nokia E66 is the best match, while Nokia E65 doesn't do bad either. Samsung Soul compares much worse to Nokia E66. Although not fool proof, negative scores can be considered good matches, while positive scores can be considered bad ones.

Levenshtein. The Levenshtein fuzzy string comparison algorithm. This algorithm calculates the difference between two strings (edit distance). The more differences are found, the higher the Score. A perfect match gets a Score of 0; less perfect matches get a higher score. Score is a positive number starting at zero.

Jaro-Winkler. The Jaro-Winkler fuzzy string comparison algorithm. This algorithm calculates the similarity between two strings. The more similarities are found, the higher the Score. A perfect match gets a Score of 1; the lowest score is 0. Score is a positive number between zero and one. 

Replacement List: you can provide a list variable here containing string replacements. These replacements are performed before the comparison is done. This allows you to correct for different spellings of a word (for example "3rd" and "third") before you compare strings, enhancing the match score. Each replacement is a separate item in the list, separated by an "=". To replace "3rd" with "third", add an item "3rd=third" to the list.

Date and Time

Set Date-Time

Set the value of a Date-Time variable, based on values for a day, month, year, hours, minutes and seconds.

Action variables
Date-Time variable:The variable that needs to be set.
Day:Day value.
Month:Month value.
Year:Year value
Hours:Hour value.
Minutes:Minute value.
Seconds:Seconds value.
Milliseconds:Milliseconds value.

Get current Date-Time

Returns the current date and time in a variable.

Tip: Use the "Date from Date variable to Text" or "Time from Date variable to Text" or "Extract from Date-Time" actions to convert dates and times.

Action variables
Result variable:The variable that will hold the current Date.

Format Date-Time

Formats a Date variable in a specific format.

Examples:
d/m/y = 5/6/00
dd/mm/yy = 05/06/00
ddd d of mmm yyyy = Mon 5 of Jun 2000
dddd d of mmmm yyyy = Monday 5 of June 2000
ddddd = 05/06/2000
dddddd = 05 June 2000
c = 05/06/2000 01:02:03

Action variables
Date-Time variable:A Date Time variable to be used.
Format specifications:Format syntax.
Resulting Text:Text variable for the formatted date time.


y = Year last 2 digits
yy = Year last 2 digits
yyyy = Year as 4 digits
m = Month number no-leading 0
mm = Month number as 2 digits
mmm = Month using ShortDayNames (Jan)
mmmm = Month using LongDayNames (January)
d = Day number no-leading 0
dd = Day number as 2 digits
ddd = Day using ShortDayNames (Sun)
dddd = Day using LongDayNames (Sunday)
ddddd = Day in ShortDateFormat
dddddd = Day in LongDateFormat

c = Use ShortDateFormat + LongTimeFormat
h = Hour number no-leading 0
hh = Hour number as 2 digits
n = Minute number no-leading 0
nn = Minute number as 2 digits
s = Second number no-leading 0
ss = Second number as 2 digits
z = Milli-sec number no-leading 0s
zzz = Milli-sec number as 3 digits
t = Use ShortTimeFormat
tt = Use LongTimeFormat

am/pm = Use after h : gives 12 hours + am/pm
a/p = Use after h : gives 12 hours + a/p
ampm = As a/p but TimeAMString,TimePMString
/ = Substituted by DateSeparator value
: = Substituted by TimeSeparator value

Extract from Date-Time

Returns the day, month, year, hour, minutes and seconds as variables from a date variable.

Tip: Use this action to convert a date variable independent of the computer locale.

Action variables
Input Date-Time variable:The date that will be split into day, month, year, hour, minutes and seconds.
Day:The day number as variable.
Month:The month number as variable.
Year:The year number as variable.
Hour:The hour number as variable.
Minutes:The minutes number as variable.
Seconds:The seconds number as variable.

Add to Date-Time

Adds days, months, years, minutes and/or seconds to a Date-Time variable.

Action variables
Date-Time variable:The variable that will be increased in value.
Day:A number of days to add.
Month:A number of months to add.
Year:A number of years to add.
Hour:A number of hours to add.
Minutes:A number of minutes to add.
Seconds:A number of seconds to add.
Milliseconds:A number of milliseconds to add.

Subtract from Date-Time

Subtract days, months, years, minutes and/or seconds from a Date-Time variable.

Action variables
Date-Time variable:The variable that will be decreased in value.
Day:A number of days to subtract.
Month:A number of months to subtract.
Year:A number of years to subtract.
Hour:A number of hours to subtract.
Minutes:A number of minutes to subtract.
Seconds:A number of seconds to subtract.
Milliseconds:A number of millisecondsto subtract.

Date-Time Span

Returns the time span in days, months, years, minutes and seconds from two Date-Time variables.

Action variables
Date-Time 1:The first Date-Time variable to use.
Date-Time 2:The second Date-Time variable to use.
Years:The span in years.
Months:The span in months.
Days:The span in days.
Hours:The span in hours.
Minutes:The span in minutes.
Seconds:The span in seconds.
Milliseconds:The span in milliseconds.


Note: The span returns an approximation based on an assumption of 365.25 days per year. Fractional years are not counted. Thus, for example, the span reports the difference between Jan 1 and Dec 31 as 0 on non-leap years and 1 on leap years.

Date-Time Fractional Span

Returns the time span with a fraction in days, months, years, minutes and seconds from two Date-Time variables.

Note: The span returns an approximation based on an assumption of 365.25 days per year.

Action variables
Date-Time 1:The first Date-Time variable to use.
Date-Time 2:The second Date-Time variable to use.
Years:The span in years.
Months:The span in months.
Days:The span in days.
Hours:The span in hours.
Minutes:The span in minutes.
Milliseconds:The span in milliseconds.

Day of the week

Returns the day name and day number in the week of a given Date-Time.

Action variables
Date-Time variable:The Date-Time variable to use.
Day number:Returns the day number in the week.
Day name:Returns the day name.
Week starts at:Choose between ISO standard Monday or Sunday.

Day of the month

Returns the day name and day number of the month of a given Date-Time.

Action variables
Date-Time variable:The Date-Time variable to use.
Day number:Returns the day number in the month.
Day name:Returns the day name.

Day of the year

Returns the day name and day number of the year of a given Date-Time.

Action variables
Date-Time variable:The Date-Time variable to use.
Day number:Returns the day number in the year.
Day name:Returns the day name.

Month of the year

Returns the month name and month number of the year of a given Date-Time.

Action variables
Date-Time variable:The Date-Time variable to use.
Month number:Returns the month number in the year.
Month name:Returns the month name.

Import & Export

Import CSV

Import an Comma Separated Values file and put the contents in a Data Grid source.

Action variables
File name with path:The path and name of the file containing the data.
Data Grid source:The Data Grid source where the data will be copied to.
Separator:The separator used to separate the data columns.
Encoding:Encoding type of the file.

Export to CSV

Export a Data Grid source to a Comma Separated Values (CSV) file.

Action variables
File name with path:The path and name of the file where the data should be saved in.
Data Grid source:The Data Grid source where the data will be copied from.
Separator:The separator used to separate different data columns in one line of the (text) file.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.
Encoding:Encoding type of the file.

Write Line to CSV

Very fast method to append CSV records to a text file.

Tip: When writing lots of data to disk, this is the fastest way to create a CSV file without keeping data in memory and the best disk performance.

Action variables
File name with path:The path and name of the file where the data should be saved in.
Separator:The separator used to separate different data columns in the CSV.
Append new line (CR+LF):Select 'Yes' to close the line with a carriage return. Select 'No' if you use this action a few times in a row to append more then 9 values to a CSV line.
Value 1-9:Variables or text values to write to the CSV separated by the separator property.
Encoding:Encoding type of the file.

Import Excel

Imports an Excel file and puts the contents in a Data Grid source.

Action variables
File name with path:The path and name of the file containing the data.
Data Grid source:The Data Grid source where the data will be copied to.
Sheet Name:Sheet name to import, when left empty the first sheet will be imported.

Export to Excel

Export data from a Data Grid source to an Excel 2000/2003 compatible file.

Action variables
File name with path:The path and name of the file where the data should be saved.
Data Grid source:The Data Grid source where the data will be copied from.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.

Import Excel 2007

Imports an Excel file from MS Office 2007 and puts the contents in a Data Grid source.

Action variables
File name with path:The path and name of the file containing the data.
Data Grid source:The Data Grid source where the data will be copied to.
Sheet Name:The name of the Excel sheet in the workbook that contains the data. When left empty, the first sheet is used.

Export to Excel 2007

Export data from a Data Grid source to an Excel file in Excel format.

Action variables
File name with path:The path and name of the file where the data should be saved in.
Data Grid source:The Data Grid source where the data will be copied from.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.

Import Access

Import an Access 2000/2003 compatible file and put the content in a Data Grid source.

Action variables
File name with path:The path and name of the file containing the data.
Data Grid source:The Data Grid source where the data will be copied to.
Table name:The name of the Table in the database that contains the data that must be loaded.
Password:Fill in your password if your database is protected by a password.

Export to Access

Export data from a Data Grid source to an Access 2000/2003 compatible file.

Action variables
File name with path:The path and name of the file where the data should be saved in.
Data Grid source:The Data Grid source where the data will be copied from.
Table Name:The table name that should be used. If left empty, the name "Export Result" is used.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.

Import DBF or FoxPro

Import a DBF file and put the contents in a Data Grid source.

Action variables
File name with path:The path and name of the file containing the data.
Data Grid source:The Data Grid source where the data will be copied to.

Export to DBF

Export data from a Data Grid source to a DBF file.

Action variables
File name with path:The path and name of the file where the data should be saved in.
Data Grid source:The Data Grid source where the data will be copied from.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.

Export to SQL Script

Export a Data Grid source to SQL Script text file.

Action variables
File name with path:The path and name of the file where the data should be saved in.
Data Grid source:The Data Grid source where the data will be copied from.
Overwrite existing file:Select between 'Yes' or 'No' to overwrite an existing file.

File System

Copy File(s)

Copies one or more files to another location.

Tip: Indicate multiple files by using wildcards like: c:\myfiles\*.*.

Action variables
Source:The file(s) that should be copied.
Destination Folder:The folder where the file(s) should be copied to.
Silent:Set silent to 'Yes' to suppress confirmation and error prompts.

Move File(s)

Moves one or more files to another location.

Tip: Indicate multiple files by using wildcards like: c:\myfiles\*.*.

Action variables
Source:The file(s) that should be moved.
Destination Folder:The folder where the file(s) should be moved to.
Silent:Set silent to 'Yes' to suppress confirmation and error prompts.

Delete File

Deletes a file.

Action variables
File name with path:The file (path and File name) that should be deleted.
Silent:Set silent to 'Yes' to suppress confirmation and error prompts.

Rename File or Folder

Change the name of a file or folder.

Action variables
Old Filename:The existing file or folder that should be renamed.
New Filename:The new File name or folder name.
Silent:Set silent to 'Yes' to suppress confirmation and error prompts.

Create Folder

Create a new folder.

Tip: You can create several nested folders at once, i.e. "c:\folder1\folder2" creates the full path indicated including 'folder1' if it did not exist already.

Action variables
Folder Name:The folder (path) that should be created.
Silent:Set silent to 'Yes' to suppress confirmation and error prompts.

Copy Folder

Copies a folder including files to another location.

Action variables
Source Folder:The folder that should be copied.
Destination Folder:The destination to copy the folder to.
Silent:Set silent to 'Yes' to suppress confirmation and error prompts.

Move Folder

Moves a folder including files to another location.

Action variables
Source Folder:The folder that should be moved.
Destination Folder:The destination to move the folder to.
Silent:Set silent to 'Yes' to suppress confirmation and error prompts.

Delete Folder

Deletes an existing folder.

Action variables
Folder Name:The folder (path) that should be deleted.
Silent:Set silent to 'Yes' to suppress confirmation and error prompts.

Get File Information

Retrieves various information about a given file, like: size, creation date, etc.

Action variables
File name with path:The File name that should be analyzed.
Display Name:The File name as displayed by the file system.
File Type:The type as displayed by the file system, like 'Word document'.
Attributes:A string containing the attributes of the file, like: 'A' from the archive attribute.
Attribute code:A number that represents the active attributes of a file.
File size:A number containing the file size of a file in bytes.
File size description:A string that displays the file size rounded to kb, MB or GB.
Creation time:The creation Date of a file.
Last access time:The Date when the file was last accessed.
Last write time:The Date when the file was last modified.
File age in days:The number of days since the file was created and today.
Associated Executable:The executable associated with the extension in Windows.

Get File Path Information

Retrieves various information about a the path of a given file, like drive, file extension, etc.

Action variables
File name with path:The File name that should be analyzed.
File drive:The file drive where the file is located.
Dir:The directory the file is located.
Path:The file path to a file.
Short path:The short path (path without spaces and in 8.3 notation) of the full path.
Filename:The file name without the file path.
File extension:The file extension of a file, including the dot.

Email

Send Mail Direct

Deliver mail directly at the receiver's mail server without relaying through an SMTP host.

Tip: Read the more help for embedding images in HTML email.

Action variables
To:The address of the recipient.
From:The sender's e-mail address.
Subject:The e-mail subject.
Body:The plain text body of the e-mail. Can be either text or a local File name.
Result variable:The result of the action (mail sent, any errors) is written to this variable.
DNS:The DNS used to auto resolve the MX records.
HTML Body:HTML part of the message, either text or a local File name.
Attachments:Comma separated attachment list of local File names.


The minimum properties required to send an e-mail are the "To", "From", "Subject" and "Body" properties.

The "To" property can only be a single email address, valid notations are 'john.doe@someplace.com' or 'John <john.doe@someplace.com>' or '"John Doe" <john.doe@someplace.com>'.

The "Body" property is the plain text part of the message, this can be either plain text or a File name that should be loaded as the body text.

The "HTML Body" property is the HTML part of the message that will be included and can either be HTML text or a local File name.

If the HTML contains pictures (GIF, JPG or PNG) with a local reference, they will be embedded inline.
Example: '<img scr="c:\mypicture.jpg">' will be embedded inline because is has a local reference; '<img scr="http://somedomain/mypicture.jpg">' will NOT be embedded inline.

The "Attachments" property is a comma separated list of local File names, e.g. 'c:\myfile.doc, c:\myfile2.txt'.

If the "DNS" property is given, that DNS is used to auto resolve the MX records, otherwise the first DNS from the local system will be used.

The "Result" property contains the result of the action, a message with a specific error or success message.

Send Mail by SMTP

Send Mail by SMTP will send a plain text or html e-mail via an SMTP host.

Tip: Read the more help for embedding images in HTML email.

Action variables
To:The address of the recipient. Multiple addresses are separated by a comma.
From:The sender's e-mail address.
Subject:The e-mail subject.
Body:The plain text body of the e-mail. Can be either text or a local File name.
Host:SMTP server that should be used for the outgoing e-mail.
Result variable:The result of the action (mail sent, any errors) is written to this variable.
CC:Carbon copy recipients. Multiple addresses are separated by a comma.
BCC:Blind carbon copy recipients. Multiple addresses are separated by a comma.
Port:Specific SMTP port that should be used for the connection.
Host username:Username for basic SMTP authentication.
Host password:Password for basic SMTP authentication.
HTML Body:HTML part of the message, either text or a local File name.
Attachments:Comma separated attachment list of local File names.


The "To", "CC" and "BCC" properties can be a single email address or multiple e-mail addresses separated by a comma, valid notations are 'john.doe@someplace.com, jane.doe@someplace.com' or 'John <john.doe@someplace.com>' or  '"John Doe" <john.doe@someplace.com>, "Jane Doe" <jane.doe@someplace.com>'.

The "Body" property is the plain text part of the message, this can be either plain text or a File name that should be loaded as the body text.

The "HTML Body" property is the HTML part of the message that will be included and can either be HTML text or a local File name.

If the HTML contains pictures (GIF, JPG or PNG) with a local reference, they will be embedded inline.
Example: '<img scr="c:\mypicture.jpg">' will be embedded inline because is has a local reference; '<img scr="http://somedomain/mypicture.jpg">' will NOT be embedded inline.

The "Attachments" property is a comma separated list of local File names, e.g. 'c:\myfile.doc, c:\myfile2.txt'.

If the "DNS" property is given, that DNS is used to auto resolve the mx records, otherwise the first DNS from the local system will be used.

The "Result" property contains the result of the action, a message with a specific error or success message.

Optionally a specific SMTP "Port", "Username" and "Password" can be specified for the SMTP connection.

Send Mail Raw

Send a raw e-mail message file to a SMTP host.

Action variables
Host:SMTP server that should be used for the outgoing e-mail.
Raw message file:A file path to a text file containing the raw message.
Result variable:The result of the action (mail sent, any errors) is written to this variable.
Port:Specific SMTP port that should be used for the connection.
Host username:Username for basic SMTP authentication.
Host password:Password for basic SMTP authentication.


A raw e-mail message file is a text file that contains headers, addresses and content for an e-mail message.
These files are typically found in message queues of mail servers and used by programs as the Microsoft SMTP service.

A simple and minimal raw message file may look like:

TO: john.doe@someplace.com
FROM: jane.doe@someplace.com
SUBJECT: message from jane

Hello John,
Bye Jane.

System

Run shell command

This action executes a shell command.

For example, using 'notepad.exe' as "Command" property value will bring up Windows notepad editor.

Note: Use quotes when File names or parameters contain spaces.

Action variables
Command:The shell command to execute.
Parameters:Any parameters you want to feed to the shell command.
Show Window:Set the window state of the executing command shell.
Working folder:The working folder for the command that is executed. When ommited the current directory is used.
Wait until finished:Set to Yes or No. On Yes the script will wait until the started process is finished and then continue.

Pipe DOS Application

This action allows you to run a DOS application and catch its output in a variable.

Example: 'ipconfig.exe /all' as "Command line" property value will catch ip information output in a variable.

Note: Use quotes when File names or parameters contain spaces.

Action variables
Command line:The DOS application including command line parameters.
Output (stdOutOutput):The standard output of the DOS application is returned in text variable.
Errors (stdOutError):The standard error output of the DOS application is returned in text variable.
Show Window:Set the window state of the executing command shell.
Time-out (seconds):When the application is not finished by the time-out it will be killed automatically. '0' means wait for ever.
Success variable:Returns 'Yes' when the application has finished before the time-out, otherwise it will return 'No'.

Get Parameter Value

A Djuggler compiled script can be called with parameters. This action reads a parameter and assigns it to a text variable to be used in the script.

Example: Set "Param name" to '/log' and call the compiled script as 'myscript.exe /log=c:\temp\mylogfile.txt'.

Tip: Use the "Default value" property value to test the parameter when not running as a compiled script.

Action variables
Param name:The parameter name to use, like '/input'. Call it on the command line with '/input=test'
Param value:A text variable that holds the parameter value given on the command line.
Default value:When no parameter is given on the command line, this value will be used as Param value.

Close Window

Close a Windows Window by it's dialog title.

This action is typically used to close a dialog outside the Djuggler environment.

Action variables
Window title:The title of the Window dialog.
Success variable:Yes is returned when a dialog with the given title is found, else No is returned.

Get System Folder

Returns the path to the special Windows folders, like the Temp folder or My Documents (Personal folder), etc as a text variable.

Action variables
System Folder Kind:Specify a special folder.
Result variable:A text variable with the complete folder path.

Get System Information

Returns various system information, like Computer name, User name, IP Address, etc as a text variable.

Action variables
System Information:Specify the system information.
Result variable:A text variable with the system information.

Windows Clipboard

Get or set a value in the Windows clipboard.

Action variables
Text to clipboard:The variable or source from which the content should be copied to the clipboard.
Text from clipboard:The variable or source in which clipboard content as text should be placed.

Get Registry Data

Returns a registry value as a text variable.

Action variables
Hive Key:Select the hive key to use.
Key:The registry key value to use.
Value:The registry value to use.
Result variable:Return variable that holds the registry data.
Success variable:When the registry could be read 'Yes' will be returned otherwise 'No'.

Deprecated

Open Web Page source

This is a deprecated action, use the Get Web Page action.

Opens a Web Page and puts the HTML source as in the IE 'view source' option in the content in the Web Page source.

Note: This is not the DOM source as shown in the Djuggler Web Inspector. This is the source as served by a web server without interpretation of Internet Explorer.

Action variables
Web Page:The Web Page source to be used.
URL:The URL to use including prefixes like http:// or https://.

Get Table

This action is deprecated, use the Get Table Content action instead.

Collects all data from a HTML table to a "Data Grid" source.

The "Table Number" variable to indicates the HTML table to use. For example Table Number 3 will collect data from the third <TABLE> tag found in the HTML.

Tip: Use the Web Page viewer (F3) to inspect the table number in a Web Page.

Action variables
Source:The source (Web Page or Text File) containing the HTML and table you want to extract.
Data Grid source:The Data Grid variable where the table data will be returned.
Table Number:Tells the action which table to extract. Search for "<TABLE" in the HTML source, and count occurrences until you reach the table you are after.
Start Row:Indicate at which row to start reading data. The first row has number "1".
End Row:Indicate at which row to stop reading data.
Start Column:Indicate at which column to start reading data. The first column has number "1".
End Column:Indicate at which column to stop reading data.
Strip HTML:Indicates whether the action will strip the data from HTML tags, thus automatically cleaning the data.

Read Tag Content

This action is deprecated, use the Web Page DOM actions instead.

Reads the content from a HTML tag.

Action variables
Source:The source (Web Page or Text File) containing the HTML and tag(s) you want to extract.
Tag:The name of the tag to read, like "TD".
Attribute Name:Optional name of the attribute to further specify the tag you need.
Attribute Value:Optional value of the attribute you use to specify the tag.
Content:Any content found is placed here.
Strip HTML:Indicates wether the action will strip the data from HTML tags, thus automatically cleaning the data.


The action looks for the tag specified in the Tag property. If you set Attribute Name and Value, only tags are matched where the tag attribute contain the set value.

For example, say you want to read the content of a html tag specified by the following html: "<TD class='myclass'>some content here...</TD>". Fill in "TD" as Tag, "class" as Attribute and "myclass" as Value. The action will now seek through the html and return the content of the first found tag in the Content property.

Fill Form Field

This action is deprecated, use the Set Form Element Value action instead.

Fills a field in a form on a Web Page. Typically used for form automation, like a login to a web site.

Action variables
Web Page:The Web Page source to be used.
Field Name:Field name that should be filled. This is the name attribute of the INPUT tag.
Value:The value to be pasted in to the form's field.

Date to Text

This action is deprecated, use the Convert Variable action instead.

Returns the date part from a Date variable as a Text variable.

Action variables
Date variable:The Date to obtain the date from.
Result variable:The text variable to be filled with the date form the Date variable.

Time to Text

This action is deprecated, use the Convert Variable action instead.

Returns the time part from a Date variable as a Text variable.

Action variables
Date variable:The Date to obtain the time from.
Result variable:The text variable to be filled with the time form the Date variable.

Convert Source Text to Variable

This action is deprecated, use the Convert Variable action instead.

Copies the content of the Source to a Variable.

Action variables
Variable:The variable to place the source text in. This should be a Text Variable.
Source:The source to copy the text from.

Convert Variable to Source Text

This action is deprecated, use the Convert Variable action instead.

Copies the content of the Variable to the Source.

Action variables
Variable:The Variable to copy the text from.
Source:The Source to place the source text in.


Tip: This action is often used to convert a variable to a Text source and save it to disk.

Get Element Value

This action is deprecated, use the Web Page DOM actions instead.

Retrieves the value (innerHTML) of a specified HTML tag. You can specify tag attribute/value combinations to indicate a specific tag.

Action variables
Web Page:The Web Page source used to retrieve the tag.
Tag Name:The tag name to retrieve.
Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Result Variable:The variable used to return the Tag content (innerHTML).
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not complete successfully.


Example:
The HTML contains a tag "<TD width=36><b>some content</b></TD>".
To retrieve this tag's content, you should specify the Tag Name as "TD", Attribute Name as "width" and Attribute Value as "36". In the Result Variable, "<b>some content</b>" will be returned.

Get Element Text

This action is deprecated, use the Web Page DOM actions instead.

Retrieves the value (innerText) of a specified HTML tag. All HTML within the tag's content is stripped. You can specify tag attribute/value combinations to indicate a specific tag.

Action variables
Web Page:The Web Page source used to retrieve the tag.
Tag Name:The tag name to retrieve.
Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Result Variable:The variable used to return the Tag content (innerHTML) in.
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not complete successfully.


Example:
The HTML contains a tag "<TD width=36><b>some content</b></TD>".
To retrieve the tag's content, specify the Tag Name as "TD", Attribute Name as "width" and Attribute Value as "36". In the Result Variable, "some content" will be returned.

Get Element Attribute Value

This action is deprecated, use the Web Page DOM actions instead.

Retrieves an attribute value of a HTML element.

Action variables
Web Page:The Web Page source used to retrieve the tag.
Tag Name:The tag name to retrieve.
Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Result Attribute Name:The attribute name that should be used to return the attribute value content from.
Result Variable:The variable used to return the attribute value in.
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not complete successfully.


Example:
The HTML contains a tag "<table id=table1 width=300>".

To retrieve the attribute width value, specify the Tag Name as "TABLE", Attribute Name as "id" and Attribute Value as "table1". Result Attribute Name as "width" and in the Result Variable, "300" will be returned.

Set Element Value

This action is deprecated, use the Web Page DOM actions instead.

Searches the first tag that matches the Tag Name, Attribute Name and Attribute Value. With the found tag, the value (innerHTML) is set.

Action variables
Web Page:The Web Page source used to set the tag.
Tag Name:The tag name to search.
Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Content:The variable used to set the Tag content (innerHTML) in.
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not compleet successfully.


Example:
The HTML contains a tag "<TD width=36><b>some content</b></TD>".

To set this tag's content, you should specify the Tag Name as "TD", Attribute Name as "width" and Attribute Value as "36". In Content you could set "other content", and the tag will then read "<TD width=36><b>other content</b></TD>".

Set Element Attribute Value

This action is deprecated, use the Web Page DOM actions instead.

Searches the first tag that matches the Tag Name, Attribute Name and Attribute Value. Optionally, a 2nd and 3rd Attribute Name and Value is matched as well.

Action variables
Web Page:The Web Page source used to set the tag.
Tag Name:The tag name to search.
Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
Attribute Name to set content for:The attribute name to set the content for.
Content:The variable used to set the Tag content (attribute value) in.
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not compleet successfully.


You can also leave empty the first Attribute Name and Attribute Value just to match on Tag Name.

Example:
The HTML contains a tag "<TD width=36 height=3><b>some content</b></TD>".
To set this tag's content, you should specify the Tag Name as "TD", Attribute Name as "width" and Attribute Value as "36". If you set Attribute Name to set content for to "height" and Content to "6", and the tag will then read "<TD width=36 height=6><b>other content</b></TD>".

Click Element

This action is deprecated, use the Web Page DOM actions instead.

Searches the first tag that matches the Tag Name, Attribute Name and Attribute Value. Optionally, a 2nd and 3rd Attribute Name and Value is matched as well.

Action variables
Web Page:The Web Page source used to perform the click on.
Tag Name:The tag name to search.
Attribute Name:The Attribute Name used to match a tag (leave empty for no attribute).
Attribute Value:The Attribute Value used to match a tag (leave empty for no attribute).
2nd Attribute Name:an optional 2nd Attribute Name used to match a tag.
2nd Attribute Value:an optional 2nd Attribute Value used to match a tag.
3rd Attribute Name:an optional 3rd Attribute Name used to match a tag.
3rd Attribute Value:an optional 3rd Attribute Value used to match a tag.
Error message:Return variable with an error messages if the action did not compleet successfully.

Connect to MSSQL

This action is deprecated, use the SQL Connect action instead.

Open a connection to a Microsoft SQL database.

Action variables
Database source:The SQL Database source to use.
Host Name:The Database host name.
User Name:The user name used to connect to the database.
Password:The password used to connect to the database.
Database Name:The name of the database your data is stored in.
Port:The port used for the connection.


When connecting to a database to run "SQL Query Direct" action, use the following basic structure:

... do actions...
Connect
SQL Query Direct
Disconnect

Connect to MySQL

This action is deprecated, use the SQL Connect action instead.

Open a connection to a MySQL database.

Action variables
Action variables:
Database source:The SQL Database source to use.
Host Name:The Database host name or ip address.
User Name:A user name used to connect to the database.
Password:A password used to connect to the database.
Database Name:The name of the database to be used.
Port:The port used for the connection.


When connecting to a database to run "SQL Query Direct" action, use the following basic structure:

... do actions...
Connect
SQL Query Direct
Disconnect

Connect to Oracle

This action is deprecated, use the SQL Connect action instead.

Open a connection to a Oracle database.

Action variables
Database source:The SQL Database source to use.
Host Name:The Database host name.
User Name:The user name used to connect to the database.
Password:The password used to connect to the database.
Database Name:The name of the database to be used.
Port:The port used for the connection.


When connecting to a database to run "SQL Query Direct" action, use the following basic structure:

... do actions...
Connect
SQL Query Direct
Disconnect

SQL Query for Records

This action is deprecated, use the SQL Query action instead.

Execute a SQL query and returns a record set in memory linked to the database connection.

Action variables
Database source:The SQL Database source to query.
Query:The SQL query (for example "select * from table1").


When using a record set, use the following basic structure:

Connect
SQL Query for Records
... do actions like Loop Data Grid Rows...
Disconnect


First use the Connect action to connect to the server.
Next run a SQL Query for Records and create a result set of records in memory, linked to the SQL database connection.
Next use actions like Get Field or Delete Record.
Changes in the records set will not be saved to the database until Commit Changes is used or the Disconnect action is called.
(c) Digital Architects | Login | Register