コンポーネント > ファイルリスナ > ファイルリスナの設定
  

ファイルリスナの設定

ファイルリスナを作成する前に、次の条件を確認します。
ファイルリスナを設定するには、次の手順を実行します。
    1ファイルリスナを作成するには、[新規] > [コンポーネント] > [ファイルリスナ]をクリックし、[作成]をクリックします。
    ファイルリスナを編集するには、[エクスプローラ]ページでファイルリスナに移動します。ファイルリスナをリストする行で、[アクション]をクリックし、[編集]を選択します。
    ランタイム環境、コネクタタイプ、接続、またはリスナルールのプロパティの更新などのファイルリスナを編集する場合、ファイルリスナをリセットする必要があります。警告メッセージが表示されます。続行するには、[OK]をクリックします。このアクションにより、以前に追跡を行ったファイルのリストがクリアされます。
    2次のファイルリスナの詳細を設定します。
    パラメータ
    説明
    ファイルリスナの名前
    ファイルリスナの名前。ファイルリスナの名前は組織内で一意であることが必要です。ファイルリスナの名前には、英数字、スペース、アンダースコアを含めることができます。名前の先頭には英字またはアンダースコアを指定する必要があります。
    ファイルリスナの名前の大文字と小文字は区別されません。
    場所
    ファイルリスナが作成されるプロジェクトディレクトリ。
    説明
    ファイルリスナの説明(省略可能)。最大長は1024文字です。
    ステータス
    ファイルリスナのステータス(有効または無効)。無効なファイルリスナは、指定したフォルダでファイルをリスニングしません。
    ランタイム環境
    ファイルリスナの実行に使用されるSecure Agentを含むランタイム環境。
    ソースタイプ
    ファイルリスナがリスニングするソースのタイプ。次のうち1つのソースタイプを選択します。
    3ファイルリスナを実行するスケジュールを設定します。
    パラメータ
    説明
    実行
    ファイルリスナを実行する頻度(毎日、毎週、または毎月)。
    開始日
    ファイルリスナの実行を開始する日付。
    終了日
    ファイルリスナの実行を終了する日付。
    無期限に繰り返す
    ファイルリスナは無期限に実行されます。
    開始
    ファイルリスナが実行を開始する時刻。
    次まで確認
    ファイルリスナが実行を終了する時刻。
    次ごとに確認
    ファイルリスナが、リスニング対象フォルダ内のファイルを確認する頻度(秒単位、分単位、または時間単位)。
    タイムゾーン
    ファイルリスナを実行する基準となるタイムゾーン。
    実行する日数
    ファイルリスナを毎週実行することを選択した場合は、ファイルリスナを実行する曜日。
    月の日付
    ファイルリスナを毎月実行することを選択した場合は、ファイルリスナを実行する月の日付。
    曜日
    ファイルリスナを毎月実行することを選択した場合は、ファイルリスナを実行する月の曜日。
    ファイルリスナを毎月実行することを選択した場合は、ファイルリスナを実行する週。例えば、次の第4日曜日にファイルリスナを実行する場合は、[曜日][日曜日][週][第4週]を選択します。
    4[障害管理]では、次のオプションを選択できます。
    5[保存]をクリックします。

サーバーソースタイプ用のファイルリスナの設定

ファイルリスナの詳細で、サーバーとしてソースタイプを選択する際、ファイルリスナはサーバーのイベントをリスニングします。
ファイルリスナは、AS2サーバー、HTTPSサーバー、SFTPサーバーでイベントをリスンするように設定できます。例えば、AS2サーバーがファイルを受信するときに通知を送信するようにファイルリスナを設定できます。ファイルリスナ詳細の設定に関する詳細については、ファイルリスナの設定を参照してください。
サーバーソースタイプを選択する際は、次のパラメータとファイルリスナルールを設定します。
    1次のパラメータを設定して、ファイルリスナがリスニングするイベントを定義します。
    パラメータ
    説明
    イベントプロバイダ
    ファイルリスナがリスニングするサーバータイプ。ファイルリスナは、AS2サーバー、HTTPSサーバー、またはSFTPサーバーをリスンするように設定できます。
    イベントのタイプ
    ファイルリスナがリスニングするサーバーイベントのタイプ。AS2サーバーに定義できるイベントタイプは次のとおりです。
    • - AS2メッセージの受信失敗
    • - AS2メッセージの受信成功
    HTTPSサーバーに定義できるイベントタイプは次のとおりです。
    • - HTTPSのアップロード失敗
    • - HTTPSのアップロード成功
    SFTPサーバーに定義できるイベントタイプは次のとおりです。
    • - SFTPのアップロード失敗
    • - SFTPのアップロード成功
    例えば、イベントタイプが「SFTPのアップロード失敗」の場合、ファイルリスナは、SFTPサーバーでファイルのアップロードが失敗したときに通知を送信します。
    2次のパラメータを設定して、リスナルールを定義します。
    パラメータ
    説明
    キー
    イベントの属性。
    タイプ
    キー値をフィルタする方法。
    • - [次を含む]。値を含むキーをフィルタ処理します。
    • - [次の値に等しい]。完全一致を見つけてルールを実行します。
    キーの値。

コネクタソースタイプ用のファイルリスナの設定

ファイルリスナの詳細で、コネクタとしてソースタイプを選択する際、ファイルリスナは接続をリスニングします。
ファイルリスナ詳細の設定に関する詳細については、ファイルリスナの設定を参照してください。
    1次のパラメータを設定して、接続を定義します。
    パラメータ
    説明
    接続タイプ
    ファイルリスナがリスニングする接続のタイプ。
    接続
    ファイルリスナがリスニングする接続。
    2次のパラメータを設定して、リスナルールを定義します。
    パラメータ
    説明
    フォルダパス
    ファイルリスナがリスニングするフォルダへのパス。
    注: ファイルリスナは、NFSおよびCIFSをサポートするネットワーク共有上のファイルおよびディレクトリにアクセスできます。
    ソースファイルシステムへの相対パスを入力できます。相対パスを入力するには、パスをピリオドで開始し、その後にスラッシュを配置します(./)。パスは、接続で指定されたソースディレクトリの相対パスです。
    パターンタイプ
    ファイルリスナがリスニングするファイル名のパターンを決定します。次のいずれかのパターンを選択します。
    • - ワイルドカード
    • - Regex
    • - インジケータファイル
    ファイルパターン
    ファイルリスナがリスニングするファイル名パターン。
    • - ワイルドカード: ファイル名のワイルドカードパターンを使用します。
    • - Regex: ファイル名パターンと一致する正規表現を使用します。
    • 正規表現のパターンタイプを選択する場合は、次の例を検討します。
      • - 次の構文を使用すると、名前にout、foo、bazを含むファイルを除くすべてのファイルをリスニングします。^(?!.*(?:out|baz|foo)).*$ all except
      • - 次の構文を使用すると、拡張子がdoc、docx、pdfのすべてのファイルをリスニングします。([a-zA-Z0-9\s_\\.\-\(\):])+(.doc|.docx|.pdf)$
      • - 次の構文を使用すると、名前にout.txtを含むファイルを除くすべてのテキストファイルをリスニングします。^(?!out).*\.txt$
    • - インジケータファイル。ファイルリスナがリスニングするファイル名を使用します。
    サブフォルダ内のファイルを確認
    ファイルリスナが、リスニング対象フォルダにあるサブフォルダ内のファイルを確認するかどうかを示します。
    アクション後
    ファイルリスナがイベントをリスニングした後にファイルリスナが実行する必要のあるアクションを決定します。
    ファイルパターンがインジケータファイルである場合にのみ、アクション後に[削除]を選択することができます。デフォルトは[なし]です。
    次の接続タイプは、[アクション後]のオプションをサポートします。
    • - ローカルフォルダ
    • - Advanced FTP V2
    • - Advanced FTPS V2
    • - Advanced SFTP V2
    • - Amazon S3 V2
    • - Microsoft Azure Data Lake Store Gen2
    • - Microsoft Fabric OneLake
    パラメータの追加
    式を作成して、フォルダパスのパラメータとして追加します。詳細については、パラメータの追加を参照してください。
    ファイル到着時に
    ファイルリスナが、登録済みのサービスに通知を送信するタイミングを決定します。
    • - 到着時。ファイルリスナがリスニングするフォルダにファイルが到着したときに通知を送信します。
    • - 更新時。ファイルリスナがリスニングするフォルダのファイルが更新されたときに通知を送信します。
    • - 削除時。ファイルリスナがリスニングするフォルダのファイルが削除されたときに通知を送信します。
    必要に応じて複数のオプションを選択できます。
    注: [アクション後][削除]の場合は、[削除時]オプションを選択しないでください。
    ルールを満たした場合はチェックを停止
    ファイルリスナは、リスナルルールに合致するとフォルダのリスニングを停止します。例えば、リスニング対象フォルダ内のファイルが削除されたときに通知を送信するようにファイルリスナを設定している場合、フォルダ内で最初にファイル削除イベントが発生するとリスナはフォルダのリスニングを停止します。
    このオプションが選択されない場合、ファイルリスナはイベントを登録済みのアプリケーションに通知し、後続のイベントを引き続きリスニングします。
    ファイルの安定性を確認
    ファイルリスナは、登録済みのサービスに通知する前に、ファイル全体がリスニング対象フォルダにコピーされたかどうかを確認します。
    ヒント: サイズの大きいファイルを転送する場合(フォルダへのファイルの書き込み処理に時間がかかる場合)は、このオプションを選択します。
    安定性確認間隔
    ファイルリスナがファイルの安定性を確認するために待機する時間(秒単位)。例えば、安定時間が15秒の場合、ファイルリスナは15秒ごとにファイルのステータスを確認します。
    安定性確認間隔フィールドは、[ファイルの安定性を確認]オプションを選択した場合にのみ有効になります。
    安定性確認間隔は、10秒から300秒の範囲です。デフォルトは10秒です。
    最初の実行時にファイルが存在するかどうかを通知
    ファイルリスナを初めて実行すると、リスニングするフォルダにファイルが存在する場合に通知が送信されます。このオプションを選択すると、[ファイルリスナが実行中でない場合にイベントを除外]オプションが無効になります。
    ファイルリスナが実行中でない場合にイベントを除外
    ファイルリスナが実行されていないときに発生するファイルイベントを除外するかどうかを決定します。このオプションを選択すると、[最初の実行時にファイルが存在するかどうかを通知]オプションが無効になります。
    3スケジュールを指定する場合は、次のオプションを検討してください。
    5[障害管理][障害時に実行を続行]を選択し、タスクがエラーで失敗してもファイルリスナを実行するようにします。[障害時に通知を送信]を選択して、タスクが失敗した場合には通知を受け取るようにします。タスクに障害が発生した場合に通知を送信する電子メールアドレスのリストを入力します。

パラメータの追加

変数を使用して、ファイルリスナが読み書きを行うパラメータを設定できます。
次のタイプの変数のいずれかを使用して、パラメータを設定できます。
注: ユーザー定義変数を使用して、ユーザーインタフェースからタスクを実行することはできません。ユーザー定義変数の値は、ファイル取り込みとレプリケーションREST APIのjobリソースを使用して渡す必要があります。詳細については、REST APIのヘルプを参照してください。
システム変数を使用したパラメータの追加
システム変数を使用して、タスクウィザードで[フォルダパス]にパラメータを追加します。
    1 ファイルリスナタスクウィザードの[アクション後]の横にあるアイコンをクリックします。
    [パラメータの追加]ウィンドウが表示されます。
    [パラメータの追加]ウィンドウでシステム変数を選択します。
    2[システム変数]カラムで必要な変数を選択し、 をクリックします。選択したシステム変数が[式]カラムに表示されます。この手順を繰り返して、複数のシステム変数を選択します。
    注: タスク内でシステム変数を使用する場合は、${systemvariablename}という形式で指定する必要があります。
    以下の表に、システム変数を示します。
    システム変数
    説明
    BadFileDir *
    リジェクトファイルのディレクトリ。次の特殊文字は使用できません。
    * ? < > " | ,
    ${$PMBadFileDir}
    CacheFileDir *
    キャッシュファイルの場所。
    ${$PMCacheDir}
    Date **
    ISO(yyyy-MM-dd)形式の現在の日付。
    ${system.date}
    Day **
    曜日
    ${system.day}
    ExtProcDir *
    外部プロシージャのディレクトリ。次の特殊文字は使用できません。
    * ? < > " | ,
    ${$PMExtProcDir}
    LookupFileDir *
    ルックアップファイルのディレクトリ。次の特殊文字は使用できません。
    * ? < > " | ,
    ${$PMLookupFileDir}
    Month **
    月(数値)
    ${system.month}
    RootDir
    ノードによるルートディレクトリへのアクセス性。これは他のサービスプロセス変数のルートディレクトリです。次の特殊文字は使用できません。
    * ? < > " | ,
    ${$PMRootDir}
    SessionLogDir *
    セッションログのディレクトリ。次の特殊文字は使用できません。
    * ? < > " | ,
    ${$PMSessionLogDir}
    StorageDir *
    実行時ファイルのディレクトリ。ワークフローリカバリファイルは、PowerCenter統合サービスプロパティで設定された$PMStorageDirに保存されます。セッションリカバリファイルは、オペレーティングシステムプロファイルで設定された$PMStorageDirに保存されます。次の特殊文字は使用できません。
    * ? < > " | ,
    ${$PMStorageDir}
    TargetFileDir *
    ターゲットファイルのディレクトリ。次の特殊文字は使用できません。
    * ? < > " | ,
    ${$PMTargetFileDir}
    TempDir *
    一時ファイルのディレクトリ。次の特殊文字は使用できません。
    * ? < > " | ,
    ${$PMTempDir}
    WorkflowLogDir *
    ワークフローログファイルの場所。
    ${$PMWorkflowLogDir}
    Year **
    ${system.year}
    * 値はデータ統合サーバーから取得されます。
    ** タイムゾーンはSecure Agentのタイムゾーンです。
    注: タスクを開始するときにパラメータの置換が発生します。ファイルリスナが起動して、パラメータ値が異なるために以前監視されていた場所とは異なる場所であると評価された場合は、以前監視されていた場所に存在するファイルに関する削除通知が送信されます。通知の削除オプションを無効にするか、[ファイルリスナが実行中でない場合にイベントを除外]オプションを有効にすると、通知は送信されません。
    3[OK]をクリックします。
    式が[フォルダパス]フィールドに表示されます。

ユーザー定義変数を使用したパラメータの追加

ユーザー定義変数を使用して、タスクウィザードで[フォルダパス]の値を定義します。
    1[フォルダパス]フィールドをクリックして、変数を入力します。変数は${systemvariablename}という形式で指定する必要があります。
    2[OK]をクリックします。
    式が[フォルダパス]に表示されます。