BPT API
BPT APIは、プロセスとアクティビティを管理するための機能を提供します。
このAPIを使用するには、開発環境の［References］ウィンドウを使用してBPT_APIエクステンションを参照します。
概要
| アクション | 説明 |
|---|---|
| Activity_Discard | アクティビティを破棄し、現在のプロセスフローのステップの実行を停止します。つまり、フローの後続アクティビティはすべて実行されません。 注意事項: このアクションでは現在のトランザクションがコミットされます。 |
| Activity_IsValidId | ある種類のアクティビティのアクティビティ識別子が有効かどうかを確認します。 |
| HumanActivity_AssignToUser | ユーザーにHuman Activityを割り当てます。Human Activityはそのユーザーのタスクボックスにのみ表示されます。 注意事項: このアクションでは現在のトランザクションがコミットされます。 |
| HumanActivity_CheckRole | ユーザーがHuman Activitを実行するためのロールを持っているかどうかを確認します。 |
| HumanActivity_FlushPendingEvents | Human Activityが保留中のすべてのイベントをただちに処理することを強制します。 注意事項: このアクションでは現在のトランザクションがコミットされます。 |
| HumanActivity_SetDueDate | Human Activityの期限を設定します。 注意事項: このアクションでは現在のトランザクションがコミットされます。 |
| Process_BulkDelete | 指定された日付より前にターミネートまたは終了した最上位レベルのプロセスのインスタンスのログ情報をすべて削除します。 削除される情報は、プロセスインスタンス、アクティビティインスタンス、入力パラメータ値、出力パラメータ値、他のプロセスインスタンス内で実行されたプロセスインスタンスなどのすべてのログです。 このアクションは、すべての最上位レベルのプロセスインスタンスを検索してそのすべてのサブプロセスを再帰的に削除し、メタモデルの一貫性を保ちます。 メタモデルでは、最上位レベルのプロセスインスタンスがProcessエンティティ内でTop_Process_Id = Idの条件により識別されます。 注意事項: このアクションでは現在のトランザクションはコミットされません。Top_Process_Id = Id。 注意事項: このアクションでは現在のトランザクションはコミットされません。 |
| Process_Delete | 最上位レベルのプロセスインスタンスのログ情報をすべて削除します。このプロセスインスタンスはターミネートまたは終了している必要があります。 削除される情報は、プロセスインスタンス、アクティビティインスタンス、入力パラメータ値、出力パラメータ値、他のプロセスインスタンス内で実行されたプロセスインスタンスなどのすべてのログです。 このアクションは、指定された最上位レベルのプロセスインスタンスを検索してそのすべてのサブプロセスを再帰的に削除し、メタモデルの一貫性を保ちます。 メタモデルでは、最上位レベルのプロセスインスタンスがProcessエンティティ内で次の条件により識別されます。 Top_Process_Id = Id。 このアクションでは、次の場合に例外が発生します。 - プロセスインスタンスが存在していない。 - プロセスインスタンスが最上位レベルのプロセスインスタンスではない。 - プロセスインスタンスがターミネートまたは終了していない。 注意事項: このアクションでは現在のトランザクションはコミットされません。 |
| Taskbox_Hide | このアクションをPreparationに追加し、画面上のタスクボックスを無効にします。 |
アクション
Activity_Discard
アクティビティを破棄し、現在のプロセスフローのステップの実行を停止します。つまり、フローの後続アクティビティはすべて実行されません。
注意事項:
このアクションでは現在のトランザクションがコミットされます。
入力
- ActivityId
- 型: EntityReference。必須。
アクティビティの識別子。
Activity_IsValidId
ある種類のアクティビティのアクティビティ識別子が有効かどうかを確認します。
入力
- ActivityId
- 型: EntityReference。必須。
アクティビティの識別子。 - Kind
- 型: EntityReference。必須。
アクティビティの種類。
出力
- IsValid
- 型: Boolean。
アクティビティの識別子が有効である場合はTrueを返します。
HumanActivity_AssignToUser
ユーザーにHuman Activityを割り当てます。Human Activityはそのユーザーのタスクボックスにのみ表示されます。
注意事項:
このアクションでは現在のトランザクションがコミットされます。
入力
- HumanActivityId
- 型: EntityReference。必須。
Human Activityの識別子。 - UserId
- 型: EntityReference。必須。
ユーザーの識別子。
HumanActivity_CheckRole
ユーザーがHuman Activityを実行するためのロールを持っているかどうかを確認します。
入力
- HumanActivityId
- 型: EntityReference。必須。
Human Activityの識別子。 - UserId
- 型: EntityReference。必須。
ユーザーの識別子。
出力
- HasPermission
- 型: Boolean。
ユーザーがアクティビティを実行するためのロールを持っている場合はTrueを返します。
HumanActivity_FlushPendingEvents
Human Activityが保留中のすべてのイベントをただちに処理することを強制します。
注意事項:
このアクションでは現在のトランザクションがコミットされます。
入力
- HumanActivityId
- 型: EntityReference。必須。
Human Activityの識別子。
出力
- ProcessedEvents
- 型: Integer。
フラッシュで処理された保留中のイベントの数を返します。
HumanActivity_SetDueDate
Human Activityの期限を設定します。
注意事項:
このアクションでは現在のトランザクションがコミットされます。
入力
- HumanActivityId
- 型: EntityReference。必須。
Human Activityの識別子。 - DueDate
- 型: DateTime。必須。
Human Activityの完了期限の日時。
Process_BulkDelete
指定された日付より前にターミネートまたは終了した最上位レベルのプロセスのインスタンスのログ情報をすべて削除します。
削除される情報は、プロセスインスタンス、アクティビティインスタンス、入力パラメータ値、出力パラメータ値、他のプロセスインスタンス内で実行されたプロセスインスタンスなどのすべてのログです。
このアクションは、すべての最上位レベルのプロセスインスタンスを検索してそのすべてのサブプロセスを再帰的に削除し、メタモデルの一貫性を保ちます。
メタモデルでは、最上位レベルのプロセスインスタンスがProcessエンティティ内で次の条件により識別されます: Top_Process_Id = Id。
注意事項:
このアクションでは現在のトランザクションはコミットされません。
入力
- ProcessesOlderThan
- 型: DateTime。必須。
この日時より前のプロセスが削除されます。 - ProcessDefinitionId
- 型: EntityReference。
プロセス定義の識別子。 - MaxDeletedProcesses
- 型: Integer。デフォルト: 1000.
削除するプロセスの最大数。デフォルトは1000です。0（ゼロ）に設定すると無制限に削除します。
出力
- HasMoreToDelete
- 型: Boolean。
削除するプロセスインスタンスがまだ残っている場合はTrueを返します。
Process_Delete
最上位レベルのプロセスインスタンスのログ情報をすべて削除します。このプロセスインスタンスはターミネートまたは終了している必要があります。
削除される情報は、プロセスインスタンス、アクティビティインスタンス、入力パラメータ値、出力パラメータ値、他のプロセスインスタンス内で実行されたプロセスインスタンスなどのすべてのログです。
このアクションは、指定された最上位レベルのプロセスインスタンスを検索してそのすべてのサブプロセスを再帰的に削除し、メタモデルの一貫性を保ちます。
メタモデルでは、最上位レベルのプロセスインスタンスがProcessエンティティ内で次の条件により識別されます: Top_Process_Id = Id。
このアクションでは、以下の場合に例外が発生します。
- プロセスインスタンスが存在していない。
- プロセスインスタンスが最上位レベルのプロセスインスタンスではない。
- プロセスインスタンスがターミネートまたは終了していない。
注意事項:
このアクションでは現在のトランザクションはコミットされません。
入力
- ProcessId
- 型: EntityReference。必須。
プロセスインスタンスの識別子。
Taskbox_Hide
このアクションをPreparationに追加し、画面上のタスクボックスを無効にします。