JAVAツール

用語の定義(共通)

1. クリック：マウスでクリックが必要な部分で、太字で表示されます。

2. 変数：ダイナミックまたは非固定のテキストへの参照は、[ ]でプロンプトが表示されます。例えば、[ユーザー名]。

3. コンポーネント：プロセス設計の各オブジェクトの通称です。

4. フィールド：一般的に入力可能なインターフェイスのことです。本システムではフォーム設計の入力できるフィールドも指します。

5. タブ：インターフェイスやウィンドウの複数シートオプションです。

6. ブロック：フィールドの集まり、一般的に上に名称が表示されます。

7. フォーム番号：data_noとも言い、1つのプロセスに1つのフォーム番号しかありません。

8. データ番号：id / data_idとも言い、1つのプロセスに複数のidがあり、処理ごとに新しいidが生成されます。

はじめに

ここでは、omflow.jarパッケージを使用して、JAVA Baseシステムにプロセスデータを作成し、アクセスする方法を紹介します。

1 ログイン関連

Class: com.syscomgo.omflow.java.Login

1.1 Tokenの取得

Method: doLogin

入力するパラメーターは以下のとおりです。

1. URL：対象のOMFLOW ServerのURLです。例：https://omflow.com.tw

2. user：プロセス権限を持つユーザーアカウントです。

3. password：ユーザーのパスワードです。

返されるデータタイプはJSON Object、フォーマットは以下のとおりです。

{
    status: boolean
    message: string (success or error message)
    token: string (token or empty)
}

1.2 Tokenを維持する

Method: keepToken

OMFLOWのAPIでは、リクエストの送信者を特定するためにTokenが必要です。Tokenには時間制限があり、最後のリクエスト（任意のリクエストを含む）から5分以上リクエストがない場合、Tokenは無効になり、再度Tokenを取得する必要があります。 この仕様の目的は、最小限のリソース消費でTokenの有効性を維持することです。

入力するパラメーターは以下のとおりです。

1. URL：対象のOMFLOW ServerのURL、例：https://omflow.com.tw

2. token：doLoginで取得したTokenです。

返されるデータタイプはString (success or error message)です。

2 データ関連

Class: com.syscomgo.omflow.java.Data

2.1 作成

Method: putData

ユーザーがフォームに入力して送信すると、該当のデータを設定済みのプロセスで進み、「手動処理」が必要なステップで一旦停止するか、もしくは「完了」後にクローズします。

入力するパラメーターは以下のとおりです。

1. URL：対象のOMFLOW ServerのURLです。例：https://omflow.com.tw

2. api_path：プロセスのAPI pathを指定します。

3. token：doLoginで取得したTokenです。

4. obj.Form：Formオブジェクト、詳細は３．４章を参照してください

返されるデータタイプはStringで「フォーム番号」またはエラーメッセージが返されます。

2.2 推進

Method: modData

ユーザーが現在のフォームの内容を確認し、必要な情報を入力した後、再度実行プロセスを開始する。

入力するパラメーターは以下のとおりです。

1. URL：対象のOMFLOW ServerのURL、例：https://omflow.com.tw

2. api_path：プロセスのAPI pathを指定します。

3. data_id：データ番号について、OMFLOWのプロセスは「並行」機能があったため、「フォーム番号」だけで正しく推進できない可能性があります。返事するリストデータの中、keyはidの值であり、data_idとなります。

4. token：doLoginで取得したToken。

5. obj.Form：Formオブジェクト、詳細は３．４章を参照してください。

返されるデータタイプはStringで「フォーム番号」またはエラーメッセージが返されます。

2.3 データの取得(リスト)

Method: getList

この方法により、ユーザーはプロセスで未完了の全てのデータを取得できます。

入力するパラメーターは以下のとおりです。

1. URL：対象のOMFLOW ServerのURLです。例：https://omflow.com.tw

2. token：doLoginで取得したTokenです。

3. obj.query：Queryオブジェクト、詳細は３．１章を参照してください。

返されるデータタイプはJSONArray、フォーマットは以下のとおりです。

[
    {'id':1,'data_no':'value','formitm_1':'value','formitm_2':'value'},
    {'id':2,'data_no':'value','formitm_1':'value','formitm_2':'value'},
    ...
]

2.4 特定のフォーム番号の取得

Method: loadHistory

フローが作成されてからユーザーによって「手動処理」され、処理した後に、先々で監査できるように、ユーザーが入力した内容を記録する「履歴」が生成されます。 この方法により、ユーザーは特定のプロセスやフォーム番号の「履歴」を取得することができます。

入力するパラメーターは以下のとおりです。

1. URL：対象のOMFLOW ServerのURLです。例：https://omflow.com.tw

2. token：doLoginで取得したTokenです。

3. api_path：プロセスのAPI pathを指定します。

4. data_no：検索するフォーム番号です。

返されるデータタイプはJSONArray、フォーマットは以下のとおりです。

[
    {'id':1,'data_no':'value','formitm_1':'value','formitm_2':'value'},
    {'id':2,'data_no':'value','formitm_1':'value','formitm_2':'value'},
    ...
]

2.5 フォームの削除

Method: delData

この方法により、ユーザーは既に作成されたプロセスの「履歴」や添付ファイルなどを含めて削除できます。

入力するパラメーターは以下のとおりです。

1. URL：対象のOMFLOW ServerのURLです。例：https://omflow.com.tw

2. api_path：プロセスのAPI pathを指定します。

3. token：doLoginで取得したTokenです。

4. data_no：入力するデータタイプはArrayListで、リストに削除するフォーム番号番号を入れる。

返されるデータタイプはbooleanです。

3 付録

節1、2ではomflow.jarが提供するサービスについて説明し、この節では最初の2つの節で言及したいくつかのオブジェクト・フォーマットを補足します。

3.1 Query

Class: com.syscomgo.omflow.java.obj.Query

searchkeyとsearch_conditionsはいずれかが有効になる (search_conditionsの方が優先)

properties	method	input type	note
api_path	setAPI	String
searchkey	setSearchkey	String	search_columnsに対してあいまい検索する
search_columns	putColumn	com.syscomgo.omflow.java.obj.Column
search_conditions	putCondition	com.syscomgo.omflow.java.obj.Condition
order_columns	putOrderColumn	com.syscomgo.omflow.java.obj.Column
index	setIndex	Int	何個目のデータから始まる
limit	setLimit	Int	1度でいくつかのデータを取得する
	clear
	toJSON

OMFLOWバージョン 1.1.6.3 機能：

3.2 Condition

Class: com.syscomgo.omflow.java.obj.Condition

properties	method	input type	note
name	setColumnName	String
oper	setOper	String	!=,=,>,<,in,contains
value	setValue	String
	setValue	ArrayList
	setValue	boolean
super	setSuper	boolean
	toJSON

3.3 Column

Class: com.syscomgo.omflow.java.obj.Column

properties	method	input type	note
name	setColumnName	String
is_query	getIsQuery	boolean	setStringValueにFalseを返す。，setQueryValueにTrueを返す。
value_string	setStringValue(String)	String
value_query	setQueryValue(query)	com.syscomgo.omflow.java.obj.query
is_text	setTextMode	boolean	default = true

3.4 Form

Class: com.syscomgo.omflow.java.obj.Form

properties	method	input type	note
formdata	setForm	String, JSONObject	フォーム名、フォーム値
	setForm	String, ArrayList	フォーム名、フォーム値
	setForm	String, String	フォーム名、フォーム値
	setForm	String, int	フォーム名、フォーム値
	getFormData		ArrayList