EPA Taskbox API
EPA（Embedded Process Automation）は、すべての保留中のアクティビティをブラウザの移動タスクボックスに自動的に表示します。各項目には手順とアクティビティページへのリンクが含まれており、ユーザーがアクティビティに関する作業を行うことができます。モバイルアプリでは、カスタムUIソリューションが必要です。
リアクティブWebアプリのタスクボックスのサンプルForgeコンポーネントとそれを使用する手順の詳細については、「リアクティブWebアプリでタスクボックスを使用する」をご覧ください。この記事では、主に従来のWebアプリのタスクボックスについて説明します。
概要
| アクション | 説明 |
|---|---|
| API_GetActivities | ユーザーのアクティビティを返します。 アクティビティのフィルタリングとページネーションが可能です。 |
| API_GetActivityGuidanceHtml | アクティビティのガイダンス手順をHTML形式でエンコードします。 |
| API_GetActivityPagination | ユーザーのタスクボックスに現在表示されているすべてのアクティビティのページネーション情報を返します。 |
| API_GetActivityVisualization | 開いているアクティビティをタスクボックスで表示する方法に関する情報を返します。 |
| API_GetDynamicHtml | （※非推奨）タスクボックスとその現在のコンテンツのJavaScriptコードを返します。 |
| API_GetNewOpenActivity | ユーザーによって現在開かれ、プロセスフローの前のアクティビティのうちのいずれか1つとして示されているアクティビティを持つアクティビティを返します。 |
| API_GetStaticHtml | （※非推奨）絶対URL（"http://<サーバー名>/"で始まるURL）を持つタスクボックスのHTMLを返します。 |
| API_MarkActivitiesAsSeen | すべてのタスクボックスアクティビティを既読として表示します。つまり、新しいアクティビティのみがタスクボックスで未読として表示されます。 |
| API_SetActivityVisualization | 開いているアクティビティをタスクボックスで表示する方法を設定します。 |
| Inbox_DisableInServer | 環境でタスクボックスを無効にします。 |
| Inbox_EnableInServer | 環境でタスクボックスを有効にします。 |
| ストラクチャ | 説明 |
|---|---|
| Inbox_FilterCriteria | |
| Inbox_PaginationCriteria | |
| Activity | TaskBox内のアクティビティの情報を持つストラクチャ。 |
| PaginationInfo | TaskBox内のアクティビティ数の情報を持つストラクチャ。 |
アクション
API_GetActivities
ユーザーのアクティビティを返します。
アクティビティのフィルタリングとページネーションが可能です。
入力
- UserId
- 型: 必須。User Identifier。
ユーザーの識別子。 - FilterCriteria
- 型: 任意。Inbox_FilterCriteria。
アクティビティのフィルタリング基準。
フィルタリングを使用しない場合は、空のままにします。 - PaginationCriteria
- 型: 必須。Inbox_PaginationCriteria。
ユーザーのタスクボックスにアクティビティを表示する場合のページネーション基準。
ページネーションを使用しない場合は、空のままにします。
出力
- ActivityList
- 型: Activity レコードリスト。
アクティビティのリスト。 - PaginationInfo
- 型: PaginationInfo.
ユーザーのタスクボックスにアクティビティを表示する場合の明確なページネーション情報。
API_GetActivityGuidanceHtml
アクティビティのガイダンス手順をHTML形式でエンコードします。
入力
- Guidance
- 型: 必須。Text。
アクティビティのガイダンス手順。
出力
- GuidanceHtml
- 型: Text。
HTML形式でエンコードされたアクティビティのガイダンス手順。
API_GetActivityPagination
ユーザーのタスクボックスに現在表示されているすべてのアクティビティのページネーション情報を返します。
入力
- UserId
- 型: 必須。User Identifier。
ユーザーの識別子。 - FilterCriteria
- 型: 任意。Inbox_FilterCriteria。
アクティビティのフィルタリング基準。
フィルタリングを使用しない場合は、空のままにします。
出力
- PaginationInfo
- 型: PaginationInfo.
ユーザーのタスクボックスに現在表示されているすべてのアクティビティのページネーション情報。
API_GetActivityVisualization
開いているアクティビティをタスクボックスで表示する方法に関する情報を返します。
入力
- ActivityId
- 型: 必須。Activity Identifier。
アクティビティの識別子。
出力
- HideDone
- 型: Boolean。
Trueの場合、タスクボックスでアクティビティが開いているときは［Done］ボタンを使用できません。 - HideRelease
- 型: Boolean。
Trueの場合、タスクボックスでアクティビティが開いているときは［Release］ボタンを使用できません。 - CustomInstructions
- 型: Text。
タスクボックスでアクティビティが開いているときに通常のアクティビティ手順の下に表示されるカスタム手順のテキスト/HTML。
手順の最大長は500文字です。
API_GetDynamicHtml
（※非推奨）タスクボックスとその現在のコンテンツのJavaScriptコードを返します。
入力
- EspaceId
- 型: 必須。Espace Identifier。
（※非推奨） - UserId
- 型: 必須。User Identifier。
ユーザーの識別子。 - ロケール
- 型: 必須。Text。
（※非推奨） - Data
- 型: 必須。Text。
（※非推奨）
出力
- Html
- 型: Text。
タスクボックスとその現在のコンテンツのJavaScriptコード。
API_GetNewOpenActivity
ユーザーによって現在開かれ、プロセスフローの前のアクティビティのうちのいずれか1つとして示されているアクティビティを持つアクティビティを返します。
入力
- UserId
- 型: 必須。User Identifier。
ユーザーの識別子。 - PreviousActivityId
- 型: 必須。Activity Identifier。
プロセスフローの前のアクティビティのうちのいずれか1つの識別子。
出力
- ActivityId
- 型: Activity Identifier。
ユーザーが現在開いているアクティビティ。
API_GetStaticHtml
（※非推奨）絶対URL（"http://<サーバー名>/"で始まるURL）を持つタスクボックスのHTMLを返します。
入力
- EspaceId
- 型: 必須。Espace Identifier。
eSpaceの識別子。 - UserId
- 型: 必須。User Identifier。
ユーザーの識別子。 - ロケール
- 型: 必須。Text。
言語ロケール。 - Data
- 型: 必須。Text。
（※非推奨）
出力
- Html
- 型: Text。
絶対URL（"http://<サーバー名>/"で始まるURL）を持つタスクボックスのHTML。
API_MarkActivitiesAsSeen
すべてのタスクボックスアクティビティを既読として表示します。つまり、新しいアクティビティのみがタスクボックスで未読として表示されます。
入力
- UserId
- 型: 必須。User Identifier。
ユーザーの識別子。
API_SetActivityVisualization
開いているアクティビティをタスクボックスで表示する方法を設定します。
入力
- ActivityId
- 型: 必須。Activity Identifier。
アクティビティの識別子。 - HideDone
- 型: 任意。Boolean。
Trueの場合、タスクボックスでアクティビティが開いているときは［Done］ボタンを使用できません。 - HideRelease
- 型: 任意。Boolean。
Trueの場合、タスクボックスでアクティビティが開いているときは［Release］ボタンを使用できません。 - CustomInstructions
- 型: 任意。Text。
タスクボックスでアクティビティが開いているときに通常のアクティビティ手順の下に表示されるカスタム手順のテキスト/HTML。
カスタム手順の最大長は500文字です。
Inbox_DisableInServer
環境でタスクボックスを無効にします。
Inbox_EnableInServer
環境でタスクボックスを有効にします。
ストラクチャ
Inbox_FilterCriteria
アトリビュート
- ActivityLabel
- 型: Text (50)。
Inbox_PaginationCriteria
アトリビュート
- StartIndex
- 型: Integer。
- LineCount
- 型: Integer。
Activity
TaskBox内のアクティビティの情報を持つストラクチャ。
アトリビュート
- Id
- 型: EntityReference。 アクティビティの識別子。
- Label
- 型: Text (50)。 アクティビティのラベル。
- LabelLang
- 型: Text (50)。 ラベルの言語ロケールのコード。
- Details
- 型: Text (50)。 アクティビティの詳細。
- DueDate
- 型: DateTime。 アクティビティの期日。
- IsOpened
- 型: Boolean。 ユーザーがすでに開いている場合はTrue。
- IsSeen
- 型: Boolean。 ページネーションによりアクティビティがTaskBox内に表示されていない場合はFalse。
PaginationInfo
TaskBox内のアクティビティ数の情報を持つストラクチャ。
アトリビュート
- Total
- 型: Integer。 TaskBox内のアクティビティの総数。
- Unseen
- 型: Integer。 ページネーションにより非表示になっているアクティビティ数。