2023:FTP (CMIS Binding): Difference between revisions

From Grooper Wiki
← Older edit
m Dgreenwood moved page FTP (CMIS Binding) - 2023 to 2023:FTP (CMIS Binding) without leaving a redirect
No edit summary
Tag: Manual revert
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{AutoVersion}}
{{AutoVersion}}
[[image:1559585255711-691.png|frame]]
<blockquote>{{#lst:Glossary|FTP}}</blockquote>
== About ==
The FTP binding can be selected as a connection option when configuring a '''CMIS Connection'''. After configuring the connection, the FTP directory (or FTP directories) are exposed to Grooper as a '''CMIS Repository'''. CMIS Repository nodes are created as children of the CMIS Connection by importing a reference to their source location.


<blockquote style="font-size:14pt">
The FTP CMIS Repository mimics the FTP directory's file system hierarchy as well.  Once a CMIS Repository is created, you can import, export, search, and browse documents from Grooper.
The '''FTP''' connection type is a CMIS Binding that connects Grooper to FTP directories for import and export operations. 
* The FTP binding can be used for import operations via [[CMIS Import]] using "Import Descendants" only. [[CMIS Query|CMIS Queries]] are not supported.
</blockquote>
* It can be used for export operations via [[CMIS Export]].
**<li class="attn-bullet"> The FTP binding only has one writable property for exported documents: "Name". As such, this binding is unsuitable for "mapped exports".  However, you can still export metadata as a "buddy file" by adding a metadata format in your [[CMIS Export]] definition.


The connected FTP directory or directories are exposed as a CMIS Repository, mimicking its file system hierarchy as well.  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 Document Export activity.
FTP directories use a a hierarchical file system (HFS), where folders and files are represented by simple object types.  As such, this binding is suitable for the [[CMIS Export#Unmapped Export|Unmapped Export]] provider rather than the [[CMIS Export#Mapped Export|Mapped Export]] provider.  You can still export metadata as a "buddy file" by adjusting the "Metadata Export" property in the Document Export activity's Export Settings.


FTP connections work largely the same as [[SFTP]] connections.  It just uses the FTP protocol instead.  How you set it up and use it within Grooper is functionally the same.


== How To: Create a New FTP Connection ==
== How To: Create a New FTP Connection ==
 
=== Add the CMIS Connection ===
<tabs>
*Expand the Projects Folder in the Node Tree
<tab name="Step 1">
*Right-click your selected Project.
===== Add the 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 ===
 
*On the CMIS Connection tab, expand the "Connection Settings" Property.
</tab>
*There, you will find the Repositories Property.
<tab name="Step 2">
*Select the ellipses.
===== Set the Connection Type =====
 
 
 


[[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]]


 
=== Configure the Connection ===
</tab>
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.
<tab name="Step 3">
===== 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]]'''.
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 Legacy Export providers, they are depreciated components and no longer recommended for use. For increased functionality in 2.72, create an FTP '''[[CMIS Connection]]''' and utilize the new [[CMIS Import]] and [[CMIS Export]] capabilities.
 
[[Category:Articles]]

Latest revision as of 14:28, 3 June 2025

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.

About

The FTP binding can be selected as a connection option when configuring a CMIS Connection. After configuring the connection, the FTP directory (or FTP directories) are exposed to Grooper as a CMIS Repository. CMIS Repository nodes are created as children of the CMIS Connection by importing a reference to their source location.

The FTP CMIS Repository mimics the FTP directory's file system hierarchy as well. Once a CMIS Repository is created, you can import, export, search, and browse documents from Grooper.

  • The FTP binding can be used for import operations via CMIS Import using "Import Descendants" only. CMIS Queries are not supported.
  • It can be used for export operations via CMIS Export.
    • The FTP binding only has one writable property for exported documents: "Name". As such, this binding is unsuitable for "mapped exports". However, you can still export metadata as a "buddy file" by adding a metadata format in your CMIS Export definition.


FTP connections work largely the same as SFTP connections.  It just uses the FTP protocol instead.  How you set it up and use it within Grooper is functionally the same.

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.

Retrieved from "https://wiki.grooper.com/index.php?title=2023:FTP_(CMIS_Binding)&oldid=28955"