Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MARP-795: Add README_DE #44

Merged
4 commits merged into from
Sep 12, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 86 additions & 0 deletions sftp-connector-product/README_DE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
Axon Ivy's **SFTP Konnektor** unterstützt dich dabei, sicheren Dateitransfer in deine Arbeitsabläufe integriert. Mit diesem SFTP-Client kannst du einfach und sicher Dateien zu einem Remote-Computer übertragen und von dort empfangen.

Dieser Konnektor:

- verwendet das SFTP-Protokoll
- basiert auf [JSch](http://www.jcraft.com/jsch/) zur Handhabung der SFTP-Verbindungen und -Operationen
- ist eine Java-Implementierung von SSH2
- ermöglicht es dir, eine Verbindung zu einem sshd-Server herzustellen und Port-Weiterleitung, X11-Weiterleitung, Dateitransfer usw. zu nutzen
- macht es einfach, sicheren Dateitransfer in deine Arbeitsabläufe zu integrieren


## Demo

1. Click on **File to Upload** and select one file from your local directory.

![Upload-File](images/Upload-File.png)

Path: Sftp/SftpUploadFile -> uploadFile(fileToBeUploaded, filename)

Description: this operation will upload the file to the root path on the server.

Parameters:

- fileToBeUploaded -> the file to upload as java.io.InputStream

- filename -> the file name as String


2. Click on **Refresh** to list all the files on the remote directory.

- Select one file from the list and click on **Download**.

![Download-File](images/Download-File.png)

Path: Sftp/SftpDownloadFile -> downloadFile(remoteFileName) Result: toFile

Description: this operation will download the file from the server.

Parameters:

- remoteFileName -> the file name as String

Result:

- toFile -> the File to download as java.io.File

The **SftpClientDemo** HTML Dialog contains all the final operations to upload, list and download the file from/to the SFTP Server.

![SftpClientDemo](images/SftpClientDemo.png)

## Setup

Before starting the demo, please make sure to have an SSH/SFTP server on your computer (respective the computer you want to access). For testing, the free
[Rebex Tiny SFTP Server](https://www.rebex.net/tiny-sftp-server/) is recommended.
1. Open the following settings in “RebexTinySftpServer.exe.config” with a text editor and update the following values:
![RebexTinySftpServer.exe.config](images/RebexTinySftpServer.exe.config.png)

2. Open the `configuration/variables.yaml` in your Designer and update the following global variables:

```

Variables:

com.axonivy.connector.sftp.server:
# The host name to the SFTP server
host: 'localhost'

# The password to the SFTP server
password: pwd

# The port number to the SFTP server
port: 22

# The username to the SFTP server
username: 'usr'

```

4. Save the changed settings.


### Prerequisites:

* Working **SFTP Server**.
* You will also need the correct Server host name and the port number.

Loading