File System Import

Provides import connectivity to file systems.

Remarks

NOTE: This Import Provider is depreciated. The Import Query Results or Import Descendants providers should be used in its place. To use Import Query Results or Import Descendants with a filesystem, create a CMIS connection with the connection type 'NTFS'.

Inherits from: Import Provider

Properties

The following 23 properties are defined.

Property Name Description
Import Source
Base Directory Type: String

The base directory from which files should be imported.

Include Subfolders Type: Boolean, Default: True

Indicates whether subfolders below the Base directory should be processed.

File Filtering
Required Attributes Type: FileAttributes, Default: 0

A file must have all attributes specified here or it will be ignored.

Ignore Attributes Type: FileAttributes, Default: 0

Files with any of the specified attributes will be ignored.

Allowed File Extensions Type: Embedded Lexicon

Specifies a Lexicon containing file extensions which should be imported. If no lexicon is specified here, all file extensions will be imported, except for those specified in the Exclusion lexicon. Each file extension in the lexicon should be in lower case and preceded by a "." character.

Excluded File Extensions Type: Embedded Lexicon

Specifies a Lexicon containing file extensions which should be excluded from the import process. Each file extension in the lexicon should be in lower case and preceded by a "." character.

Exclusion Filter Type: Embedded Extractor

An optional extractor which is used to filter out undesirable file types. For each file on the source file system, the data type will be executed against the full path to the file. If the data type returns any results at all, the file will be excluded from the import process.

Use this property to filter out files such as Microsoft Office temporary files: ~$New_Resume.docx

Maximum File Size Type: Int64, Default: 0

The maximum size of a file to be imported, in megabytes. Files larger than this will be ignored.

Ignore Unknown File Types Type: Boolean, Default: False

If true, files for which no file registration is present in the Windows registry will be ignored.

Disposition
File Disposition Type: DispositionType, Default: NoChange

Disposition of Items after successful import. Can be one of the following values:

  • NoChange - Do not do anything to each item after importing.
  • Flag - Flag each item after importing.
  • Delete - Delete each item after importing.
  • Move - Move each item after importing.

Attributes To Set Type: FileAttributes, Default: 0

File attributes which should be set on each file after import.

Attributes To Clear Type: FileAttributes, Default: 0

File attributes which should be cleared on each file after import.

Disposition Directory Type: String

The directory files should be moved into after successfully importing.

Processing Options
Sparse Import Type: Boolean, Default: True

If true, documents will be imported in sparse mode. Sparse documents avoid duplicating storage in Grooper when the content can be accessed through a link. Sparse imports serve two general purposes:

  • To speed up imports. Afterwards, content can then be loaded in parallel in a Batch Process, using the Execute activity.
  • To avoid duplicating storage in Grooper unnecessarily. All Grooper modules can work with sparse documents in the same way they can work with normal documents.

Skip Count Type: Int32, Default: 0

Indicates the number of items to skip at the beginning of the sequence. Use this property to restart an import which was previously stopped.

Max Items Type: Int32, Default: 0

Indicates the maximum number of items to process. This can be used with Skip Count to perform incremental imports.

Batch Creation
Starting Step Type: Batch Process Step

The step within a batch process where batches will be started.

Folder Levels Type: List of Folder Level Info

Defines the number of folder levels which will be translated into subfolders within the Grooper Batch.

Maximum Items per Batch Type: Int32, Default: 2500

The maximum number of items to be imported into a single batch.

Priority Type: Int32, Default: 3, Range: 1 - 5

The priority of the batch. The Priority value controls the order in which tasks are processed, with the value 1 representing the highest priority level, and the value 5 representing the lowest priority level. (i.e. Items of priority 1 are processed before items of Priority 2, and so on). The batch must be paused before this property can be edited.

Batch Name Prefix Type: String

An optional prefix to be prepended onto each batch name.

Example

Given the date is 01-02-2019 and the time is 1:39:00 PM, entering "Tommy Oliver's AP batch_:_" will result in the batch being named:

"Tommy Oliver's AP batch_:_ 2019-01-02 01:39:00 PM"

Start Paused Type: Boolean, Default: True

If true, created batches will be started in a paused state.

Batch Folder Classification
Content Type Type: Content Type

Optionally assign a content type to created batch folders.

See Also

Batch Process Step, Content Type, Embedded Extractor, Embedded Lexicon, Folder Level Info

Used By

Import Watcher