Read and Review Automation Anywhere Documentation

Automation 360

Close Contents


Open Contents

Add an iterator in a custom package for Loop action

  • Updated: 2022/05/20
    • Automation 360 v.x
    • Build
    • RPA Workspace

Add an iterator in a custom package for Loop action

Add an iterator in your package for Loop action.

Add an iterator to a Loop action

  • To create an iterator, set commandType property of BotCommand annotation with value as Iterator.
  • There are two methods required by iterator, and they are defined by HasNext, and Next annotations.
@BotCommand(commandType = BotCommand.CommandType.Iterator)
@CommandPkg(name = "loop.iterators.files",
        label = "For each file in folder",
        node_label = "for each file and assign file name and extension to {{returnTo}}",
        description = "Iterator for each file in folder.",
        return_type = DataType.DICTIONARY,
        return_sub_type = DataType.STRING,
        return_required = true,
        return_description = "Note: Access the 'name' key to access file name and 'extension' 
        key to access the file extension.",
        return_label = "Assign file name and extension to this variable")
public class FileLoop extends AbstractCommandFileIterator {
    @Idx(index = "1", type = AttributeType.TEXT)
    @Pkg(label = "Folder path")
    private String folderPath;
    public boolean hasNext() {
        return getFileIterator(folderPath).hasNext();
    public Value<?> next() {
        Map<String, Value> returnValueMap = new HashMap<>();
        FileIterator fileIterator = getFileIterator(folderPath);
        String fileName = fileIterator.getNext();
        returnValueMap.put(FILE_NAME, new StringValue(fileIterator.getFileName(fileName)));
        returnValueMap.put(EXTENSION, new StringValue(fileIterator.getExtension(fileName)));
        return new DictionaryValue(returnValueMap);
    public void setFolderPath(String folderPath) {
        this.folderPath = folderPath;
Send Feedback