Shows a form from Process Services.


Basic Usage


Custom form outcomes template

You can set the custom form outcomes using an <adf-cloud-form-custom-outcomes> element.

<adf-cloud-form .... >

        <button mat-button (click)="onCustomOutcome1()">
        <button mat-button (click)="onCustomOutcome2()">
        <button mat-button (click)="onCustomOutcome3()">


Empty form template

The template defined inside empty-form will be shown when no form definition is found:

<adf-cloud-form .... >

    <div empty-form >
        <h2>Empty form</h2>


Class members


NameTypeDefault valueDescription
appNamestring""App name to fetch corresponding form and values.
appVersionnumberThe application version to use when fetching data
dataTaskVariableCloud[]Custom form values map to be used with the rendered form.
disableCompleteButtonbooleanfalseIf true then the Complete outcome button is shown but it will be disabled.
disableSaveButtonbooleanfalseIf true then the Save outcome button is shown but will be disabled.
disableStartProcessButtonbooleanfalseIf true then the Start Process outcome button is shown but it will be disabled.
fieldValidatorsFormFieldValidator[]FormFieldValidator allow to override the form field validators provided.
formFormModelUnderlying form model instance.
formIdstringTask id to fetch corresponding form and values.
nameNodestringName to assign to the new node where the metadata are stored.
pathstringPath of the folder where the metadata will be stored.
processInstanceIdstringProcessInstanceId id to fetch corresponding form and values.
readOnlybooleanfalseToggle readonly state of the form. Forces all form widgets to render as readonly if enabled.
showCompleteButtonbooleantrueToggle rendering of the Complete outcome button.
showRefreshButtonbooleantrueToggle rendering of the Refresh button.
showSaveButtonbooleantrueToggle rendering of the Save outcome button.
showTitlebooleantrueToggle rendering of the form title.
showValidationIconbooleantrueToggle rendering of the validation icon next to the form title.
taskIdstringTask id to fetch corresponding form and values.


errorEventEmitter<any>Emitted when any error occurs.
executeOutcomeEventEmitter<FormOutcomeEvent>Emitted when any outcome is executed. Default behaviour can be prevented via event.preventDefault().
formCompletedEventEmitter<FormModel>Emitted when the form is submitted with the Complete outcome.
formContentClickedEventEmitter<ContentLinkModel>Emitted when form content is clicked.
formDataRefreshedEventEmitter<FormModel>Emitted when form values are refreshed due to a data property change.
formErrorEventEmitter<FormFieldModel[]>Emitted when the supplied form values have a validation error.
formLoadedEventEmitter<FormModel>Emitted when the form is loaded or reloaded.
formSavedEventEmitter<FormModel>Emitted when the form is submitted with the Save or custom outcomes.


All formXXX events receive a FormCloudModel instance as their argument:




onFormSaved(form: FormCloudModel) {

Displaying a form

There are various ways to display a form. The common scenarios are detailed below.

Displaying a form instance by task id and processInstanceId


For an existing Task both the form and its values will be fetched and displayed.

Displaying a form definition by form id


In this case, only the form definition will be fetched.

Controlling outcome execution behaviour

In unusual circumstances, you may need to take complete control of form outcome execution. You can do this by implementing the executeOutcome event, which is emitted for both system outcomes and custom ones.

Note that by default, the code in your executeOutcome handler is executed before the default behavior but you can switch the default behavior off using event.preventDefault(). You might want to do this, for example, to provide custom form validation or to show a summary of the form validation before it is submitted.




import { FormOutcomeEvent } from '@alfresco/adf-core';

class MyView {

    validateForm(event: FormOutcomeEvent) {
        let outcome = event.outcome;

        // you can also get additional properties of outcomes
        // if you defined them within outcome definition

        if (outcome) {
            let form = outcome.form;
            if (form) {
                // check/update the form here


There are two other functions that can be very useful when you need to control form outcomes:

  • saveTaskForm() - Saves the current form
  • completeTaskForm(outcome?: string) Saves and completes the form with a given outcome name

Field Validators

You can supply a set of validator objects to the form using the fieldValidators property. Each validator implements a check for a particular type of data (eg, a date validator might check that the date in the field falls between 1980 and 2017). ADF supplies a standard set of validators that handle most common cases but you can also implement your own custom validators to replace or extend the set. See the Form Field Validator interface for full details and examples.

Common scenarios

Rendering a form using form definition JSON

See the demo-form file for an example of form definition JSON.

The component below (with the JSON assigned to the formDefinitionJSON property), shows how a form definition is rendered:

    selector: 'sample-form',
    template: `<div class="form-container">
class SampleFormComponent implements OnInit {

    form: FormCloudModel;
    formDefinitionJSON: any;

    constructor(private formService: FormService) {

    ngOnInit() {        
        this.form = this.formService.parseForm(this.formDefinitionJSON);

Customizing the styles of form outcome buttons

You can use normal CSS selectors to style the outcome buttons of your form. Every outcome has an CSS id value following a simple pattern:


In the CSS, you can target any outcome ID and change the style as in this example:

#adf-cloud-form-complete {
    background-color: blue !important;
    color: white;

#adf-cloud-form-save {
    background-color: green !important;
    color: white;

#adf-cloud-form-customoutcome {
    background-color: yellow !important;
    color: white;

form style sample

See also

© 2023 Alfresco Software, Inc. All Rights Reserved.