チェーンの一部として単一の Secure File Transfer Protocol(SFTP)サーバと対話するには、SFTP 接続コマンドを含むステップを追加します。
注: このコネクタを使用するには、組織独自の SFTP サーバーへのアクセスが必要です。Workiva は、 SFTP サーバーをホストまたは提供しません。
これらのコマンドを有効にするには、IT 管理者はまずSFTP 接続 を設定します。
削除
SFTP サーバー上のファイルやフォルダを削除するには、Delete コマンドを使用します。
プロパティ
プロパティ |
詳細 |
ファイル |
削除するファイルとフォルダを入力します。複数のファイルやフォルダに一致させるには、ワイルドカード文字* . |
フォルダをスキップする |
指定したファイルと一致するフォルダを無視するには、このボックスにチェックを入れます。 |
再帰的 |
指定したフォルダとその内容全体を削除するには、このボックスにチェックを入れます。 |
出力
出力 |
出力タイプ |
削除されたファイル |
JSON |
削除されたフォルダ |
JSON |
すべての項目を削除 |
JSON |
終了コード
コード |
タイプ |
詳細 |
0 |
成功 |
成功 |
2 |
エラー |
タスク失敗 |
6 |
エラー |
削除マークが付けられたディレクトリがスキップされるように設定されておらず、再帰的が設定されていなかった。 |
ファイルをダウンロード
SFTPサーバーからファイルをダウンロードするには、Download File コマンドを使用する。
プロパティ
プロパティ |
詳細 |
ファイル |
SFTPサーバーから取得するファイル名を入力します。 注: グループ反復でこのコマンドを使用する場合、ファイルを識別するために、コマンド反復のリモートファイル反復 変数を使用する。 |
パラレルダウンロード |
大容量ファイルなどの並行ダウンロードを有効にするには、このボックスをチェックします。 |
スレッド数 |
Parallel Download を選択した場合は、並行して実行するスレッド数を選択します。よくわからない場合は、デフォルト値の3のままにしておいてください。 |
出力
出力 |
出力タイプ |
ダウンロードしたファイル |
ファイル |
終了コード
コード |
タイプ |
詳細 |
0 |
成功 |
成功 |
2 |
エラー |
タスク失敗 |
取得
SFTPサーバーからファイルを取得するには、Get 。
プロパティ
プロパティ |
詳細 |
ファイル |
取得するファイルを入力します。複数のファイルにマッチさせるには、ワイルドカード文字* . |
リンク先 |
ファイルの保存先を入力します。複数のファイルを検索するには、ディレクトリを入力します。 |
出力
出力 |
出力タイプ |
取得ファイル |
JSON |
取得ファイル (テキスト) |
文字列 |
終了コード
コード |
タイプ |
詳細 |
0 |
成功 |
成功 |
2 |
エラー |
タスク失敗 |
6 |
エラー |
ディレクトリはスキップされず、削除のマークもつかなかった。 |
リスト・ディレクトリ
SFTPサーバーのディレクトリ内のファイルを一覧表示するには、List Directory コマンドを使用する。
プロパティ
プロパティ |
詳細 |
ディレクトリ |
リストアップするコンテンツのあるディレクトリを入力します。ディレクトリ内の複数のファイルやフォルダをリストアップするには、ワイルドカード文字* を使用します。 注: このコマンドを、後で繰り返し実行するDownload Fileコマンドのためにファイルをリストアップするために使用する場合は、ダウンロードするファイル名を含めてください。日付やタイムスタンプに基づくなど、反復ごとに名前が変わる場合は、ワイルドカード文字* を含める。 |
詳細レベル |
ファイルとフォルダの詳細レベルを選択します:
- 短い 、ファイル名とフォルダ名のみ。
- フル 、所有権と許可を含む名前と追加情報。
|
出力
終了コード
コード |
タイプ |
詳細 |
0 |
成功 |
成功 |
2 |
エラー |
タスク失敗 |
5 |
エラー |
指定されたディレクトリが見つからない |
ディレクトリを作成する
SFTPサーバー上に新しいディレクトリを作成するには、Make Directory コマンドを使用する。
プロパティ
プロパティ |
詳細 |
ディレクトリ |
SFTPサーバーに作成するディレクトリを入力します。 |
再帰的 |
ディレクトリが存在しない場合、ディレクトリ全体のパスを作成するには、このボックスをチェックする。 |
出力
なし
終了コード
コード |
タイプ |
詳細 |
0 |
成功 |
成功 |
2 |
エラー |
タスク失敗 |
4 |
エラー |
指定したディレクトリの作成エラー |
6 |
成功 |
ディレクトリはすでに存在する |
移動
SFTPサーバー上のファイルを移動するには、Move コマンドを使用する。
プロパティ
プロパティ |
詳細 |
ファイル |
移動するファイルを入力します。複数のファイルやフォルダに一致させるには、ワイルドカード文字* . |
リンク先 |
ファイルの保存先を入力します。複数のファイルを移動するには、ディレクトリを入力します。 |
出力
出力 |
出力タイプ |
移動したファイル |
JSON |
移動したファイル(テキスト) |
文字列 |
終了コード
コード |
タイプ |
詳細 |
0 |
成功 |
成功 |
2 |
エラー |
タスク失敗 |
4 |
エラー |
複数のファイルを移動する場合、移動先は既存のディレクトリでなければならない |
5 |
エラー |
指定されたソース・ファイルが見つかりません。 |
置く
SFTPサーバーにファイルをアップロードするには、Put 。
プロパティ
プロパティ |
詳細 |
ファイル |
アップロードするファイルを入力します。複数のファイルやフォルダに一致させるには、ワイルドカード文字* . |
リンク先 |
ファイルの保存先を入力します。複数のファイルをアップロードするには、ディレクトリを入力します。 |
出力
出力 |
出力タイプ |
リモートファイル |
JSON |
リモートファイル(テキスト) |
文字列 |
終了コード
コード |
タイプ |
詳細 |
0 |
成功 |
成功 |
2 |
エラー |
タスク失敗 |
6 |
エラー |
ディレクトリはスキップされず、削除のマークもつかなかったが、再帰的は設定されていなかった。 |