Adding field sets

A field set is a collection of fields from a detail page data source that can be added to a detail page within a detail page layout block.

A field set will be displayed in one column. If you want fields to be presented in several columns (useful when you have a lot of fields on the header), you need to create several field sets as child pages to the parent layout block.

To add a field set to a layout block of a detail page

  1. In CMS, go to Contents.
  2. Select the content node, and then, under a detail page node, select a block for which you want to add a field set.
  3. Select the icon of the selected node (the icon appears when you point to the node title).
  4. Select Field set in the Create dialog window that appears.

  5. If you have at least one content template of the field set page type, the created template(s) will be available for selection to use as a basis for the new page. Otherwise, this step is not shown. You can select Blank in case you don't want to use a template.
  6. On the header, enter the field set name that will be used to identify it in CMS. Note that if the layout block view type is set to Tab, this name will be displayed as the tab caption.
  7. On the General tab, fill in general settings.
    1. Title - Specifies the title of the field set. For field sets, you can leave this empty.
    2. Subtitle - Specifies the subtitle of the field set. For field sets, you can leave this empty.
    3. Icon - Specifies the image that will be displayed in front of the layout block title.
    4. Width settings - Specifies the adaptive grid width settings for the field set per device. The width is automatically adjusted depending on the device the page is opened from.
    5. Hide element - This setting hides the field set from the dashboard or detail page. It can be configured per member group. Select one or several member groups, for which this field set will be hidden. Alternatively, you can select the ~All~ check box to hide it for all member groups (without the necessity to select every member group's check box) or select the Hide element check box to have all member groups selected at once.
    6. Background color - Specifies the color that will be used as background of this field set.
    7. Background image- Specifies the image that will be displayed in the background of this field set.
    8. Description - Specifies a description of this field set.
    9. Navigate-to page - Specifies the portal page that will be displayed when the portal member edits a record on the layout block. For field set within detail pages, filling in this setting is usually not required.
    10. Content-from page - Specifies the portal page that will be displayed instead of the created page. The path on the address bar will be that of the original page. Use this setting only if you want to redirect the member to another existing portal page. Select Add to add a page that will be displayed instead of the source page.
    11. Redirect-to page - Specifies the portal page that will be displayed instead of the created page. The path on the address bar will be that of the target page. Use this setting only if you want to redirect the member to another existing portal page. Select Add to add a page that will be displayed instead of the source page.
  8. On the Fields tab, configure caption settings and which fields from the data source (taken from the parent detail page) will be displayed on this field set.
    1. Caption settings
      1. Hide caption - Use this switch to hide field caption from the data set.
      2. Width settings - Specifies the adaptive grid width settings for the field set per device. The width is automatically adjusted depending on the device the page is opened from.
    2. Fields - Specifies the fields that will be available on the field set.
      Select the icon to add a new field. To change the default position of a field, hold the icon and then drop the field in the required position. Use the icon to remove a field if necessary or the icon to edit an existing field.
      1. Caption - Specifies the field caption for this site localization.
      2. Name - Specifies the name of the field from which data is retrieved. Select an available field from the list. The list of available fields depends on the data source settings configured on the Data source tab of the parent detail page.
      3. Editable on edit page - Specifies whether it will be allowed to edit the field value on an existing record and for which member groups.
      4. Editable on create page - Specifies whether it will be allowed to edit the field value when creating a new record with this field (using the command that creates a new record and opens the detail page) and for which member groups.
      5. Data type - Specifies the data type that defines how field value will be edited and displayed. Ensure that the data type corresponds to the data type of the field in the data source, which is specified in Media > Portal Settings > Entities > [Entity_Name] > Fields > [Field_Name] > Field Settings tab > Type. If you select a data type that is not logically compatible with the original field type, the field value may not be displayed. Also, you may want to choose a different data type in case you want to change the purpose of the field on the portal. You can leave this setting empty to preserve the source data type. Note that there are additional data types, with extended options, which are available only for fields in an extended field set. Select one of the available data types:
        1. Default (Text) - This data type denotes text string.

        2. Multiline - This data type denotes text string with the ability to add multiple lines of text.

        3. Boolean - This data type indicates whether the value is true or false. A check box will be shown that can be selected or cleared.

        4. Date - Denotes a date value. The displayed  text format of the date may be determined by other date-related settings. The field will also have a calendar control that the member will be able to use to set a date.

        5. DateTime - Denotes a date & time value. The field will also have a calendar control that the member will be able to use to set a date as well as a time control to set time.

        6. Option - This data type denotes an option value. The member will be able to use the drop-down list to select an option.

        7. Entity type (Entity type filter) - This data type denotes a filter by entity type. This data type is used to add a filter by entity type to a notification subscription setup page.

        8. Hidden - With this data type the field, both the caption and value, will be hidden on the page.
        9. Multiselection - This data type denotes an option value with the ability to select multiple options.

        10. Numeric - This data type stores numeric values with up to 2 numbers after comma. The field will  have a control to increase or decrease the value with step 1.

        11. Upload (Attachment) - This data type denotes a file attachment. This data type is used when you want to use the field to upload, store, and download files. The field will have a control that will allow members upload files. All uploaded files will be displayed in the field value. Members will be able to download files by selecting the file name in the field in the edit mode. Downloaded files can be removed if necessary.

        12. Entity filter - This data type denotes a filter by entity. At present, this data type is not used for fields in a standard field set.
      6. Default value - Specifies the default value for this field that will be filled in automatically when a new record with this field is created.
        1. Constant value - Use this type to specify a constant value that will be filled in.
        2. Value from parent - Use this type to use a value from a parent entity field as the default value. You will need to specify a field from the parent entity if any.
        3. Value-from member field name - Use this option to use a value from a member field (a field from the portal member settings) as the default value. You will need to specify a member field the value will be taken from.
        4. Data query - Use this option to use a query that will retrieve data. You will need to specify a data source query.
        5. Date value - Use this option if you want the field to be filled in with a date. The date may be calculated according to the specified method. For example, 1 day after the current date, 2 weeks before the current date, etc.
        6. No. series value - Specifies the number series value. With this default value type, when a new record is created or in case the value is missing when you edit the field, the field is filled in automatically by increasing the previous value with the increment specified in the chosen number series setup.
          1. No. series code - Specifies the code of the number series setup (in case there are many) to use for this field. Number series settings that you choose here are set up for the field in the entity setting.
        7. Value from entity - Specifies the entity and the field from this entity, the value from which will be retrieved in this field.
      7. Required – Specifies whether having value in this field will be mandatory. If you enable this switch, the member will not be able to leave the field empty when editing value; an error message will be displayed.
      8. Value validation – Specifies a validation or multiple validations that will be applied to the field value on the grid page or detail card. When the field isn't editable, validations will not be applied. Value validation can also be set up on the entity level. Select the icon and select the type of validation:
        1. Required - Specifies a validation that verifies whether the field after having been edited contains value.
          1. Enabled - Specifies whether this validation is turned on. If the validation is disabled, it will not be run when entering a field value.
          2. Validation message - Specifies the text of an error message that will be displayed if the validation criteria are not fulfilled.
        2. Field length - Specifies validation that verifies whether the length of the field after having been edited is within the specified length range.
          1. Enabled - Specifies whether this validation is turned on. If the validation is disabled, it will not be run when entering a field value.
          2. Validation message - Specifies the text of an error message that will be displayed if the validation criteria are not fulfilled.
          3. Minimum length - Specifies a numeric value that will be used as the minimum field length value when validating the field.
          4. Maximum length - Specifies a numeric value that will be used as the maximum field length value when validating the field.
        3. Regular expression - Specifies a validation that verifies whether the field value after having been edited meets the format defined by a regular expression.
          1. Enabled - Specifies whether this validation is turned on. If the validation is disabled, it will not be run when entering a field value.
          2. Validation message - Specifies the text of an error message that will be displayed if the validation criteria are not fulfilled.
          3. Regular expression - Specifies a regular expression that defines the format that the field value must meet to pass the validation. Refer to this site for help on creating a regular expression. Several examples:
            Explanation: Only letters from A to Z letters are valid; case sensitive. Value: [A-Z]
            Explanation: The following characters are not allowed: <>\/$. Value: [^<>\/\$]+
        4. Email - Specifies validation that verifies whether the field value that is email after having been edited meets the predefined criteria of email.
          1. Enabled - Specifies whether this validation is turned on. If the validation is disabled, it will not be run when entering a field value.
          2. Validation message - Specifies the text of an error message that will be displayed if the validation criteria are not fulfilled.
        5. Custom validation - Specifies a client- and/or server-side validation that verifies whether the field value after having been edited fulfils the criteria that are defined in a custom or predefined script/code.
          1. Enabled - Specifies whether this validation is turned on. If the validation is disabled, it will not be run when entering a field value.
          2. Validation message - Specifies the text of an error message that will be displayed if the validation criteria are not fulfilled.
          3. Client-side validation - Specifies JavaScript code that defines validation criteria that must be fulfilled on the client side after the field value is changed. Select the icon next to the setting to select one of pre-defined or custom-made validations. If you use both client- and server-side validation, they must validate the same. After you select a predefined custom validation, the required settings will be filled in automatically. If you need additional custom validation that would suit your needs, contact the portal development team.
          4. Server-side validation - Specifies the title of a function in a custom piece of code that defines validation criteria that must be fulfilled on the server side after the field value is changed. Select the icon next to the setting to select one of pre-defined or custom-made validations. Server-side validation may be useful when multiple users are trying to change the same field value. If you use both client- and server-side validation, they must validate the same. After you select a predefined custom validation, the required settings will be filled in automatically. If you need additional custom validation that would suit your needs, contact the portal development team.
        6. File size/type - Specifies a validation that verifies whether the size of an uploaded file doesn't exceed the maximum allowed size and/or that the file type belongs to the allowed file types.
          1. Enabled - Specifies whether this validation is turned on. If the validation is disabled, it will not be run when entering a field value.
          2. Validation message - Specifies the text of an error message that will be displayed if the validation criteria are not fulfilled.
          3. Maximum file size - Specifies the maximum allowed file size in KB to fulfil the validation criteria.
            File type(s) validation message - Specifies the text of an error message that will be displayed if the allowed file type(s) validation criteria are not fulfilled.
          4. File type(s) - Specifies the list of allowed file type(s) to fulfil the validation criteria. Allowed file types must be listed as file extensions and, if more than one, separated by a comma without spaces. Example: .docx,.xlsx,.png
        7. No. of selected options - Specifies a validation that verifies whether the number of selected options in an extended field with the multiselection or multiple picker data type is within the allowed range of selectable options.
          1. Enabled - Specifies whether this validation is turned on. If the validation is disabled, it will not be run when entering a field value.
          2. Validation message - Specifies the text of an error message that will be displayed if the validation criteria are not fulfilled.
          3. Min. no. of selected options - Specifies the minimum number of options that can be selected in the field to fulfil the criteria.
          4. Max. no. of selected options - Specifies the maximum number of options that can be selected in the field to fulfil the criteria.
        8. Google reCAPTCHA - Specifies validation that verifies whether the Google reCAPTCHA test has been passed successfully.
          1. Enabled - Specifies whether this validation is turned on. If the validation is disabled, it will not be run when entering a field value.
          2. Validation message - Specifies the text of an error message that will be displayed if the validation criteria are not fulfilled.
          3. Validation message title - Specifies the title that will be displayed on the validation message.
          4. Google reCAPTCHA version - Specifies the version of the Google reCAPTCHA that is used for this validation. Select the version for which the site key and secret key were obtained during the reCAPTCHA account registration and which are specified in the site localization additional settings.
      9. Value alignment – Specifies how value in the field as well as field caption will be aligned. Select one of the following options:
        1. Center – Value will be centered. This type of alignment will be used by default if you leave the setting empty.
        2. Left – Value will be aligned left.
        3. Right – Value will be aligned right.
      10. Data format - Specifies the display format for the field value. This setting is optional. It defines how the value will look like and what additional properties the field value will have.
        1. Hyperlink - Use this option to turn the field value into a hyperlink that opens an internal or external page.
          1. Title - Specifies the title of the format expression. This title is only used for back end purposes.
          2. Internal page - Specifies an internal page that the hyperlink in the field value will lead to.
          3. External page - Specifies the URL of an external web page that the hyperlink in the field value will lead to.
          4. URL query & parameters - Specifies the part of a Uniform Resource Locator (URL) that follows the question mark "?" and contains parameters or key-value pairs used to send additional information to a web server. This query may include variables in double square brackets, such as [[fieldname]], which will be replaced with the corresponding value.
          5. Open link in - Specifies how the link will be opened: in a new window, in a popup window, in the same frame, or in the same window.
        2. Percent of progress - Use this option when you need the value to display the progress in percentages.
        3. Show alert - Use this option when the field value is used to show an alert(s). Note: This functionality is under development.
        4. Fully custom format string - Use this advanced option to format the field data using a fully custom string, which may include plain text, variables, function calls, templates, etc.
          1. Title - Specifies the title of the format expression. This title is only used for back end purposes.
          2. Format expression - Specifies expression that defines how data looks like. It may include plain text, variables, function calls, templates, etc. You can select preconfigured format expressions if necessary. For examples of configuration using this setting, see Data format string configuration examples. Use the  icon next to the setting to insert a predefined common expression.
        5. Tags - Use this option to provide the ability to add new or existing tags to a record as well as to manage tags that have already been added.
          1. Title - Specifies the title of the format expression. This title is only used for back end purposes.
          2. Action icon - Specifies the image that is used as the icon of the action that provides the ability to add new or existing tags to a record. To use the default icon, leave this empty.
          3. Entity - Specifies the entity where added tags are stored. By default, the PortalTags entity is used, which was designed for this purpose.
          4. Tag group name - Specifies the name of a tag group, to which tags that are added in this field are assigned. If you leave this empty, the tags added in this field won't have any tag group. The tag group defines which tags are suggested when selecting a tag to add (on any page): only tags from the same tag group and tags without a tag group are suggested.

              Tip

            You can use field variables in tag group names to create a complex group, the name of which would be generated using field value(s) from a record where tags are added. For example: [[fieldname1]]-[[fieldname2]] where "fieldname1" and "fieldname2" are the names of fields from the page source entity. This means that a tag is assigned to a tag group with the current values of these two fields and will be suggested only if the same fields in the given entity have the same value on a record where you are trying to add a tag.  

          5. Allow new tags - Specifies that members are allowed to create new tags in this field. If disabled, members can only add existing tags to a record.
          6. Dialog window settings - Specifies the settings that allow you to configure the dialog window that will be displayed when adding new tags or managing tags that have already been added. When the member uses the action that provides the ability to add new/existing tags or delete tags that have already been added, this dialog window is displayed.
            1. Title - Specifies the title that will be displayed at the top of the dialog window. Recommended value: Add Tags.
            2. Height - Specifies the height of the dialog window in pixels. Recommended value: 500.
            3. Width - Specifies the adaptive width of the dialog window, The width will be automatically adjusted depending on the device the portal is opened on.
        6. Formatting rules - Use this type to configure cosnditions that must be met so that specific formatting is applied to the field value.
          1. Title - Specifies the title of the formatting rule set. This title is only used for back end purposes.
          2. Format expression - Specifies expression that defines how data looks like. It may include plain text or variables. If you configure this setting, the field value will be replaced with the one that corresponds to this expression.
          3. Formatting rules - Specifies sets of conditions that must be met so that specific formatting is applied to the field value.
            1. Title - Specifies the title that is used to identify this setting set in CMS.
            2. Rules - Specifies conditions that must be met so that this page part is displayed or formatting is applied depending on where you are setting this up. These rules are set up in the same way as filters on the Data source tab in the grid or detail page settings.
            3. Style - Specifies formatting that is applied to the field value if the conditions are met.
            4. Font color - Specifies font color that is applied to the field value if the conditions are met.
            5. Background color - Specifies the background color that is applied to the field value if the conditions are met.
            6. Border color - Specifies the border color of a border that is applied to the field value if the conditions are met.
            7. Tooltip - Specifies the text of the tooltip that will be displayed when hovering over the tooltip icon in the field if the conditions for this rule set are met.
            8. Enabled - Specifies that this condition set is active.

                Note

              Conditional formatting in this case is applied to the field value. You can also set up conditional formatting for other places: detail layout block and grid record (see the settings for the grid page).

      11. Tooltip text - Specifies a help message which appears when a cursor is positioned over the field caption.
      12. Width settings - Specifies the adaptive width of the field. The longer the caption the longer the width is recommended. If you do not specify the width, the default width will be used.
      13. Lookup entity mask – Specifies the template (mask) that defines how field options will look like in the drop-down list with the member selects the AssistButton in the field. You can combine variables in double square brackets (fields from this entity) with text constants. E.g.: Country: [[countryname]] Code: [[code]]
  9. Select Save and publish to save the changes and publish them on the front end. Optionally, you can select Preview to preview how the page will look like in the front end.
  10. Repeat steps 3 through 9 to add more field sets if necessary.