EPA Taskbox API
The Embedded Process Automation (EPA) automatically displays in the user's web browser all pending activities in a floating taskbox. Each item includes instructions and a link that will lead the user to the web page where the activity can be completed. In Mobile Apps a custom taskbox needs to be created.
Summary
| Actions | |
|---|---|
| API_GetActivities | Returns the activities of a user. Activity filtering and pagination are allowed. |
| API_GetActivityGuidanceHtml | Encodes the activity guidance instructions in HTML format. |
| API_GetActivityPagination | Returns the pagination information of all activities currently displayed in the Taskbox of the user. |
| API_GetActivityVisualization | Returns information on how an open activity is displayed in the Taskbox. |
| API_GetDynamicHtml | [Deprecated] Returns the JavaScript code for the Taskbox and its current content. |
| API_GetNewOpenActivity | Returns the activity that is currently open by the user and has the indicated activity as one of the previous activities in the process flow. |
| API_GetStaticHtml | [Deprecated] Returns the HTML of the Taskbox with absolute URLs, i.e., starting with "http://<Server Name>/". |
| API_MarkActivitiesAsSeen | Displays all Taskbox activities for the user as already seen, i.e., only new activities will be displayed as not seen in the Taskbox. |
| API_SetActivityVisualization | Sets how an open activity is displayed in the Taskbox. |
| Inbox_DisableInServer | Disables the Taskbox in the environment. |
| Inbox_EnableInServer | Enables the Taskbox in the environment. |
| Structures | |
|---|---|
| Inbox_FilterCriteria | |
| Inbox_PaginationCriteria | |
| Activity | The structure with the information of an activity in the TaskBox. |
| PaginationInfo | The structure with information of the number of activities in the TaskBox. |
Actions
API_GetActivities
Returns the activities of a user.
Activity filtering and pagination are allowed.
Inputs
- UserId
- Type: mandatory, User Identifier.
The identifier of the user.
- FilterCriteria
- Type: optional, Inbox_FilterCriteria.
The criteria for filtering activities.
Leave it empty for no filtering.
- PaginationCriteria
- Type: mandatory, Inbox_PaginationCriteria.
The pagination criteria for displaying the activities in the Taskbox of the user.
Leave it empty for no pagination.
Outputs
- ActivityList
- Type: Activity Record List.
The list of activities.
- PaginationInfo
- Type: PaginationInfo.
The definite pagination information for displaying the activities in the Taskbox of the user.
API_GetActivityGuidanceHtml
Encodes the activity guidance instructions in HTML format.
Inputs
- Guidance
- Type: mandatory, Text.
The activity guidance instructions.
Outputs
- GuidanceHtml
- Type: Text.
The activity guidance instructions encoded in HTML format.
API_GetActivityPagination
Returns the pagination information of all activities currently displayed in the Taskbox of the user.
Inputs
- UserId
- Type: mandatory, User Identifier.
The identifier of the user.
- FilterCriteria
- Type: optional, Inbox_FilterCriteria.
The criteria for filtering activities.
Leave it empty for no filtering.
Outputs
- PaginationInfo
- Type: PaginationInfo.
The pagination information of all activities currently displayed in the Taskbox of the user.
API_GetActivityVisualization
Returns information on how an open activity is displayed in the Taskbox.
Inputs
- ActivityId
- Type: mandatory, Activity Identifier.
The identifier of the activity.
Outputs
- HideDone
- Type: Boolean.
If True, the 'Done' button is not available when the activity is open in the Taskbox.
- HideRelease
- Type: Boolean.
If True, the 'Release' button is not available when the activity is open in the Taskbox.
- CustomInstructions
- Type: Text.
The text/HTML of custom instructions displayed below the normal activity instructions when the activity is open in the Taskbox.
The instructions have a maximum length of 500 characters.
API_GetDynamicHtml
[Deprecated] Returns the JavaScript code for the Taskbox and its current content.
Inputs
- EspaceId
- Type: mandatory, Espace Identifier.
[Deprecated]
- UserId
- Type: mandatory, User Identifier.
The identifier of the user.
- Locale
- Type: mandatory, Text.
[Deprecated]
- Data
- Type: mandatory, Text.
[Deprecated]
Outputs
- Html
- Type: Text.
The JavaScript code for the Taskbox and its current content.
API_GetNewOpenActivity
Returns the activity that is currently open by the user and has the indicated activity as one of the previous activities in the process flow.
Inputs
- UserId
- Type: mandatory, User Identifier.
The identifier of the user.
- PreviousActivityId
- Type: mandatory, Activity Identifier.
The identifier of one of the previous activities in the process flow.
Outputs
- ActivityId
- Type: Activity Identifier.
The activity that is currently open by the user.
API_GetStaticHtml
[Deprecated] Returns the HTML of the Taskbox with absolute URLs, i.e., starting with "http://<Server Name>/".
Inputs
- EspaceId
- Type: mandatory, Espace Identifier.
The identifier of the eSpace.
- UserId
- Type: mandatory, User Identifier.
The identifier of the user.
- Locale
- Type: mandatory, Text.
The language locale.
- Data
- Type: mandatory, Text.
[Deprecated]
Outputs
- Html
- Type: Text.
The HTML of the Taskbox with absolute URLs, i.e., starting with "http://<Server Name>/".
API_MarkActivitiesAsSeen
Displays all Taskbox activities for the user as already seen, i.e., only new activities will be displayed as not seen in the Taskbox.
Inputs
- UserId
- Type: mandatory, User Identifier.
The identifier of the user.
API_SetActivityVisualization
Sets how an open activity is displayed in the Taskbox.
Inputs
- ActivityId
- Type: mandatory, Activity Identifier.
The identifier of the activity.
- HideDone
- Type: optional, Boolean.
If True, the 'Done' button is not available when the activity is open in the Taskbox.
- HideRelease
- Type: optional, Boolean.
If True, the 'Release' button is not available when the activity is open in the Taskbox.
- CustomInstructions
- Type: optional, Text.
The text/HTML for custom instructions displayed below the normal activity instructions when the activity is open in the Taskbox.
The custom instructions have a maximum length of 500 characters.
Inbox_EnableInServer
Enables the Taskbox in the environment.
Structures
Activity
The structure with the information of an activity in the TaskBox.
Attributes
- Id
- Type: EntityReference.
The identifier of the Activity.
- Label
- Type: Text (50).
The label of the Activity.
- LabelLang
- Type: Text (50).
The code of the language locale of the label.
- Details
- Type: Text (50).
The details of the Activity.
- DueDate
- Type: DateTime.
The due date of the Activity.
- IsOpened
- Type: Boolean.
Is True if the activity is already open by a user.
- IsSeen
- Type: Boolean.
Is False if the activity is not visible in the TaskBox due to pagination.
PaginationInfo
The structure with information of the number of activities in the TaskBox.
Attributes
- Total
- Type: Integer.
The total number of activities in the TaskBox.
- Unseen
- Type: Integer.
The number of unseen activities due to pagination.