Adding extended field sets
Extended field sets are fields sets with additional data types, which are not available in the standard field set. Extended field sets can be added to detail pages within detail page layout blocks.
To add an extended field set to a detail page layout block:
- In CMS, go to Contents.
- Select the content node, and then, under a detail page node, select a block for which you want to add a field set.
- Select the icon of the selected node (the icon appears when you point to the node title).
- Select Field set in the Create dialog window that appears.
- If you have at least one content template of the extended 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.
- 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.
- On the General tab, fill in general settings.
- Title - Specifies the title of the field set. For extended field sets, you can leave this empty.
- Subtitle - Specifies the subtitle of the extended field set. For field sets, you can leave this empty.
- Icon - Specifies the image that will be displayed in front of the layout block title.
- 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.
- Hide element - This setting hides the extended 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.
- Background color - Specifies the color that will be used as background of this field set.
- Background image- Specifies the image that will be displayed in the background of this extended field set.
- Description - Specifies a description of this extended field set.
- Navigate-to page - Specifies the portal page that will be displayed when the portal member edits a record on the layout block. For extended field set within detail pages, filling in this setting is usually not required.
- 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.
- 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.
- 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.
- Caption settings
- Hide caption - Use this switch to hide field caption from the data set.
- 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.
- Fields - Specifies the fields that will be available on the extended 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.- Caption - Specifies the field caption for this site localization.
- 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. Field data may not be retrieved from the data source depending on the data type that you select for this field.
- Data type – Specifies the type of data that this field can contain. Select the icon to specify the field data type. For fields in an external field set, the following data types are available:
- Boolean editor – Use this data type to make this field a check box that can be selected or cleared. Important: The field must be configured as editable for members to be able to select or clear the check box.
- Date – Use this data type to make this field a calendar control. This data type is useful for date fields so that a calendar is used to see or select a date instead of text box. Important: The field must be configured as editable for members to be able to use the Calendar control. Otherwise, the field value from the data source will be displayed. Select the icon and fill in settings for this data type as follows:
- Disable all before today – Specifies that dates earlier than today's date are not available for selection in the calendar.
- Disable today – Specifies that today's date is not available for selection in the calendar.
- Disable all after today – Specifies that the dates later than today's date are not available for selection in the calendar.
- Disable – Select the check box next to days of week that will not be available for selection in the calendar.
- Show week number – Specifies that the week number is displayed in the calendar.
- Template – Specifies the template that this field is based on.
Note
The Template functionality is under development and cannot be used yet.
- Entity filter builder – Use this data type to make this field a filter by entity. This data type is used to add filters by entity in pages configured for managing notification subscriptions.
Select the icon and fill in settings for this data type as follows:- AllowedEntities – Specifies the entities that will be used as filters. Specify the entity name, grid, portal notification template and email notification template for each entity.
- Template – Specifies the template that this field will be based on.
Note
The Template functionality is under development and cannot be used yet.
- File uploader – Use this data type to have this field display uploaded image(s). The field will contain a control to upload and download images. The field may contain multiple uploaded images, which can be viewed as a slide gallery. Uploaded images can be deleted and downloaded if necessary. Important: The field must be configured as editable for members to be able to upload files. Otherwise, the field value from the data source will be displayed.
Select the icon and fill in settings for this data type as follows:- Allowed file types – Specifies the list of image extensions that can be used to upload an image(s) in this field. Use a comma to separate extensions. You can leave this setting empty to allow uploading images with all supported extensions. The following extensions are supported: .jpg, .jpeg,.png,.gif.
- Image settings – Specifies settings for uploaded images:
- Enabled – Specifies whether uploaded files will be displayed as images.
- Image width – Specifies the width of the uploaded image per device type. Tip: It is recommended that you leave this setting with the default configuration, and instead change the width of the field.
- Enable slide view – Use this switch to allow uploading multiple images. Images will be displayed as slide gallery.
- Enable image caption – Specifies whether the image caption will be displayed. The image file name is used as image caption.
- Template – Specifies the template that this field will be based on.
Note
The Template functionality is under development and cannot be used yet.
- Multiple values picker – Use this data type to make this an option field, in which multiple options can be selected. Important: The field must be configured as editable for members to be able to select options. Otherwise, the field value from the data source will be displayed.
Select the icon next to Values to an option that will be available for selection in this field:- Title – Specifies the title of the value to identify it in these settings.
- Value – Specifies the value that will be displayed in the option box.
- Background image – Specifies the image that will be used as background. This setting is optional.
- Background image – Specifies the icon that will indicate the selected option. Select an icon or skip this setting to use the default one.
- Numeric editor – Use this data type to make this an option field where a numeric value can selected with the help of the navigational arrows. Important: The field must be configured as editable for members to be able to select values. Configure settings for this data type as follows:
- No. of characters after comma – Specify how many characters will be displayed after comma if the value is decimal.
- Minimum – Specifies the lowest allowed number to which the value can be changed by using the navigational arrows.
- Maximum – Specifies the highest allowed number to which the value can be changed by using the navigational arrows.
- Step – Specifies the step of each value change when you use the navigation arrows to change the value.
- Template – Specifies the template that this field will be based on.
Note
The Template functionality is under development and cannot be used yet.
- Single value picker – Use this data type to make this an option field, in which a single option can be selected. Important: The field must be configured as editable for members to be able to select options. Otherwise, the field value from the data source will be displayed.
Select the icon next to Values to an option that will be available for selection in this field:- Title – Specifies the title of the value to identify it in these settings.
- Value – Specifies the value that will be displayed in the option box.
- Background image – Specifies the image that will be used as background. This setting is optional.
- Background image – Specifies the icon that will indicate the selected option. Select an icon or skip this setting to use the default one.
- Text editor – Use this data type to make this field a text field where the member will be able to type a text value. Configure settings for this data type as follows:
- Enable multiline – Use this switch to allow multiple lines of text in the field value.
- Show HTML editor – Use this switch to enable the HTML editor that will be used to fill in or edit this field value.
- Read only – Use this switch to make this field non-editable.
- Edit mask – Specifies input mask that will be used for filling in this field value. See the setting tooltip for mask rules.
- Template – Specifies the template that this field will be based on.
Note
The Template functionality is under development and cannot be used yet.
- Custom validation script – Specifies a custom java script that will be used to check the field value to ensure it follows a specific validation rule.
- Validation message – Specifies the text of the message that will be displayed in case the field value does not follow the rule in the the custom validation script.
- Extended calendar editor – Use this data type embed a calendar page into a detail page. Configure settings for this data type as follows:
- Event starting date field - Specifies the field from the calendar source entity that stores the starting date-time of calendar events.
- Event ending date field - Specifies the field from the calendar source entity that stores the ending date-time of calendar events.
- Calendar page - Specifies the calendar page that will be embedded into the detail page. Select the Add button, and then navigate-to a stand-alone calendar page that will be embedded.
- Row height - Specifies the decimal value that defines the height of row in the embedded calendar. The bigger this number the more information calendar events will be displayed. However, with big row height, less rows will be visible at a time, and the member will have to scroll down the calendar. Recommended value: from 10 till 50.
- Custom validation script - Specifies script that will be executed to validate the field value. Using a custom validation script is optional.
- Validation message - Specifies the text of the error message that will be displayed in case the custom validation script fails.
- Notifications template editor - Specifies the data type that is used to provide the ability to select, preview, and edit notification templates on the subscription setup card.
- Enable preview - Use this switch to enable the button on the notifications template editor that will allow to look at the portal notification title and description, or email notification subject and body in a popup.
- Allow edit - Use this switch to enable possibility of editing title (subject) and description (body) of the selected notification template.
- Template type - Specifies the type of notification template.
- Preview title/subject field - Specifies the field that will be used to retrieve the title/subject of the notification on the notification preview.
- Password body field - Specifies the field that will be used to retrieve the body of the notification on the notification preview.
- Password editor - Specifies the data type that is used for a field where a password is entered.
- Description - Specifies a description of the password field (why the password is hidden).
- Hide password icon - Specifies an icon that is used for the button that hides the entered password.
- Show password icon - Specifies an icon that is used for the button that shows the entered password.
- Tags editor - Specifies the data type that is used for a field where tags are added/displayed. This data type is used for displaying tags on the page header (for displaying tags directly in the tags field, use the Tags data format string instead).
- Entity - Specifies the table the data from which will be retrieved on the page. For data type, use the Portal Tags entity,
- 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.
- Show tags in header - Specifies that added tags are displayed in the header of the detail page, next to the page title. If disabled, the added tags are shown directly in the field value.
- 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.
- 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.
- Boolean editor – Use this data type to make this field a check box that can be selected or cleared. Important: The field must be configured as editable for members to be able to select or clear the check box.
- Editable fields (existing record) - Specifies whether it will be allowed to edit the field value on an existing record and for which member groups.
- Editable fields (new record) - 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.
- Default value - Specifies the default value for this field that will be filled in automatically when a new record with this field is created. Select the icon and select the type of content:
- Constant value - Use this type to specify a constant value that will be filled in.
- Data query - Use this option to use a query that will retrieve data. You will need to specify a data source query.
- 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.
- Increment value - Use this option if you want on each new record the field value to be increased by a regular amount according to the configured pattern. This type may be useful, for example, when you create new documents on a page and you want the document number to be automatically filled in with increment value. Each value consists of a combination of a prefix (optional) and a value, increased by increment step on each new record. For example, ORD-100, ORD-101, ORD-102, and so on, where ORD- is a prefix, and the increment step is 1. With this option you will also need to specify the following:
- Prefix - This prefix will be attached to each new value in this field.
- Last value used - Specifies the value that was used last. This value will be a starting point and will increase by the amount specified in the Increment step field on each new record.
- Increment step - Specifies the amount by which the value will be increased on each new record.
- 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.
- 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.
- Required - Specifies whether it is mandatory for this field to contain data.
- 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:
- Required - Specifies a validation that verifies whether the field after having been edited contains value.
- Enabled - Specifies whether this validation is turned on. If the validation is disabled, it will not be run when entering a field value.
- Validation message - Specifies the text of an error message that will be displayed if the validation criteria are not fulfilled.
- Field length - Specifies validation that verifies whether the length of the field after having been edited is within the specified length range.
- Enabled - Specifies whether this validation is turned on. If the validation is disabled, it will not be run when entering a field value.
- Validation message - Specifies the text of an error message that will be displayed if the validation criteria are not fulfilled.
- Minimum length - Specifies a numeric value that will be used as the minimum field length value when validating the field.
- Maximum length - Specifies a numeric value that will be used as the maximum field length value when validating the field.
- Regular expression - Specifies a validation that verifies whether the field value after having been edited meets the format defined by a regular expression.
- Enabled - Specifies whether this validation is turned on. If the validation is disabled, it will not be run when entering a field value.
- Validation message - Specifies the text of an error message that will be displayed if the validation criteria are not fulfilled.
- 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: [^<>\/\$]+
- Email - Specifies validation that verifies whether the field value that is email after having been edited meets the predefined criteria of email.
- Enabled - Specifies whether this validation is turned on. If the validation is disabled, it will not be run when entering a field value.
- Validation message - Specifies the text of an error message that will be displayed if the validation criteria are not fulfilled.
- 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.
- Enabled - Specifies whether this validation is turned on. If the validation is disabled, it will not be run when entering a field value.
- Validation message - Specifies the text of an error message that will be displayed if the validation criteria are not fulfilled.
- 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.
- 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.
- 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.
- Enabled - Specifies whether this validation is turned on. If the validation is disabled, it will not be run when entering a field value.
- Validation message - Specifies the text of an error message that will be displayed if the validation criteria are not fulfilled.
- 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. - 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
- 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.
- Enabled - Specifies whether this validation is turned on. If the validation is disabled, it will not be run when entering a field value.
- Validation message - Specifies the text of an error message that will be displayed if the validation criteria are not fulfilled.
- Min. no. of selected options - Specifies the minimum number of options that can be selected in the field to fulfil the criteria.
- Max. no. of selected options - Specifies the maximum number of options that can be selected in the field to fulfil the criteria.
- Google reCAPTCHA - Specifies validation that verifies whether the Google reCAPTCHA test has been passed successfully.
- Enabled - Specifies whether this validation is turned on. If the validation is disabled, it will not be run when entering a field value.
- Validation message - Specifies the text of an error message that will be displayed if the validation criteria are not fulfilled.
- Validation message title - Specifies the title that will be displayed on the validation message.
- 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.
- Required - Specifies a validation that verifies whether the field after having been edited contains value.
- 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.
- Hide field caption – Specifies whether the field caption will be hidden for this field.
- Value alignment – Specifies how value in the field as well as field caption will be aligned. Select one of the following options:
- Center – Value will be centered. This type of alignment will be used by default if you leave the setting empty.
- Left – Value will be aligned left.
- Right – Value will be aligned right.
- Tooltip text - Specifies a help message which appears when a cursor is positioned over the field caption.
- Template - Specifies a predefined template that will be used to display this field.
- 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.
- Hyperlink - Use this option to turn the field value into a hyperlink that opens an internal or external page.
- Title - Specifies the title of the format expression. This title is only used for back end purposes.
- Internal page - Specifies an internal page that the hyperlink in the field value will lead to.
- External page - Specifies the URL of an external web page that the hyperlink in the field value will lead to.
- 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.
- 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.
- Percent of progress - Use this option when you need the value to display the progress in percentages.
- Show alert - Use this option when the field value is used to show an alert(s). Note: This functionality is under development.
- 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.
- Title - Specifies the title of the format expression. This title is only used for back end purposes.
- ormat 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.
- 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.
- Title - Specifies the title of the format expression. This title is only used for back end purposes.
- 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.
- Entity - Specifies the entity where added tags are stored. By default, the PortalTags entity is used, which was designed for this purpose.
- 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.
- 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.
- 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.
- Title - Specifies the title that will be displayed at the top of the dialog window. Recommended value: Add Tags.
- Height - Specifies the height of the dialog window in pixels. Recommended value: 500.
- Width - Specifies the adaptive width of the dialog window, The width will be automatically adjusted depending on the device the portal is opened on.
- Formatting rules - Use this type to configure cosnditions that must be met so that specific formatting is applied to the field value.
- Title - Specifies the title of the formatting rule set. This title is only used for back end purposes.
- 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.
- Formatting rules - Specifies sets of conditions that must be met so that specific formatting is applied to the field value.
- Title - Specifies the title that is used to identify this setting set in CMS.
- 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.
- Style - Specifies formatting that is applied to the field value if the conditions are met.
- Font color - Specifies font color that is applied to the field value if the conditions are met.
- Background color - Specifies the background color that is applied to the field value if the conditions are met.
- Border color - Specifies the border color of a border that is applied to the field value if the conditions are met.
- 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.
- 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).
- Hyperlink - Use this option to turn the field value into a hyperlink that opens an internal or external page.
- Caption settings
- Select Save and publish to save the changes and publish them on the front end. Optionally, if you were editing the page, you can select Save and preview to preview how the page will look like on the front end.
- Repeat steps 3 through 9 to add more field sets if necessary.