Import Provider: Difference between revisions

From Grooper Wiki
Redirected page to Import Provider (Property)
Tag: New redirect
 
Removed redirect to Import Provider (Property)
Tag: Removed redirect
Line 1: Line 1:
#REDIRECT [[Import Provider (Property)]]
{{stubs}}
{{AutoVersion}}
<blockquote>{{#lst:Glossary|Import Provider}}</blockquote>
 
== About ==
 
There are three categories of Import Providers:
* CMIS Import providers
* Legacy Import" providers
* Other Import providers
 
== CMIS Import Providers ==
The [[CMIS Import]] providers are used to import content over a '''[[CMIS Connection]]''' from '''CMIS Repositories'''.  This allows users to import from various on-premise and cloud based storage platforms.
 
Documents are imported from CMIS Connections using either the Import Descendants or Import Query Results providers.
* [[Import Descendants]] will import all documents within a designated folder location of a CMIS Repository (including documents in sub-folders).
* [[Import Query Results]] allows you to use a query syntax similar to a SQL query (called a [[CMIS Query]]) to set conditions for import based on the item's available metadata, such as a documents name, file type, creation date, archive status, or other variables.
 
*<li class="attn-bullet">'''BE AWARE!''' Import Descendants is a simplified version of Import Query Results. 
** It is best practice to use Import Query Results when you are able.  It is more fully featured and more developed.
** Import Descendants should only be used for CMIS Connection Types that are not query-able.
 
 
For more information on how to set up a CMIS Connection and how to import using a CMIS Import provider, visit the following articles:
* [[CMIS Connection]]
* [[CMIS Import]]
** [[Import Descendants]]
** [[Import Query Results]]
 
== Other Import ==
 
There are two import mechanisms you ''cannot'' use a CMIS Connection for.  These have very specialized import mechanisms requiring unique providers.
 
* OPEX Import
** This provider is necessary to import content using OPEX Scanning Devices (commonly used for mailroom automation).
* Test Batch
** This provider allows users to import content from a Grooper Test Batch (a Batch in the "Batches > Test" branch of the Grooper node tree).
** This provider has no real use in production scenarios. It is typically used by Grooper designers testing a Batch Process.
* Search Import
** This provider allows you to import documents from the [[Search Page]]. It will create a Batch from documents in the search query's result list.
 
== Legacy Import Providers ==
 
These providers exist in Grooper for backwards compatibility. 
* In newer versions of Grooper, it is best practice to use a CMIS Import Provider with an analogous "CMIS Binding" (the provider selected when configuring a CMIS Connection).
* However, they are still supported for older versions of Grooper that are upgraded to more current ones.
 
The Legacy Import Providers are as follows:
* File System Import
** This provider imports content over a local network to the Windows file system.
** The analogous CMIS Connection binding is "NTFS".
* FTP Import
** This provider imports content using the FTP protocol.
** The analogous CMIS Connection binding is "FTP".
* SFTP Import
** This provider imports content using the SFTP protocol.
** The analogous CMIS Connection binding type is "SFTP.
* Mail Import
** This provider imports content to mail servers using the IMAP protocol.
** The analogous CMIS Connection binding type is "IMAP".
** FYI: If you are importing from a Microsoft Exchange server (i.e. you are using Outlook) you should use the Exchange binding.  It is more fully featured, and will interoperate with Exchange email clients better.

Revision as of 14:52, 28 May 2025

STUB

This article is a stub. It contains minimal information on the topic and should be expanded.

This article is about the current version of Grooper.

Note that some content may still need to be updated.

2025 202320212.90

Import Providers enable Grooper to import file-based content from numerous sources, including Windows file systems, SFTP file systems, mail servers and various content management systems (CMS). An Import Provider is selected and configured when configuring "Import Jobs". Import Jobs are submitted in one of two ways:

  • By a user from the Imports page: Ad-hoc or "user directed" Import Jobs are submitted from the Imports Page, using the "Submit Import Job" button.
  • From an Import Watcher service: Automated or "scheduled" Import Jobs are submitted by an Import Watcher service according to its Poling Loop or Specific Times specification.

In both cases, an Import Provider is selected and configured using using the "Provider" property.

About

There are three categories of Import Providers:

  • CMIS Import providers
  • Legacy Import" providers
  • Other Import providers

CMIS Import Providers

The CMIS Import providers are used to import content over a CMIS Connection from CMIS Repositories. This allows users to import from various on-premise and cloud based storage platforms.

Documents are imported from CMIS Connections using either the Import Descendants or Import Query Results providers.

  • Import Descendants will import all documents within a designated folder location of a CMIS Repository (including documents in sub-folders).
  • Import Query Results allows you to use a query syntax similar to a SQL query (called a CMIS Query) to set conditions for import based on the item's available metadata, such as a documents name, file type, creation date, archive status, or other variables.
  • BE AWARE! Import Descendants is a simplified version of Import Query Results.
    • It is best practice to use Import Query Results when you are able. It is more fully featured and more developed.
    • Import Descendants should only be used for CMIS Connection Types that are not query-able.


For more information on how to set up a CMIS Connection and how to import using a CMIS Import provider, visit the following articles:

Other Import

There are two import mechanisms you cannot use a CMIS Connection for. These have very specialized import mechanisms requiring unique providers.

  • OPEX Import
    • This provider is necessary to import content using OPEX Scanning Devices (commonly used for mailroom automation).
  • Test Batch
    • This provider allows users to import content from a Grooper Test Batch (a Batch in the "Batches > Test" branch of the Grooper node tree).
    • This provider has no real use in production scenarios. It is typically used by Grooper designers testing a Batch Process.
  • Search Import
    • This provider allows you to import documents from the Search Page. It will create a Batch from documents in the search query's result list.

Legacy Import Providers

These providers exist in Grooper for backwards compatibility.

  • In newer versions of Grooper, it is best practice to use a CMIS Import Provider with an analogous "CMIS Binding" (the provider selected when configuring a CMIS Connection).
  • However, they are still supported for older versions of Grooper that are upgraded to more current ones.

The Legacy Import Providers are as follows:

  • File System Import
    • This provider imports content over a local network to the Windows file system.
    • The analogous CMIS Connection binding is "NTFS".
  • FTP Import
    • This provider imports content using the FTP protocol.
    • The analogous CMIS Connection binding is "FTP".
  • SFTP Import
    • This provider imports content using the SFTP protocol.
    • The analogous CMIS Connection binding type is "SFTP.
  • Mail Import
    • This provider imports content to mail servers using the IMAP protocol.
    • The analogous CMIS Connection binding type is "IMAP".
    • FYI: If you are importing from a Microsoft Exchange server (i.e. you are using Outlook) you should use the Exchange binding. It is more fully featured, and will interoperate with Exchange email clients better.