Adding actions to detail pages
Detail (card) page actions allow portal members to perform various operations with a record when they have opened its detail (card) page.
Note Availability of actions on a detail page depends on the member group permissions for that detail page. Thus, an action will be available for a portal member only if the portal member is assigned to a portal member group for which the action is allowed. |
To add an action to a detail (card) page
- In CMS, open the page settings for a detail page, for which you want to add or edit an action.
- On the Permissions tab, next to member group permissions, select the icon to create a new permission set or the icon to edit the existing one.
- Under Member group, select one or several member groups, for which the specified fields and added actions below will be available. Alternatively, you can select the ~All~ check box to make the toolbar commands below available for all member groups (without the necessity to select every member group's check box) or select the Member Group check box to have all member groups selected at once.
Note
Member groups that you select here are common for three types of member group permissions settings: field visibility, general page settings, and toolbar commands. Therefore, steps 2 and 3 are performed only once for these three types of permission settings.
- After you have specified the member group(s), under Toolbar commands, select the icon to add a new toolbar command that will be available on this detail page for portal members that belong to the specified member groups.
- Select one of the available predefined toolbar commands to add a grid action and configure its settings:
- Delete - Use this command to add an action to a detail page toolbar that will delete the record. Available toolbar command settings:
- Command title - Specifies the title of the action that will be displayed when the portal members points to the action icon. For example: Delete.
- Show command title - Use this switch to show or hide the action title. When the title is hidden, the portal members can still see the title in the tooltip when they hover over the action icon.
- Show command without icon - Use this switch to show or hide the action icon on the grid toolbar.
- Enabled in grid column - Use this switch to hide or make this action available directly on the record line within the grid.
- Enabled on commands toolbar - Use this switch to hide or make this action available on the commands toolbar.
- Command icon - Specifies the icon that will be used for the action. Select the square and browse to an icon in the portal media library. You can leave this setting empty to use the predefined default icon for this toolbar command. When choosing an icon, select any icon library set except umbraco-icon because icons from this icon library are not meant to be used with front end elements – this may cause bugs and visual glitches.
- Split command subgroup - Specifies whether the action created on the basis of this command will end the group of actions. An empty space will be displayed after the group of actions to separate it from the next group of actions.
- Allow removing all records - Specifies whether members who have access to this action are allowed to delete records regardless of the their ownership. When this switch is disabled, a member will be able to delete only records that were created by that member.
- Command style - Specifies the style that will be applied to the command on the command toolbar.
- Highlight filters action - If you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the promoted filters.
- Highlight grid action - if you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the grid command toolbar. We recommend applying this style either to all actions on a page or to none of them. If you leave this setting empty, the default style will be applied.
- Download files - Specifies whether the action that downloads all file attachments will be available on the detail page. Available action commands:
- Command title - Specifies the title of the action that will be displayed when the portal members points to the action icon. For example: Download attachments.
- Show command title - Use this switch to show or hide the action title. When the title is hidden, the portal members can still see the title in the tooltip when they hover over the action icon.
- Show command without icon - Use this switch to show or hide the action icon on the grid toolbar.
- Command icon - Specifies the icon that will be used for the action. Select the square and browse to an icon in the portal media library. You can leave this setting empty to use the predefined default icon for this toolbar command. When choosing an icon, select any icon library set except umbraco-icon because icons from this icon library are not meant to be used with front end elements – this may cause bugs and visual glitches.
- Split command subgroup - Specifies whether the action created on the basis of this command will end the group of actions. An empty space will be displayed after the group of actions to separate it from the next group of actions.
- Command style - Specifies the style that will be applied to the command on the command toolbar.
- Highlight filters action - If you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the promoted filters.
- Highlight grid action - if you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the grid command toolbar. We recommend applying this style either to all actions on a page or to none of them. If you leave this setting empty, the default style will be applied.
- Refresh - Use this command to add an action to a detail page toolbar that will refresh data on the detail page. This action may be useful when the data source for a detail page is an external system. Available toolbar command settings:
- Command title - Specifies the title of the action that will be displayed when the portal members points to the action icon. For example: Refresh.
- Show command title - Use this switch to show or hide the action title. When the title is hidden, the portal members can still see the title in the tooltip when they hover over the action icon.
- Show command without icon - Use this switch to show or hide the action icon on the grid toolbar.
- Command icon - Specifies the icon that will be used for the action. Select the square and browse to an icon in the portal media library. You can leave this setting empty to use the predefined default icon for this toolbar command. When choosing an icon, select any icon library set except umbraco-icon because icons from this icon library are not meant to be used with front end elements – this may cause bugs and visual glitches.
- Split command subgroup - Specifies whether the action created on the basis of this command will end the group of actions. An empty space will be displayed after the group of actions to separate it from the next group of actions.
- Command style - Specifies the style that will be applied to the command on the command toolbar.
- Highlight filters action - If you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the promoted filters.
- Highlight grid action - if you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the grid command toolbar. We recommend applying this style either to all actions on a page or to none of them. If you leave this setting empty, the default style will be applied.
- Export - Use this command to add an action to a detail page toolbar that will export the record to the specified format. You can use this toolbar command to add several actions. For example, one action that saves data as PDF and another action that exports data to Excel. Available toolbar command settings:
- Command title - Specifies the title of the action that will be displayed when the portal members points to the action icon. For example: Export.
- Show command title - Use this switch to show or hide the action title. When the title is hidden, the portal members can still see the title in the tooltip when they hover over the action icon.
- Show command without icon - Use this switch to show or hide the action icon on the grid toolbar.
- Export type - Specifies the format into which records will be exported. Select the field, and select one of the available formats. At present, the following formats are supported:
- CSV (Comma-separated values) - Records will be saved as a file in the CSV (comma-separated values)
- Excel - Records will be exported to Microsoft Office Excel.
- PDF - Records will be saved as a file in the PDF format.
- Command icon - Specifies the icon that will be used for the action. Select the square and browse to an icon in the portal media library. You can leave this setting empty to use the predefined default icon for this toolbar command. When choosing an icon, select any icon library set except umbraco-icon because icons from this icon library are not meant to be used with front end elements – this may cause bugs and visual glitches.
- Split command subgroup - Specifies whether the action created on the basis of this command will end the group of actions. An empty space will be displayed after the group of actions to separate it from the next group of actions.
- Command style - Specifies the style that will be applied to the command on the command toolbar.
- Highlight filters action - If you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the promoted filters.
- Highlight grid action - if you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the grid command toolbar. We recommend applying this style either to all actions on a page or to none of them. If you leave this setting empty, the default style will be applied.
- Print - Use this command to add an action to a detail page toolbar that will print out the record. Available toolbar command settings:
- Command title - Specifies the title of the action that will be displayed when the portal members points to the action icon. For example: Print.
- Show command title - Use this switch to show or hide the action title. When the title is hidden, the portal members can still see the title in the tooltip when they hover over the action icon.
- Show command without icon - Use this switch to show or hide the action icon on the grid toolbar.
- Command icon - Specifies the icon that will be used for the action. Select the square and browse to an icon in the portal media library. You can leave this setting empty to use the predefined default icon for this toolbar command. When choosing an icon, select any icon library set except umbraco-icon because icons from this icon library are not meant to be used with front end elements – this may cause bugs and visual glitches.
- Split command subgroup - Specifies whether the action created on the basis of this command will end the group of actions. An empty space will be displayed after the group of actions to separate it from the next group of actions.
- Command style - Specifies the style that will be applied to the command on the command toolbar.
- Highlight filters action - If you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the promoted filters.
- Highlight grid action - if you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the grid command toolbar. We recommend applying this style either to all actions on a page or to none of them. If you leave this setting empty, the default style will be applied.
- Send email - Use this command to add an action to a page that will allow the portal member to send an email. This email can contain data from a record or simple text as well as file attachments if necessary. An email is based on an email templates that can be set up in the site localization settings. The recipients can be either filled in automatically (for example, with values from fields, constant values, etc.) or filled in manually.
- Command title - Specifies the title of the action that will be displayed when the portal member points to the action icon. For example: Send Email.
- Show command title - Use this switch to show or hide the action title. When the title is hidden, the portal members can still see the title in the tooltip when they hover over the action icon.
- Show command without icon - Use this switch to show or hide the action icon on the grid toolbar.
- Enabled on commands toolbar - Use this switch to enable or disable the availability of this action on the detail header.
- Command icon - Specifies the icon that will be used for the action. Select the square and browse to an icon in the portal media library. You can leave this setting empty to use the predefined default icon for this toolbar command. When choosing an icon, select any icon library set except umbraco-icon because icons from this icon library are not meant to be used with front end elements – this may cause bugs and visual glitches.
- Email template - Specifies which email template will be used for email sent with this action. You will be able to select a template that was set up in the site localization settings on the Entities tab under Email Templates.
- File Uploader - Specifies whether it will be possible to upload an email attachment and which uploader will be used for this.
- Recipient settings - Specifies the settings that define how the Send to field in the email will be filled in. Select the icon to configure these settings. You can select a field, the value from which will be used, from any portal entity as well as set filters. if you configure these settings, a drop-down list with available recipients, filtered by these settings, will be available to the portal member to select an email recipient(s).
- Default recipient (xDefaultRecipient) - Specifies which email recipient will be used by default. Select the icon and configure the default recipient. You can specify a constant value, a field in a parent page, a field on the member page, or specify a data query.
- Autosave changes upon sending email - Use this switch to enable or disable automatic saving of changes in field values, if any, on the page before sending an email with this action. If this switch is disabled, the portal member will have to manually save the changes prior to trying to send an email with this action.
- Skip dialog - Specifies that a dialog where you can edit an email (the recipient, email body, subject) before sending will not be shown when you use the action. In this case, the email will be sent using the email template configured in the Email templates settings of the site localization settings.
- Send from member - Specifies whether an email will be sent from the portal member email address instead of the email address configured in the smtp setup.
- Keep detail page open on save - Specifies whether the detail page will remain open upon sending an email.
- Command style - Specifies the style that will be applied to the command on the command toolbar.
- Highlight filters action - If you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the promoted filters.
- Highlight grid action - if you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the grid command toolbar. We recommend applying this style either to all actions on a page or to none of them. If you leave this setting empty, the default style will be applied.
- Save - Use this command to add an action to a page that will allow you configure automatic saving of changes in field values and, optionally, allow you to add a button to manually save changes if necessary. When there's at least one editable field (on record editing or on record creation) for the member's role, and the Save action is not added to the page, the changes are saved automatically with default settings. When the Save action is added, its save settings will be used instead of the default save settings. Available toolbar command settings:
- Command title - Specifies the title of the action that will be displayed on the button. For example: Save or Save & Close or Save & Stay.
- Show command title - Use this switch to show or hide the action title. When the title is hidden, the portal members can still see the title in the tooltip when they hover over the action icon.
- Show command without icon - Use this switch to show or hide the action icon on the grid toolbar.
- Command icon - Specifies the icon that will be used for the action. Select the square and browse to an icon in the portal media library. You can leave this setting empty to use the predefined default icon for this toolbar command. When choosing an icon, select any icon library set except umbraco-icon because icons from this icon library are not meant to be used with front end elements – this may cause bugs and visual glitches.
- Keep detail page open - Specifies whether the detail page will be automatically close upon saving changes and the parent (grid) page opened. If you switch off this setting, the detail page remains open upon saving changes.
- Automatically save after (ms) - Specifies after how many milliseconds changes on the page will be saved automatically. If you leave this field empty or set it to 0, the changes will be saved automatically upon leaving the page unless manually saved by the member. Note that 1000 milliseconds equals 1 second.
- Hide Save button - Specifies whether the Save button, which allows the member to manually save the changes, will be hidden. When the button is hidden, automatic saving still works as configured, and the save status is displayed.
Note
As soon as the page has at least one editable field, the save status is always visible on the page regardless of whether the manual Save button is configured and regardless of whether the Save button is hidden or shown.
- Command style - Specifies the style that will be applied to the command on the command toolbar.
- Highlight filters action - If you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the promoted filters.
- Highlight grid action - if you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the grid command toolbar. We recommend applying this style either to all actions on a page or to none of them. If you leave this setting empty, the default style will be applied.
- Setup button position as right on a grid - Specifies whether the Save button will always be in the rightmost position on the action toolbar regardless of the button settings position in relation to other button settings. If this switch is disabled, the button position will be the same as the position of the button settings in relation to other button settings of the page.
- Message settings - Specifies the settings that allow you to configure messages that will be displayed when data is saved successfully or when data saving fails due to some reason.
- Information message - Specifies the message that will be displayed if data is saved successfully when the action is used.
- Error message - Specifies the message that will be displayed if data saving fails when the action is used.
- Height - Specifies the message that will be displayed if data saving fails when the action is used.
- Title - Specifies the title that will be displayed at the top of the dialog window.
- Width - Specifies the adaptive width of the dialog window, The width will be automatically adjusted depending on the device the portal is opened on.
- Redirect-to page - Specifies the page that will be opened after the operations performed with this action will be completed. This can be useful when the action is added to a detail page, and the member, after using the action, may want to see the changes in records on the affected grid page.
- Skip confirmation - Specifies that the confirmation message that asks the member whether they are sure that they want to make changes will not be shown when the action is used.
- Base dictionary key - Specifies the base dictionary key data from which, including its related dictionary keys, will be used to apply predefined command texts displayed on the front end when using this action. When you specify a key here, then edit this key in the dictionary (e.g. provide a description), and then use the action on the front end for the first time, the related dictionary keys with predefined texts are automatically created. You can adjust the text in those keys according to your needs. If you leave this setting empty, the default text entries will be used from the XFGrid.Command.ComplexDeleteRecord dictionary key group (for the Complex Delete action) or from the XFGrid.Command.ModifyRecord dictionary key group (for the Complex Modify action).
- Notifications - Use this command to add an action to a grid page toolbar and/or grid lines that will allow portal members of the members groups within this permissions set to subscribe to changes on a record or unsubscribed from changes. This action is part of the Notifications functionality. You can add a link to any existing page on the portal. Available command settings:
- Disabled state caption - Specifies the title of the action that will be displayed when the portal member points to the action icon while subscription to changes on a record(s) is not enabled to subscribe to changes. For example: Subscribe to changes or Notify about changes.
- Show command title - Use this switch to show or hide the action title. When the title is hidden, the portal members can still see the title in the tooltip when they hover over the action icon.
- Show command without icon - Use this switch to show or hide the action icon on the grid toolbar.
- Enabled state caption - Specifies the title of the action that will be displayed when the portal member points to the action icon while subscription to changes on a record(s) is enabled to unsubscribe to changes. For example: Unsubscribe from changes or Stop notifying about changes.
- Enabled in a commands toolbar - Use this switch to enable or disable the availability of this action on the detail header.
- Disabled state icon - Specifies the icon that will be used for the action while subscription to changes on a record(s) is not enabled. Select the square and browse to an icon in the portal media library. You can leave this setting empty to use the predefined default icon for this toolbar command.
- Enabled state icon - Specifies the icon that will be used for the action while subscription to changes on a record(s) is enabled. Select the square and browse to an icon in the portal media library. You can leave this setting empty to use the predefined default icon for this toolbar command.
- Split command subgroup - Specifies whether the action created on the basis of this command will end the group of actions. An empty space will be displayed after the group of actions to separate it from the next group of actions.
- Command style - Specifies the style that will be applied to the command on the command toolbar.
- Highlight filters action - If you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the promoted filters.
- Highlight grid action - if you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the grid command toolbar. We recommend applying this style either to all actions on a page or to none of them. If you leave this setting empty, the default style will be applied.
- Complex modify - Use this command to add an action that allows the member to edit a record as well as records in other related pages at the same time according to the configured rules. When using this action, the member won't need to manually edit the selected record(s) or related records(s): what changes the action makes, the conditions that must be met for the changes to be made, as well as which entities and records will be considered related are configured within the action settings.
- Command title - Specifies the caption of the action that will be displayed when the portal member points to the action icon. For example: Complex edit. Tip: We recommend giving a title that is based on the changes the action actually does. E.g.: Change ticket status and mark related entries as completed
- Show command title - Use this switch to show or hide the action title. When the title is hidden, the portal members can still see the title in the tooltip when they hover over the action icon.
- Show command without icon - Use this switch to show or hide the action icon on the grid toolbar.
- Command icon - Specifies the icon that will be used for the action. Select the square and browse to an icon in the portal media library. You can leave this setting empty to use the predefined default icon for this toolbar command. When choosing an icon, select any icon library set except umbraco-icon because icons from this icon library are not meant to be used with front end elements – this may cause bugs and visual glitches.
- Split command subgroup - Specifies whether the action created on the basis of this command will end the group of actions. An empty space will be displayed after the group of actions to separate it from the next group of actions.
- Command style - Specifies the style that will be applied to the command on the command toolbar.
- Highlight filters action - If you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the promoted filters.
- Highlight grid action - if you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the grid command toolbar. We recommend applying this style either to all actions on a page or to none of them. If you leave this setting empty, the default style will be applied.
- Base dictionary key - Specifies the base dictionary key data from which, including its related dictionary keys, will be used to apply predefined command texts displayed on the front end when using this action. When you specify a key here, then edit this key in the dictionary (e.g. provide a description), and then use the action on the front end for the first time, the related dictionary keys with predefined texts are automatically created. You can adjust the text in those keys according to your needs. If you leave this setting empty, the default text entries will be used from the XFGrid.Command.ModifyRecord dictionary key group.
- Dialog window settings - Specifies the settings for the dialog window that will be displayed on each step when the action is used.
- Title - Specifies the title that will be displayed at the top of the dialog window that will be shown when the action is used.
- Height - Specifies the height of the dialog window in pixels. Set the height in accordance with the amount of content that you set up for the dialog window. With the default content, the recommended height is within 400 - 500 range.
- Width - Specifies the adaptive width of the dialog window, The width will be automatically adjusted depending on the device the portal is opened on. Recommended width: 4 out 12.
- Description - Specifies a description that will be displayed in the dialog window what the action is in process. Note that this description will remain visible in the dialog window until it's closed.
- Processing message - Specifies the message that will be displayed in the dialog window when the action is in process. Note that this message will remain visible in the dialog window until it's closed.
- Final message - Specifies the message that will be displayed in the dialog window after the action processing has finished. This message will be displayed both when processing is successful and when it fails (in the latter case, additionally an error message will be displayed). Note that this description will remain visible in the dialog window until it's closed.
- Items - Specifies various items (for example variable fields in double square brackets to show which values were modified) that will be displayed in the dialog window after the action processing has finished. We recommend that you set up here the list of fields that the action modifies. Examples of field variables: [[No]], [[StartingDate]], etc.
- Validation filters - Specifies validation filters that define the conditions that must be met for the a record to be applicable for changes. These validation filters are optional. Use them to narrow down the records that will be applicable for changes.
- Filter set title - Specifies the title of the filter set. This title will be displayed in the dialog window during validation when the action is used.
- Filter set filters - Specifies the filters that define the criteria that must be met for a record to be applicable for changes. Set up filters like in any other area of Xpand Portal CMS.
- Skippable - Specifies that the member will be able to proceed with processing changes if the criteria in this filter set are not met. In this case, a confirmation message will be shown.
- Fields to update - Specifies the fields from the entity in the current page data source the values of which will be updated when the action is used. For each field, you need to set up how its value will be updated.
- Field - Specifies the field from the entity in the current page data source the value of which will be updated when the action is used.
- Value - Specifies the value with which the field will be updated. There are many different ways to fill in a field that you can choose from:
- Constant value - Use this type to specify a constant value that will be filled in.
- Value from parent - Use this type to use a value from a parent entity field. 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). You will need to specify a member field the value will be taken from.
- 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.
- No. series value - Specifies the number series value. With this 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.You will need to specify 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.
- Value from entity - Specifies the entity and the field from this entity, the value from which will be retrieved in this field.
- Relations - Specifies related entities the records in which will be updated at the same time with the current entity when the action is used. You will need to specify the fields that will need to be updated in these related entities and with what values. Additionally, you set filters to define criteria that must be met for a record in a related entity to be applicable for changes.
- Related entity - Specifies the related entity the records in which will be updated at the same time with the current entity when the action is used. Records in all pages where this entity is used as data source will be updated as soon as the records meet the validation filters.
- Required - Specifies that at least one related entity that matches the filtering criteria must be present for it to be applicable for modification.
- Related entity filters - Specifies set(s) of validation filters that define the conditions that must be met for a related entity to be applicable for changes.
- Validation Filters - Specifies validation filters that define the conditions that must be met for the a record in the related entity to be applicable for changes. These validation filters are optional. Use them to narrow down the records that will be applicable for changes.
- Filter set title - Specifies the title of the filter set. This title will be displayed in the dialog window during validation when the action is used.
- Filter set filters - Specifies the filters that define the criteria that must be met for a record to be applicable for changes. Set up filters like in any other area of Xpand Portal CMS.
- Skippable - Specifies that the member will be able to proceed with processing changes if the criteria in this filter set are not met. In this case, a confirmation message will be shown.
- Related Entity values - Specifies the fields from the related entity the values of which will be updated as well as with what values when this action is used.
- Field - Specifies the field from the related entity the value of which will be updated when the action is used.
- Value - Specifies the value with which the field will be updated. There are many different ways to fill in a field that you can choose from:
- Constant value - Use this type to specify a constant value that will be filled in.
- Value from parent - Use this type to use a value from a parent entity field. 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). You will need to specify a member field the value will be taken from.
- 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.
- No. series value - Specifies the number series value. With this 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.You will need to specify 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.
- Value from entity - Specifies the entity and the field from this entity, the value from which will be retrieved in this field.
- Deep validation - Specifies additional filters that define the criteria for the related entity's child entity(ies) that must be met for a related entity to be applicable for changes.
- Child entity - Specifies a related entity's child entity that must meet the criteria below for the related entity to be applicable for changes when the action is used.
- Records mandatory - Specifies that in this related entity's child entity at least one record must exist for the related entity to be applicable for changes when the action is used.
- Child entity filters - Specifies filters that define the criteria that this related entity's child entity must meet for the related entity to be applicable for changes when the action is used.
- Skip confirmation - Specifies that the confirmation message that asks the member whether they are sure that they want to make changes will not be shown when the action is used.
- Redirect-to page - Specifies the page that will be opened after the operations performed with this action will be completed. This can be useful when the action is added to a detail page, and the member, after using the action, may want to see the changes in records on the affected grid page.
- Complex delete - Use this command to add an action that allows the member to delete a record(s) on a page as well as records on other related pages at the same time according to the configured rules. Related pages are configured in the action settings.
- Command title - Specifies the caption of the action that will be displayed when the portal member points to the action icon. For example: Complex delete. Tip: The title can be based on the rules that define records to be deleted.
- Show command title - Use this switch to show or hide the action title. When the title is hidden, the portal members can still see the title in the tooltip when they hover over the action icon.
- Show command without icon - Use this switch to show or hide the action icon on the grid toolbar.
- Command icon - Specifies the icon that will be used for the action. Select the square and browse to an icon in the portal media library. You can leave this setting empty to use the predefined default icon for this toolbar command. When choosing an icon, select any icon library set except umbraco-icon because icons from this icon library are not meant to be used with front end elements – this may cause bugs and visual glitches.
- Editable in grid column - Specifies whether the action will be available in the grid column and the record context menu where it will be used to perform an action with an individual record.
- Enabled on commands toolbar - Specifies whether the action will be available on the grid commands toolbar where it will be used to perform an action with multiple selected records.
- Split command subgroup - Specifies whether the action created on the basis of this command will end the group of actions. An empty space will be displayed after the group of actions to separate it from the next group of actions.
- Allow removing all records - Specifies that the member can delete any record on this page even if they are not the owner of it.
- Command style - Specifies the style that will be applied to the command on the command toolbar.
- Highlight filters action - If you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the promoted filters.
- Highlight grid action - if you apply this style, the command will be highlighted, which makes it accentuated. This style is specifically designed to be used with buttons on the grid command toolbar. We recommend applying this style either to all actions on a page or to none of them. If you leave this setting empty, the default style will be applied.
- Base dictionary key - Specifies the base dictionary key data from which, including its related dictionary keys, will be used to apply predefined command texts displayed on the front end when using this action. When you specify a key here, then edit this key in the dictionary (e.g. provide a description), and then use the action on the front end for the first time, the related dictionary keys with predefined texts are automatically created. You can adjust the text in those keys according to your needs. If you leave this setting empty, the default text entries will be used from the XFGrid.Command.ComplexDeleteRecord dictionary key group.
- Dialog window settings - Specifies the settings for the dialog window that will be displayed on each step when the action is used.
- Title - Specifies the title that will be displayed at the top of the dialog window that will be shown when the action is used.
- Height - Specifies the height of the dialog window in pixels. Set the height in accordance with the amount of content that you set up for the dialog window. With the default content, the recommended height is within 400 - 500 range.
- Width - Specifies the adaptive width of the dialog window, The width will be automatically adjusted depending on the device the portal is opened on. Recommended width: 4 out 12.
- Description - Specifies a description that will be displayed in the dialog window what the action is in process. Note that this description will remain visible in the dialog window until it's closed.
- Processing message - Specifies the message that will be displayed in the dialog window when the action is in process. Note that this description will remain visible in the dialog window until it's closed.
- Final message - Specifies the message that will be displayed in the dialog window after the action processing has finished. This message will be displayed both when processing is successful and when it fails (in the latter case, additionally an error message will be displayed). Note that this description will remain visible in the dialog window until it's closed.
- Items - Specifies various items (for example variable fields in double square brackets to show which values were modified) that will be displayed in the dialog window after the action processing has finished. We recommend that you set up here the list of fields that the action modifies. Examples of field variables: [[No]], [[StartingDate]], etc.
- Validation filters - Specifies validation filters that define the conditions that must be met for a record to be applicable for deletion.
- Relations - Specifies related entities the records in which will be deleted at the same time with the current entity when the action is used. Additionally, you set filters to define criteria that must be met for a record in a related entity to be applicable for changes.
- Related entity - Specifies the related entity the records in which will be deleted at the same time with the current entity when the action is used. Records in all pages where this entity is used as data source will be updated as soon as the records meet the validation filters.
- Related entity filters - Specifies set(s) of validation filters that define the conditions that must be met for records in a related entity to be applicable for changes.
- Related Entity values - Specifies the fields from the related entity the values of which will be updated as well as with what values when this action is used. Modifying field values with the Complex delete action can be useful in integration of Xpand Portal with another system: sometimes a record must contain a specific value, and only then it can be deleted or marked for deletion during data synchronization.
- Field - Specifies the field from the related entity the value of which will be updated when the action is used.
- Value - Specifies the value with which the field will be updated. There are many different ways to fill in a field that you can choose from:
- Constant value - Use this type to specify a constant value that will be filled in.
- Value from parent - Use this type to use a value from a parent entity field. 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). You will need to specify a member field the value will be taken from.
- 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.
- No. series value - Specifies the number series value. With this 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.You will need to specify 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.
- Value from entity - Specifies the entity and the field from this entity, the value from which will be retrieved in this field.
- Fields to update - Specifies the fields from the current data source the values of which will be updated as well as with what values when this action is used. Modifying field values with the Complex delete action can be useful in integration of Xpand Portal with another system: sometimes a record must contain a specific value, and only then it can be deleted or marked for deletion during data synchronization.
- Skip confirmation - Specifies that the confirmation message that asks the member whether they are sure that they want to make changes will not be shown when the action is used.
- Redirect-to page - Specifies the page that will be opened after the operations performed with this action will be completed. This can be useful when the action is added to a detail page, and the member, after using the action, may want to see the changes in records on the affected grid page.
- Mark as deleted for synchronization - Specifies that deleted records will be marked as deleted for synchronization with an ERP system. Selecting this may be useful if you use synchronization of Xpand Portal with another system, and you want deleted records to be also deleted in the other system after synchronization.
- Delete - Use this command to add an action to a detail page toolbar that will delete the record. Available toolbar command settings:
- Repeat step 5 to add more actions to this permission set.
- Optionally, you can create another permission set for toolbar commands (which also includes field visibility and general page settings permissions), by selecting the icon under Member groups permissions and repeating steps 2 through 6 for a different combination of member groups.
- 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.