File System Import (Import Provider)

From Grooper Wiki

This article is about the current version of Grooper.

Note that some content may still need to be updated.

2025

WIP

This article is a work-in-progress or created as a placeholder for testing purposes. This article is subject to change and/or expansion. It may be incomplete, inaccurate, or stop abruptly.

This tag will be removed upon draft completion.

File System Import refers to a Legacy Import Provider used to import documents directly from your Windows File System into Grooper.

About

The File System Import Import Provider is considered a Legacy Import Provider. It is recommended in all current and future versions of Grooper to configure your Projects using a CMIS Connection set to NTFS and an Import Descendants or Import Query Results Import Provider instead. It is still an option in Grooper primarily for Projects orginally created in previous versions of Grooper that have been updated to newer versions.

How To

Remember, this Provider is a Legacy Provider and should only really be used when updating a Project that was created in a previous version of Grooper that is already set up with File System Import. For those that need to update their Provider, this is how File System Import works.

Basic Configuration

This is a Basic Configuration guide for File System Import. To make edits to what the Batch is named and how to assign the Batch to a Batch Process on import, see the #Batch Creation section of this article.

  1. Click over to the Imports Page in Grooper.
  2. Click the Add "+" icon on the right side of the Context Toolbar.
  3. When the Submit Import Job window appears, enter in a Description for your Import.
    • This is the name of your Import Job, not the name of the Batch that will be created.
  4. Set the Provider property to File System Import. Click the hamburger icon "☰" to access the drop down.
  5. Open the Provider sub properties and insert the UNC Path to the folder you want to import from into the Base Directory property.
  6. Decide if you want to Include Subfolders in your import and set to True or False accordingly.
    • If set to false, it will only import documents in the immediate folder, ignoring any documents in subfolders.
  7. Required or Ignore Attributes properties will let you specify attributes of documents you want to bring in or you want to exclude from the import.
  8. Allowed File Extensions and Excluded File Extensions allow you to specify what file extensions to import.
  9. Exclusion Patterns allow you to use regex to determine certain files not to import.
  10. If you set the maximum file size, no documents larger than this will be imported.
  11. Ignore Unknown File Types when set to True will not import any documents that have file types Windows does not recognize.
  12. The File Disposition property determines what happens to the documents when they are imported.
    • The Delete option for the File Disposition will not appear if you are performing a Sparse Import.
  13. Decide whether you want a Sparse Import and set to True or False accordingly.
  14. click "Submit".

You should now have imported documents in your Test Folder under your Batches folder in the design page. They should be located in a folder called "Imported Batches".

Click here for an interactive walkthrough

Batch Creation

Folder Levels property

The Folder Levels property under Batch Creation for a File System Import allows you to maintain the Windows' folder hierarchy in your Batch when the documents are imported into Grooper.

The File System Import Provider can be used in many different places in Grooper (wherever you can configure an import). In this tutorial, we are going to instruct you how to use the File System Import Provider when creating a new Import on the Import Page.

  1. Click the icon in the Context Toolbar to navigate to the Imports Page.
  2. Click on the Add icon on the right side of the Context Toolbar.
  3. Set the Description, Provider, and all Provider properties to your preferences for your import (see the #Basic Configuration section above for details on how to set that up).
  4. Open the Folder Levels property editor by clicking the "..." icon to the right of the property.
  5. Click the Add "+" icon at the top of the editor.
  6. Change the Folder Level property to the folder level you want to keep when importing into Grooper. Add another to the list if desired by clicking the Add "+" icon.
    • Consider the UNC Path of \\OKCWGRO02\Imports and Exports\Imports\Documents to Import\001\Leases. Ignore the network name and count the number of folders in the Path. Assign a number starting with number 1 to each folder.
      • "Imports and Exports" would be 1.
      • "Imports" would be 2.
      • "Documents to Import" would be 3.
      • "001" would be 4.
      • "Leases" would be 5.
    • If you wanted to keep the 001 and Leases folders in your Batch, you would need to set two Folder Levels to 4 and 5.
  7. Click "OK" in the top right corner of the Folder Levels editor.
  8. Click "Submit" at the top right of the Submit Import Job window to submit the job.
  9. When you look at your imported Batch, the Folder Levels in your Batch should be the same folders you specified when configuring the import.

Click here for an interactive walkthrough

Retrieved from "https://wiki.grooper.com/index.php?title=File_System_Import_(Import_Provider)&oldid=28971"