Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NameDescription
Iterator Method
  • Method to load the dataset.
  • Choose to load records either by using a Process Tool or from Datalist
List
  • Choose list to retrieve dataset from.
  • This option is needed when "Iterator Method" is set to "Datalist".
Iterator Process Tool
  • Choose a process tool to retrieve the dataset from.
  • Process Tool must

return 
  • return a collection of map as dataset.

    Code Block
    languagejava
    titleSample Bean Shell Code
    linenumberstrue
    import org.joget.commons.util.LogUtil;
    import java.util.Collection;
    import java.util.Map;
    
    Collection col = new ArrayList();
    
    Map map = new HashMap();
    map.put("id", "1");
    map.put("name", "Alice");
    col.add(map);
    
    map = new HashMap();
    map.put("id", "2");
    map.put("name", "George");
    col.add(map);
    
    return col;
    
    
  • You may use "Database Query Process Tool" bundled with this plugin to enter a SQL query string.
  • This option is needed when "Iterator Method" is set to "Process Tool".
Record ID

Specify which column to be used as record ID / primary key from the dataset.

Code Block
languagejava
titleExample
linenumberstrue
id

Execute Process Tool

NameDescription
Process Tool
  • With the dataset loaded, the plugin will iterate through each record
,
  • and set the record or assignment as the context, and execute the process tool defined here.
For correct parsing of hash variable,
  • In the plugin configuration, when using hash variable, instead of using # to encapsulate, please replace # with $$ in your plugin for parsing to take place in the correct context. For examples:-
EXAMPLE -
EXAMPLE -
    • Code Block
      languagejava
      titleExample
      linenumberstrue
      $$form.request.name$$
    • Record mode, use $$form.request.name[@recordId@]$$.

      Code Block
      languagejava
      titleExample
      linenumberstrue
      $$form.
EXAMPLE -
    • request.name[@recordId@]$$
    • Retrieve values from iterator's dataset, use {columnName}.

      Code Block
      languagejava
      titleExample
      linenumberstrue
      {id}
      Code Block
      languagejava
      titleExample
      linenumberstrue
      {name}

Advanced

NameDescription
Debug ModeTurn this mode on to print out debugging information to the server log.
Delay Between Execution
  • Introduce a delay of 1 second between each record.
  • This option is useful in some use cases such as sending out email emails to prevent hitting the send limit per second.

...