Configuration Guide
Configuration Guide
Breadcrumbs

Search List Widget

Definition

The Search Widget allows to create a result table on a feature.

đź“ś

Use case: display all identities for which a manager is responsible.

image-20220928-082918.png

It is also possible to add a search area by defining at least one “mode” of search (see configuration). The search will be constrained by the scope defined in the widget.

Configuration

Properties

The widget inherit all the configuration from the SearchWidget with the addition of the scope property.

Property name

Type

Mandatory

Description

Values (default value in bold)

scope

-

NO

Allows to limit the search results.
See the page Scope.

-

exportTaskId

String

NO

Allows to reference a SYNC export definition (by ID) to run exports asynchronously with progress and file download at completion; when unset, the widget falls back to the synchronous export. Only attributes permitted by the referenced definition are accepted; otherwise a 422 validation error is returned.


Example

Search List Widget Configuration Example
XML
<widget id="search-list-widget" xsi:type="ctdbum:SearchListWidgetType">
    <hidden>false</hidden>
    <config>
      <scope type="EXPRESSION" objectKind="IDENTITY">
        	<searchExpression>
            	<search:Prop op="EQUALS" name="Responsible_ID">
                	<value script="true">OBJECT.id</value>
                </search:Prop>
            </searchExpression>
            <objectTypes>
            	<objectType>Employee</objectType>
            </objectTypes>
      </scope>
      <modes>
          <mode>MULTICRITERIA</mode> <!-- If empty, there will be no search area displayed -->
          <mode>SIMPLE</mode>
          <mode>FORMULA</mode>
      </modes>
      <actions>
          <action id="user-card-update" xsi:type="ctdbum:ButtonWidgetType">
            <hidden>false</hidden>
            <config>
                <align>LEFT</align>
                <authenticationLevelSufficient>false</authenticationLevelSufficient>
                <borderless>false</borderless>
                <circle>true</circle>
                <color>blue-dark</color>
                <icon>fa fa-user-circle-o</icon>
                <label>true</label>
                 <target xsi:type="ctdbum:LinkTargetType">
                   <link>feature://user-card-update/{dataKey.id}</link>
                   <target>SELF</target>
                </target>
                <outline>false</outline>
                <size>XS</size>
            </config>
          </action>
      </actions>
      <allowExport>true</allowExport>
      <columns>
          <column>
            <attribute>true</attribute>
            <dataKey>photo</dataKey>
            <dataType>string</dataType>
            <dateFormat>DAY_MONTH_YEAR_LONG</dateFormat>
            <ellipsis>false</ellipsis>
            <hidden>true</hidden>
            <sortAs>ALPHA</sortAs>
            <sortDirection>DESC</sortDirection>
            <sortable>false</sortable>
            <sorted>false</sorted>
            <type>image</type>
          </column>
          <column>
            <attribute>true</attribute>
            <dataKey>id</dataKey>
            <dataType>string</dataType>
            <dateFormat>DAY_MONTH_YEAR_LONG</dateFormat>
            <ellipsis>true</ellipsis>
            <hidden>false</hidden>
            <sortAs>ALPHA</sortAs>
            <sortDirection>ASC</sortDirection>
            <sortable>true</sortable>
            <sorted>true</sorted>
            <type>general</type>
          </column>
          <column>
            <attribute>true</attribute>
            <dataKey>firstName</dataKey>
            <dataType>string</dataType>
            <dateFormat>DAY_MONTH_YEAR_LONG</dateFormat>
            <ellipsis>false</ellipsis>
            <hidden>false</hidden>
            <sortAs>ALPHA</sortAs>
            <sortDirection>ASC</sortDirection>
            <sortable>true</sortable>
            <sorted>false</sorted>
            <type>general</type>
          </column>
          <column>
            <attribute>true</attribute>
            <dataKey>lastName</dataKey>
            <dataType>string</dataType>
            <dateFormat>DAY_MONTH_YEAR_LONG</dateFormat>
            <ellipsis>false</ellipsis>
            <hidden>false</hidden>
            <sortAs>ALPHA</sortAs>
            <sortDirection>ASC</sortDirection>
            <sortable>true</sortable>
            <sorted>false</sorted>
            <type>general</type>
          </column>
      </columns>
      <rowClickActions/>
      <additionalSearchAttributes/>
      <displayFrozenOperators>true</displayFrozenOperators>
      <frozen>NO</frozen>
    </config>
</widget>