2023.1:Import Watcher (Service): Difference between revisions

From Grooper Wiki
// via Wikitext Extension for VSCode
// via Wikitext Extension for VSCode
Line 17: Line 17:


An '''Import Watcher''' is a service that is required for importing digital documents, such as PDFS, into Grooper. The '''Import Watcher''' creates "Import Jobs" that bring in files to new '''Batches''' in Grooper. It is also required to automate scheduled imports as well as for ad-hoc user directed imports from the Imports Page.
An '''Import Watcher''' is a service that is required for importing digital documents, such as PDFS, into Grooper. The '''Import Watcher''' creates "Import Jobs" that bring in files to new '''Batches''' in Grooper. It is also required to automate scheduled imports as well as for ad-hoc user directed imports from the Imports Page.
To make use of an '''Import Watcher''' you first will have to install the service via Grooper Config. If all you want to do is ad-hoc user directed imports, you're good to go after installing and starting the service. If you would like to add scheduled imports or set up a polling loop to periodically import documents, you will be able to do that from the Grooper Web Client after you have installed the '''Import Watcher''' service.


== How To ==
== How To ==
<div style="padding-left: 1.5em";>
<div style="padding-left: 1.5em";>
=== Installation ===
=== Installing the Import Watcher Service ===


In order to create an Import Job to bring digital documents into Grooper, you will need to install an '''Import Watcher''' service. If all you want is user-directed imports, then you can install the '''Import Watcher''' without setting up any scheduling or polling loops. We will go through that process in this section.
In order to create Import Jobs to bring digital documents into Grooper, you will need to install an '''Import Watcher''' service. To install any service, you will need admin access to Grooper Config. Open Grooper Config and follow the instructions below:
 
To install a service you will need admin access to Grooper Config. Open Grooper Config and follow the instructions below:


# Click on "Edit Services" located in the Grooper Config toolbar.
# Click on "Edit Services" located in the Grooper Config toolbar.
Line 54: Line 54:


[[File:2023.1 Import-Watcher-(Services) 02 01 Installation 05.png]]
[[File:2023.1 Import-Watcher-(Services) 02 01 Installation 05.png]]
=== Setting up Scheduled Imports ===
=== Setting up a Polling Loop ===


</div>
</div>

Revision as of 09:33, 27 June 2024

This article is about an older version of Grooper.

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

202520242023.1

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.

An Import Watcher is a Grooper Service that schedules and runs Import Jobs. It uses an Import Provider to query files in a file system or content management system that meet specified criteria according to a defined schedule (every minute, every day, only on Sundays, etc.). These files are imported into Grooper as documents (folder Batch Folders) in a new inventory_2 Batch.

  • Afterward, the imported files can be (and should be) moved, deleted, or modified to prevent repeat imports in the next polling cycle.

Glossary

About

An Import Watcher is a service that is required for importing digital documents, such as PDFS, into Grooper. The Import Watcher creates "Import Jobs" that bring in files to new Batches in Grooper. It is also required to automate scheduled imports as well as for ad-hoc user directed imports from the Imports Page.

To make use of an Import Watcher you first will have to install the service via Grooper Config. If all you want to do is ad-hoc user directed imports, you're good to go after installing and starting the service. If you would like to add scheduled imports or set up a polling loop to periodically import documents, you will be able to do that from the Grooper Web Client after you have installed the Import Watcher service.

How To

Installing the Import Watcher Service

In order to create Import Jobs to bring digital documents into Grooper, you will need to install an Import Watcher service. To install any service, you will need admin access to Grooper Config. Open Grooper Config and follow the instructions below:

  1. Click on "Edit Services" located in the Grooper Config toolbar.


  1. When the "Service Manager" window pops up, you will see a list of all the services that are currently running on your server.
  2. Click on "Install..." in the toolbar at the top.


  1. When the "Install New Service" window pops up, click on the drop down in the top right to select the repository you want to install the Import Watcher for.
  2. Select "Import Watcher" from the list of services.
  3. Click "OK" in the toolbar at the top.


  1. In the "Import Watcher" pop up window, enter your user name and password in the two bottom properties. Be sure to include your domain followed by a backslash (\) in your username.
  2. Click "Execute".


  1. Now your Import Watcher service should show up in your list on the "Service Manager". Select the Import Watcher you created.
  2. Click "Start" in the top toolbar to start the service.


Setting up Scheduled Imports

Setting up a Polling Loop