SFTP (CMIS Binding)

This article is about the current version of Grooper. Note that some content may still need to be updated.
2025	2023	2.72

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

About

The SFTP binding can be selected as a connection option when configuring a CMIS Connection. After configuring the connection, the SFTP directory (or SFTP 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 SFTP CMIS Repository mimics the SFTP directory's file system hierarchy as well. Once a CMIS Repository is created, you can import, export, search, and browse documents from Grooper.

• The SFTP 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 SFTP 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.

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

How To: Create a New SFTP CMIS Connection

Click here for an interactive walkthrough

1. Right-click the Project (or Folder) where you want to add your CMIS Connection.
2. Click "Add", then select "CMIS Connection..."
3. Name the CMIS Connection.
4. Click Execute to create.
5. Within your newly created CMIS Connection, click the hamburger icon at the far end of the Connection Settings property to access the dropdown list and choose your Connection Type.
6. From the list, select SFTP.
7. Expand the Connection Settings property and expose the Repositories sub-property.
8. Click the ellipses to add a Repository configuration.
9. Within the Repositories List Window that pops up, click the Add button.
10. Adding the unconfigured Repository to the list, you will need to enter the Hostname for the Repository.
11. Name your Repository.
12. Enter the appropriate username and password associated with the Hostname.
13. When finished, click OK.
14. Save.
15. Click the List Repositories button.
16. From the list, select the Repository you wish to import.
17. Click the Import Repositories button.
18. Ensure that the selected Repository is the one you want, and click Execute.
19. Once successfully imported, your Repository will appear as in the Node Tree as a child Object of your CMIS Connection.

Importing and Exporting with SFTP

Importing

Submitting an Import Job

Click here for an interactive walkthrough

1. Click the Imports cloud icon on either on the Grooper homepage, or within the icons along the top row.

   • IMPORTANT: You will need to have an Import Watcher Service installed and running before submitting an Import Job.

2. On the Imports page, click the Add New Jobs button.
3. A Submit Import Job window will appear. Enter a description.
4. Next, select the Provider which will define your Import job by clicking the hamburger icon at the end of the Provider property.
5. Choose Import Descendants.

   • SFTP is not a queryable CMIS Binding. Hence, Import Query Results cannot be chosen as the Provider when importing via a SFTP CMIS Connection, only Import Descendants

6. Expand the Provider property to expose the Repository sub-property and choose the SFTP Repository.
7. Choose what folder within the Repository you want to import Batch Content from; otherwise Grooper will import the entirety of the Repository.
8. Click Submit to import.
9. You can view your imported Batch by going to the Design page and clicking Batches --> Test --> Imported Batches and selecting the newly imported Batch.

Exporting

Configuring an Export Behavior

Click here for an interactive walkthrough

1. Click the ellipses at the end of the Behaviors property to configure.

   • Behaviors can be configured on any Content Type Node Object - be it Content Models, Document Types, or Content Categories. Content Models are the most common place to configure Behaviors.

2. The Behaviors List window will pop up. Click the add button and select Export Behaviors from the add list.
3. Configure Export Definitions by clicking the ellipses at the end of the Export Definitions property.
4. Click the add button and select CMIS Export.
5. Select the Repository where you will be exporting your Batch contents.
6. If you want to export to the root of your Repository, leave the Target Folder property defaulted to / ; otherwise, you can click ... to open up the Target Folder select window and choose the specific location of your export.
7. Define the content your exporting by selecting the Object Type.
8. Configure Read Mappings, Write Mappings, and Export Format if need be.
9. When finished, click OK.
10. Click OK to finalize configurations of the Export Behavior.
11. Save.