APL Collection Strategy configurations are used on top of pre-defined collection strategies to customize how files are collected from the local file system.

The following functions blocks may be used in the APL Collection Strategy code:

The initialize, deinitialize, begin, commit, and rollback function blocks are equivalent to the corresponding APL function blocks described in Function Blocks.

The collection specific functions blocks are invoked in the following order:

1. prepareBaseDirList
2. accept
3. filterFiles
4. preFileCollection
5. postFileCollection

The initialize function block is used to prepare for the collection and set up an environment to be used in a later stage, when the batch workflow is executed.

void initialize()

The deinitialize function block is used to clean-up and close resources.

void deinitialize()

prepareBaseDirList

The prepareBaseDirList function block prepares for a list of base directories. A base directory is the directory that includes the files to be collected. This directory is defined when configuring an agent's Base Collection Strategy. Base directory paths can be added, removed, and modified.

The prepareBaseDirList function block is invoked by the Collection agent right after the collection preparation activities that were initiated by the initialize function.

void prepareBaseDirList( list<string>  dirList  )

void prepareBaseDirList(list<string> dirList) {
    string dir = listGet(dirList, 0);
    string subDir = dir + "/sub";
    listAdd(dirList, subDir);
}

accept

The collection agent processes the base directory and its included files and creates an internal file list including all files to be collected. The accept function block is invoked by the collection agent each time a new file is about to be added to the list, and, based on each file's fileInfo object, either accepts or rejects the file.

boolean accept
( FileInfo  file  )

boolean accept(FileInfo file) {
    if(file.isFile) { 
        if ( strStartsWith(file.name, "INFILE_ascii") ) {
            return true;
        } else {
            return false;
        }
     } else{
        return false;
    }
}

filterFiles

The filterFiles function block is invoked by the collection agent right after the accept function has been executed and when the list of files has been created. Files to collect can be removed, but not added or modified. Collection order can be modified by sorting the list.

void filterFiles
( list<FileInfo>  fileInfoList  )

Parameter:

In the following example, file1 is not collected if there is another file with the same name that includes the prefix "ignore_" (ignore_file1) in the collected directory.

void filterFiles(list<FileInfo> fileInfoList) {

    // put the files into a map
    string ignorePrefix = "ignore_";
    map<string, FileInfo> fileInfoMap = mapCreate(string, FileInfo);
    int i = listSize(fileInfoList);
    while(i > 0) {
        i = i - 1;
        FileInfo fileInfo = listGet(fileInfoList, i);
        mapSet(fileInfoMap, fileInfo.name, fileInfo);
    }
    
    // Remove from the map files that are indicated as files 
    // that should be ignored, along with their ignore_ indicator 
    // files .
    
    i = listSize(fileInfoList);
    while(i > 0) {
        i = i - 1;
        FileInfo fileInfo = listGet(fileInfoList, i);
        
        // check if the filename start with the ignore prefix
        boolean ignore = strStartsWith(fileInfo.name, ignorePrefix);
        
        if(ignore) {
            string fileToIgnore = strSubstring(fileInfo.name, 
            strLength(ignorePrefix), strLength(fileInfo.name));
            mapRemove(fileInfoMap, fileInfo.name);   
            mapRemove(fileInfoMap, fileToIgnore);   
        }
    }
    
    // put the remaining files in the fileInfoList
    listClear(fileInfoList);
    
    list<FileInfo> remainingFiles = mapValues(fileInfoMap);
    i = listSize(remainingFiles);
    while(i > 0) {
        i = i - 1;
        listAdd(fileInfoList, listGet(remainingFiles, i));
    }
}

The preFileCollection function block is invoked by the Collection agent right before a file is collected.

void preFileCollection
( string  fileName  )

postFileCollection

The postFileCollection function block is invoked by the Collection agent right after a file has been collected.

void postFileCollection
( string  fileName  )

begin

The begin function block is invoked by the Collection agent during the Begin Batch processing phase and marks a start point for the file based transaction handling. On severe errors, such as when a transaction fails, the APL command abort("reason") should be invoked.

void begin
( long  transactionID  )

commit

The commit function block is invoked by the Collection agent right after the End Batch processing phase and marks the end of the file-based transaction handling. On severe errors, such as when a transaction fails, the APL command abort("reason") should be invoked.

void commit
( long  transactionID ,                
boolean  isRecover  )

rollback

The rollback function block is invoked in case of a system failure, right after the End Batch processing phase. On severe errors, such as when a transaction fails, the APL abort("reason") command should be invoked.

void rollback
( long  transactionID ,                
boolean  isRecover  )