ListSmb

Description:

Lists concrete files shared via SMB protocol. Each listed file may result in one flowfile, the metadata being written as flowfile attributes. Or - in case the 'Record Writer' property is set - the entire result is written as records to a single flowfile. This Processor is designed to run on Primary Node only in a cluster. If the primary node changes, the new Primary Node will pick up where the previous node left off without duplicating all of the data.

Tags:

samba, smb, cifs, files, list

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
SMB Client Provider Servicesmb-client-provider-serviceController Service API:
SmbClientProviderService
Implementation: SmbjClientProviderService		Specifies the SMB client provider to use for creating SMB connections.
Listing Strategylisting-strategyTracking Timestamps
  • Tracking Entities This strategy tracks information of all the listed entities within the latest 'Entity Tracking Time Window' to determine new/updated entities. This strategy can pick entities having old timestamp that can be missed with 'Tracking Timestamps'. Works even when multiple subdirectories are being written at the same time while listing is running. However additional DistributedMapCache controller service is required and more JVM heap memory is used. See the description of 'Entity Tracking Time Window' property for further details on how it works.
  • No Tracking This strategy lists an entity without any tracking. The same entity will be listed each time on executing this processor. It is recommended to change the default run schedule value. Any property that related to the persisting state will be disregarded.
  • Tracking Timestamps This strategy tracks the latest timestamp of listed entity to determine new/updated entities. Since it only tracks few timestamps, it can manage listing state efficiently. However, any newly added, or updated entity having timestamp older than the tracked latest timestamp can not be picked by this strategy. For example, such situation can happen in a file system if a file with old timestamp is copied or moved into the target directory without its last modified timestamp being updated. Also may miss files when multiple subdirectories are being written at the same time while listing is running.
Specify how to determine new/updated entities. See each strategy descriptions for detail.
Input DirectorydirectoryThe network folder from which to list files. This is the remaining relative path after the share: smb://HOSTNAME:PORT/SHARE/[DIRECTORY]/sub/directories. It is also possible to add subdirectories. The given path on the remote file share must exist. This can be checked using verification. You may mix Windows and Linux-style directory separators.
File Name Suffix Filterfile-name-suffix-filterFiles ending with the given suffix will be omitted. Can be used to make sure that files that are still uploading are not listed multiple times, by having those files have a suffix and remove the suffix once the upload finishes. This is highly recommended when using 'Tracking Entities' or 'Tracking Timestamps' listing strategies.
Record Writerrecord-writerController Service API:
RecordSetWriterFactory
Implementations: FreeFormTextRecordSetWriter
CSVRecordSetWriter
ParquetRecordSetWriter
RecordSetWriterLookup
ScriptedRecordSetWriter
XMLRecordSetWriter
JsonRecordSetWriter
AvroRecordSetWriter		Specifies the Record Writer to use for creating the listing. If not specified, one FlowFile will be created for each entity that is listed. If the Record Writer is specified, all entities will be written to a single FlowFile instead of adding attributes to individual FlowFiles.
Minimum File Agemin-file-age5 secsThe minimum age that a file must be in order to be listed; any file younger than this amount of time will be ignored.
Maximum File Agemax-file-ageAny file older than the given value will be omitted.
Minimum File Sizemin-file-sizeAny file smaller than the given value will be omitted.
Maximum File Sizemax-file-sizeAny file larger than the given value will be omitted.
Target System Timestamp Precisiontarget-system-timestamp-precisionAuto Detect
  • Auto Detect Automatically detect time unit deterministically based on candidate entries timestamp. Please note that this option may take longer to list entities unnecessarily, if none of entries has a precise precision timestamp. E.g. even if a target system supports millis, if all entries only have timestamps without millis, such as '2017-06-16 09:06:34.000', then its precision is determined as 'seconds'.
  • Milliseconds This option provides the minimum latency for an entry from being available to being listed if target system supports millis, if not, use other options.
  • Seconds For a target system that does not have millis precision, but has in seconds.
  • Minutes For a target system that only supports precision in minutes.
Specify timestamp precision at the target system. Since this processor uses timestamp of entities to decide which should be listed, it is crucial to use the right timestamp precision.
Entity Tracking State Cacheet-state-cacheController Service API:
DistributedMapCacheClient
Implementations: HBase_2_ClientMapCacheService
SimpleRedisDistributedMapCacheClientService
HazelcastMapCacheClient
CouchbaseMapCacheClient
RedisDistributedMapCacheClientService
DistributedMapCacheClientService
CassandraDistributedMapCache		Listed entities are stored in the specified cache storage so that this processor can resume listing across NiFi restart or in case of primary node change. 'Tracking Entities' strategy require tracking information of all listed entities within the last 'Tracking Time Window'. To support large number of entities, the strategy uses DistributedMapCache instead of managed state. Cache key format is 'ListedEntities::{processorId}(::{nodeId})'. If it tracks per node listed entities, then the optional '::{nodeId}' part is added to manage state separately. E.g. cluster wide cache key = 'ListedEntities::8dda2321-0164-1000-50fa-3042fe7d6a7b', per node cache key = 'ListedEntities::8dda2321-0164-1000-50fa-3042fe7d6a7b::nifi-node3' The stored cache content is Gzipped JSON string. The cache key will be deleted when target listing configuration is changed. Used by 'Tracking Entities' strategy.
Entity Tracking Time Windowet-time-window3 hoursSpecify how long this processor should track already-listed entities. 'Tracking Entities' strategy can pick any entity whose timestamp is inside the specified time window. For example, if set to '30 minutes', any entity having timestamp in recent 30 minutes will be the listing target when this processor runs. A listed entity is considered 'new/updated' and a FlowFile is emitted if one of following condition meets: 1. does not exist in the already-listed entities, 2. has newer timestamp than the cached entity, 3. has different size than the cached entity. If a cached entity's timestamp becomes older than specified time window, that entity will be removed from the cached already-listed entities. Used by 'Tracking Entities' strategy.
Supports Expression Language: true (will be evaluated using variable registry only)
Entity Tracking Initial Listing Targetet-initial-listing-targetAll Available
  • Tracking Time Window Ignore entities having timestamp older than the specified 'Tracking Time Window' at the initial listing activity.
  • All Available Regardless of entities timestamp, all existing entities will be listed at the initial listing activity.
Specify how initial listing should be handled. Used by 'Tracking Entities' strategy.

Relationships:

NameDescription
successAll FlowFiles that are received are routed to success

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
filenameThe name of the file that was read from filesystem.
shortNameThe short name of the file that was read from filesystem.
pathThe path is set to the relative path of the file's directory on the remote filesystem compared to the Share root directory. For example, for a given remote locationsmb://HOSTNAME:PORT/SHARE/DIRECTORY, and a file is being listed from smb://HOSTNAME:PORT/SHARE/DIRECTORY/sub/folder/file then the path attribute will be set to "DIRECTORY/sub/folder".
serviceLocationThe SMB URL of the share.
lastModifiedTimeThe timestamp of when the file's content changed in the filesystem as 'yyyy-MM-dd'T'HH:mm:ss'.
creationTimeThe timestamp of when the file was created in the filesystem as 'yyyy-MM-dd'T'HH:mm:ss'.
lastAccessTimeThe timestamp of when the file was accessed in the filesystem as 'yyyy-MM-dd'T'HH:mm:ss'.
changeTimeThe timestamp of when the file's attributes was changed in the filesystem as 'yyyy-MM-dd'T'HH:mm:ss'.
sizeThe size of the file in bytes.
allocationSizeThe number of bytes allocated for the file on the server.

State management:

ScopeDescription
CLUSTERAfter performing a listing of files, the state of the previous listing can be stored in order to list files continuously without duplication.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.

See Also:

PutSmbFile, GetSmbFile, FetchSmb