Files
alfresco-ng2-components/docs/process-services-cloud/components/screen-cloud.component.md
Alexander Puschkin 1fe4dd6fc9 AAE-36822 Removes showNextTaskCheckbox input for the feature flag (#11066)
* Removes showNextTaskCheckbox input

Removes the `showNextTaskCheckbox` input from the `UserTaskCloudComponent` and related files.

The `showNextTaskCheckbox` input is no longer needed, instead the visibility of the 'Open next task' checkbox will depend on the canCompleteTask() method.
This change simplifies the component's API and ensures that the checkbox is always displayed when it should be.

* Adds option to open next task after completion

Introduces a new checkbox on the task screen that, when checked, automatically navigates the user to the next available task upon completion of the current one.
It enhances user experience by streamlining task completion workflows, eliminating the need for manual navigation.

* revert changes

* review
2025-08-06 11:14:07 +02:00

5.0 KiB

Title, Added, Status, Last reviewed
Title Added Status Last reviewed
Screen Cloud Component 2025-02-05 Active 2025-02-05

Screen Cloud Component

Provides space for a dynamic component. Dynamic component should implement interface UserTaskCustomUi. Dynamic component must be registered with service that extends ScreenRenderingService. Key for component is a string taken from property formKey stored in xml. In component this value is stored in property screenId. To register component use method register, example:

import { ScreenRenderingService } from '@alfresco/adf-process-services-cloud';

export class YourService extends ScreenRenderingService {

    constructor() {
        super();
        this.register(
            {
                [formKeyThatIdentifiesDynamicComponent]: () => DynamicComponent
            },
            true
        );
    }
}

Basic Usage

<adf-cloud-task-screen 
    [appName]="appName"
    [canClaimTask]="canClaimTask()"
    [canUnclaimTask]="canUnclaimTask()"
    [processInstanceId]="taskDetails.processInstanceId"
    [rootProcessInstanceId]="taskDetails.rootProcessInstanceId"
    [screenId]="screenId"
    [showCancelButton]="showCancelButton"
    [taskName]="taskDetails.name"
    [taskId]="taskId"
    (cancelTask)="onCancelClick()"
    (claimTask)="onClaimTask()"
    (error)="onError($event)"
    (taskCompleted)="onCompleteTask()"
    (taskSaved)="onFormSaved()"
    (unclaimTask)="onUnclaimTask()"
/>

Class members

Properties

Name Type Default value Description
appName string "" App id to fetch corresponding form and values.
canClaimTask boolean Boolean informing if a task can be claimed.
canUnclaimTask boolean Boolean informing if a task can be unclaimed.
isNextTaskCheckboxChecked boolean false Whether the Open next task checkbox is checked by default or not.
processInstanceId string Process Instance Id to fetch corresponding data.
rootProcessInstanceId string Root Process Instance Id to fetch corresponding data.
readOnly boolean false Toggle readonly state of the task.
showCancelButton boolean true Toggle rendering of the Cancel button.
showNextTaskCheckbox boolean false Toggle rendering of the Open next task checkbox (controlled internally by parent component).
screenId string Screen id to create dynamic component
taskId string Task id to fetch corresponding form and values.
taskName string Name of the task.

Events

Name Type Description
cancelTask EventEmitter<any> Emitted when the task is cancelled.
error EventEmitter<any> Emitted when any error occurs.
taskSaved EventEmitter Emitted when the task is saved.
claimTask EventEmitter<string> Emitted when the task is claimed.
taskCompleted EventEmitter<string> Emitted when the task is completed.
unclaimTask EventEmitter<string> Emitted when the task is unclaimed.

Enabling fullscreen display for the dynamic component

Dynamic component must implement logic for method switchToDisplayMode.

MyView.component.html

<button (click)="adfCloudTaskScreen.switchToDisplayMode('fullScreen')">Full screen</button>

<adf-cloud-task-screen  
    #adfCloudTaskScreen
    [appName]="appName"
    [canClaimTask]="canClaimTask()"
    [canUnclaimTask]="canUnclaimTask()"
    [processInstanceId]="taskDetails.processInstanceId"
    [rootProcessInstanceId]="taskDetails.rootProcessInstanceId"
    [screenId]="screenId"
    [showCancelButton]="showCancelButton"
    [taskName]="taskDetails.name"
    [taskId]="taskId"
    (cancelTask)="onCancelClick()"
    (claimTask)="onClaimTask()"
    (error)="onError($event)"
    (taskCompleted)="onCompleteTask()"
    (taskSaved)="onFormSaved()"
    (unclaimTask)="onUnclaimTask()"
/>