2023:Import Provider

From Grooper Wiki
Revision as of 09:37, 27 August 2024 by Randallkinard (talk | contribs)

This article is about an older version of Grooper.

Information may be out of date and UI elements may have changed.

2025202320212.90

STUB

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

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.

Import Providers can be used in two ways:

  • To perform manual "ad-hoc" file imports when creating new Batches from the IMPORTS page.
  • To perform automatic, scheduled file imports using one or more Import Watcher services (set up in Grooper Config).

There are three categories of Import Providers:

  • CMIS Import Providers
  • Legacy Import Providers
  • Other Import Providers

CMIS Import Providers

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.
  • Import Query Results allows you to use a query syntax similar to a SQL query (called a CMISQL 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 was created as a simplified version of Import Query Results. In almost all cases, it is preferable to use Import Query Results. It is more fully featured and more developed.


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.
    • Most typically, this provider is used by Grooper designers testing a Batch Process. It has little uses in production scenarios.

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 Connection type.
  • 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 type is NTFS.
  • FTP Import
    • This provider imports content using the FTP protocol.
    • The analogous CMIS Connection types is FTP.
  • SFTP Import
    • This provider imports content using the SFTP protocol.
    • The analogous CMIS Connection types is SFTP.
  • Mail Import
    • This provider imports content to mail servers using the IMAP protocol.
    • The analogous CMIS Connection type is IMAP.
    • FYI: If you are importing from a Microsoft Exchange server (i.e. you are using Outlook) you should use the Exchange CMIS Connection type. It is more fully featured, and will interoperate with Exchange email clients better.

Glossary

Batch Process: settings Batch Process nodes are crucial components in Grooper's architecture. A Batch Process is the step-by-step processing instructions given to a inventory_2 Batch. Each step is comprised of a "Code Activity" or a Review activity. Code Activities are automated by Activity Processing services. Review activities are executed by human operators in the Grooper user interface.

  • Batch Processes by themselves do nothing. Instead, they execute edit_document Batch Process Steps which are added as children nodes.
  • A Batch Process is often referred to as simply a "process".

Batch: inventory_2 Batch nodes are fundamental in Grooper's architecture. They are containers of documents that are moved through workflow mechanisms called settings Batch Processes. Documents and their pages are represented in Batches by a hierarchy of folder Batch Folders and contract Batch Pages.

CMIS Connection: cloud CMIS Connections provide a standardized way of connecting to various content management systems (CMS). CMIS Connections allow Grooper to communicate with multiple external storage platforms, enabling access to documents and document metadata that reside outside of Grooper's immediate environment.

  • For those that support the CMIS standard, the CMIS Connection connects to the CMS using the CMIS standard.
  • For those that do not, the CMIS Connection normalizes connection and transfer protocol as if they were a CMIS platform.

CMIS Import: CMIS Import refers to two Import Providers used to import content from settings_system_daydream CMIS Repositories: Import Descendants and Import Query Results. CMIS Imports allow users to import from various on-premise and cloud based storage platforms (including Windows folders, Outlook inboxes, Box accounts, AppEnhancer applications and more).

CMIS Repository: settings_system_daydream CMIS Repository nodes provide document access in external storage platforms through a cloud CMIS Connection. With a CMIS Repository, users can manage and interact with those documents within Grooper. They are used primarily for import using Import Descendants and Import Query Results and for export using CMIS Export.

  • CMIS Repositories are create as a child node of a CMIS Connection using the "Import Repository" command.

CMIS: CMIS (Content Management Interoperability Services) is open standard allowing different content management systems to "interoperate", sharing files, folders and their metadata as well as programmatic control of the platform over the internet.

Exchange: Exchange is a connection option for cloud CMIS Connections. It connects Grooper to Microsoft Exchange email servers (including Outlook servers) for import and export operations.

FTP: FTP is a connection option for cloud CMIS Connections. It connects Grooper to FTP directories for import and export operations.

IMAP: IMAP is a connection option for cloud CMIS Connections. It connects Grooper to email messages and folders through an IMAP email server for import and export operations.

Import Descendants: Import Descendants is one of two Import Providers that use cloud CMIS Connections to import document content into Grooper. Import Descendants imports files from a settings_system_daydream CMIS Repository folder location, including any files in any sub-folders (i.e. all "descendant" files).

Import Provider: 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.

Import Query Results: Import Query Results is one of two Import Providers that use cloud CMIS Connections to import document content into Grooper. Import Query Results imports files from a settings_system_daydream CMIS Repository that match a "CMISQL query" (a specialized query language based on SQL database queries).

NTFS: NTFS is a connection option for cloud CMIS Connections. It connects Grooper to files and folders in the Microsoft Windows NTFS file system for import and export operations.

Repository: A "repository" is a general term in computer science referring to where files and/or data is stored and managed. In Grooper, the term "repository" may refer to:

SFTP: SFTP is a connection option for cloud CMIS Connections. It connects Grooper to SFTP directories for import and export operations.

Test Batch: "Test Batch" is a specialized Import Provider designed to facilitate the import of content from an existing inventory_2 Batch in the test environment. This provider is most commonly used for testing, development, and validation scenarios, and is not intended for production use.

  • Looking for information on "production" vs "test" Batches in Grooper? See here.
Retrieved from "https://wiki.grooper.com/index.php?title=2023:Import_Provider&oldid=25208"