Configuration Guide
Configuration Guide
Breadcrumbs

Button Group Widget

Definition

The Button Group Widget allows to display a group of buttons (next to each other) on a feature, allowing to redirect the user to other features.

This Widget has the same properties as the Button Widget in the <entry> property.

image-20220928-090046.png


Configuration

Properties

Property name

Type

Mandatory

Description

Values (default value in bold)

alignment

String

NO

Used to define the display area of the Widget.

LEFT, RIGHT

entries

-

NO

Allows to define the list of redirection to features.

-

entries properties

Property name

Type

Mandatory

Description

Values (default value in bold)

entry

-

NO

Allows to define properties of each redirection.

This tag is configured as many times as we want to add links.

-
entry properties

Each entry will have the following configuration:

Property name

Type

Mandatory

Description

Values (default value in bold)

authenticationLevelSufficient

Boolean

NO

Used to define if the feature is "sensitive" or not.

If true, to access the Feature, the user will have to upgrade his/her authentication level (see settings BUM).

true, false

borderless

Boolean

NO

Used to define if the label of the Widget is underlined or not (when the cursor goes over the text).

true, false

circle

Boolean

NO

Used to define if the border of the Widget is circled or not. If false, the border of the Widget is square-shaped.

true, false

label

Boolean

NO

Used to define if the label of the Widget is displayed inside the button or not.

The label will have to be translated by a I18N key: "ui.features."id of the feature".views."id of the view".sections."id of the section".widgets."id of the action".label

true, false

target

ButtonTargetSupport

NO

If no target is defined, the button will have no action.

Used to define the redirection of the user to another feature.

This is a polymorphic property that can be of three different types:

ButtonLinkTarget

Allows to configure a link that will open in the current tab or a new tab.

The “target” property can take two values:

SELF = open link in same tab

NEW_TAB = open link in a new tab

XML
<target xsi:type="ctdbum:LinkTargetType">
   <link>feature://test_user-card-update/{dataKey.id}</link>
   <target>SELF | NEW_TAB</target>
</target>
ModalWidgetTarget

Open a Widget in a modal dialog (for such an action as: reset a password, role dashboard, ...).

The size of the dialog can be controlled by defining a display option on the widget (modalSize : XS ,SM,LG)

XML
<target xsi:type="ctdbum:ModalWidgetTargetType">
   <widgetToOpen id="role-dashboard" xsi:type="ctdbum:RoleDashboardWidgetType">
      ...
   </widgetToOpen>
</target>
ModalTarget

Allows to configure a link that will open in a modal dialog. It is similar to the widgetToOpen case but the modal is fully routable using the (secondary:…) url pattern.

The “onDismiss” property control the behaviour of the primary route (the one behind the modal) after the modal is dismissed.

NONE = Do nothing

REFRESH = Refresh the primary route

XML
<target xsi:type="ctdbum:ModalTargetType">
  <link>feature://test_user-card-read/{dataKey.id}</link>
  <modalSize>LG</modalSize>
  <onDismiss>NONE</onDismiss>
</target>


For a link to a feature:

feature://<featureId>/{dataKey.id}

For a hub Feature: feature://user-hub.user-card-read/{dataKey.id}

For a link to a user task:

task://<action>/<id>

  • task://to-approve/<taskInstanceId>

  • task://about-me/<operationId>

  • task://submitted-by-me/<operationId>

  • task://admin/<operationId>

outline

Boolean

NO

Used to define how to display the configured color.

true (background is white and text is the configured color), false (background is the configured color and text is white)

Example

Code

Link configuration

<widget id="btn-group" xsi:type="ctdbum:ButtonGroupWidgetType">
	<hidden>false</hidden>
    <config>
    	<alignment>LEFT</alignment>
        <entries>
        	<entry id="user-card-read" xsi:type="ctdbum:ButtonWidgetType">
            	<hidden>false</hidden>
                <config>
					<authenticationLevelSufficient>false</authenticationLevelSufficient>
                	<borderless>false</borderless>
                	<circle>false</circle>
                	<label>true</label>
					<target xsi:type="ctdbum:LinkTargetType">
                      <link>feature://user-card-read/{dataKey.id}</link>
                      <target>SELF</target>
                    </target>
                	<outline>false</outline>
				</config>
			</entry>
            <entry id="user-card-create" xsi:type="ctdbum:ButtonWidgetType">
            	<hidden>false</hidden>
                <config>
					<authenticationLevelSufficient>false</authenticationLevelSufficient>
                    <borderless>false</borderless>
                    <circle>false</circle>
                    <label>true</label>
                    <target xsi:type="ctdbum:LinkTargetType">
                      <link>feature://user-card-create/{dataKey.id}</link>
                      <target>SELF</target>
                    </target>
                    <outline>false</outline>
                </config>
            </entry>
		</entries>
	</config>
 </widget>


Widget to open configuration

<widget id="btn-group" xsi:type="ctdbum:ButtonGroupWidgetType">
	<hidden>false</hidden>
    <config>
    	<alignment>LEFT</alignment>
        <entries>
            <entry id="reset-password" xsi:type="ctdbum:ButtonWidgetType">
            	<hidden>false</hidden>
                <config>
		   			<authenticationLevelSufficient>false</authenticationLevelSufficient>
                    <borderless>true</borderless>
                    <circle>true</circle>
                    <label>true</label>
                    <outline>true</outline>
                    <target xsi:type="ctdbum:ModalWidgetTargetType">
                      <widgetToOpen id="reset-password" xsi:type="ctdbum:ResetPasswordWidgetType">
                      	<hidden>false</hidden>
                          <config>
                          	<bordered>false</bordered>
                              <title>true</title>
                              <securityQuestions>true</securityQuestions>
  							  <securityQuestionsCount>2</securityQuestionsCount>
                              <manualPasswordEntry>true</manualPasswordEntry>
  		             		  <autogeneratedPasswordEntry>false</autogeneratedPasswordEntry>
                              <sendPasswordEmail>true</sendPasswordEmail>
							  <sendPasswordEmailNotificationId>password_generated_email</sendPasswordEmailNotificationId>
                              <sendPasswordEmailOverride>true</sendPasswordEmailOverride>
                              <sendPasswordSms>true</sendPasswordSms>
                              <sendPasswordSmsNotificationId>password_generated_sms</sendPasswordSmsNotificationId>
                              <sendPasswordSmsOverride>false</sendPasswordSmsOverride>
                              <sendResetLinkEmail>true</sendResetLinkEmail>
                              <sendResetLinkEmailIntent>password_reset</sendResetLinkEmailIntent>
                              <sendResetLinkEmailNotificationId>password_reset_link</sendResetLinkEmailNotificationId>
                              <sendResetLinkEmailOverride>true</sendResetLinkEmailOverride>
                              <sendResetLinkLifetime>PT30M</sendResetLinkLifetime>
                              <requirePasswordChange>true</requirePasswordChange>
                              <style>INLINE</style>
							</config>
						</widgetToOpen>
                    </target>
				</config>
			</entry>
   		</entries>
 	</config>
 </widget>

Modal target configuration

<widget id="btn-group" xsi:type="ctdbum:ButtonGroupWidgetType">
	<hidden>false</hidden>
    <config>
    	<alignment>LEFT</alignment>
        <entries>
        	<entry id="user-card-read" xsi:type="ctdbum:ButtonWidgetType">
            	<hidden>false</hidden>
                <config>
					<authenticationLevelSufficient>false</authenticationLevelSufficient>
                	<borderless>false</borderless>
                	<circle>false</circle>
                	<label>true</label>
					<target xsi:type="ctdbum:ModalTargetType">
                      <link>feature://user-card-read/{dataKey.id}</link>
                      <modalSize>LG</target>
                      <onDismiss>NONE</onDismiss>
                    </target>
                	<outline>false</outline>
				</config>
			</entry>
            <entry id="user-card-create" xsi:type="ctdbum:ButtonWidgetType">
            	<hidden>false</hidden>
                <config>
					<authenticationLevelSufficient>false</authenticationLevelSufficient>
                    <borderless>false</borderless>
                    <circle>false</circle>
                    <label>true</label>
                    <target xsi:type="ctdbum:ModalTargetType">
                      <link>feature://user-card-create/{dataKey.id}</link>
                      <modalSize>LG</target>
                      <onDismiss>NONE</onDismiss>
                    </target>
                    <outline>false</outline>
                </config>
            </entry>
		</entries>
	</config>
 </widget>
  • Button Widget

    Allows to display a button on a feature, in order to redirect the user to another feature.

  • Button Dropdown Widget

    Allows to display a button on a feature with a dropdown list which contains several buttons, in order to redirect the user to other features.