APIオプション¶

APIオプションを利用する際の設定を行います。
APIオプションは、ワークフローシステムと外部システムを連携するためのプログラムインターフェースです。

APIオプションを利用するためには、ワークフローシステム（サーバー）のライセンスパスワードとは別に、APIオプションのライセンスパスワードが必要です。
ライセンスパスワードの発行手続きについては、[ワークフローシステム導入マニュアル]を参照ください。
ライセンスパスワードの設定については、ライセンスを参照ください。

詳細については、以下を参照ください。

認証

後処理プログラム

ヒント

APIオプションには以下の種類があります。

Java API

ワークフローシステムと同一プロセス上で動作するJavaインターフェース
SOAP API

ワークフローシステムからSOAPで公開されるWebサービスインターフェース
REST API

ワークフローシステムからRESTで公開されるWebサービスインターフェース

各APIの仕様、利用方法などの詳細な情報はオプション製品「APIオプション」付属のマニュアルを参照ください。

ページTOPへ

認証¶

APIの認証および接続制限に関する設定を行います。

SOAP API、REST APIは、標準設定ではワークフローシステムに対してローカルエリアネットワークまたはインターネットを経由してアクセスできる環境であれば使用できます。
REST APIの接続を許可する場合や、SOAP API、REST APIで特定のシステムや特定の環境のみにアクセスを制限する場合、以下の設定を行ってください。

項目詳細

項目

説明

SOAP API

└ アカウント認証を有効にする

SOAP APIのアカウント認証を有効にする場合にチェックします。
SOAP APIを利用するプログラムでワークフローシステムへの認証情報が設定された場合のみ、APIの使用を許可する設定です。
認証情報の設定方法や権限など、詳細はオプション製品「APIオプション」付属のマニュアルを参照ください。

REST API

└ 接続を許可する

REST APIの接続を許可する場合にチェックします。
チェックした場合、REST APIの接続に使用する[APIトークン]を設定する必要があります。
認証情報の設定方法など、詳細はオプション製品「APIオプション」付属のマニュアルを参照ください。

REST API

└ APIトークン * 必須※

REST APIの接続に使用するAPIトークンを入力します。 [生成]から自動生成することもできます。

文字種別	半角英数
最大文字数	（なし）
禁則文字	（なし）

[REST API 接続を許可する]にチェックした場合、この項目は必須です。

REST API

└ 生成

APIトークンを自動生成し、[APIトークン]に表示します。

接続許可IP

SOAP APIやREST APIに接続できる環境をIPアドレスで限定する場合に設定します。
特定のIPアドレスからの接続のみ受け付ける場合、IPアドレスを入力します。複数のIPアドレスを設定する場合は半角カンマ（,）区切りで入力します。

初期状態は「」（空）が設定されています。

ページTOPへ

後処理プログラム¶

案件の申請・承認などをトリガーとして呼び出される後処理プログラムを登録します。
後処理用のプログラムをサブクラスに実装した後、動作させるためには、後処理用のクラスを継承したサブクラスの完全修飾名の設定を行う必要があります。
例えば、申請後処理の「FinalProcessAfterApply」クラスを継承したサブクラスが「sample」パッケージに含まれる「DisplayApply」クラスの場合、「sample.DisplayApply」を[申請後処理]に指定します。

ヒント

後処理用のクラスのパッケージは「jp.co.itarchitects.xFlow.action」です。

注意

後処理プログラムはパッケージ版のみ利用できます。クラウド版では利用できません。

項目詳細

項目	説明
申請後処理	FinalProcessAfterApplyクラスを継承したサブクラスの完全修飾名を設定します。申請後処理のクラスを継承したサブクラスを動作させる場合に設定します。
承認後処理	FinalProcessAfterApproveクラスを継承したサブクラスの完全修飾名を設定します。承認後処理のクラスを継承したサブクラスを動作させる場合に設定します。
決裁後処理	FinalProcessAfterSanctionクラスを継承したサブクラスの完全修飾名を設定します。決裁後処理のクラスを継承したサブクラスを動作させる場合に設定します。
閲覧後処理	FinalProcessAfterBrowseクラスを継承したサブクラスの完全修飾名を設定します。閲覧後処理のクラスを継承したサブクラスを動作させる場合に設定します。
完了後処理	FinalProcessAfterCompletionクラスを継承したサブクラスの完全修飾名を設定します。完了後処理のクラスを継承したサブクラスを動作させる場合に設定します。
否認後処理	FinalProcessAfterDenyクラスを継承したサブクラスの完全修飾名を設定します。否認後処理のクラスを継承したサブクラスを動作させる場合に設定します。
下書き後処理	FinalProcessAfterSaveクラスを継承したサブクラスの完全修飾名を設定します。下書き後処理のクラスを継承したサブクラスを動作させる場合に設定します。
申請取戻し後処理	FinalProcessAfterCancelクラスを継承したサブクラスの完全修飾名を設定します。申請取戻し後処理のクラスを継承したサブクラスを動作させる場合に設定します。
承認取戻し後処理	FinalProcessAfterCancelApproveクラスを継承したサブクラスの完全修飾名を設定します。承認取戻し後処理のクラスを継承したサブクラスを動作させる場合に設定します。
再申請請求後処理	FinalProcessAfterAskToReapplyクラスを継承したサブクラスの完全修飾名を設定します。再申請請求後処理のクラスを継承したサブクラスを動作させる場合に設定します。
再承認請求後処理	FinalProcessAfterAskToReapproveクラスを継承したサブクラスの完全修飾名を設定します。再承認請求後処理のクラスを継承したサブクラスを動作させる場合に設定します。

ページTOPへ