Skip to main content
Version: 8.0

Set up the display condition of a page field

Level: intermediate

To implement the example:

  1. Set up the page UI. Read more >>>
  2. Set up the field display condition. Read more >>>
Example

Set up the display condition for the Sick leave, days left field on the custom request page. Display the field for requests that originate from employees, i. e., requests whose Originator type field is set to "Employee."

1. Set up the page UI​

  1. Create an app based on the Records & business processes template. Instructions: Create an app manually (user documentation).

    For this example, create a Requests app.

  2. Open the form page in the Freedom UI Designer.

    For this example, open the Requests form page.

  3. Add a field.

    For this example, add the following fields:

    • field that contains the request originator type
    • field that contains the number of sick days left

    To do this:

    1. Add a field of needed type to the working area of the Freedom UI Designer.

    2. Click and fill out the field properties.

      Element

      Element type

      Property

      Property value

      Field that contains the request originator type

      Dropdown

      Title

      Originator type

      Code

      UsrOriginatorType

      Lookup

      Contact type

      Field that contains the number of sick days left

      Number

      Title

      Sick leave, days left

      Code

      UsrSickDaysLeft

  4. Save the changes.

2. Set up the field display condition​

Configure the business logic in the Client Module Designer. For this example, set up the field display condition.

  1. Open the source code of the Freedom UI page. To do this, click .

  2. Add an attribute.

    1. Go to the viewModelConfig schema section → attributes configuration object.
    2. Add an IsRequestFromEmployee attribute that stores data about the contact type from which the request originates.
    viewModelConfig schema section
    viewModelConfig: /**SCHEMA_VIEW_MODEL_CONFIG*/[
        "attributes": {
            ...,
            /* The attribute that stores the request originator type. */
            "IsRequestFromEmployee": {}
        },
        ...
    ]/**SCHEMA_VIEW_MODEL_CONFIG*/,

  3. Bind an attribute to the field.

    1. Go to the viewConfigDiff schema section → UsrSickDaysLeftField element.
    2. Bind the IsRequestFromEmployee attribute to the visible property.
    viewConfigDiff schema section
    viewConfigDiff: /**SCHEMA_VIEW_CONFIG_DIFF*/[
        ...,
        /* Field that contains the number of sick days left. */
        {
            "operation": "insert",
            "name": "UsrSickDaysLeft",
            "values": {
                ...,
                /* The property that flags the field as visible. Bound to the "IsRequestFromEmployee" attribute. */
                "visible": "$IsRequestFromEmployee"
            },
            ...
        }
    ]/**SCHEMA_VIEW_CONFIG_DIFF*/,

  4. Implement the base request handler.

    1. Go to the handlers schema section.

    2. Add a custom implementation of the crt.HandleViewModelAttributeChangeRequest base request handler.

      1. Run the handler when the value of any attribute changes, including changes made after loading the attribute values from the data source.
      2. Find the ID of the "Employee" value in the Contact type lookup. For this example, the ID is "60733efc-f36b-1410-a883-16d83cab0980."
      3. Save the ID from the previous step to the employeeOriginatorTypeId constant.
      4. Check the UsrOriginatorType attribute value. If the new attribute value refers to the "Employee" contact type, set the IsRequestFromEmployee attribute value to true, otherwise set it to false. I. e., if the request originates from an "Employee" contact type, the page displays the Sick leave, days left field. Otherwise, the page hides the field.
    handlers schema section
    handlers: /**SCHEMA_HANDLERS*/[
        {
            request: "crt.HandleViewModelAttributeChangeRequest",
            /* The custom implementation of the system request handler. */
            handler: async (request, next) => {
                /* Check the request originator type. */
                if (request.attributeName === 'UsrOriginatorType') {
                    const employeeOriginatorTypeId = '60733efc-f36b-1410-a883-16d83cab0980';
                    const selectedOriginatorType = await request.$context.UsrOriginatorType;
                    const selectedOriginatorTypeId = selectedOriginatorType?.value;
                    /* If the request originates from an employee, set the "IsRequestFromEmployee" to "true." */
                    request.$context.IsRequestFromEmployee = selectedOriginatorTypeId === employeeOriginatorTypeId;
                }
                /* Call the next handler if it exists and return its result. */
                return next?.handle(request);
            }
        }
    ]/**SCHEMA_HANDLERS*/,

  5. Save the changes.

View the result​

  1. Open the Requests section.
  2. Create a request that has an arbitrary name. For example, "Sick leave."
  3. Select "Employee" in the Originator type field.

As a result:

  • Creatio will display the Sick leave, days left field for requests that originate from an "Employee" contact type. View the result >>>
  • Creatio will hide the Sick leave, days left field for requests that originate from other contact types, e. g., "Customer."

Source code​

UsrAppRequests_FormPage
/* AMD module declaration. */
define("UsrAppRequests_FormPage", /**SCHEMA_DEPS*/[]/**SCHEMA_DEPS*/, function/**SCHEMA_ARGS*/()/**SCHEMA_ARGS*/ {
    return {
        viewConfigDiff: /**SCHEMA_VIEW_CONFIG_DIFF*/[
            {
                "operation": "merge",
                "name": "Feed",
                "values": {
                    "dataSourceName": "PDS",
                    "entitySchemaName": "UsrRequests"
                }
            },
            {
                "operation": "merge",
                "name": "AttachmentList",
                "values": {
                    "columns": [
                        {
                            "id": "7692c437-8b98-4ccc-8c25-c8e4d235795e",
                            "code": "AttachmentListDS_Name",
                            "caption": "#ResourceString(AttachmentListDS_Name)#",
                            "dataValueType": 28,
                            "width": 200
                        }
                    ]
                }
            },
            {
                "operation": "insert",
                "name": "UsrName",
                "values": {
                    "layoutConfig": {
                        "column": 1,
                        "row": 1,
                        "colSpan": 1,
                        "rowSpan": 1
                    },
                    "type": "crt.Input",
                    "label": "$Resources.Strings.UsrName",
                    "control": "$UsrName",
                    "labelPosition": "auto"
                },
                "parentName": "SideAreaProfileContainer",
                "propertyName": "items",
                "index": 0
            },
            /* Field that contains the request originator type. */
            {
                "operation": "insert",
                "name": "UsrOriginatorType",
                "values": {
                    "layoutConfig": {
                        "column": 1,
                        "row": 2,
                        "colSpan": 1,
                        "rowSpan": 1
                    },
                    "type": "crt.ComboBox",
                    "label": "$Resources.Strings.UsrOriginatorType",
                    "labelPosition": "auto",
                    "control": "$UsrOriginatorType",
                    "listActions": [],
                    "showValueAsLink": true,
                    "controlActions": []
                },
                "parentName": "SideAreaProfileContainer",
                "propertyName": "items",
                "index": 1
            },
            {
                "operation": "insert",
                "name": "addRecord_ul85ru4",
                "values": {
                    "code": "addRecord",
                    "type": "crt.ComboboxSearchTextAction",
                    "icon": "combobox-add-new",
                    "caption": "#ResourceString(addRecord_ul85ru4_caption)#",
                    "clicked": {
                        "request": "crt.CreateRecordFromLookupRequest",
                        "params": {}
                    }
                },
                "parentName": "UsrOriginatorType",
                "propertyName": "listActions",
                "index": 0
            },
            /* Field that contains the number of sick days left. */
            {
                "operation": "insert",
                "name": "UsrSickDaysLeft",
                "values": {
                    "layoutConfig": {
                        "column": 1,
                        "row": 3,
                        "colSpan": 1,
                        "rowSpan": 1
                    },
                    "type": "crt.NumberInput",
                    "label": "$Resources.Strings.UsrSickDaysLeft",
                    "labelPosition": "auto",
                    "control": "$UsrSickDaysLeft",
                    /* The property that flags the field as visible. Bound to the "IsRequestFromEmployee" attribute. */
                    "visible": "$IsRequestFromEmployee"
                },
                "parentName": "SideAreaProfileContainer",
                "propertyName": "items",
                "index": 2
            }
        ]/**SCHEMA_VIEW_CONFIG_DIFF*/,
        viewModelConfig: /**SCHEMA_VIEW_MODEL_CONFIG*/[
            "attributes": {
                "UsrName": {
                    "modelConfig": {
                        "path": "PDS.UsrName"
                    }
                },
                "UsrOriginatorType": {
                    "modelConfig": {
                        "path": "PDS.UsrOriginatorType"
                    }
                },
                "UsrSickDaysLeft": {
                    "modelConfig": {
                        "path": "PDS.UsrSickDaysLeft"
                    }
                },
                "UsrOriginatorType_List": {
                    "isCollection": true,
                    "viewModelConfig": {
                        "attributes": {
                            "value": {
                                "modelConfig": {
                                    "path": "UsrOriginatorType_List_DS.Id"
                                }
                            },
                            "displayValue": {
                                "modelConfig": {
                                    "path": "UsrOriginatorType_List_DS.Name"
                                }
                            }
                        }
                    },
                    "modelConfig": {
                        "path": "UsrOriginatorType_List_DS",
                        "sortingConfig": {
                            "attributeName": "UsrOriginatorType_List_Sorting",
                            "default": [
                                {
                                    "columnName": "Name",
                                    "direction": "asc"
                                }
                            ]
                        },
                        "pagingConfig": {
                            "rowCount": 50,
                            "rowsOffset": null
                        }
                    },
                    "embeddedModel": {
                        "name": "UsrOriginatorType_List_DS",
                        "config": {
                            "type": "crt.EntityDataSource",
                            "config": {
                                "entitySchemaName": "ContactType"
                            }
                        }
                    }
                },
                "UsrOriginatorType_List_Sorting": {
                    "isCollection": true,
                    "viewModelConfig": {
                        "attributes": {
                            "columnName": {},
                            "direction": {}
                        }
                    }
                },
                /* The attribute that stores the request originator type. */
                "IsRequestFromEmployee": {}
            },
        ]/**SCHEMA_VIEW_MODEL_CONFIG*/,
        modelConfig: /**SCHEMA_MODEL_CONFIG*/[
            "PDS": {
                "type": "crt.EntityDataSource",
                "config": {
                    "entitySchemaName": "UsrRequests"
                }
            }
        ]/**SCHEMA_MODEL_CONFIG*/,
        handlers: /**SCHEMA_HANDLERS*/[
            {
            request: "crt.HandleViewModelAttributeChangeRequest",
            /* The custom implementation of the system request handler. */
            handler: async (request, next) => {
                /* Check the request originator type. */
                if (request.attributeName === 'UsrOriginatorType') {
                    const employeeOriginatorTypeId = '60733efc-f36b-1410-a883-16d83cab0980';
                    const selectedOriginatorType = await request.$context.UsrOriginatorType;
                    const selectedOriginatorTypeId = selectedOriginatorType?.value;
                    /* If the request originates from an employee, set the "IsRequestFromEmployee" to "true." */
                    request.$context.IsRequestFromEmployee = selectedOriginatorTypeId === employeeOriginatorTypeId;
                }
                /* Call the next handler if it exists and return its result. */
                return next?.handle(request);
            }
        }
        ]/**SCHEMA_HANDLERS*/,
        converters: /**SCHEMA_CONVERTERS*/{}/**SCHEMA_CONVERTERS*/,
        validators: /**SCHEMA_VALIDATORS*/{}/**SCHEMA_VALIDATORS*/
    };
});

Resources​

Package with example implementation