SFTP / SSH

The SFTP / SSH connection in linqi allows files to be sent to or retrieved from servers via SFTP, as well as commands to be executed via SSH. This can be useful for various services, for example there are automated letter sending services which are addressed with SFTP.

info

To be able to use the SSH connection, you must activate the corresponding feature in the business unit management.

Connection

To be able to communicate with a server via the SSH actions in linqi, you must first create a corresponding connection in the connection management ( button in the navigation). In the connection list, you can use the plus button on the top right-hand side and then select SSH.

You have the following options in the connection settings

• Display name:
  The display name helps you to reuse the connection and can be freely assigned.
• Domain / IP:
  Enter the domain or IP address of the server you want to connect to here.
• Type of connection:
  Here you can define the way linqi logs on to the server. The following options are available:
  • User name and password:
    Here linqi attempts to log on to the server with a user name and password. No certificates are used.
  • Certificate with private key:
    Here linqi uses a user name and a certificate containing a private key to log in.
  • Certificate with public key:
    This requires a username, password and a certificate with a public key.
• Username:
  Here you enter the user name with which linqi logs on to the server.
• Password:
  If you have selected username and password or certificate with public key as the type of connection, you must enter the user's password here. This cannot be requested again afterwards.
• Certificate: If you have selected Certificate with private key or Certificate with public key as the type of connection, you must upload the corresponding certificate here. This cannot be queried again afterwards.
• Authorized persons:
  Here you can restrict which persons can use this connection in the process designer, details can be found here.

Actions

List SFTP files

You can use this action to list the files and folders in a specific path on the server. For example, you can check whether a specific file already exists or download a list of files.
The following configuration options are available:

• Connection:
  Select the connection (see above) which is used to log on to the server.
• Path:
  Define here the path on the server which is to be searched.
• Filter:
  You can define a filter here. For example, if you only want to list PDF files, you can enter .pdf here. If you want to define several filters, you can separate them with comma values. If you define several filters, these are combined. So if you enter .pdf, .docx here, all PDF and Word files will be found.
• Enable error output:
  As soon as you activate this switch, you can Intercept and process errors.

This action provides the following placeholders:

• Files & folders:
  This placeholder contains all files and folders found. This can be used, for example, in a loop action to run through all the objects found, or in other places to insert the values separated by commas.
  • Filename:
    This value returns the name of the file or folder.
  • Complete path:
    This value returns the full path to the file or folder, and so includes the folder.
  • Quantity:
    Returns the number of entries found.
• Files:
  This placeholder contains all files found without folders. The handling and subordinate properties are exactly the same as those of the files & folders placeholder.
• Folders:
  This placeholder contains all folders found without files. The handling and subordinate properties are exactly the same as those of the files & folders placeholder.

Download SFTP file

You can use this action to download the content of a file from the server. You can then transfer these files to a SharePoint environment, for example, display them in a form or attach them to an e-mail.
The following configuration options are available:

• Connection:
  Select the connection (see above) that is used to log in to the server.
• Filename:
  Enter the name of the file to be downloaded here. This can of course also be defined using a placeholder, e.g. a file name that you have previously queried using the SFTP list files action.
• Folder:
  Here you can define the path of the folder in which the file to be downloaded is located.
• Overwritten file name:
  The file name of the file on the server is used by default. If you enter a value here, this value is used as the file name. This allows you to attach the file to an e-mail under a different name, for example.
• Enable error output:
  As soon as you activate this switch, you can Intercept and process errors.

This action provides the following placeholders:

• Downloaded file: You can use this placeholder to reference the downloaded file. For example, you can attach it to an e-mail or display it in forms.

Upload SFTP file

You can use this action to upload a file from linqi to the server.
The following configuration options are available:

• Connection:
  Select the connection (see above) which is used to log in to the server.
• File:
  You can use this placeholder to define the file to be uploaded. This could, for example, be a file from a form, a generated PDF file or a file that has been uploaded from another system.
• Folder:
  Define the path of the folder on the server to which the file is to be uploaded here.
• Enable error output:
  As soon as you activate this switch, you can Intercept and process errors.

Create SFTP folder

You can use this action to create a folder on the server. For example, you can create a folder for the running process to which you can then upload files using the corresponding action.
The following configuration options are available:

• Connection:
  Select the connection (see above) that is used to log in to the server.
• Folder name:
  Enter the name of the folder to be created here. You could of course also use a placeholder to reference the process number or similar here.
• Superordinate path:
  Here you define the path of the folder in which the new folder is to be created.
• Enable error output:
  As soon as you activate this switch, you can Intercept and process errors.

Delete SFTP file/folder

You can use this action to delete a file or folder on the server.
The following configuration options are available:

• Connection:
  Select the connection (see above) here which is used to log in to the server.
• Path:
  You can use this to specify the path to the folder or file. This is deleted when the process is executed.
• Enable error output:
  As soon as you activate this switch, you can Intercept and process errors.

Execute SSH command

You can use this action to execute an SSH command on the server. For example, you can start a script.
The following configuration options are available:

• Connection:
  Select the connection (see above) here which is used to log in to the server.
• Command:
  Here you can specify the command to be executed on the server.
• Enable error output:
  As soon as you activate this switch, you can Intercept and process errors.

This action provides the following placeholders:

• Result:
  This placeholder provides the response text from the server.