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 compariment.
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 whitch 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 a certain condition, 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 whitch 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:
No variables need to be set for this action.
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.
Structure example:
If ...
... do actions ...
Else
... do actions ...
End If
Action variables:
No variables need to be set for this action.
Go to Label
Jumps to a Label action in the script and executes lines from there until a Return action is encountered.
The "Label name" property value should match the exact name of the label to jump to. Use the Return 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.
Labels are typically used if a script has a block of actions that are repeated two or more times in a script. By using the label method the number of script lines can be reduced and the script logic will improve. Another approach is simplifying complex scripts by creating a label for each specific task in the script. At the beginning of the script all labels are called with the Go to Label action in the order the tasks should be performed.
Action variables:
Label name: The (exact) name of the label to jump to.
Structure example 1:
... actions ...
Go to Label UpdateLogFile
... actions ...
Go to Label UpdateLogFile
... actions ...
Stop Script Execution
Label UpdateLogFile
... actions ...
Return
Structure example 2:
Go to Label GetPriceInformation
Go to Label ComparePrices
Go to Label SaveResults
Stop Script Execution
Label GetPriceInformation
... actions ...
Return
Label ComparePrices
... actions ...
Return
Label SaveResults
... actions ...
Return
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 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.
Tip: When using labels to create 'procedures' at the end of a script, use a Stop Script Execution action before the labels.
Labels are typically used if a script has a block of actions that are repeated two or more times in a script. By using the label method the number of script lines can be reduced and the script logic will improve. Another approach is simplifying complex scripts by creating a label for each specific task in the script. At the beginning of the script all labels are called with the Go to Label action in the order the tasks should be performed.
Structure example 1:
... actions ...
Go to Label UpdateLogFile
... actions ...
Go to Label UpdateLogFile
... actions ...
Stop Script Execution
Label UpdateLogFile
... actions ...
Return
Structure example 2:
Go to Label GetPriceInformation
Go to Label ComparePrices
Go to Label SaveResults
Stop Script Execution
Label GetPriceInformation
... actions ...
Return
Label ComparePrices
... actions ...
Return
Label SaveResults
... actions ...
Return
Tip: Labels can be nested in the script logic.
Return
Use the Return action to indicate the end of label and jump back to position where the Label was called with a Go to label action.
Action variables:
No variables need to be set for this action.
Structure example 1:
... actions ...
Go to Label UpdateLogFile
... actions ...
Go to Label UpdateLogFile
... actions ...
Stop Script Execution
Label UpdateLogFile
... actions ...
Return
Structure example 2:
Go to Label GetPriceInformation
Go to Label ComparePrices
Go to Label SaveResults
Stop Script Execution
Label GetPriceInformation
... actions ...
Return
Label ComparePrices
... actions ...
Return
Label SaveResults
... actions ...
Return
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.
Loops
Loop
The Loop action is a simple infinite loop untill 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:
No variables need to be set for this action.
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.
File name: 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.
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 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.
File Mask: Specify an optional file mask. For example "*.txt" to loop only files with the extension txt.
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 Web Pages
Loops Web Pages with a typical "Next" button. The "Next Page Button Recorder" is used to identity a "Next" page button.
A Loop Web Pages action should always be proceeded by a Get Web Page using the DOM source to set the initial Web Page in which the click to the next page is performed.
Tip: The source obtained by Loop Web Pages is the DOM source and might slightly differ from source obtained via the "view source option" in Internet Explorer or other browsers. The Read Next Link by Title action in combination with a simple Loop action can be used as an alternative for the Loop Web Pages action using the HTML source.
Web pages with a next page structure like: "
1|2|3 >Next" can be looped until the last page using this action. The Next link is identified using the Button recorder behind the three dots. The recorder opens in a new browser window.
Using the Next Page Button Recorder:
1. Put the URL for the first page in the navigation edit box and press the "
Go" button. The first page with the Next link structure is loaded in the browser pane.
2. Press the
Record button on the right and then click on the
Next link in the actual browser pane. The HTML tag identifing the Next link is shown on the right pane.
3. Press the
Save Recording and Exit button to save the recording and close the browser window.
Action variables:
Web Page: The Web Page Source that should be used.
Next Page Button Recorder: Clicking on the button with the three dots will open up a special web browser for recording the "Next page button".
Structure example using Loop Web Pages:
Get Web page ... using DOM source
Loop Web Pages
... actions ...
End Loop
Structure example using Read Next Link by Title:
Get Web page ... using HTML source
Loop
Read Next Link by Title
If Condition aLink is Empty
Exit Loop
End Loop
... actions ...
End Loop
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. An End Loop action is needed to close the loop in the script logic.
Tip: To loop a sorted list, use the Sort List action before the loop.
Action variables:
List variable: The List variable containing list items.
Result variable for Item: With each pass of the loop, the result variable is filled with the current item content.
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. An End Loop action is needed to close the loop in the script logic.
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.
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. An End Loop action is needed to close the loop in the script logic.
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 the 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'.
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'.
Action variables:
XML Document source: The XML Document source to be used.
Start at: The starting point from which to start searching in the XML tree.
Look for: 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.
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: The starting point from which to start searching in the XML tree.
Look for: 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.
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 Succeeded 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: The full path and name of the file to be read.
Read Line variable: Contains the line content of the file with each pass of the loop.
Structure example:
Loop Text File Lines
... actions using the Read Line property 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 for Records action.
The loop starts with the first record in the record set and runs until the last record is reached.
Note: When the loop finishes it will apply any changes made in the record set to the database automatically.
When using a record set, use the following basic structure:
Connect
SQL Query for Records
Loop Records
... actions like Get Field Value...
End Loop
Disconnect
Action variables:
SQL Database: The SQL Database source connection to use.
End Loop
Each Loop action needs an End Loop action to indicate the end of the loop.
Structure example:
Loop While ...
... actions ...
End Loop
Action variables:
No variables need to be set for this action.
Exit Loop
Forces an exit in a loop and is often used in combination with an If or If Condition action.
Action variables:
No variables need to be set for this action.
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 seperator.
Wait
Puases the execution of the script for a number of miliseconds.
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 500 miliseconds 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.
Action variables:
No variables need to be set for this action.
On Error Go to Label
Jumps to a specified label when the script encounters an error.
Tip: When the Supress Errors & Dialogs action is used this action can be used to catch and handle script errors.
Action variables:
Label name: The label 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 Supress Errors & Dialogs action is used this action can be used to catch and handle script errors.
Action variables:
Result variable: This variable gets filled with a description of the last encountered 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.
Typically used before Label actions or when the script encounters a condition it should stop at all times.
Action variables:
No variables need to be set for this action.
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.
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.
Action variables:
No variables need to be set for this action.
Get Script Properties
Returns various script properties like the script path, script name, build version. It it also reveils information about the Djuggler version and edition used to create the script.
Action variabless:
Script Path: Returns the fiel 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: This action is typically used in a debug situation.
Action variables:
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 Grid Viewer
Shows or hides up Djuggler's internal grid viewer.
Note: This action is typically used in a debug situation.
Action variables:
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: This action is typically used in a debug situation.
Action variables:
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
Append a text line to a log file, including a date time stamp.
Note: This action is typically used in a debug situation.
Action variables:
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.
Missing action
When a script is loaded that is created by a more recent version of Djuggler a missing action statement will replace all unkown actions from the new Djuggler version.
Action variables:
No variables need to be set for this action.
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.
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:
Title text: The title for the dialog.
Answer variable: A 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.
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:
Title text: The title for the dialog.
Answer variable: A 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.
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:
Title text: The title for the dialog.
Answer variable: A variable where the directory 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.
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:
Visability: 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.
Visiablity: 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.
Max file size: The max size Kb for 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.
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 Data
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 or write to a log file.
Tip: Use this action to verify the content of variables before writing them to any output as a database or 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).
Match 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.
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)".
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)
Action variables:
Math Expression: The mathematical expression.
Result variable: A variable that holds the result of the expression.
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 (including path): The file where the list items should be read from.
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 variabless:
List variable: The List that should be saved.
File name: 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.
Add Item to List
AAdds 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 separted by an equal sign, like for example: "color=red", color is the name part and red is the value part.
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.
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.
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.
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 (including path): The file where the content should be read from.
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 (including path): The file in which the content should be saved.
Overwrite existing file: Select between 'Yes' or 'No' to overwrite an existing 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: The name of the file to write to.
Text line: Text line to be written to the end of the file.
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 (including path): The name of the file to write to.
Append text: Text to be written to the end of the file.
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: 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: 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'.
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'.
Action variables:
XML Document source: The XML Document source to be used.
Start at: The starting point from which to start searching in the XML tree.
Look for: 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.
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.
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.
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.
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).
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.
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 miliseconds.
Web Pages
Get Web Page
Opens a Web Page and puts the HTML content in the Web Page source as DOM or HTML source. The DOM source enables advanced actions like Click Form Element. The HTML source is the raw html as served by a web server.
HTML source is faster then the DOM source because only requests the source from a web server and won't request 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.
Tip: To inspect the source, use the Djuggler's Inspector from the menu and the Inspect button.
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 HTML source as served by the web server.
Browse Silently: Option for fast page loading the DOM source without load pictures and suppressing pop-up's and page error messages.
Time out: 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 supressed when DOM source is selected.
Proxy Address: Address used for a proxy.
Proxy Port: Port for a proxy address.
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 ampersants 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.
Post Data: a string of form variables and their values like 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.
Time out: 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 supressed when DOM source is selected.
Proxy Address: Address used for a proxy.
Proxy Port: Port for a proxy address.
Run Web Macro
Records and automates an entire "manual" browse action, complete with typed urls, mouse clicks and filled form fields.
The Web Inspector is launched in Recorder mode by clicking on the three dots behind the recorder property. The browse recording is started by clicking the Record button, followed by clicking the Stop button and Close.
When running a script, the exact sequence of events is replayed on the Web Page variable in this action. Note that this browsing is done from the current page in the Web Page variable.
Action variables:
Web Page: The Web Page source to be used.
Recorder: Opens the Web Inspector for recording. When a recording is successfully made 'Recorded' is displayed.
Browse Silently: Option for fast page loading the DOM source without load pictures and suppressing pop-up's and page error messages.
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.
File name: 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.
Tip: Use this action in a loop to collect all hyperlinks in a Web Page.
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.
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.
Tip: Use this action in a loop to collect all images in a Web Page.
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.
Save Image
Save an Image variable to disk. Typically used in combination with the Read Next Image action.
Note: When the File name is not specified, the File name from the image is used.
Action variables:
Image: Image variable to be saved.
Folder: A folder where the image should be saved.
File name: The File name that should be used.
Success variable: On a successful save action the variable will contain Yes, 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, based on table number or table that contains a specific text string.
The "Table Number" variable to indicates the HTML table to use. For example Table Number 3 will collect data from the thrid <TABLE> tag found in the HTML. As an alternative a table can be found based on a unique text string.
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. Yes or No is returned.
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: A syntax check on the URL. Yes or 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.
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.
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.
Success: A variable that holds Yes or No when the specified text has been found before the time out.
Time out: Time out for the action in seconds, after which the script will continue.
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: The number of milliseconds to wait before refreshing the source.
Clear IE Cache
Clears the Internet Explorer Cache.
Note: This action will also clear the cache for the regular IE browser.
Action variables:
No variables need to be set for this action.
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.
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 IE Version
Puts 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:
IE Version: Returns the IE version used on the computer running the script.
IE Major: Returns the IE Major version used on the comptuer running the script.
Execute JavaScript
Executes JavaScript in a Web Page source. This can either be an existing JavaScript function found in the HTML source or JavaScript in the action property.
Tip: The Execute JavaScript is used in combination with the Refresh Browser Source or Wait for Content action to handle AJAX enabled web sites. See the AJAX demo scripts.
Action variables:
Web Page: The Web Page source to use.
JavaScript code: The code or existing function in the HTML source to be executed.
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.
Complete Page Links
Completes all links (a href's) in a Web Page source's content.
Example: A link like "./support/index.htm"; would be translated into something like "http://www.mysite.com//support/index.htm".
Tip: Calling
Get Web Page after a
Complete Page Links action refills the Web Page source, so to complete all links in the new page, you would have to call
Complete Page Links again.
Action variables:
Source: The Web Page source where links should be completed.
Complete Relative URL
Completes a relative URL to a full URL.
Example: "./support.asp" is completed to "http://www.djuggler.com/support.asp".
Note that completion of a URL depends on the Web Page where it was obtained from. Always use the correct Web Page source to complete a URL.
Action variables:
Web Page: The Web Page source used to complete the relative URL.
Web Pages Interaction
Get Element Value
Retrieves the value (innerHTML) of a specified HTML tag. You can specify tag attribute/value combinations to indicate a specific tag.
If more than one tag matches the specifications the value of the first matching tag is returned.
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.
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: Contains errors messages or is empty if action completely successfully.
Get Element Text
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.
If more than one tag matches the spcifications, the value of the first matching tag is returned.
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.
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: Contains errors messages or is empty if action completely successfully.
Get Element Attribute Value
Retrieves an element attribute value of a specified HTML tag.
If more than one tags match the specification, the value of the first matching tag is returned.
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.
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: Contains errors messages or is empty if action completely successfully.
Set Element Value
Searches the first tag that matches the Tag Name, Attribute Name and Attribute Value. With the found tag, the the value (innerHTML) is set.
Tip: If you want to set an INPUT tag value like a typicall username box, use the Set (Form) Element Atribute Value action.
Note: 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><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>".
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: Contains errors messages or is empty if action completely successfully.
Set Element Attribute Value
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. When the tag is found, the value of the Attribute Name to set content for is set with Content. Be aware that more than one tag can match the specifications, so be as specific (use more attributes) as you can.
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>".
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: Contains errors messages or is empty if action completely successfully.
Click Element
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. When the tag is found, a mouse click on the element is performed. Be aware that more than one tag can match the specifications, so be as specific (use more attributes) as you can.
You can also leave empty the first Attribute Name and Attribute Value just to match on Tag Name.
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: Contains errors messages or is empty if action completely successfully.
Get Form Element Value
Retrieves the value (innerHTML) of a specified FORM tag. You can specify tag attribute/value combinations to indicate a specific tag.
If more than one tag matches the spcifications, the value of the first matching tag is returned. This action is similar to Get Element Value, but additionally you can specify form attributes (typically name="form1") to indicate the form. This makes this action more specific in indicating the right tag.
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.
Action variables:
Web Page: The Web Page source used to retrieve the tag.
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: Contains errors messages or is empty if action completely successfully.
Get Form Element Attribute Value
Retrieves the value of an attribute element from a Form tag.
If more than one tag matches the spcifications, the value of the first matching tag is returned.
This action is similar to Get Element Attribute Value, but in addition a specific form can be specified.
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.
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.
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: Contains errors messages or is empty if action completely successfully.
Set Form Element Value
Sets the value (innerHTML) of a specified FORM tag. You can specify tag attribute/value combinations to indicate a specific tag.
If more than one tag matches the specifications, the value of the first matching tag is returned. This action is similar to Set Element Value, but additionally you can specify form attributes (typically name="form1") to indicate the form. This makes this action more specific in indicating the right tag.
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>".
Action variables:
Web Page: The Web Page source used to set the tag.
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 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: Contains errors messages or is empty if action completely successfully.
Set Form Element Attribute Value
Sets the value of a specified FORM tag attribute. You can specify tag attribute/value combinations to indicate a specific tag.
If more than one tag matches the specifications, the value of the first matching tag is returned. This action is similar to Set Element Attribute Value, but additionally you can specify form attributes (typically name="form1") to indicate the form. This makes this action more specific in indicating the right tag.
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>".
Action variables:
Web Page: The Web Page source used to retrieve the tag.
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 content to fill the attribute value.
Content: 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: Contains errors messages or is empty if action completely successfully.
Click Form Element
Performs a mouse click on a certain element in an HTML page. Typically used to click on a submit button programmatically.
Tip: The Djuggler Web Inspector can inspect the tag information needed for this action.
Action variables:
Web Page: The Web Page source to use.
Element Tag: The type of the tag to be clicked, for example the INPUT tag.
Element Name: The name attribute of the tag.
Get Select Options
Gets all options from a SELECT element on a form and puts them in a list. This way you can build a loop that iterates all options in a SELECT dropdown. The action returns a list of option values and a list of option descriptions.
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".
Action variables:
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.
Set Select Option
Select a option from a SELECT element on a form. This way you can change a SELECT dropdown in a Web Page. Use either the option value or the option description to indicate which option you wish to select.
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.
Action variables:
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).
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".
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.
Action variables:
Data Grid source: The Data Grid source to use.
Variable: Text variable where the cell content should be returned.
Row: Indicates the cell row number.
Column: Indicates the cell column number.
Set Data Cell Value
Copy the value of a variable into a Data Grid cell.
Note: Rows and Column numbers start at "1".
Use the Row and Column variables to specify the cell. For example, using Row:2 and Column:3 would set the content in the cell located at the second horizontal row and the third vertical column.
Action variables:
Data Grid source: The Data Grid source to use.
Variable: Variable the content should be copied from.
Row: Indicates the cell row number.
Column: Indicates the cell column number.
Store Variable(s) in Grid
Stores one or more variables into 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.
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.
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.
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.
Tip: This action is typically used to create a row header in a Data Grid.
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.
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. However 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.
Action variables:
Data Grid source: The Data Grid source to be cleared.
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. Use comma's to separate row numbers, dashes (-) to indicate a row range. Do not use spaces.
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.
Action variables:
Data Grid source: The Data Grid used for the action.
Row: The row(s) to delete.
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. Use comma's to separate row numbers, dashes (-) to indicate a row range. Do not use spaces.
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.
Action variables:
Data Grid source: The Data Grid used for the action.
Column: The column(s) to delete.
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.
Action variables:
Data Grid source: The Data Grid source to use.
Data Grid to append: The column number used to sort the rows in the grid.
Find in Data Grid
Finds the string in the Text To Find property. The matching is done in column Column Number. The row number containing the match is returned in property Result Row. The first row is indicated by a "1". 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.
Note: The data grid is sorted at the indicated column before the search is done. A binary (fast) search is done at the grid.
Action variables:
Data Grid source: The Data Grid source to use.
Text to find: The text to erach 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.
Compare Grids
Compares one Data Grid to another and gives back the desired set of results in the Resulting Data Grid property. Text in the grid is compared at the indicated column number (Compare Rows at column number).
The Result Contains property determines the resulting set after comparing the grids. You can obtain sets containing the difference between the grids, a set containing matching rows in the set, or a set of rows missing in one grid which are present in the other. The set is returned in the
Resulting Data Grid property.
Note: The grids are sorted before the data grids are compared.
Action variables:
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: "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
"Occurences in grid 1 missing in grid 2": returns rows occuring in grid 1 that are not found in grid 2
"Occurences in grid 2 missing in grid 1": returns rows occuring in grid 2 that are not found in grid 1.
Resulting DataGrid: The resulting set of rows is returned here.
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.
Comapre Column Number: The column number used to seek duplicates.
SQL Database
Connect to MSSQL
Open a connection to a Microsoft SQL database.
Use the SQL Query Direct action for direct SQL update and insert statements, or use the SQL Record Set actions to loop through a record set after a SQL select statement.
When using a record set, use the following basic structure:
Connect
SQL Query for Records
... do actions like Loop Data Grid Rows...
Disconnect
When connecting to a database to run "
SQL Query Direct" action, use the following basic structure:
... do actions...
Connect
SQL Query Direct
Disconnect
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.
Connect to MySQL
Open a connection to a MySQL database.
Use the SQL Query Direct action for direct SQL update and insert statements, or use the SQL Record Set actions to loop through a record set after a SQL select statement.
When using a record set, use the following basic structure:
Connect
SQL Query for Records
... do actions like Loop Data Grid Rows...
Disconnect
When connecting to a database to run "
SQL Query Direct" action, use the following basic structure:
... do actions...
Connect
SQL Query Direct
Disconnect
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.
Connect to Oracle
Open a connection to a Oracle database.
Use the SQL Query Direct action for direct SQL update and insert statements, or use the SQL Record Set actions to loop through a record set after a SQL select statement.
When using a record set, use the following basic structure:
Connect
SQL Query for Records
... do actions like Loop Data Grid Rows...
Disconnect
When connecting to a database to run "
SQL Query Direct" action, use the following basic structure:
... do actions...
Connect
SQL Query Direct
Disconnect
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.
Connect to Informix
Open a connection to a Informix database.
Use the SQL Query Direct action for direct SQL update and insert statements, or use the SQL Record Set actions to loop through a record set after a SQL select statement.
When using a record set, use the following basic structure:
Connect
SQL Query for Records
... do actions like Loop Data Grid Rows...
Disconnect
When connecting to a database to run "
SQL Query Direct" action, use the following basic structure:
... do actions...
Connect
SQL Query Direct
Disconnect
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.
Connect to DB2
Open a connection to a DB2 database.
Use the SQL Query Direct action for direct SQL update and insert statements, or use the SQL Record Set actions to loop through a record set after a SQL select statement.
When using a record set, use the following basic structure:
Connect
SQL Query for Records
... do actions like Loop Data Grid Rows...
Disconnect
When connecting to a database to run "
SQL Query Direct" action, use the following basic structure:
... do actions...
Connect
SQL Query Direct
Disconnect
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.
Disconnect
Close a connection to a SQL database.
Note: When a SQL Record Set is being used, the close action automatically applies changes made to the current record set to the database.
Action variables:
SQL Database: The SQL Database source connection that should be closed.
SQL Query Direct
Execute a SQL query directly without returning in a record set in memory.
Note: Changes made by the query are reflected in the database immediately.
Tip: SQL Query Direct is typically used for updating a database or adding new records.
When connecting to a database to run a "
SQL Query Direct" action, use the following basic structure:
... do actions...
Connect
SQL Query Direct
Disconnect
Always first use a "
Connect" action to connect to the server. Next you run a "
SQL Query Direct" action. Use "
Disconnect" action as the last action to close the database connection.
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'").
SQL Record Set
SQL Query for Records
Execute a SQL query and returns a record set in memory linked to the database connection.
Record sets can be looped with Loop Records. Field values can be set or read with Get and Set Field actions.
Note: Record sets are commited back to the database with the Commit Changes action or on the Disconnect.
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 the
Disconnect action is called.
Action variables:
Database source: The SQL Database source to query.
Query: The SQL query (for example "select * from table1").
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 for example.
Note: Changes will be applied to the database after a Disconnect or Commit Changes action, or after 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.
Note: Changes will be applied to the database after a Disconnect or Commit Changes action, or after a Loop Records has finished.
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.
Note: Changes will be applied to the database after a Disconnect or Commit Changes action, or after a Loop Records has finished.
Action variables:
Database source: The SQL Database source connection to use.
Field Name or Column nr: The exact field name as in the database or the column number (first column in the record is zero).
Variable: 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.
Use the "Field Name or Column number" property to indicate which field in the record is to be used.
Note: Changes will be applied to the database after a Disconnect or Commit Changes action, or after a Loop Records has finished.
Action variables:
Database source: The SQL Database source connection to use.
Field Name or Column nr: The exact field name as in the database or the column number (first column in the record is zero).
Value: The field value to be set.
Commit Changes
Apply any changes to the active record set into the database. Use this action to force a commit to the database.
Note: When a Loop Records has finished or Disconnect action is invoked, changes to the database will be commited automatically.
Action variables:
Database source: The SQL Database source connection to commit changes to.
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.
Copy Query to Data Grid
Copy the complete content of the 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 mached with '#13#' or by a wildcard '*'.
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.
The
Find Text in Source action, like
Copy Text from Source and
Insert Text in Source are
Source Text Manipulation actions. Meaning they operate on a source with a cursor position, while normal
Text Manipulation actions like
Copy Text do also work with sources but without a cursor position.
A cursor position in a source is remembered and used the next time you use a
Source Text Manipulation action. This is typically used when collecting a structure of data from HTML table in a loop action for example.
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'.
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*>'. Line breaks in a source must also be mached with '#13#' or by a wildcard '*'.
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.
The
Copy Text from Source action, like
Insert Text in Source are
Source Text Manipulation actions. Meaning they operate on a source with a cursor position, while normal
Text Manipulation actions like
Copy Text do also work with sources but without a cursor position.
A cursor position in a source is remembered and used the next time you use a
Source Text Manipulation action. This is typically used when collecting a structure of data from HTML table in a loop action for example.
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.
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
Copy text between a "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 mached with '#13#' or by a wildcard '*'.
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.
The
Copy Text from Source Between action, like
Copy Text from Source and
Insert Text in Source are
Source Text Manipulation actions. Meaning they operate on a source with a cursor position, while normal
Text Manipulation actions like
Copy Text do also work with sources but without a cursor position.
A cursor position in a source is remembered and used the next time you use a
Source Text Manipulation action. This is typically used when collecting a structure of data from HTML table in a loop action for example.
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.
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.
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.
The
Insert Text in Source action, like
Copy Text from Source are
Source Text Manipulation actions. Meaning they operate on a source with a cursor position, while normal
Text Manipulation actions like
Copy Text do also work with sources but without a cursor position.
A cursor position in a source is remembered and used the next time you use a
Source Text Manipulation action.
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'.
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 all occurrences of a text from the current cursor position in the source with a new text.
Tip: This actions supports one or more astrix ('*') wildcard for a copy like from '<TR*>*Name:' to '</TR>'. Line breaks in a source must also be matched with '#13#' or by a wildcard '*'.
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.
The
Replace Text in Source action, like
Copy Text from Source are
Source Text Manipulation actions. Meaning they operate on a source with a cursor position, while normal
Text Manipulation actions like
Copy Text do also work with sources but without a cursor position.
A cursor position in a source is remembered and used the next time you use a
Source Text Manipulation action.
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.
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. The "Mached Text" is returned in a variable.
Tip: More info on regular expressions can be found at: http://www.regular-expressions.info
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.
The
Match Text in Source action, like
Copy Text from Source are
Source Text Manipulation actions. Meaning they operate on a source with a cursor position, while normal
Text Manipulation actions like
Copy Text do also work with sources but without a cursor position.
A cursor position in a source is remembered and used the next time you use a
Source Text Manipulation action.
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 Succeeded: 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.
Text Manipulation
Replace Text
Replace a single or all occurrences of a text with another text in a source or variable.
Note: This text is case sensitive.
Tip: This action supports an '*' as wildcard.
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 occurenses.
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. If the text was not found, "Result Position" is set to 0.
A 'position' is the 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.
Tip: This actions supports one or more asterix ('*') wildcard for a search text like '<TR*>*Name:'. Line breaks in a source must also be mached with '#13#' or by a wildcard '*'.
Action variables:
Source text: A source or variable to use for this action.
Text To Find: Text to find in the content.
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".
A 'position' is the 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.
Tip: This actions supports one or more asterix ('*') wildcard for a search text like '<TR*>*Name:'. Line breaks in a source must also be mached with '#13#' or by a wildcard '*'.
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.
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:'. Line breaks in a source must also be mached with '#13#' or by a wildcard '*'.
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.
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 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.
Example: '<B>Hello <I>World</I></B>' would become 'Hello World'.
Action variables:
Text variable: A text variable that should have all HTML tags removed.
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 variabless:
Number variable: The number variable to be formatted.
Format specification: 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 ' ' to a space.
Tip: See the more info for examples.
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 unencoded.
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 (&); all other characters are encoded using the hexadecimal ampersand format (&#xHHHH;).
Example: "& € f ? ?" encodes to "& € φ д 联"
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: "& € φ д 联" 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 separatoror: Type of date separator to be used.
Time separatoror: Type of time separator to be used.
Currency: Currency symbol to be used in the script.
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 DateTime 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
Maps 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 "Returned Match" is returned in a text variable.
Tip: More information on regular expressions can be found at: http://www.regular-expressions.info
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 Number: 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 Succeeded: If a match was successful, this variable is set to "Yes". If it was unsuccessful, it is set to "No".
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.
Tip: More info on regular expressions can be found at: http://www.regular-expressions.info
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.
Fuzzy Compare
Compares one string to another and gives back a match score as a number. The number is used to determine how similar or dissimilar one string is compared to another. For determing the best fuzzy match from a list, use the Fuzzy Best Match action instead.
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.
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.
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.
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 stringin the
Text property. The
Scoreis 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.
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.
Fuzzy Best Match in DataGrid
Finds the best (fuzzy) match in a data grid column. The best matching string in the list is returned.
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 stringin the
Text property. The
Scoreis 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.
Action variables:
Input text: A text string.
Data Grid: A Grid to compare the text string with.
Column Number: A Data Grid Column number to use for comparisment.
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.
Date and Time
Set Date-Time
Sets 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.
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 in the 'Variables' group 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:
DateTime variable: A DateTime 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:
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.
Subtract from Date-Time
Substracts 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 substract.
Month: A number of months to substract.
Year: A number of years to substract.
Hour: A number of hours to substract.
Minutes: A number of minutes to substract.
Seconds: A number of seconds to substract.
Date-Time Span
Give the time span 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. 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.
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.
Month: The span in months.
Days: The span in days.
Hours: The span in hours.
Minutes: The span in minutes.
Seconds: The span in seconds.
Date-Time Fractional Span
Give 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.
Month: The span in months.
Days: The span in days.
Hours: The span in hours.
Minutes: The span in minutes.
Seconds: The span in seconds.
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.
This action supports CSV with comma, semi-colon and tab as separators.
Action variables:
File name: 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.
Export to CSV
Export a Data Grid source to a Comma Separated Values (CSV) file.
CSV files with comma, semi-colon and tab as separators are supported.
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.
Write Line to CSV
Very fast method to append lines to a CSV 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: 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: 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.
Note: The first Excel sheet is always used for import.
This action supports Excel 97, 2000 and 2003 formats.
For Excel 2007 format, please see the separate action for this format.
Action variables:
File name: 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 Excel
Export data from a Data Grid source to an Excel file.
The exported file is readable in Excel versions 97, 2000 and 2003.
Action variables:
File name: 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.
This action only supports Excel 2007 format, please see the separate actions for other Excel formats.
Action variables:
File name: 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.
The exported file is readable in Excel version 2007.
Action variables:
File name: 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 file and put the contents in a Data Grid source.
This action supports Access 97, 2000 and 2003 formats.
Action variables:
File name: 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 file in Excel format.
The exported file is readable in Access versions 97, 2000 and 2003.
Action variables:
File name: 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 "ExportResult" 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.
This action supports DBF and FoxPro formats.
Action variables:
File name: 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: 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: 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: 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 name: The existing file or folder that should be renamed.
New name: 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:
Folder Name: 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: 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.
Get File Path Information
Retrieves various information about a the path of a given file, like drive, file extension, etc.
Action variables:
File name: 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.
File name: 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.
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.
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.
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.
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.
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.
Send Mail Raw
Send a raw e-mail message file to a smtp host.
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.
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.
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 extact title of the Window dialog.
Success: 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.
Copy to Clipboard
Put a variable or source content in the Windows clipboard.
This is a typical action used in debugging a script.
Action variables:
Text: The variable or source from which the content should be copied to the clipboard.
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.
Registry data: 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, please 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 webserver 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 thrid <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 Interaction actions instead.
Reads the content from a HTML tag.
The position of the cursor in the Source is remembered. This means that by calling this action multiple times you can read subsequent tags to get their content.
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.
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.
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.
Example: If the form element looks like "<INPUT Name="usr_name">".
Setting the name to the value "John" is done by settting Field Name to "usr_name" and Value to John.
Tip: The Djuggler Web Inspector can inspect the tag information needed for this action.
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.
Tip: The date format is based on the computer locale settings. Use the Extract from Date-Time action to convert independent from locale settings.
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.
Note: The time format is based on the computer locale settings. Use the Extract from Date-Time action to convert independent from locale settings.
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.
If the Source is a Web Page for example, the HTML source of the Web Page is copied to the 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.
If the Source is a Text File for example, current content of Variable would be copied to the Text File.
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.
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 compariment.
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 whitch 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 a certain condition, 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 whitch 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:
No variables need to be set for this action.
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.
Structure example:
If ...
... do actions ...
Else
... do actions ...
End If
Action variables:
No variables need to be set for this action.
Go to Label
Jumps to a Label action in the script and executes lines from there until a Return action is encountered.
The "Label name" property value should match the exact name of the label to jump to. Use the Return 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.
Labels are typically used if a script has a block of actions that are repeated two or more times in a script. By using the label method the number of script lines can be reduced and the script logic will improve. Another approach is simplifying complex scripts by creating a label for each specific task in the script. At the beginning of the script all labels are called with the Go to Label action in the order the tasks should be performed.
Action variables:
Label name: The (exact) name of the label to jump to.
Structure example 1:
... actions ...
Go to Label UpdateLogFile
... actions ...
Go to Label UpdateLogFile
... actions ...
Stop Script Execution
Label UpdateLogFile
... actions ...
Return
Structure example 2:
Go to Label GetPriceInformation
Go to Label ComparePrices
Go to Label SaveResults
Stop Script Execution
Label GetPriceInformation
... actions ...
Return
Label ComparePrices
... actions ...
Return
Label SaveResults
... actions ...
Return
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 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.
Tip: When using labels to create 'procedures' at the end of a script, use a Stop Script Execution action before the labels.
Labels are typically used if a script has a block of actions that are repeated two or more times in a script. By using the label method the number of script lines can be reduced and the script logic will improve. Another approach is simplifying complex scripts by creating a label for each specific task in the script. At the beginning of the script all labels are called with the Go to Label action in the order the tasks should be performed.
Structure example 1:
... actions ...
Go to Label UpdateLogFile
... actions ...
Go to Label UpdateLogFile
... actions ...
Stop Script Execution
Label UpdateLogFile
... actions ...
Return
Structure example 2:
Go to Label GetPriceInformation
Go to Label ComparePrices
Go to Label SaveResults
Stop Script Execution
Label GetPriceInformation
... actions ...
Return
Label ComparePrices
... actions ...
Return
Label SaveResults
... actions ...
Return
Tip: Labels can be nested in the script logic.
Return
Use the Return action to indicate the end of label and jump back to position where the Label was called with a Go to label action.
Action variables:
No variables need to be set for this action.
Structure example 1:
... actions ...
Go to Label UpdateLogFile
... actions ...
Go to Label UpdateLogFile
... actions ...
Stop Script Execution
Label UpdateLogFile
... actions ...
Return
Structure example 2:
Go to Label GetPriceInformation
Go to Label ComparePrices
Go to Label SaveResults
Stop Script Execution
Label GetPriceInformation
... actions ...
Return
Label ComparePrices
... actions ...
Return
Label SaveResults
... actions ...
Return
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.
Loops
Loop
The Loop action is a simple infinite loop untill 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:
No variables need to be set for this action.
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.
File name: 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.
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 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.
File Mask: Specify an optional file mask. For example "*.txt" to loop only files with the extension txt.
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 Web Pages
Loops Web Pages with a typical "Next" button. The "Next Page Button Recorder" is used to identity a "Next" page button.
A Loop Web Pages action should always be proceeded by a Get Web Page using the DOM source to set the initial Web Page in which the click to the next page is performed.
Tip: The source obtained by Loop Web Pages is the DOM source and might slightly differ from source obtained via the "view source option" in Internet Explorer or other browsers. The Read Next Link by Title action in combination with a simple Loop action can be used as an alternative for the Loop Web Pages action using the HTML source.
Web pages with a next page structure like: "
1|2|3 >Next" can be looped until the last page using this action. The Next link is identified using the Button recorder behind the three dots. The recorder opens in a new browser window.
Using the Next Page Button Recorder:
1. Put the URL for the first page in the navigation edit box and press the "
Go" button. The first page with the Next link structure is loaded in the browser pane.
2. Press the
Record button on the right and then click on the
Next link in the actual browser pane. The HTML tag identifing the Next link is shown on the right pane.
3. Press the
Save Recording and Exit button to save the recording and close the browser window.
Action variables:
Web Page: The Web Page Source that should be used.
Next Page Button Recorder: Clicking on the button with the three dots will open up a special web browser for recording the "Next page button".
Structure example using Loop Web Pages:
Get Web page ... using DOM source
Loop Web Pages
... actions ...
End Loop
Structure example using Read Next Link by Title:
Get Web page ... using HTML source
Loop
Read Next Link by Title
If Condition aLink is Empty
Exit Loop
End Loop
... actions ...
End Loop
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. An End Loop action is needed to close the loop in the script logic.
Tip: To loop a sorted list, use the Sort List action before the loop.
Action variables:
List variable: The List variable containing list items.
Result variable for Item: With each pass of the loop, the result variable is filled with the current item content.
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. An End Loop action is needed to close the loop in the script logic.
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.
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. An End Loop action is needed to close the loop in the script logic.
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 the 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'.
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'.
Action variables:
XML Document source: The XML Document source to be used.
Start at: The starting point from which to start searching in the XML tree.
Look for: 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.
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: The starting point from which to start searching in the XML tree.
Look for: 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.
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 Succeeded 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: The full path and name of the file to be read.
Read Line variable: Contains the line content of the file with each pass of the loop.
Structure example:
Loop Text File Lines
... actions using the Read Line property 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 for Records action.
The loop starts with the first record in the record set and runs until the last record is reached.
Note: When the loop finishes it will apply any changes made in the record set to the database automatically.
When using a record set, use the following basic structure:
Connect
SQL Query for Records
Loop Records
... actions like Get Field Value...
End Loop
Disconnect
Action variables:
SQL Database: The SQL Database source connection to use.
End Loop
Each Loop action needs an End Loop action to indicate the end of the loop.
Structure example:
Loop While ...
... actions ...
End Loop
Action variables:
No variables need to be set for this action.
Exit Loop
Forces an exit in a loop and is often used in combination with an If or If Condition action.
Action variables:
No variables need to be set for this action.
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 seperator.
Wait
Puases the execution of the script for a number of miliseconds.
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 500 miliseconds 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.
Action variables:
No variables need to be set for this action.
On Error Go to Label
Jumps to a specified label when the script encounters an error.
Tip: When the Supress Errors & Dialogs action is used this action can be used to catch and handle script errors.
Action variables:
Label name: The label 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 Supress Errors & Dialogs action is used this action can be used to catch and handle script errors.
Action variables:
Result variable: This variable gets filled with a description of the last encountered 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.
Typically used before Label actions or when the script encounters a condition it should stop at all times.
Action variables:
No variables need to be set for this action.
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.
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.
Action variables:
No variables need to be set for this action.
Get Script Properties
Returns various script properties like the script path, script name, build version. It it also reveils information about the Djuggler version and edition used to create the script.
Action variabless:
Script Path: Returns the fiel 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: This action is typically used in a debug situation.
Action variables:
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 Grid Viewer
Shows or hides up Djuggler's internal grid viewer.
Note: This action is typically used in a debug situation.
Action variables:
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: This action is typically used in a debug situation.
Action variables:
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
Append a text line to a log file, including a date time stamp.
Note: This action is typically used in a debug situation.
Action variables:
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.
Missing action
When a script is loaded that is created by a more recent version of Djuggler a missing action statement will replace all unkown actions from the new Djuggler version.
Action variables:
No variables need to be set for this action.
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.
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:
Title text: The title for the dialog.
Answer variable: A 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.
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:
Title text: The title for the dialog.
Answer variable: A 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.
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:
Title text: The title for the dialog.
Answer variable: A variable where the directory 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.
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:
Visability: 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.
Visiablity: 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.
Max file size: The max size Kb for 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.
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 Data
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 or write to a log file.
Tip: Use this action to verify the content of variables before writing them to any output as a database or 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).
Match 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.
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)".
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)
Action variables:
Math Expression: The mathematical expression.
Result variable: A variable that holds the result of the expression.
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 (including path): The file where the list items should be read from.
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 variabless:
List variable: The List that should be saved.
File name: 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.
Add Item to List
AAdds 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 separted by an equal sign, like for example: "color=red", color is the name part and red is the value part.
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.
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.
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.
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 (including path): The file where the content should be read from.
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 (including path): The file in which the content should be saved.
Overwrite existing file: Select between 'Yes' or 'No' to overwrite an existing 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: The name of the file to write to.
Text line: Text line to be written to the end of the file.
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 (including path): The name of the file to write to.
Append text: Text to be written to the end of the file.
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: 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: 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'.
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'.
Action variables:
XML Document source: The XML Document source to be used.
Start at: The starting point from which to start searching in the XML tree.
Look for: 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.
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.
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.
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.
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).
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.
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 miliseconds.
Web Pages
Get Web Page
Opens a Web Page and puts the HTML content in the Web Page source as DOM or HTML source. The DOM source enables advanced actions like Click Form Element. The HTML source is the raw html as served by a web server.
HTML source is faster then the DOM source because only requests the source from a web server and won't request 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.
Tip: To inspect the source, use the Djuggler's Inspector from the menu and the Inspect button.
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 HTML source as served by the web server.
Browse Silently: Option for fast page loading the DOM source without load pictures and suppressing pop-up's and page error messages.
Time out: 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 supressed when DOM source is selected.
Proxy Address: Address used for a proxy.
Proxy Port: Port for a proxy address.
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 ampersants 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.
Post Data: a string of form variables and their values like 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.
Time out: 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 supressed when DOM source is selected.
Proxy Address: Address used for a proxy.
Proxy Port: Port for a proxy address.
Run Web Macro
Records and automates an entire "manual" browse action, complete with typed urls, mouse clicks and filled form fields.
The Web Inspector is launched in Recorder mode by clicking on the three dots behind the recorder property. The browse recording is started by clicking the Record button, followed by clicking the Stop button and Close.
When running a script, the exact sequence of events is replayed on the Web Page variable in this action. Note that this browsing is done from the current page in the Web Page variable.
Action variables:
Web Page: The Web Page source to be used.
Recorder: Opens the Web Inspector for recording. When a recording is successfully made 'Recorded' is displayed.
Browse Silently: Option for fast page loading the DOM source without load pictures and suppressing pop-up's and page error messages.
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.
File name: 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.
Tip: Use this action in a loop to collect all hyperlinks in a Web Page.
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.
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.
Tip: Use this action in a loop to collect all images in a Web Page.
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.
Save Image
Save an Image variable to disk. Typically used in combination with the Read Next Image action.
Note: When the File name is not specified, the File name from the image is used.
Action variables:
Image: Image variable to be saved.
Folder: A folder where the image should be saved.
File name: The File name that should be used.
Success variable: On a successful save action the variable will contain Yes, 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, based on table number or table that contains a specific text string.
The "Table Number" variable to indicates the HTML table to use. For example Table Number 3 will collect data from the thrid <TABLE> tag found in the HTML. As an alternative a table can be found based on a unique text string.
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. Yes or No is returned.
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: A syntax check on the URL. Yes or 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.
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.
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.
Success: A variable that holds Yes or No when the specified text has been found before the time out.
Time out: Time out for the action in seconds, after which the script will continue.
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: The number of milliseconds to wait before refreshing the source.
Clear IE Cache
Clears the Internet Explorer Cache.
Note: This action will also clear the cache for the regular IE browser.
Action variables:
No variables need to be set for this action.
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.
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 IE Version
Puts 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:
IE Version: Returns the IE version used on the computer running the script.
IE Major: Returns the IE Major version used on the comptuer running the script.
Execute JavaScript
Executes JavaScript in a Web Page source. This can either be an existing JavaScript function found in the HTML source or JavaScript in the action property.
Tip: The Execute JavaScript is used in combination with the Refresh Browser Source or Wait for Content action to handle AJAX enabled web sites. See the AJAX demo scripts.
Action variables:
Web Page: The Web Page source to use.
JavaScript code: The code or existing function in the HTML source to be executed.
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.
Complete Page Links
Completes all links (a href's) in a Web Page source's content.
Example: A link like "./support/index.htm"; would be translated into something like "http://www.mysite.com//support/index.htm".
Tip: Calling
Get Web Page after a
Complete Page Links action refills the Web Page source, so to complete all links in the new page, you would have to call
Complete Page Links again.
Action variables:
Source: The Web Page source where links should be completed.
Complete Relative URL
Completes a relative URL to a full URL.
Example: "./support.asp" is completed to "http://www.djuggler.com/support.asp".
Note that completion of a URL depends on the Web Page where it was obtained from. Always use the correct Web Page source to complete a URL.
Action variables:
Web Page: The Web Page source used to complete the relative URL.
Web Pages Interaction
Get Element Value
Retrieves the value (innerHTML) of a specified HTML tag. You can specify tag attribute/value combinations to indicate a specific tag.
If more than one tag matches the specifications the value of the first matching tag is returned.
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.
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: Contains errors messages or is empty if action completely successfully.
Get Element Text
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.
If more than one tag matches the spcifications, the value of the first matching tag is returned.
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.
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: Contains errors messages or is empty if action completely successfully.
Get Element Attribute Value
Retrieves an element attribute value of a specified HTML tag.
If more than one tags match the specification, the value of the first matching tag is returned.
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.
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: Contains errors messages or is empty if action completely successfully.
Set Element Value
Searches the first tag that matches the Tag Name, Attribute Name and Attribute Value. With the found tag, the the value (innerHTML) is set.
Tip: If you want to set an INPUT tag value like a typicall username box, use the Set (Form) Element Atribute Value action.
Note: 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><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>".
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: Contains errors messages or is empty if action completely successfully.
Set Element Attribute Value
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. When the tag is found, the value of the Attribute Name to set content for is set with Content. Be aware that more than one tag can match the specifications, so be as specific (use more attributes) as you can.
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>".
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: Contains errors messages or is empty if action completely successfully.
Click Element
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. When the tag is found, a mouse click on the element is performed. Be aware that more than one tag can match the specifications, so be as specific (use more attributes) as you can.
You can also leave empty the first Attribute Name and Attribute Value just to match on Tag Name.
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: Contains errors messages or is empty if action completely successfully.
Get Form Element Value
Retrieves the value (innerHTML) of a specified FORM tag. You can specify tag attribute/value combinations to indicate a specific tag.
If more than one tag matches the spcifications, the value of the first matching tag is returned. This action is similar to Get Element Value, but additionally you can specify form attributes (typically name="form1") to indicate the form. This makes this action more specific in indicating the right tag.
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.
Action variables:
Web Page: The Web Page source used to retrieve the tag.
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: Contains errors messages or is empty if action completely successfully.
Get Form Element Attribute Value
Retrieves the value of an attribute element from a Form tag.
If more than one tag matches the spcifications, the value of the first matching tag is returned.
This action is similar to Get Element Attribute Value, but in addition a specific form can be specified.
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.
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.
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: Contains errors messages or is empty if action completely successfully.
Set Form Element Value
Sets the value (innerHTML) of a specified FORM tag. You can specify tag attribute/value combinations to indicate a specific tag.
If more than one tag matches the specifications, the value of the first matching tag is returned. This action is similar to Set Element Value, but additionally you can specify form attributes (typically name="form1") to indicate the form. This makes this action more specific in indicating the right tag.
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>".
Action variables:
Web Page: The Web Page source used to set the tag.
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 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: Contains errors messages or is empty if action completely successfully.
Set Form Element Attribute Value
Sets the value of a specified FORM tag attribute. You can specify tag attribute/value combinations to indicate a specific tag.
If more than one tag matches the specifications, the value of the first matching tag is returned. This action is similar to Set Element Attribute Value, but additionally you can specify form attributes (typically name="form1") to indicate the form. This makes this action more specific in indicating the right tag.
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>".
Action variables:
Web Page: The Web Page source used to retrieve the tag.
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 content to fill the attribute value.
Content: 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: Contains errors messages or is empty if action completely successfully.
Click Form Element
Performs a mouse click on a certain element in an HTML page. Typically used to click on a submit button programmatically.
Tip: The Djuggler Web Inspector can inspect the tag information needed for this action.
Action variables:
Web Page: The Web Page source to use.
Element Tag: The type of the tag to be clicked, for example the INPUT tag.
Element Name: The name attribute of the tag.
Get Select Options
Gets all options from a SELECT element on a form and puts them in a list. This way you can build a loop that iterates all options in a SELECT dropdown. The action returns a list of option values and a list of option descriptions.
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".
Action variables:
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.
Set Select Option
Select a option from a SELECT element on a form. This way you can change a SELECT dropdown in a Web Page. Use either the option value or the option description to indicate which option you wish to select.
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.
Action variables:
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).
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".
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.
Action variables:
Data Grid source: The Data Grid source to use.
Variable: Text variable where the cell content should be returned.
Row: Indicates the cell row number.
Column: Indicates the cell column number.
Set Data Cell Value
Copy the value of a variable into a Data Grid cell.
Note: Rows and Column numbers start at "1".
Use the Row and Column variables to specify the cell. For example, using Row:2 and Column:3 would set the content in the cell located at the second horizontal row and the third vertical column.
Action variables:
Data Grid source: The Data Grid source to use.
Variable: Variable the content should be copied from.
Row: Indicates the cell row number.
Column: Indicates the cell column number.
Store Variable(s) in Grid
Stores one or more variables into 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.
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.
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.
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.
Tip: This action is typically used to create a row header in a Data Grid.
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.
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. However 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.
Action variables:
Data Grid source: The Data Grid source to be cleared.
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. Use comma's to separate row numbers, dashes (-) to indicate a row range. Do not use spaces.
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.
Action variables:
Data Grid source: The Data Grid used for the action.
Row: The row(s) to delete.
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. Use comma's to separate row numbers, dashes (-) to indicate a row range. Do not use spaces.
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.
Action variables:
Data Grid source: The Data Grid used for the action.
Column: The column(s) to delete.
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.
Action variables:
Data Grid source: The Data Grid source to use.
Data Grid to append: The column number used to sort the rows in the grid.
Find in Data Grid
Finds the string in the Text To Find property. The matching is done in column Column Number. The row number containing the match is returned in property Result Row. The first row is indicated by a "1". 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.
Note: The data grid is sorted at the indicated column before the search is done. A binary (fast) search is done at the grid.
Action variables:
Data Grid source: The Data Grid source to use.
Text to find: The text to erach 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.
Compare Grids
Compares one Data Grid to another and gives back the desired set of results in the Resulting Data Grid property. Text in the grid is compared at the indicated column number (Compare Rows at column number).
The Result Contains property determines the resulting set after comparing the grids. You can obtain sets containing the difference between the grids, a set containing matching rows in the set, or a set of rows missing in one grid which are present in the other. The set is returned in the
Resulting Data Grid property.
Note: The grids are sorted before the data grids are compared.
Action variables:
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: "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
"Occurences in grid 1 missing in grid 2": returns rows occuring in grid 1 that are not found in grid 2
"Occurences in grid 2 missing in grid 1": returns rows occuring in grid 2 that are not found in grid 1.
Resulting DataGrid: The resulting set of rows is returned here.
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.
Comapre Column Number: The column number used to seek duplicates.
SQL Database
Connect to MSSQL
Open a connection to a Microsoft SQL database.
Use the SQL Query Direct action for direct SQL update and insert statements, or use the SQL Record Set actions to loop through a record set after a SQL select statement.
When using a record set, use the following basic structure:
Connect
SQL Query for Records
... do actions like Loop Data Grid Rows...
Disconnect
When connecting to a database to run "
SQL Query Direct" action, use the following basic structure:
... do actions...
Connect
SQL Query Direct
Disconnect
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.
Connect to MySQL
Open a connection to a MySQL database.
Use the SQL Query Direct action for direct SQL update and insert statements, or use the SQL Record Set actions to loop through a record set after a SQL select statement.
When using a record set, use the following basic structure:
Connect
SQL Query for Records
... do actions like Loop Data Grid Rows...
Disconnect
When connecting to a database to run "
SQL Query Direct" action, use the following basic structure:
... do actions...
Connect
SQL Query Direct
Disconnect
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.
Connect to Oracle
Open a connection to a Oracle database.
Use the SQL Query Direct action for direct SQL update and insert statements, or use the SQL Record Set actions to loop through a record set after a SQL select statement.
When using a record set, use the following basic structure:
Connect
SQL Query for Records
... do actions like Loop Data Grid Rows...
Disconnect
When connecting to a database to run "
SQL Query Direct" action, use the following basic structure:
... do actions...
Connect
SQL Query Direct
Disconnect
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.
Connect to Informix
Open a connection to a Informix database.
Use the SQL Query Direct action for direct SQL update and insert statements, or use the SQL Record Set actions to loop through a record set after a SQL select statement.
When using a record set, use the following basic structure:
Connect
SQL Query for Records
... do actions like Loop Data Grid Rows...
Disconnect
When connecting to a database to run "
SQL Query Direct" action, use the following basic structure:
... do actions...
Connect
SQL Query Direct
Disconnect
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.
Connect to DB2
Open a connection to a DB2 database.
Use the SQL Query Direct action for direct SQL update and insert statements, or use the SQL Record Set actions to loop through a record set after a SQL select statement.
When using a record set, use the following basic structure:
Connect
SQL Query for Records
... do actions like Loop Data Grid Rows...
Disconnect
When connecting to a database to run "
SQL Query Direct" action, use the following basic structure:
... do actions...
Connect
SQL Query Direct
Disconnect
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.
Disconnect
Close a connection to a SQL database.
Note: When a SQL Record Set is being used, the close action automatically applies changes made to the current record set to the database.
Action variables:
SQL Database: The SQL Database source connection that should be closed.
SQL Query Direct
Execute a SQL query directly without returning in a record set in memory.
Note: Changes made by the query are reflected in the database immediately.
Tip: SQL Query Direct is typically used for updating a database or adding new records.
When connecting to a database to run a "
SQL Query Direct" action, use the following basic structure:
... do actions...
Connect
SQL Query Direct
Disconnect
Always first use a "
Connect" action to connect to the server. Next you run a "
SQL Query Direct" action. Use "
Disconnect" action as the last action to close the database connection.
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'").
SQL Record Set
SQL Query for Records
Execute a SQL query and returns a record set in memory linked to the database connection.
Record sets can be looped with Loop Records. Field values can be set or read with Get and Set Field actions.
Note: Record sets are commited back to the database with the Commit Changes action or on the Disconnect.
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 the
Disconnect action is called.
Action variables:
Database source: The SQL Database source to query.
Query: The SQL query (for example "select * from table1").
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 for example.
Note: Changes will be applied to the database after a Disconnect or Commit Changes action, or after 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.
Note: Changes will be applied to the database after a Disconnect or Commit Changes action, or after a Loop Records has finished.
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.
Note: Changes will be applied to the database after a Disconnect or Commit Changes action, or after a Loop Records has finished.
Action variables:
Database source: The SQL Database source connection to use.
Field Name or Column nr: The exact field name as in the database or the column number (first column in the record is zero).
Variable: 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.
Use the "Field Name or Column number" property to indicate which field in the record is to be used.
Note: Changes will be applied to the database after a Disconnect or Commit Changes action, or after a Loop Records has finished.
Action variables:
Database source: The SQL Database source connection to use.
Field Name or Column nr: The exact field name as in the database or the column number (first column in the record is zero).
Value: The field value to be set.
Commit Changes
Apply any changes to the active record set into the database. Use this action to force a commit to the database.
Note: When a Loop Records has finished or Disconnect action is invoked, changes to the database will be commited automatically.
Action variables:
Database source: The SQL Database source connection to commit changes to.
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.
Copy Query to Data Grid
Copy the complete content of the 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 mached with '#13#' or by a wildcard '*'.
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.
The
Find Text in Source action, like
Copy Text from Source and
Insert Text in Source are
Source Text Manipulation actions. Meaning they operate on a source with a cursor position, while normal
Text Manipulation actions like
Copy Text do also work with sources but without a cursor position.
A cursor position in a source is remembered and used the next time you use a
Source Text Manipulation action. This is typically used when collecting a structure of data from HTML table in a loop action for example.
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'.
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*>'. Line breaks in a source must also be mached with '#13#' or by a wildcard '*'.
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.
The
Copy Text from Source action, like
Insert Text in Source are
Source Text Manipulation actions. Meaning they operate on a source with a cursor position, while normal
Text Manipulation actions like
Copy Text do also work with sources but without a cursor position.
A cursor position in a source is remembered and used the next time you use a
Source Text Manipulation action. This is typically used when collecting a structure of data from HTML table in a loop action for example.
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.
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
Copy text between a "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 mached with '#13#' or by a wildcard '*'.
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.
The
Copy Text from Source Between action, like
Copy Text from Source and
Insert Text in Source are
Source Text Manipulation actions. Meaning they operate on a source with a cursor position, while normal
Text Manipulation actions like
Copy Text do also work with sources but without a cursor position.
A cursor position in a source is remembered and used the next time you use a
Source Text Manipulation action. This is typically used when collecting a structure of data from HTML table in a loop action for example.
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.
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.
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.
The
Insert Text in Source action, like
Copy Text from Source are
Source Text Manipulation actions. Meaning they operate on a source with a cursor position, while normal
Text Manipulation actions like
Copy Text do also work with sources but without a cursor position.
A cursor position in a source is remembered and used the next time you use a
Source Text Manipulation action.
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'.
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 all occurrences of a text from the current cursor position in the source with a new text.
Tip: This actions supports one or more astrix ('*') wildcard for a copy like from '<TR*>*Name:' to '</TR>'. Line breaks in a source must also be matched with '#13#' or by a wildcard '*'.
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.
The
Replace Text in Source action, like
Copy Text from Source are
Source Text Manipulation actions. Meaning they operate on a source with a cursor position, while normal
Text Manipulation actions like
Copy Text do also work with sources but without a cursor position.
A cursor position in a source is remembered and used the next time you use a
Source Text Manipulation action.
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.
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. The "Mached Text" is returned in a variable.
Tip: More info on regular expressions can be found at: http://www.regular-expressions.info
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.
The
Match Text in Source action, like
Copy Text from Source are
Source Text Manipulation actions. Meaning they operate on a source with a cursor position, while normal
Text Manipulation actions like
Copy Text do also work with sources but without a cursor position.
A cursor position in a source is remembered and used the next time you use a
Source Text Manipulation action.
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 Succeeded: 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.
Text Manipulation
Replace Text
Replace a single or all occurrences of a text with another text in a source or variable.
Note: This text is case sensitive.
Tip: This action supports an '*' as wildcard.
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 occurenses.
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. If the text was not found, "Result Position" is set to 0.
A 'position' is the 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.
Tip: This actions supports one or more asterix ('*') wildcard for a search text like '<TR*>*Name:'. Line breaks in a source must also be mached with '#13#' or by a wildcard '*'.
Action variables:
Source text: A source or variable to use for this action.
Text To Find: Text to find in the content.
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".
A 'position' is the 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.
Tip: This actions supports one or more asterix ('*') wildcard for a search text like '<TR*>*Name:'. Line breaks in a source must also be mached with '#13#' or by a wildcard '*'.
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.
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:'. Line breaks in a source must also be mached with '#13#' or by a wildcard '*'.
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.
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 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.
Example: '<B>Hello <I>World</I></B>' would become 'Hello World'.
Action variables:
Text variable: A text variable that should have all HTML tags removed.
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 variabless:
Number variable: The number variable to be formatted.
Format specification: 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 ' ' to a space.
Tip: See the more info for examples.
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 unencoded.
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 (&); all other characters are encoded using the hexadecimal ampersand format (&#xHHHH;).
Example: "& € f ? ?" encodes to "& € φ д 联"
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: "& € φ д 联" 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 separatoror: Type of date separator to be used.
Time separatoror: Type of time separator to be used.
Currency: Currency symbol to be used in the script.
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 DateTime 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
Maps 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 "Returned Match" is returned in a text variable.
Tip: More information on regular expressions can be found at: http://www.regular-expressions.info
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 Number: 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 Succeeded: If a match was successful, this variable is set to "Yes". If it was unsuccessful, it is set to "No".
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.
Tip: More info on regular expressions can be found at: http://www.regular-expressions.info
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.
Fuzzy Compare
Compares one string to another and gives back a match score as a number. The number is used to determine how similar or dissimilar one string is compared to another. For determing the best fuzzy match from a list, use the Fuzzy Best Match action instead.
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.
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.
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.
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 stringin the
Text property. The
Scoreis 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.
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.
Fuzzy Best Match in DataGrid
Finds the best (fuzzy) match in a data grid column. The best matching string in the list is returned.
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 stringin the
Text property. The
Scoreis 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.
Action variables:
Input text: A text string.
Data Grid: A Grid to compare the text string with.
Column Number: A Data Grid Column number to use for comparisment.
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.
Date and Time
Set Date-Time
Sets 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.
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 in the 'Variables' group 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:
DateTime variable: A DateTime 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:
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.
Subtract from Date-Time
Substracts 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 substract.
Month: A number of months to substract.
Year: A number of years to substract.
Hour: A number of hours to substract.
Minutes: A number of minutes to substract.
Seconds: A number of seconds to substract.
Date-Time Span
Give the time span 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. 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.
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.
Month: The span in months.
Days: The span in days.
Hours: The span in hours.
Minutes: The span in minutes.
Seconds: The span in seconds.
Date-Time Fractional Span
Give 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.
Month: The span in months.
Days: The span in days.
Hours: The span in hours.
Minutes: The span in minutes.
Seconds: The span in seconds.
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.
This action supports CSV with comma, semi-colon and tab as separators.
Action variables:
File name: 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.
Export to CSV
Export a Data Grid source to a Comma Separated Values (CSV) file.
CSV files with comma, semi-colon and tab as separators are supported.
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.
Write Line to CSV
Very fast method to append lines to a CSV 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: 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: 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.
Note: The first Excel sheet is always used for import.
This action supports Excel 97, 2000 and 2003 formats.
For Excel 2007 format, please see the separate action for this format.
Action variables:
File name: 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 Excel
Export data from a Data Grid source to an Excel file.
The exported file is readable in Excel versions 97, 2000 and 2003.
Action variables:
File name: 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.
This action only supports Excel 2007 format, please see the separate actions for other Excel formats.
Action variables:
File name: 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.
The exported file is readable in Excel version 2007.
Action variables:
File name: 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 file and put the contents in a Data Grid source.
This action supports Access 97, 2000 and 2003 formats.
Action variables:
File name: 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 file in Excel format.
The exported file is readable in Access versions 97, 2000 and 2003.
Action variables:
File name: 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 "ExportResult" 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.
This action supports DBF and FoxPro formats.
Action variables:
File name: 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: 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: 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: 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 name: The existing file or folder that should be renamed.
New name: 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:
Folder Name: 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: 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.
Get File Path Information
Retrieves various information about a the path of a given file, like drive, file extension, etc.
Action variables:
File name: 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.
File name: 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.
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.
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.
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.
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.
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.
Send Mail Raw
Send a raw e-mail message file to a smtp host.
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.
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.
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 extact title of the Window dialog.
Success: 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.
Copy to Clipboard
Put a variable or source content in the Windows clipboard.
This is a typical action used in debugging a script.
Action variables:
Text: The variable or source from which the content should be copied to the clipboard.
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.
Registry data: 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, please 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 webserver 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 thrid <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 Interaction actions instead.
Reads the content from a HTML tag.
The position of the cursor in the Source is remembered. This means that by calling this action multiple times you can read subsequent tags to get their content.
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.
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.
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.
Example: If the form element looks like "<INPUT Name="usr_name">".
Setting the name to the value "John" is done by settting Field Name to "usr_name" and Value to John.
Tip: The Djuggler Web Inspector can inspect the tag information needed for this action.
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.
Tip: The date format is based on the computer locale settings. Use the Extract from Date-Time action to convert independent from locale settings.
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.
Note: The time format is based on the computer locale settings. Use the Extract from Date-Time action to convert independent from locale settings.
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.
If the Source is a Web Page for example, the HTML source of the Web Page is copied to the 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.
If the Source is a Text File for example, current content of Variable would be copied to the Text File.
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.