Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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.
    Image Removed
    Completes Task
    When checked, performing this action will set the completion flag of the Task to true.  The completion field is configured here
    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
    titleExample
    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.
    Image Removed

Data Updates

Lock?

...

  •   You can find more details of the options here.
  • 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
    titleExample
    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.



    Image Added

Data Updates

This option is when you are configuring the workflow to support multiple tasks in one level running in parallel.  When tasks are running in parallel, there is possibility that when one user saves the application, it could overwrite what another user is doing at the same time.  To prevent this, each Task can be configured only to update a specific section of the data model. 

Info
The lookup for this field will return only Structures in the data model.  All fields that need to be updated in parallel should be placed within their own structure.

Image Added

Lock?

When parallel tasks are configured, this option enforces a lock on the form so that multiple people cannot attempt to open and execute the same task.  After a user has opened the Task, any other users will get a warning that the form is currently locked and no actions will be made available to them. 

More






Image Added

  • Completion Field
    This is a boolean field in the Data Model that is used to determine when the task has been completed.

  • Audit Log Comments Field
    This is a field in the Data Model that is used to write a comment into the Audit Log when the task is actioned.

    Info

    When using this with parallel tasks, the field in the Data Model MUST be inside the structure configured in the Data Model Updates section of the Task.  If the field is outside the configured structure, the comment will not be saved.


  • Attachments
    This option allows for form level attachments to be supported.  If checked, the Attachments button will appear at the bottom left of the toolbar.

  • Number Range
    If the form is configured to use a SAP Number Range to assign a unique number to each instance of the form, this option informs the platform that when this Task is processed, the Number Range should be queried and associated with the instance of the form.  Reasons why this would not unchecked would be for situations where a Draft versions should not yet assign a number. 

  • No Revision
    When checked, this task will not create and track any revisions at this level.  You may not want the Draft level to create unnecessary revisions of the data.
     
  • Hide in Process Flow
    This option will hide this specific task from the Process Flow diagram.

  • Terminating Task
    This indicates whether the Task is at the end of the workflow, example Complete or Rejected.  The task will be displayed differently in the Process Flow diagram.

  • Status Override
    In the MyForms application, the status of the form is normally taken from the Level.  If there are multiple tasks within a level, this Status Override will allow a developer to configure a different status depending on the specific Task that is active.

    Info

    In situations with parallel task execution, it may not always be possible to determine the exact task and the Level status will be used instead.