Skip to main content

Ingest File Server Binary File

Copy binary file from file server path to Azure Data Lake Storage Gen2.

To use this activity within the API, use an ActivityCode of FILESERVER-BINARY-ADLS.

Example JSON​

An example of what the Task Config would look like for a task using this activity. Some of these variables would be set at the group level to avoid duplication between tasks.

NULL

Variable Reference​

The following variables are supported:

  • SourceConnection - (Required) Source connection to use.

  • RelativeFilePath - (Optional) Relative path from the File Server Root folder.

  • Filename - (Required) Filename to ingest. Can be wildcarded.

  • OverrideFilePathWithDynamicValue - (Optional) Call into 'Override File Path' Pipeline to override values of either or both of RelativeFilePath and Filename.

  • LastModifiedHours - (Optional) Only files with a last modified time greater than the current UTC time minus Last Modified Hours will be returned. If empty, no time based filter will be applied.

  • DeleteFileFromSourceAfterCopying - (Optional) Should the source file be deleted once it has been successfully copied to its destination?

  • FailIfFileNotExists - (Optional) Should the Task fail if the file isn't found. If set to true, the Task will retry until the file arrives (or the Task reaches the maximum retry threshold).

  • TargetConnection - (Optional) Target connection to use.

  • DataLakeSystemFolder - (Required) Name of the folder in the Data Lake that acts as the parent folder for all datasets belonging to this System.

  • DataLakeDatasetFolder - (Required) Name of the folder in the Data Lake that the dataset will be stored under. Used with 'Data Lake System Folder' to form the fully qualified path to the dataset within the data Container in the Data Lake.

  • ExtractControlVariableName - (Optional) For incremental loads only, the name to assign the Extract Control variable in State Config for the ExtractControl value derived from the Extract Control Query above.

  • ExtractControlVariableSeedValue - (Optional) The initial value to set for the Extract Control variable in State Config - this will have no impact beyond the original seeding of the Extract Control variable in State Config.

  • DIUsToUseForCopyActivity - (Optional) Specifies the powerfulness of the copy executor. Value can be between 2 and 256. When left at default, the Data Factory dynamically applies the optimal DIU setting based on the source-sink pair and data pattern.

  • MaximumNumberOfAttemptsAllowed - (Optional) The total number of times the running of this Task can be attempted.

  • MinutesToWaitBeforeNextAttempt - (Optional) If a Task run fails, the number of minutes to wait before re-attempting the Task.

  • RetainHistory - (Optional) Should the raw files be saved to the History Container to preserve them?

  • IsFederated - (Optional) Makes task available to other Insight Factories within this organisation.

  • Links - (Optional) NULL