You can specify custom data for the personalization of the columns in your table as shown in the examples.

Example 1 for a normal aggregation:

<table:Column id="Ledger" minScreenWidth="Tablet" demandPopin="true">
	<table:customData>
		<core:CustomData key="p13nData"
		   value='\{"columnKey": "Ledger", "leadingProperty":"Ledger",
		    "additionalProperty":"LedgerName", "sortProperty": "Ledger",
		    "filterProperty": "Ledger", "type":"numeric"}' />
	</table:customData>
	<Label text="Ledger" />
	<table:template>
		<Text text="{Ledger}" />
	</table:template>
</table:Column> 

To use the SAPUI5 shortcut notation, add the following namespace part in the XML view:

xmlns:customData="http://schemas.sap.com/sapui5/extension/sap.ui.core.CustomData/1"

Example 2 for use of the shortcut notation:

<table:Column id="CompanyCode" minScreenWidth="Tablet" demandPopin="true"
	 customData:p13nData='\{"columnKey": "CompanyCode", "leadingProperty":"CompanyCode", "additionalProperty":"CompanyName","sortProperty": "CompanyCode", "filterProperty": "CompanyCode", "type":"numeric", "maxLength":"4"}'>
	<Label text="Company Code" />
	<table:template>
		<Text text="{CompanyCode}" />
	</table:template>
</table:Column>

In the p13nData object you can specify the following properties:

• columnKey

  A unique key used to save, retrieve, or apply personalization for a column.

• leadingProperty

  Retrieves data for the OData property specified here from the backend system when the column is made visible.

  OData model property name must be used.

• additionalProperty

  Property has to be requested if a column is visible.

  OData model property name must be used.

  Multiple property names can be specified here as comma-separated values (CSV).

• sortProperty

  Sorts the table based on the column specified.

  OData model property name must be used.

  This property is similar to sortProperty of sap.ui.table.Column of the grid table and should only be used if the latter does not support this feature.

• filterProperty

  Filters the table with the condition that has been defined.

  OData model property name must be used.

  This property is similar to filterProperty of sap.ui.table.Column of the grid table and should only be used if the latter does not support this feature.

• isGroupable

  Shows a field in the Group panel of the View Settings automatically; otherwise, a field might become visible only once the table (rows) are bound.

  This property is only required for the type AnalyticalTable. SmartTable automatically sets this property to true if a field is sortable, filterable, and a dimension.

• type

  Determines the type of a control; its value can be date, time, boolean, numeric, stringdate, string, or undefined. The control will be adapted according to the type.

  stringdate is used to export fields with the IsCalendarDate annotation.

• maxLength

  Numeric value to restrict number of entries in input fields

• precision

  Numeric value for precision

• scale

  Numeric value for scale

• nullable

  Defines whether a field can have no value (and is then relevant for filtering with the Empty value). Consumers of the control can use the string value false to indicate that the field is not nullable. The default is nullable.

The following additional properties are required in P13ndata for proper formatting of custom columns for an SAPUI5-client-side export to the spreadsheet:

You need to specify custom data with at least one leadingProperty for the table columns without a leadingProperty available in the control itself so the SmartTable control can fetch the data correctly.

<Column> 
    <customData> 
          <core:CustomData key="p13nData" value='\{"columnKey":"Id","leadingProperty": "Id","sortProperty": "Id","filterProperty": "Id"}'/>
     </customData>
    <Text text="Sales Order" /> 
</Column>

Without this, the SmartTable control cannot recognize the column.

For the sap.m.Table/ResponsiveTable, you need to provide a corresponding ColumnListItem in the items aggregation in addition to the columns, as you would when using this SAPUI5 table on its own.

<smartTable:SmartTable entitySet="Items"..>
	<Table>
	      <!-- Columns must have unique IDs if table personalization service is used -->
	      <columns>
		 <Column id="Name" width="auto" minScreenWidth="Tablet" visible="false"
		     customData:p13nData='\{"leadingProperty":"Name", "columnKey":"Name", "sortProperty":"Name", "type":"numeric"\}'>
		     <header>
			<Label text="{/#Item/Name/@sap:label}"/> 
		     </header>
		 </Column>    
	     </columns> 
	     <ColumnListItem id="columnListItem" vAlign="Middle" type="Navigation" press="onItemPressed">
		<cells>
	             <Text text="{path:'Name', formatter:'my.own.formatter.functionName'}" maxLines="2"... />
	        </cells>
	     </ColumnListItem>
      </Table>
 </smartTable:SmartTable>  

The sap.m.Table uses the columns aggregation for the header and the items aggregation containing ColumnListItem with cells for the template control that is cloned for each row in the table.

For editing scenarios with backend metadata and field controls, it is recommended to use the SmartField control along with the SmartTable control. You can have the SmartTable automatically create SmartField controls using the following code:

<smartTable:SmartTable id="ItemsST" entitySet="Items" customData:useSmartField="true"...>

To make this work, the customData namespace has to be defined correctly in the XML view to enable SAPUI5 shortcut notation for custom data aggregations: xmlns:customData="http://schemas.sap.com/sapui5/extension/sap.ui.core.CustomData/1".

Grouping in ResponsiveTable is done by sorting table entries. You can define your own formatting for the group title in ResponsiveTable by specifying a group function for the first sorter.

For more information on how this can be done, see the code sample.

When using the SmartTable control, you can use the beforeRebindTable event and get available sorters using the bindingParams (event parameter). Check if the first sorter there has a group.

onBeforeRebindTable: function(oEvent) {
	var mBindingParams = oEvent.getParameter("bindingParams");
	var oSorter = mBindingParams.sorter[0];
 //Check if sorter is for Grouping
	if(oSorter.vGroup){

There are two options. The first option looks like this:

//Replace the Group function
		oSorter.fnGroup = this.mGroupFunctions[oSorter.sPath];

You can also do the following:

//Replace the Grouping sorter itself		
		mBindingParams.sorter[0] = new Sorter(oSorter.sPath, bDescending, this.mGroupFunctions[oSorter.sPath]);
 }
 

For more information on how this.mGroupFunction has to be implemented, see the code sample in the Demo Kit.

You can replace group functions for the sorter or the sorter itself with the ones you have defined (with own formatter for grouping based on the property) if the sorter is used for grouping.

Use the beforeRebindTable event and implement this manually.

onBeforeRebindTable: function(oEvent) {         var
        mBindingParams = oEvent.getParameter( "bindingParams" );       
		mBindingParams.parameters[ "custom" ] =
        {                        "search-focus" :
        sBasicSearchFieldName, //  the name of the search
        field                        "search" :
        sBasicSearchText //  the search text
        itself!                };  }

This will then be used internally when creating the table binding.

Use the beforeRebindTable event and implement this manually.

onBeforeRebindTable:  function  (oEvent) {  
        var   oBindingParams = oEvent.getParameter( "bindingParams" );
         if  (oBindingParams.parameters.select.search( "SomeIconCode1" ) < 0) {
                             oBindingParams.parameters.select +=  ",SomeIconCode1" ;
         }
      if (oBindingParams.parameters.select.search( "SomeIconCode2" ) < 0) { 
                             oBindingParams.parameters.select +=  ",SomeIconCode2" ;
         } . . . 

This will then be used internally when creating the table binding.

You can modify the array of filters before binding is triggered in the SmartTable control by listening to the beforeRebindTable event.

To enable this, your code in the XML view should look like this:

<smartTable:SmartTable entitySet="LineItemsSet" beforeRebindTable="onBeforeRebindTable"…

You can now get the list of filters and sorters to be used in table binding using the following:

...
onBeforeRebindTable: function(oEvent) {
              var mBindingParams = oEvent.getParameter("bindingParams");
              var aFilters = mBindingParams.filters

With this, you need to set back the value to mBindingParams.filters, and you can pass a new filter array as well.

someMethod: function() {
           //get the smartTable and call the method rebindTable()
           oSmartTable.rebindTable();
       }
...

onBeforeRebindTable: function(e) {  
                   var b = e.getParameter("bindingParams"); 
                    var aDateFilters = [new sap.ui.model.Filter("BindingPeriodValidityEndDate",sap.ui.model.FilterOperator.LE,d), new sap.ui.model.Filter("BindingPeriodValidityEndDate",sap.ui.model.FilterOperator.GT, null).....];
                    var oOwnMultiFilter = new sap.ui.model.Filter(aDateFilters, true);

                    //Special handling for multiple multi-filters
                    if (b.filters[0] && b.filters[0].aFilters) {
                            var oSmartTableMultiFilter = b.filters[0];
                            // if an internal multi-filter exists then combine custom multi-filters and internal multi-filters with an AND
                            b.filters[0] = new sap.ui.model.Filter([oSmartTableMultiFilter, oOwnMultiFilter], true);
                     } else {
                          b.filters.push(oOwnMultiFilter);
                    }
}

You can do this using the customToolbar aggregation, as shown below:

<smartTable:SmartTable id="ItemsST" entitySet="Items" ...  
        <smartTable:customToolbar> 
                <OverflowToolbar design="Transparent"> 
                        <ToolbarSpacer/> 
                        <Button text="Test"/> 
                        <Button text="Click me!"/> 
               </OverflowToolbar> 
       </smartTable:customToolbar>

SmartTable provides a tableBindingPath property in addition to entitySet, which can be used to specify a navigation property path, for example, SalesOrder(123)/toItems.

var mBindingParams = oEvent.getParameter("bindingParams");

mBindingParams.parameters.entitySet = "NameOfEntitySet";

SmartTable creates the initially visible column based on the LineItem or the PresentationVariant annotations. You can either specify the initial fields there or create it manually in the XML view by adding columns to the underlying table.

For more information, see the sample.

The applyVariant() is an interface function for the SmartVariantManagement control that sets the current view for the SmartTable control.

Applications can also create their own application-specific views as the default, which are not standard views defined by the SmartTable control. These application views are only called once during the initialization of the SmartTable control.

If an application default view has been defined, then all other views are based on this application default view. Any change made to the SmartTable control and saved as a view is merged with the application default view by the SmartTable control. This data is then stored as a new view, a combination of the change made and the application default view.

For example, an application default view contains two groups that have been defined for the SmartTable control. When a new group is added and saved as a view, the new view will comprise the newly added group and the application default view. Thus, the end result are three groups for the SmartTable control.

If the backend does not support count, if the count support has been disabled in the model, or in case of a tree scenario, you have to set showRowCount="false" in the SmartTable control.

As a general rule, the SmartTable control looks for annotations without a qualifier, the primary annotations. However, you can also use the PresentationVariant and LineItem annotations with qualifiers as mentioned below.

We first look for PresentationVariant and try to get the LineItem annotation from there. If no such annotation exists, we look for the LineItem annotation directly on the entity.

You can set the qualifier that you want to use for the LineItem annotation in the SmartTable control using lineItemQualifier customData:

<SmartTable customData:lineItemQualifier=”Customer360” …>

Or, if you want us to use a specific PresentationVariant, presentationVariantQualifier is also supported, which can be used as shown below:

<SmartTable customData:presentationVariantQualifier =”Customer360” …>

If no qualifier has been defined for the presentation variant, you can use the fallback option and check if there is a LineItem annotation with or without a qualifier, as specified by the application developer.

For the switch you have to enable the SmartToggle feature in the SmartTable controls as follows:

<smartTable:SmartTable id="ItemsST" entitySet="Items" customData:useSmartToggle="true"...>

In order for this to work, the customData namespace in the XML view must be declared correctly to enable shortcut notation for custom data aggregations:customData="http://schemas.sap.com/sapui5/extension/sap.ui.core.CustomData/1".

The formatting in an SAPUI5 client-side generated spreadsheet can differ slightly from the UI. However, if you notice large differences, the issue might be due to custom columns that do not have sufficient P13ndata, as required for a client-side export.

The following additional properties are required in P13ndata for proper formatting of custom columns for an SAPUI5-client-side export to the spreadsheet:

Apart from the configuration, you can use the beforeExport event to change the formatting and configuration of an SAPUI5 client-side export to a spreadsheet as shown in the samples.

For more information, see the sample for SmartTable and the samples for sap.ui.export.Spreadsheet .

The SmartTable control supports the Text and TextArrangement annotations which allow you to show descriptions and ID fields together as annotated by the TextArrangement annotation (or configured using displayBehaviour custom data). The use of this annotation has some limitations. For more information, see the API Reference: Text annotation.

In addition, AnalyticalBinding ignores the entire $select if the dimensions and measures do not match what has been calculated internally. Using Text or TextArrangement automatically only works if $select contains the correct fields. If you add some dimensions to requestAtLeast, Criticality, or other fields, $select is ignored, and fetching the descriptions and the criticality, for example, does not work.

During automatic dimension selection AnalyticalBinding ignores the specified $select if a text or description column is added to the table content without the corresponding dimension. To work around this binding limitation, the SmartTable control calculates and adds the dimension of the property of the Text annotation to the additionalProperty custom data (used to calculate $select) in the SmartTable control wherever possible.

There are a few other things to keep in mind when using this feature:

• Multiple dimensions must not point to the same property of the Text annotation (only one will be used).

• Text annotation itself is marked as a dimension, the actual dimension field is not automatically selected.

• The Text annotation for ignored or hidden dimension fields does not automatically contain the dimension name in additionalProperty, as metadata analysis for such fields is ignored.

SmartTable internally activates actions for the column headers of a responsive table. Users can select a column and sort and filter it using the buttons that are displayed.

Keep in mind that the following applies:

• The active column headers are only available if useTablePersonalisation="true".

• If a column has already been filtered, clicking the filter button will not show the selected column directly (this is the same as in a grid table, since there is a restriction for p13nFilterPanel).

• Pressing the Ctrl key and clicking on a column to add multiple sorters is currently not supported.

For more information, see the sample.

If exportType="UI5Client" for SmartTable, the Export to Spreadsheet button will be rendered as sap.m.MenuButton with the menu options Export and Export As. Export As provides a number of export settings that can be configured by the user.

For more information about the spreadsheet export and the options on the export UI, see Spreadsheet Export.

The SmartTable control fires the initialise event just once after it has completed analyzing the metadata and has initialised its inner state for the first time. Therefore, using attachInitialise does not help. However, the isInitialised method can be used in such scenarios.

You can also use the following code sample to handle scenarios where you need to trigger some function after this control has been initialized. It should work in scenarios where the event has already been fired:

if (oSmartControl.isInitialised()){
  runSomeCodeAfterInit();
} else {
  oSmartControl.attachInitialise(runSomeCodeAfterInit);
}

The SmartTable control automatically adds the unit, in this case the currency code, as an additional sorter before the amount unless the unit is added as a sorter explicitly. This happens if the ApplyMultiUnitBehaviorForSortingAndFiltering annotation is applied. This behavior is applicable for all columns in the SmartTable control.

For more information, see the API Reference.

For custom columns, the required p13nData information has to be provided by the consumers (isCurrency and unit).

The following key combinations are supported:

• CTRL SHIFT E or ⌘ / Command SHIFT E : Opens the Export As dialog for the spreadsheet export

• CTRL , or ⌘ / Command , : Opens the personalization settings

The SmartTable control disables the personalization for the first column if tableType is set to sap.ui.comp.smarttable.TableType.TreeTable. The TreeTable control provides a comprehensive set of features for displaying hierarchical data where a table is displayed as a hierarchical tree. TreeTable is designed to retain this structure also for the first column of the table, which is why SmartTable excludes it from personalization.

The currency and UoM columns in the SmartTable control are built to be aligned at decimal point. Although the overall content is right aligned, the header and cell might not be aligned as this is a generic control that is not built to handle a single currency or UoM (for example, %, h).

The UoM part always uses ~3em to prevent the content from being cut off. That is why there might be a space behind the unit in the cell in contrast to the header, depending on the UoM or currency used.

Also, if either the Product Depth or Product Width column is added to a SmartTable control, the UoM, such as m or cm, might not be aligned, but the aim is to align the values at decimal point and not at header and content level.

The application can use custom columns if an exact alignment of content and header is required.

For more information, see the Sample.