...
Details:
| Table of Contents |
|---|
Task ID
The Task ID should be a unique value that will be passed into the ABAP exits in your implementation class. This can be used to determine the current task and perform any actions accordingly.
Level
Each task must exist within a level. The values in this drop down are configured in the Levels section of the workflow designer.
Abbrev.
This is the abbreviated name of the task that is displayed in the Process Flow diagram. The Process Flow diagram allows the user to zoom in or out and when the diagram is zoomed out, it is not possible to show the full Task ID on the diagram. In this situation, the abbreviation text is used instead.
Roles
The roles button allows you to configure which role should perform each task. A task can have one or many roles associated with it. The list of roles will include any custom created roles as well as the system roles of:
- Initiator - Only the person performing the original submission will be able to execute the task. This is useful when sending back a request to the original initiator for final review.
- All - Any person with access to the application will be able to execute the task.
- None - No one will be able to see or execute the task.
- Administrator - Any administrators of the form can execute the task. This is useful to provide administrators a way to go in and execute a task on someone's behalf.
Requirements
Each task can be configured to execute only when certain requirements have been met. A good use case of this is when certain approval tasks are needed only in certain circumstances (e.g. A value threshold has been met). Requirements must first be configured in the Requirements section of the workflow designer.
Actions
The actions for a Task configure which actions a user can take when that task is executed. Each action will appear in the footer of the application as a button. The Text, Icon and Button Type of the button can be configured.
- Action ID - This is a unique ID of the action that is passed into the ABAP user exits. When the status of the form changes, ABAP code can be used to interrogate the last performed Action and perform the necessary operations.
- Action Text - This is the text that appears on the button.
- Icon - This is the SAP UI5 icon that is displayed on the button.
- Button Type - This is the styling that the button will use. You can see some examples of button types here.
- Behaviour - This button opens up additional configuration options for the button.
Completes Task
When checked, performing this action will set the completion flag of the Task to true. The completion field is configuredhere
Default Path
This indicates that this action will be performed if the Task requirements are not met and thus the Task will be skipped. This allows you to configure a chain of tasks that may be conditional. If a task is not executed due to requirements, the action with the Default Path option checked will be executed.
Bypass Validations
This will ignore any validations on the form and is useful for actions such as Save as Draft.
Go Back
When this option is checked, performing the action will take the user back to the Fiori Launch Pad, FAB Launch Pad or the My Forms app depending where they came from. Save as Draft is a good example where you do not want to take the user back and instead leave them on the form to continue working.
Hidden Action
Checking this option will hide the button for the action on the Footer
One-List Action
This indicates that the action that can be performed by a user in the OneList application, where configured.
Front-End Action Only
For front end only actions where no backend ABAP code is needed, the user can set this option that will prevent the form from doing any backend ABAP processing. Note: This will also mean that the data in your application will NOT be persisted to the backend.
Validation Function
The Validation Function allows you to enter a JavaScript function name, which must exist in a Script element of the Form. This function is called when the Form is attempted to be submitted (if the ByPass Validations setting on the action is false). The function allows client-side validations to be performed before sending the data to the back-end. If the function returns false, the call to the back-end is aborted.Generally, most validations are done on the back-end in SAP (via implementation class and method VALIDATIONS_ON_SAVE). This Validation function allows some checks to be made before sending the data to the back-end.
Success Function
The Success Function is a JavaScript function which must exist in a Script element in the Form. The function is called after the call to the back-end is successful and allows a deviation from the default behavior (which is usually to exit the form) [if Go Back is true on the action].
Implement this function if you do not want to go back to the main menu when the action is successful, but rather go back to the previous Page and refresh the list on that Page. It can be useful where an app has two pages - the first one being a list, and the second the main detail page.
Prompt Function
The Prompt Function allows you to enter a JavaScript function name, which must exist in a Script element of the Form. This function is called before the action takes place. Implement this if you need to have a prompt asking for a user's input before the App can proceed with the action. The JavaScript function should return TRUE or FALSE to indicate whether the action should be executed or not.
Outcomes - This button opens an editor to configure the Outcomes when this action is performed. An Outcome is another task that can be in any level within the application.
Info title Example The Outcome of an Approve action may be the Completed Task whereas the Reject action may take the Form back to the original Creation or a specific Review task. 