SFTP ファイル転送ワークフロー

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:8分
  • SFTP ファイル転送アクティビティパックには、複数のアクティビティを使用して SFTP サーバーのファイルを管理するスコープ対象ワークフローが含まれます。

    SFTP ファイル転送ワークフローの最大アクティビティ数は 10,000 に設定されています。このため、ワークフローは 1 つのサーバーから別のサーバーに最大 1,000 のファイルを移動できます。

    ワークフローへのアクセス

    • 移動先 ワークフロー > ワークフローエディター をクリックし 、[ワークフロー ] タブを選択します。
    • SFTP ファイル転送ワークフローをクリックして開きます。
    • ワークフロー ヘッダーの情報アイコンをクリックし、プロパティ ダイアログ ボックスを表示します。

    入力変数

    表 : 1. [SFTP ファイル転送ワークフロー] 入力変数
    変数 説明 デフォルト値
    ソース ホスト 移動するファイルを含むサーバーの名前または IP アドレス。
    ソース ポート ソース サーバーとの通信に使用するポート番号。 22
    ソース ディレクトリー ソース ファイルが置かれているディレクトリーへのフル パス。
    ソース ファイル 移動する特定のソース ファイルの名前。このリストのファイル名はセミコロンで区切ります。このフィールドはワイルド カードの使用をサポートしています。このフィールドの値が他のフィールドのオプションにどのように影響するかについては、表の下のセクションを参照してください。
    除外ファイル 移動から除外する特定のソース ファイルの名前。システムは、ソース ディレクトリーまたはサブフォルダーにある他のすべてのファイルを移動します。このリストのファイル名はセミコロンで区切ります。このフィールドはワイルド カードの使用をサポートしています。このフィールドの値が他のフィールドのオプションにどのように影響するかについては、表の下のセクションを参照してください。
    ターゲット ホスト ファイルの移動先のサーバーの名前または IP アドレス。
    ターゲット ポート ターゲット ホストとの通信に使用するポート番号。 22
    日時形式 $[DateTime] 変数が [ターゲット ディレクトリー] または [ターゲット ファイル] フィールドで使用される場合に適用されるタイムスタンプ形式。システムはインスタンスの現在時刻を使用してタイムスタンプ値を作成します。 yyyy-MM-dd
    ターゲット ディレクトリー ファイルの移動先のターゲット ホスト内のディレクトリーへのパス。$[DateTime] 変数をディレクトリー名に追加すると、名前にタイムスタンプが含まれるターゲット ディレクトリーを指定できます。たとえば、ターゲット ディレクトリーに次のようなパスを入力できます。/user/jacinto.gawron/documents/projects_$[DateTime]。これにより、ディレクトリーは projects_20150505 になります。タイムスタンプ変数を使用すると、システムは [日時形式] フィールドで指定された形式を使用します。
    ターゲット ファイル タイムスタンプが追加されたときにターゲット ファイル名に使用する形式。次の変数を使用すると、ファイル名のプリフィックスとしてタイムスタンプを追加したり、ファイル名にタイムスタンプを挿入したりするようにシステムを設定することができます。
    • $[DateTime][日時形式] フィールドで定義された形式を使用する現在のタイムスタンプ。
    • $[SourceFile]:完全なファイル名。
    • $[SourceFile:Base]:拡張子のない基本ファイル名。
    • $[SourceFile:Ext]:ファイル拡張子のみ。

    タイムスタンプがプリフィックスとして追加されたターゲット ファイル名は、次のように表されます。$[DateTime]_$[SourceFile]。このため、ファイル名は 20150505_file1.txt のように表示されます。

    名前にタイムスタンプが挿入されたターゲット ファイル名は、次のように表されます。$[SourceFile:Base]_$[DateTime]$[SourceFile:Ext]。このため、ファイル名は file1_20150505.txt のように表示されます。

    移動条件を適用 チェックボックスをオンにすると、ファイル転送に条件が適用されます。このチェックボックスをオンにすると、条件設定に追加するフィールドが表示されます。 false
    最小ファイル サイズ (バイト) ターゲット ファイルの最小サイズ要件を定義する条件。この設定は、ファイルが有効かどうかを判断するのに役立ちます。このフィールドは、[移動条件を適用] チェックボックスが選択された場合に表示されます。 0
    最大ファイル サイズ (バイト) ターゲット ファイルの最大サイズ要件を定義する条件。このフィールドは、[移動条件を適用] チェックボックスが選択された場合に表示されます。 -1
    ファイルは次の値より古くない このファイルの経過時間範囲の最も古い許容日付を設定する条件。範囲は、指定された日付の 00:00 (深夜) から開始されます。このフィールドは、[移動条件を適用] チェックボックスが選択された場合に表示されます。
    ファイルは次の値より新しくない このファイルの経過時間範囲の最も新しい許容日付を設定する条件。範囲は指定された日付の 23:59 に終了します。このフィールドは、[移動条件を適用] チェックボックスが選択された場合に表示されます。
    サブフォルダーを含める ソース ディレクトリー内のサブフォルダーからファイルを移動するには、チェックボックスをオンにします。選択内容がフォーム内の他のフィールドにどのように影響するかについては、表の下のセクションを参照してください。
    移動順 ファイルがソースからターゲットに移動される順序。可能なオプションは:
    • [なし] (ソース ディレクトリー内のファイルと同じ順序)
    • タイムスタンプ別
    • ファイル名別
    • ファイル サイズ別
    ソート順 [移動順] フィールドで選択したオプションを使用して、ターゲット ディレクトリーでファイルがソートされる順序。ソート オプションは [上昇] および [降順] です。 desc
    再試行の最大数 タイムアウト前にアクティビティがターゲット ホストにコネクトしたり、ファイルを移動したりできる試行回数。ファイルの移動またはホストへの接続の再試行制限を超えた場合、システムはエラーをログに記録します。エラーの最大数を超えない場合、システムは再びコネクトを試行するか、次に指定したファイルを移動しようとします。 2
    再試行間の時間 (秒) ターゲットへのコネクトまたはファイルの移動開始を繰り返す間隔の秒数。 10
    失敗の最大数 試行が終了する前に、システムがターゲット ホストへのコネクトに失敗したり、ファイルの移動を失敗したりできる許容回数。設定した再試行の回数を超えた場合にエラーが発生します。デフォルト設定を使用すると、システムが 2 回の再試行後にターゲットにコネクトしたり、ファイルを移動したりできない場合、エラーが発生します。 0
    重複ファイル アクション 移動対象のファイルがすでにターゲット ディレクトリー内に存在する場合に実行するアクション。以下から選択可能です。
    • [上書き] (ファイルが存在する場合)
    • インデックスを使用して名前を変更
    • 移動しない
    上書き
    ファイル属性を保存 コピーしたファイルのソース ファイルのタイム スタンプとモード情報を使用するには、チェック ボックスをオンにします。このチェック ボックスをオフにすると、コピーしたファイルには現在のタイム スタンプとモードがあります。
    注:
    このタイム スタンプはファイル属性であり、ファイル名には追加されません。
    false
    成功時に、ファイルをソースから削除 元のファイルが新しい場所にコピーされたときにソース ディレクトリーから削除するには、チェック ボックスをオンにします。このチェック ボックスをオフにすると、ソース ファイルがソース ホストの現在の場所に保持されます。 false
    失敗時に、移動済みファイルをターゲットとして保持 ファイル転送操作全体が失敗した場合でも、正常に移動されたターゲット上のファイルを保持するには、チェック ボックスをオンにします。このチェック ボックスをオフにすると、一般的なエラーが発生した場合、転送されたすべてのファイルがターゲットから正常に削除されます。 true
    ソースの認証情報タグ ソースホストで SSH コマンドを実行するために、このアクティビティが使用する必要のある特定のオーケストレーションアクティビティの認証情報エイリアス
    ターゲットの認証情報タグ このアクティビティがターゲット ホスト上で SSH コマンドを実行するために使用する必要がある特定の認証情報タグ。

    ファイル選択ロジック

    ソース ホストから移動するファイルを選択する場合、システムは次のロジックを使用します。
    • [ソース ファイル] および [除外ファイル] フィールドが空の場合、システムはソース ディレクトリー内のすべてのファイルを移動します。
    • [サブフォルダーを含める] チェック ボックスがオンの場合、次の依存関係が存在します。
      • [ソース ファイル] および [除外ファイル] フィールドでファイルが指定されていない場合、システムはソース ディレクトリー内のすべてのファイルとソース ディレクトリーのすべてのサブフォルダー内のすべてのファイルを移動します。
      • [ソース ファイル] フィールドにファイル名が含まれている場合、システムはソース ディレクトリーまたはそのサブフォルダーのいずれかの場所からそのファイルを移動します。
      • [除外ファイル] フィールドにファイル名が含まれている場合、システムはソース ディレクトリーとそのサブフォルダーから除外されたファイル以外のすべてのファイルを移動します。
    • [サブフォルダーを含める] チェック ボックスがオフになっていると、システムはソース ディレクトリーのみを調べて、移動または除外するファイルを探します。