【公式】HULFT-WebFileTransfer Web API説明書_2022年3月1日_第4版発行:

フォルダイベント情報設定

フォルダイベント情報を設定します。フォルダイベントは任意のフォルダに紐づけて管理されます。

(1) 必要な権限

RegisterFolderEvent APIを使用するには以下の権限が必要です。

システム管理の更新権限

管理対象種別による違いは以下のとおりです。

システム全体: 任意のフォルダイベントを設定可能
グループ単位: hulft_flag（HULFT連携可否）とapp_flag（アプリ連携可否）を“false”にしたフォルダイベントのみ設定可能

= 備考 =

上記権限に加えて、リクエストで指定したオブジェクトに対するアクセス権が必要です。

(2) リクエストURL

http(s)://Domain:xxxx/コンテキスト名/RegisterFolderEvent

(3) リクエストインタフェース

表1.44 フォルダイベント情報設定のリクエストインタフェースの項目

項目名

説明

文字

省略

省略値

folder_event_id

フォルダイベントID

登録するフォルダイベントIDを32バイト以内で指定します。

半角

enabled_flag

使用可能フラグ

フォルダイベントの有効／無効を指定します。falseを指定すると、フォルダイベントを一時的に停止する（起動しない）ことができます。

true	有効
false	無効

半角

○

false

group_id

グループID （*1）

フォルダイベントの対象ユーザのグループIDを32バイト以内で指定します。

カンマ区切りによる複数指定可。ただし、group_idを複数指定した場合は、user_idの指定不可。

半角

○

ブランク

user_id

ユーザID （*1）

フォルダイベントの対象ユーザのユーザIDを32バイト以内で指定します。

カンマ区切りによる複数指定可。ただし、user_idを複数指定した場合は、group_idは単一指定のみ可。

半角

○

ブランク

object_id

オブジェクトID

フォルダイベントを登録するフォルダのオブジェクトIDを16バイトで指定します。

半角

load_type

転送種別

フォルダイベントの種別を指定します。

0	アップロードイベント
1	ダウンロードイベント
3	スケジュールイベント

半角

○

event_filter

適用条件

フォルダイベントを適用する条件を指定します。

0	転送正常時にイベントを適用
1	転送エラー時にイベントを適用
2	転送前にイベントを適用

半角

○

event_trigger

発生条件

フォルダイベントの発生条件を指定します。

0	指定したユーザが転送するたび
1	指定したユーザが全員転送した後
2	スケジュール設定

半角

○

file_name_trigger

トリガファイル名

フォルダイベントの実行対象のファイル名（HULFT-WebFileTransfer上の登録名）を255バイト以内で指定します。

完全一致に加え、「*」（アスタリスク）を使用した前方一致、後方一致の指定が可能です。

文字

○

ブランク

event_sync_flag

イベント同期フラグ

true	同期する
false	同期しない

半角

○

false

schedule_flag

スケジュール実行可否

フォルダイベントをスケジュール実行するかどうかを指定します。

true	実行する
false	実行しない

半角

○

false

mail_flag

メール連携可否

メール連携を実行するかどうかを指定します。

true	実行する
false	実行しない

半角

○

false

hulft_flag

HULFT連携可否

HULFT連携を実行するかどうかを指定します。

true	実行する
false	実行しない

半角

○

false

app_flag

アプリ連携可否

アプリ連携を実行するかどうかを指定します。

true	実行する
false	実行しない

半角

○

false

move_flag

オブジェクト移動可否

フォルダ移動を実行するかどうかを指定します。

true	実行する
false	実行しない

半角

○

false

comment

コメントを255バイト以内で指定します。

混在

○

ブランク

event_start_date

イベント適用開始日

フォルダイベントをスケジュール実行する場合の適用開始日を指定します。

YYYYMMDD形式。

半角

○

load_typeが3の場合は必須

execute_time

イベント実行時刻

フォルダイベントをスケジュール実行する場合の実行時刻を指定します。

HHMMSS形式。

半角

○

load_typeが3の場合は必須

iteration_flag

繰り返しフラグ

フォルダイベントをスケジュール実行する場合の繰り返し条件を指定します。

true	繰り返す
false	繰り返さない（一度だけ実行）

半角

○

false

mon_flag

イベント発生日（月曜日）

フォルダイベントをスケジュール実行する場合の曜日指定。

true	実行する
false	実行しない

半角

○

false

tue_flag

イベント発生日（火曜日）

フォルダイベントをスケジュール実行する場合の曜日指定。

true	実行する
false	実行しない

半角

○

false

wed_flag

イベント発生日（水曜日）

フォルダイベントをスケジュール実行する場合の曜日指定。

true	実行する
false	実行しない

半角

○

false

thu_flag

イベント発生日（木曜日）

フォルダイベントをスケジュール実行する場合の曜日指定。

true	実行する
false	実行しない

半角

○

false

fri_flag

イベント発生日（金曜日）

フォルダイベントをスケジュール実行する場合の曜日指定。

true	実行する
false	実行しない

半角

○

false

sat_flag

イベント発生日（土曜日）

フォルダイベントをスケジュール実行する場合の曜日指定。

true	実行する
false	実行しない

半角

○

false

sun_flag

イベント発生日（日曜日）

フォルダイベントをスケジュール実行する場合の曜日指定。

true	実行する
false	実行しない

半角

○

false

mail_to

宛先to

メールの宛先を1件あたり255バイト以内で指定します。

カンマ区切りによる複数指定可。

例）a@z,b@z,c@z

半角

○

mail_flagがtrueの場合は必須

mail_cc

宛先cc

メールの宛先ccを1件あたり255バイト以内で指定します。

カンマ区切りによる複数指定可。

例）a@z,b@z,c@z

半角

○

ブランク

mail_bcc

宛先bcc

メールの宛先bccを1件あたり255バイト以内で指定します。

カンマ区切りによる複数指定可。

例）a@z,b@z,c@z

半角

○

ブランク

subject

タイトル

メールのタイトルを512バイト以内で指定します。

混在

○

ブランク

message

本文

メールの本文を3328バイト以内で指定します。

混在

○

ブランク

mail_precondition

メール連携前提条件

メール連携実行の前提となるイベントを指定します。

0	なし
2	HULFT連携
3	アプリ連携
4	フォルダ移動

半角

○

type

配信、集信種別

HULFT連携する場合のHULFTの配信、集信の種別を指定します。

0	配信
1	集信

半角

○

hulft_flagがtrueの場合は必須

file_id

ファイルID

HULFTのファイルIDを指定します。HULFTのVer.8.0以降と連携している場合には50バイト以内で、それより前のバージョンと連携している場合には8バイト以内で指定します。

半角

○

hulft_flagがtrueの場合は必須

sync_flag

同期転送要求

HULFT連携する場合に、同期転送を行うか非同期転送を行うかを指定します。

true	同期転送
false	非同期転送

半角

○

true

wait_time

同期転送待ち時間

同期転送でタイムアウトするまでの待ち時間を指定します。

設定範囲：10～259200（単位：秒）

半角

○

259200

（sync_flagがtrueの場合のみ有効）

hulft_rcv_registration_type

HULFT集信連携ファイル登録種別

フォルダイベントの登録先フォルダに集信ファイルと同名のファイルがあった場合の動作

0	上書きしない
1	上書きする

半角

○

message0

メッセージ0

HULFTのメッセージ0を50バイト以内で指定します。

混在

○

ブランク

messagel0

拡張メッセージ0

HULFTの拡張メッセージ0を200バイト以内で指定します。

混在

○

ブランク

messagel1

拡張メッセージ1

HULFTの拡張メッセージ1を200バイト以内で指定します。

混在

○

ブランク

hulft_precondition

HULFT連携前提条件

HULFT連携実行の前提となるイベントを指定します。

0	なし
1	メール連携
3	アプリ連携
4	フォルダ移動

半角

○

download_limit

ダウンロード回数

フォルダイベントで外部からファイルを取得する場合のダウンロード回数を指定します。

設定範囲：-1、1～9999（単位：回）

半角

○

-1（保存期限まで有効）

save_limit

保存期限

フォルダイベントで外部からファイルを取得する場合の保存期限を指定します。

設定範囲：1～99999（単位：日）

半角

○

プロパティファイル（env.properties）のfileupload.default.savelimitに従う

command1

コマンド1（*2）

アプリ連携のコマンドを1024バイト以内で指定します。

混在

○

app_flagがtrueの場合は必須

command2

コマンド2（*2）

アプリ連携のコマンドを1024バイト以内で指定します。

混在

○

ブランク

command3

コマンド3（*2）

アプリ連携のコマンドを1024バイト以内で指定します。

混在

○

ブランク

app_precondition

アプリ連携前提条件

アプリ連携実行の前提となるイベントを指定します。

0	なし
1	メール連携
2	HULFT連携
4	フォルダ移動

半角

○

target_upload_flag

ターゲットアップロードフラグ

アプリ連携が正常終了した場合に、ターゲットファイルの上書きアップロードを実行するかを指定します。

false	実行しない
true	実行する

半角

○

false

move_to

移動先オブジェクトID

ファイルの移動先のオブジェクトIDを16バイトで指定します。

半角

○

move_flagがtrueの場合は必須

move_registration_type

移動連携ファイル登録種別

移動先フォルダに移動対象ファイルと同名のファイルがあった場合の動作

0	上書きしない
1	上書きする

半角

○

move_precondition

フォルダ移動前提条件

フォルダ移動実行の前提となるイベントを指定します。

0	なし
1	メール連携
2	HULFT連携
3	アプリ連携

半角

○

target_file

ターゲットファイル

連携先のイベントで使用するファイルを255バイト以内で指定します。

連携先のイベントに転送対象ファイルが引き継がれない場合、この指定が使用されます。

半角

○

ブランク

*1	:	「system_service」、「everyone」、「unknown」以外の値を指定します。
*2	:	プロパティファイル（env.properties）のfolderevent.app.command.pathにパスが設定されている場合、そのパスからの相対パスを指定します。設定されていない場合はフルパスを指定します。

パラメータの相関関係について

load_type（転送種別）、event_filter（適用条件）、event_trigger（発生条件）の指定可能な組み合わせ、およびevent_sync_flag（イベント同期フラグ）の設定値の関係は以下のようになります。

load_type	event_filter	event_trigger
load_type	event_filter	0	1	2
0、1	0	○	F	×
	1	○	×	×
	2	T	×	×
3		×	×	F

○	:	load_type、event_filter、event_triggerの指定可能な組み合わせ event_sync_flagの設定値は任意
T	:	load_type、event_filter、event_triggerの指定可能な組み合わせ event_sync_flagの設定値は“true”（同期する）のみ可能
F	:	load_type、event_filter、event_triggerの指定可能な組み合わせ event_sync_flagの設定値は“false”（同期しない）のみ可能
×	:	load_type、event_filter、event_triggerの指定不可の組み合わせ（指定するとエラー）

load_type（転送種別）、event_filter（適用条件）、event_trigger（発生条件）、および実行されるイベントとtarget_file（ターゲットファイル）の関係は以下のようになります。

load_type	event_filter	event_trigger	HULFT連携（配信）	HULFT連携（集信）	アプリ連携	メール連携	フォルダ移動
0	0	0	□	◎	□	□	□
	0	1	◎	◎	○	○	○
	1	0	×	×	―	―	×
	2	0	▼	×	▼	×	×
1	0	0	□	◎	□	□	□
	0	1	◎	◎	○	○	○
	1	0	×	×	―	―	×
	2	0	×	▼	▼	×	×
3		2	◎	◎	○	○	○

◎	:	target_fileの指定が必須
○	:	target_fileの指定が可能（省略可）ただし以下の場合は指定が必須 app_flag（アプリ連携可否）が“true”（実行する）で、command1～3（コマンド1～3）に$TARGET、$PATH、$FILE、$COMMENT、$OPTION1、$OPTION2、$OPTION3、$OBJECTIDのいずれかが含まれる場合 mail_flag（メール連携可否）が“true”（実行する）で、message（本文）に$PATH、$FILE、$COMMENT、$OPTION1、$OPTION2、$OPTION3、$OBJECTIDのいずれかが含まれる場合
□	:	target_fileは引き継がれない（転送ファイルが引き継がれる）
▼	:	target_fileは指定不可（転送ファイルが引き継がれる） hulft_flag（HULFT連携可否）とapp_flag（アプリ連携可否）を同時に“true”（実行する）に設定した場合はエラー
―	:	ファイルは引き継がれない以下の場合はエラー app_flag（アプリ連携可否）が“true”（実行する）で、command1～3（コマンド1～3）に$TARGET、$PATH、$FILE、$COMMENT、$OPTION1、$OPTION2、$OPTION3、$OBJECTIDのいずれかが含まれる場合 mail_flag（メール連携可否）が“true”（実行する）で、message（本文）に$PATH、$FILE、$COMMENT、$OPTION1、$OPTION2、$OPTION3、$OBJECTIDのいずれかが含まれる場合
×	:	load_type、event_filter、event_triggerをこの組み合わせで設定した場合、当該イベントを実行する設定にするとエラー

file_name_trigger（トリガファイル名）はevent_trigger（発生条件）が“0”（指定したユーザが転送するたび）の場合のみ指定可能です。“1”（指定したユーザが全員転送した後）および“2”（スケジュール設定）の場合に指定するとエラーになります。

少なくとも1つのイベントを設定する必要があります。以下がすべて“false”（実行しない）の場合はエラーになります。

mail_flag（メール連携可否）
hulft_flag（HULFT連携可否）
app_flag（アプリ連携可否）
move_flag（オブジェクト移動可否）

load_type（転送種別）とschedule_flag（スケジュール実行可否）の設定値の関係は以下のようになります。

load_type	schedule_flag
load_type	true	false
0	×	○
1	×	○
3	○	×

○	:	指定可能な組み合わせ
×	:	指定不可の組み合わせ（指定するとエラー）

load_type（転送種別）が“3”（スケジュールイベント）の場合、event_start_date（イベント適用開始日）とexecute_time（イベント実行時刻）はAPIの実行日時より前の日時が指定されているとエラーになります。

command1（コマンド1）、command2（コマンド2）、command3（コマンド3）が以下のHULFT-WebFileTransfer置換文字で始まる場合はエラーになります。

$TARGET
$PATH
$FILE
$DATE
$TIME
$USER
$GROUP
$OPTION1
$OPTION2
$OPTION3
$COMMENT
$USERID
$GROUPID
$OPERATIONID
$OBJECTID

(4) レスポンスインタフェース

表1.45 フォルダイベント情報設定のレスポンスインタフェースの項目
項目名	説明	備考
folder_event_id	フォルダイベントID 正常に登録したフォルダイベントIDが返却されます。

【公式】HULFT-WebFileTransfer Web API説明書_2022年3月1日_第4版発行:

load_type	event_filter	event_trigger	HULFT連携（配信）	HULFT連携（集信）	アプリ連携	メール連携	フォルダ移動
0	0	0	□	◎	□	□	□
	0	1	◎	◎	○	○	○
	1	0	×	×	―	―	×
	2	0	▼	×	▼	×	×
1	0	0	□	◎	□	□	□
	0	1	◎	◎	○	○	○
	1	0	×	×	―	―	×
	2	0	×	▼	▼	×	×
3		2	◎	◎	○	○	○

load_type	event_filter	event_trigger	HULFT連携（配信）	HULFT連携（集信）	アプリ連携	メール連携	フォルダ移動
0	0	0	□	◎	□	□	□
	0	1	◎	◎	○	○	○
	1	0	×	×	―	―	×
	2	0	▼	×	▼	×	×
1	0	0	□	◎	□	□	□
	0	1	◎	◎	○	○	○
	1	0	×	×	―	―	×
	2	0	×	▼	▼	×	×
3		2	◎	◎	○	○	○

load_type	event_filter	event_trigger	HULFT連携（配信）	HULFT連携（集信）	アプリ連携	メール連携	フォルダ移動
0	0	0	□	◎	□	□	□
	0	1	◎	◎	○	○	○
	1	0	×	×	―	―	×
	2	0	▼	×	▼	×	×
1	0	0	□	◎	□	□	□
	0	1	◎	◎	○	○	○
	1	0	×	×	―	―	×
	2	0	×	▼	▼	×	×
3		2	◎	◎	○	○	○