Using the Premium File System Destination Component
The Premium File System Destination Component is an SSIS data flow pipeline component that can be used to write data to a File System. There are three pages of configuration:
- Error Handling
The General page is used to specify general settings for the Premium File System Destination Component. The Columns page is used to manage columns from the upstream component. The Error Handling page allows you to specify how errors should be handled when they occur.
The General page allows you to specify general settings for the component.
- Connection Manager
The Premium File System Destination Component requires a connection. The Connection Manager drop-down will show a list of connection managers that are available:
Similar to the Source Component, the Connection Managers offered within this toolkit are the following:
- Local File
- FTPS Connection Manager
- SFTP Connection Manager
The Action specifies how you want to write to the file system specified in the selected Connection Manager. There are 3 Actions:
- Upload - Uploads files and creates folders
- Move - Moves files and folders from 1 folder to another
- Delete - Deletes specified items
- Duplicate Mode
The Duplicate Mode specifies how to handle rows that try to either Move to/Upload an item that already exists. There are 3 Modes:
- Fail - Throws error if item exists. This can still be handled via the Error Handling
- Auto Increment - Increments the number at the end of the item name. If one does not exists one is added. It continues to increment the number until no item with that name exists.
- Overwrite - Replaces the existing item with the item being uploaded/moved to that location.
- Map Unmapped Fields Button
By clicking this button, the component will try to map any unmapped attributes by matching their names with the input columns from upstream components.
- Clear All Mappings Button
By clicking this button, the component will reset (clear) all your mappings in the destination component.
The Columns page of the Premium File System Destination Component allows you to map the columns from upstream components to the Premium File System Fields.
In the Columns page, you would see a grid that contains four columns as shown below.
- Input Column - You can select an input column from an upstream component for the corresponding Premium File System Field.
- Premium File System Field - Specifies how to write the current item to the specified File System.
- Data Type - This column indicates the type of value for the current field.
- Unmap - This column can be used to unmap the field from the upstream input column, or otherwise it can be used to map the field to an upstream input column by matching its name if the field is not currently mapped.
Error Handling page
The Error Handling page allows you to specify how errors should be handled when they happen.
There are three options available.
- Fail on error
- Redirect rows to error output
- Ignore error
When the Redirect rows to error output option is selected, rows that failed to write to the File System will be redirected to the 'Error Output' output of the Destination Component. As indicated in the screenshot below, the blue output connection represent rows that were successfully written, and the red 'Error Output' connection represents rows that were erroneous. The 'ErrorMessage' output column found in the 'Error Output' may contain the error message that was reported by server or the component itself.
Using the Local File Connection Manager found in the Premium File Pack components
Within the Control Flow and Data Flow Components found in this toolkit, you will notice a 'Local File' connection manager in the Connection Manager area. Note that the Local File does not have to be configured in order for you to use this. You would simply select the 'Local File' option, and you would be able to access the folder and files within the local machine.