2023:FTP (CMIS Binding): Difference between revisions

From Grooper Wiki
No edit summary
// via Wikitext Extension for VSCode
Line 5: Line 5:
<blockquote>{{#lst:Glossary|FTP}}</blockquote>
<blockquote>{{#lst:Glossary|FTP}}</blockquote>


The connected FTP directory or directories are exposed as a '''CMIS Repository''', which mimics its file system hierarchy. Once connected, you can import, export, search, and browse documents from Grooper.
The connected FTP directory or directories are exposed as a '''CMIS Repository''', which mimics its file system hierarchy. Once connected, you can import, export, search, and browse documents from Grooper.


The '''''FTP''''' binding can be used for import operations via '''''[[CMIS Import]]''''' using either "Import Descendants" or "Import Query Results". It can be used for export operations via the '''[[Export]]''' activity using a '''''[[CMIS Export]]''''' configuration.
The '''''FTP''''' binding can be used for import operations via '''''[[CMIS Import]]''''' using either "Import Descendants" or "Import Query Results". It can be used for export operations via the '''[[Export]]''' activity using a '''''[[CMIS Export]]''''' configuration.


== Glossary ==
== Glossary ==
Line 37: Line 37:


== How To: Create a New FTP Connection ==
== How To: Create a New FTP Connection ==
<tabs>
=== Add the CMIS Connection ===
<tab name="Step 1">
===== Add the CMIS Connection =====
 
 
{|
*Expand the Projects Folder in the Node Tree
*Expand the Projects Folder in the Node Tree
*Right-click your selected Project.
*Right-click your selected Project.
*Select "Add", then "CMIS Connection".
*Select "Add", then "CMIS Connection".
|
 
[[File:2023_FTP_CMIS_Binding_How_To_Create_a_New_FTP_Connection_01.png]]
[[File:2023_FTP_CMIS_Binding_How_To_Create_a_New_FTP_Connection_01.png]]
|}


 
=== Set the Connection Type ===
</tab>
<tab name="Step 2">
===== Set the Connection Type =====
{|
*On the CMIS Connection tab, expand the "Connection Settings" Property.
*On the CMIS Connection tab, expand the "Connection Settings" Property.
*There, you will find the Repositories Property.
*There, you will find the Repositories Property.
*Select the ellipses.
*Select the ellipses.
|
 
|-
[[File:2023_FTP_CMIS_Binding_How_To_Create_a_New_FTP_Connection_Step_2_01.png]]
[[File:2023_FTP_CMIS_Binding_How_To_Create_a_New_FTP_Connection_Step_2_01.png]]
|}


</tab>
=== Configure the Connection ===
<tab name="Step 3">
This brings up the "FTP Repository Configuration Collection Editor". Here, you can enter one or more FTP paths to be used as the repository's root. You will also need to enter the user name and password to access the FTP server. The repository's name will default to the end destination folder. Or, you can name the repository under "Repository Name". Press **Add** to enter a new path, establishing the folder at the end of that path as a repository.
===== Configure the Connection =====
 
This brings up the "FTP Repository Configuration Collection Editor".  Here, you can enter one or more FTP paths to be used as the repository's root.  You will also need to enter the user name and password to access the FTP server. The repository's name will default to the end destination folder. Or, you can name the repository under "Repository Name". Press **Add** to enter a new path, establishing the folder at the end of that path as a repository.


There are three optional properties:
There are three optional properties:
* '''Time Out''' - Set the time (in seconds) for calls to the FTP server before a timeout error. This is 30 seconds by default.
* '''Time Out''' - Set the time (in seconds) for calls to the FTP server before a timeout error. This is 30 seconds by default.
* '''Enable SSL''' - False by default. If true, secured socket layers will be enabled.
* '''Enable SSL''' - False by default. If true, secured socket layers will be enabled.
* '''Read Only''' - Change this to "True" if you want these folders to be read only.  This can be useful to prevent unintentional changes to the file system if you only need the connection to a file system for imports.
* '''Read Only''' - Change this to "True" if you want these folders to be read only. This can be useful to prevent unintentional changes to the file system if you only need the connection to a file system for imports.
 


[[File:2023_FTP_CMIS_Binding_How_To_Create_a_New_FTP_Connection_Step_3_01.png]]
[[File:2023_FTP_CMIS_Binding_How_To_Create_a_New_FTP_Connection_Step_3_01.png]]


 
=== List Repositories ===
</tab>
After you Save, press the "List Repositories" button to show the folder paths you just added as repositories.
<tab name="Step 4">
===== List Repositories =====
 
After you Save, press the "List Repositories" button to show the folder paths you just added as repositories.
 


[[image:1559584904814-709.png|center]]
[[image:1559584904814-709.png|center]]


 
=== Import Repository ===
</tab>
Select "Import Repository" to bring in these repositories for Grooper to import and export to the corresponding folders in the connected file system. The red circle on the upper right corner of the icon will go from red to green once the repository is imported.
<tab name="Step 5">
===== Import Repository =====
 
Select "Import Repository" to bring in these repositories for Grooper to import and export to the corresponding folders in the connected file system.  The red circle on the upper right corner of the icon will go from red to green once the repository is imported.
 


[[image:1559584945360-275.png|center]]
[[image:1559584945360-275.png|center]]
</tab>
</tabs>


== Version Differences ==
== Version Differences ==
 
Prior to 2.72, connections to FTP directories would have used the "FTP Import" and "FTP Export" providers. While these providers still exists in Grooper as legacy import and export providers, they are deprecated components and no longer recommended for use. For increased functionality in 2.72 and beyond, create a '''[[CMIS Connection (Object)|CMIS Connection]]'''.
Prior to 2.72, connections to FTP directories would have used the "FTP Import" and "FTP Export" providers. While these providers still exists in Grooper as legacy import and export providers, they are deprecated components and no longer recommended for use. For increased functionality in 2.72 and beyond, create an FTP '''[[CMIS Connection]]''' and utilize the new [[CMIS Import]] and [[CMIS Export]] capabilities.
 
[[Category:Articles]]

Revision as of 08:31, 10 May 2024

This article is about an older version of Grooper.

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

202520232.72

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

The connected FTP directory or directories are exposed as a CMIS Repository, which mimics its file system hierarchy. Once connected, you can import, export, search, and browse documents from Grooper.

The FTP binding can be used for import operations via CMIS Import using either "Import Descendants" or "Import Query Results". It can be used for export operations via the Export activity using a CMIS Export configuration.

Glossary

CMIS Connection Type:

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 Export: CMIS Export is an Export Definition available when configuring an Export Behavior. It exports content over a cloud CMIS Connection, allowing users to export documents and their metadata to various on-premise and cloud-based storage platforms.

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.

Export: output Export is an Activity that transfers documents and extracted information to external file systems and content management systems, completing the data processing workflow.

FTP: FTP is a connection option for cloud CMIS Connections. It connects Grooper to FTP directories 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 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).

Node Tree: The Node Tree is the hierarchical list of Grooper node objects found in the left panel in the Design Page. It is the basis for navigation and creation in the Design Page.

Project: package_2 Projects are the primary containers for configuration nodes within Grooper. The Project is where various processing objects such as stacks Content Models, settings Batch Processes, profile objects are stored. This makes resources easier to manage, easier to save, and simplifies how node references are made in a Grooper Repository.

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:

How To: Create a New FTP Connection

Add the CMIS Connection

  • Expand the Projects Folder in the Node Tree
  • Right-click your selected Project.
  • Select "Add", then "CMIS Connection".

Set the Connection Type

  • On the CMIS Connection tab, expand the "Connection Settings" Property.
  • There, you will find the Repositories Property.
  • Select the ellipses.

Configure the Connection

This brings up the "FTP Repository Configuration Collection Editor". Here, you can enter one or more FTP paths to be used as the repository's root. You will also need to enter the user name and password to access the FTP server. The repository's name will default to the end destination folder. Or, you can name the repository under "Repository Name". Press **Add** to enter a new path, establishing the folder at the end of that path as a repository.

There are three optional properties:

  • Time Out - Set the time (in seconds) for calls to the FTP server before a timeout error. This is 30 seconds by default.
  • Enable SSL - False by default. If true, secured socket layers will be enabled.
  • Read Only - Change this to "True" if you want these folders to be read only. This can be useful to prevent unintentional changes to the file system if you only need the connection to a file system for imports.

List Repositories

After you Save, press the "List Repositories" button to show the folder paths you just added as repositories.

Import Repository

Select "Import Repository" to bring in these repositories for Grooper to import and export to the corresponding folders in the connected file system. The red circle on the upper right corner of the icon will go from red to green once the repository is imported.

Version Differences

Prior to 2.72, connections to FTP directories would have used the "FTP Import" and "FTP Export" providers. While these providers still exists in Grooper as legacy import and export providers, they are deprecated components and no longer recommended for use. For increased functionality in 2.72 and beyond, create a CMIS Connection.