Tables are used to display the structured information. For example, Figure 7-2 shows an ADF Table component of Summit sample application for ADF Desktop Integration with data downloaded from the respective Fusion web application.

Figure 7-2 ADF Table Component with Downloaded Data

Description of "Figure 7-2 ADF Table Component with Downloaded Data"

After you have added a table component to your integrated Excel workbook, you may find that you need to add additional functionality to configure your table. Following are links to other functionality that table components can use.

• Search and Select dialog: You can configure a ModelDrivenColumnComponent subcomponent in a table column, as described in Adding a Model-Driven List Picker to an ADF Table Component, to display a dialog where end users can search and select data.

• Dependent List of Values: You can add dependent list of values components in your table component. See Creating Dependent Lists of Values in an Integrated Excel Workbook.

• Styles: You can configure the display of your form-type components using several predefined Excel styles. See Working with Styles.

• Tooltips: You can configure tooltips to display additional information or instructional text to your end users. See Displaying Tooltips in ADF Desktop Integration Components.

• EL Expressions: You can use EL expressions with table-type components. See ADF Desktop Integration EL Expressions.

1. Open the integrated Excel workbook.
2. Select the cell in the Excel worksheet into which you want to insert the ADF Table component.

   When selecting a cell, make sure that the:

   • Data of two tables do not overlap at runtime

   • Selected cell is not a merged cell

3. In the bindings palette of the ADF Desktop Integration Designer task pane, select the tree binding to use and click Insert Binding.
4. In the dialog that appears, select ADF Table and click OK.

   Note:

   • By default, the ModelDrivenColumnComponent subcomponent is defined as the subcomponent type for all columns when you insert an ADF Table component using the bindings palette.

     If you want a column to have a different subcomponent type, open the ADF Table property inspector (select any cell of the ADF Table component and click the Edit Properties button in the Oracle ADF tab), click the browse (...) icon of the Columns property. In the Edit Columns dialog, select the column, and click the browse (...) icon of the UpdateComponent property. In the Select Component dialog, select the desired subcomponent type, verify the binding and other properties, and click OK.

   • For tree bindings with multiple <nodeDefinition> elements (child nodes), attribute names used in the expressions for Value properties of UpdateComponent and InsertComponent must be unique across all <nodeDefinitions>.

5. Configure properties for the ADF Table component, as described in Table 7-1, using the property inspector shown in Figure 7-4.

   Figure 7-4 ADF Table Property Inspector

   

   Table 7-1 ADF Table Component Properties

   Set this property to...	This value...
   BatchOptions.CommitBatchActionID	The Commit action binding that the page definition file exposes.
   UniqueAttribute	Specify a binding expression that uniquely identifies each row in the iterator associated with the tree binding. A UniqueAttribute property value should only be specified if the tree binding's iterator does not support row keys.
   RowLimit	(Optional) configure this group of properties to determine the number of rows that the ADF Table component downloads. See Limiting the Number of Rows Your Table-Type Component Downloads.

6. Click OK.
7. Choose the appropriate option in the Insert Component: ADF Table dialog:

   • Yes to create default ribbon commands for the new table to download and upload data. You can delete or edit these ribbon commands at a later time. We recommend that you change the default ribbon command label. See How to Configure a Worksheet Ribbon Command for the Runtime Ribbon Tab.

   • No if you want to configure the download and upload of data at a later time or use one of the other available methods (for example, a worksheet event), as described in Downloading Data to an ADF Table Component, and Uploading Changes from an ADF Table Component .

Figure 7-5 shows the ADF Table component in EditCustomers-DT.xlsx in design mode.

Figure 7-5 ADF Table Component in Design Mode

Description of "Figure 7-5 ADF Table Component in Design Mode"

Figure 7-6 shows the ADF Table component in EditCustomers-DT.xlsx at runtime.

Figure 7-6 ADF Table Component at Runtime

Description of "Figure 7-6 ADF Table Component at Runtime"

For information about the properties that you can set for the ADF Table component, see ADF Table Component Properties and Actions.

To remove the table component, use the Delete ribbon command. See Removing ADF Desktop Integration Components.

1. Open the integrated Excel workbook.
2. Select the cell in the Excel worksheet that references the ADF Table component and click the Edit Properties button in the Oracle ADF tab.
3. In the Edit Component: ADF Table dialog, click the browse (...) icon of the Columns property.

   The Edit Columns dialog appears, listing all the columns of the selected ADF Table component.

4. Click Add to add a new column. The new column is inserted at the end of the Members list. To move the column to a specific position, select the column and use the Up and Down arrow keys.
5. Configure the new column's properties in the right pane of the dialog.
6. Click OK.

1. Open the integrated Excel workbook.
2. Click the Worksheet Properties button in the Oracle ADF tab, and add a ribbon command. For information about adding a ribbon command in a worksheet, see How to Define a Workbook Ribbon Command for the Runtime Ribbon Tab.

   Note:

   Instead of adding a ribbon command, you can configure a worksheet event to invoke the action set at runtime.

3. Open the Edit Action dialog to configure an action set. For information about invoking action sets, see Using Action Sets.
4. Add the following actions in the following order to the action set that invokes at runtime:

   • ADFmAction Execute action binding to execute the query on the iterator binding referenced by the ADF Table component TreeID property. This makes sure the binding is up-to-date before the action set invokes the ADF Table component Download action.

   • ADF Table component Download action.

     The ADF Table component Download action downloads the current state of the binding referenced by the ADF Table component TreeID property.

   Figure 7-7 shows the Edit Action dialog in the EditCustomers-DT.xlsx workbook where the action set invoked by the Download ribbon command in the Excel ribbon is configured.

   Figure 7-7 Action Set Downloading Data to an ADF Table Component

   
5. Click OK.

The end user invokes the action set that you configured. The action set invokes the list of actions specified in order. These include an action that invokes the Download action of the ADF Table component. When invoked, the Download action downloads all rows from the tree binding referenced by the ADF Table component TreeID property.

Make a note of the following points when the Download action is invoked at runtime:

• If any rows are marked as changed when the Download action is invoked, the end user is prompted to confirm the action and to continue (see Figure 7-8). If the end user chooses No, the action and the action set are cancelled without error.

• All existing Excel rows are removed from the table in Excel.

• The status column is cleared of all messages.

• Any criteria that has been applied to the worksheet using Excel's Filter functionality is automatically cleared prior to the Upload action.

• Excel's precision for a specified number is confined to 15 significant figures. If server data has a higher precision, Excel silently changes the precision. For example, 1234567890123456789012345678901234567890 is downloaded as 1.23456789012345E+39.

Figure 7-8 Confirmation Prompt Before Downloading Data in ADF Table

Description of "Figure 7-8 Confirmation Prompt Before Downloading Data in ADF Table"

The number of rows that the action downloads depends on the values set for the RowLimit group of properties in the ADF Table component. See Limiting the Number of Rows Your Table-Type Component Downloads .

When the Download action is invoked, it examines the state of each row in the iterator. Rows of state STATUS_INITIALIZED are downloaded as pending insert rows in the table, while rows of other states are downloaded as pending update rows.

You can use STATUS_INITIALIZED rows to pre-populate values for some, or all, attributes of the pending insert rows. As a STATUS_INITIALIZED row is not validated, you can configure an action to populate the STATUS_INITIALIZED row partially and insert it into the iterator before the Download action is invoked. The Download action then treats this row as a pending insert row so that a new row, based on the pre-populated row, can be inserted.

Note that STATUS_INITIALIZED rows are not automatically removed from the iterator during download. You can configure another action to remove STATUS_INITIALIZED rows after download. For example, you can configure an action set with the following actions:

1. ADFmAction that creates STATUS_INITIALIZED rows

2. Table.Download action

3. ADFmAction that cleans up STATUS_INITIALIZED rows

ADF Desktop Integration also supports a table action called DownloadForInsert. DownloadForInsert is an obsolete action and can be replaced with the Download action. DownloadForInsert continues to work as it always has worked in previous releases. The key difference, with respect to Download, is that DownloadForInsert only considers rows in the iterator that are in the STATUS_INITIALIZED state.

1. Open the project in JDeveloper.
2. If not present, add a Commit action binding to the page definition file that is associated with the Excel worksheet that hosts the ADF Table component.

   See Working with Page Definition Files for an Integrated Excel Workbook and Page Definition Requirements for an ADF Table Component.

3. Open the integrated Excel workbook.
4. Select the cell in the Excel worksheet that references the ADF Table component and click the Edit Properties button in the Oracle ADF tab.
5. Make sure that the ADF Table component RowAction properties are set, as described in Table 7-2, and shown in Figure 7-9.

Table 7-2 RowAction Properties of ADF Table Component

Property	Value
InsertRowEnabled	False
DeleteRowEnabled	False
UpdateRowEnabled	True

Figure 7-9 ADF Table RowActions Properties to Update Data

When the end user changes data in a row, ADF Desktop Integration marks the row and an upward pointing triangle appears in a row of the _ADF_ChangedColumn column.

After updating the existing data, the end user initiates the upload process to save the changes. For information about the ADF Table component's upload process, see Uploading Changes from an ADF Table Component.

Excel uploads modified rows from the integrated workbook in batches rather than row by row. You can configure the number of rows uploaded for each batch as well as the actions an ADF Table component invokes when it uploads and commits a batch of rows. For information about batch processing, see Batch Processing in an ADF Table Component.

For information about the properties that you can set for the ADF Table component, see ADF Table Component Properties and Actions.

1. Open the project in JDeveloper.
2. If not present, add a CreateInsert and a Commit action binding to the page definition file that is associated with the Excel worksheet that hosts the ADF Table component.

   See Working with Page Definition Files for an Integrated Excel Workbook and Page Definition Requirements for an ADF Table Component.

3. Open the integrated Excel workbook.
4. Select the cell in the Excel worksheet that references the ADF Table component and click the Edit Properties button in the Oracle ADF tab.
5. In the Edit Component: ADF Table dialog, configure the RowActions properties of the ADF Table component as described in Table 7-3:

   Table 7-3 RowActions properties of ADF Table component

   Set this property to...	This value...
   AutoConvertNewRowsEnabled	True. When True, end users can edit the rows under the ADF Table component or paste new data directly into the rows under the component to convert them to rows in the ADF Table component provided that the worksheet Protection.Mode property is set to Off (the default value). For information about worksheet properties, see Worksheet Actions and Properties.
   InsertRowEnabled	True
   InsertBeforeRowActionID	The CreateInsert action binding that the page definition file exposes.
   InsertRowsAfterUploadEnabled	True, to upload the inserted rows again regardless of whether they have been previously uploaded. By default, this property is set to False. The property is ignored if InsertRowEnabled is set to False.

6. Configure the BatchOptions properties of the ADF Table component as described in Table 7-4.

   Table 7-4 BatchOptions Properties of the ADF Table Component

   Set this property to...	This value...
   CommitBatchActionID	The Commit action binding that the page definition file exposes.

7. Configure the Columns property of the ADF Table component as described in Table 7-5.

   Note:

   ADF Desktop Integration automatically sets the appropriate property values if you selected a tree binding when inserting the ADF Table component, as described in How to Insert an ADF Table Component. (Optional) Review and adjust the other Columns property values as needed. See ADF Table Component Column Properties.

   Table 7-5 Columns property of ADF Table component

   Set this property to...	This value...
   InsertUsesUpdate	True
   UpdateComponent	Set the Value field of the UpdateComponent property to the update attribute from the page definition file. For example, #{row.bindings.ProductId.inputValue}. Verify that ReadOnly property of UpdateComponent is set appropriately. Set ReadOnly to False if you do want users to edit the values in the column, set to True otherwise. The default value of the ReadOnly property is False. See Adding a ModelDrivenColumnComponent Subcomponent to Your ADF Table Component.

8. Repeat Step 7 for each column that contains data to commit during invocation of the Upload action.

1. Open the integrated Excel workbook.
2. Open the Edit Action dialog to configure the action set that invokes the ADF Table component Upload action.

   For information about action sets, see Using Action Sets.

3. Add the ADF Table component Upload action to the list of actions that the action set invokes at runtime.

   Figure 7-10 shows the Edit Actions dialog in the EditCustomers-DT.xlsx workbook, where the action set invoked by the ribbon command labeled Upload at runtime is configured.

   Figure 7-10 Action Set Uploading Data from an ADF Table Component

   
4. Click OK.
5. If you do not want the Upload Options dialog to appear, select the cell in the Excel worksheet that references the ADF Table component and click the Edit Properties button in the Oracle ADF tab.

   Set DisplayUploadOptions to False in the Table Properties dialog and click OK.

At runtime, the end user invokes the action set through whatever mechanism you configured (ADF component, worksheet ribbon command, or worksheet event). This triggers the following sequence of events:

1. If the ADF Table component contains dynamic columns, ADF Desktop Integration verifies whether the dynamic columns that were expanded the last time the ADF Table component's Download action was invoked are still present in the Fusion web application. If the columns are not present, ADF Desktop Integration prompts the end user to determine whether to continue upload process. If the end user decides not to continue, ADF Desktop Integration returns an abort code to the executing action set.

2. If the ADF Table component contains no pending changes to upload, the ADF Table component's Upload action returns a success code to the executing action set.

3. The ADF Table component uploads modified rows in batches, rather than row by row. You can configure the batch options using the BatchOptions group of properties. For information about batch options for the ADF Table component, see Batch Processing in an ADF Table Component.

   Each row of a batch is processed in the following way, and the process continues until all changed rows of each batch are processed:

   1. For inserted rows, invoke the InsertBeforeRowActionID action, if specified.

   2. For edited rows, position the tree binding iterator to the correct row.

   3. Set attributes from the worksheet into the model, including any cached row attribute values.

   4. For edited rows, invoke the UpdateRowActionID action; and for inserted rows, invoke the InsertAfterRowActionID action, if specified.

   5. For each uploaded row, displays a status message indicating success or failure in the Status column. If a row fails to upload, the Status column displays a message (for example, Update Failed). More detailed information about the failure is shown in the Status Viewer when the end user clicks in any cell on the row with the failure. See Using the Status Viewer to Report Error Messages to End Users.

      For information about the Status column, see Special Columns in the ADF Table Component .

   6. For any row failure, the ADF Table component verifies the value of AbortOnFail. If AbortOnFail is set to False, it continues the upload process. Otherwise the component stops uploading data and invokes the Commit action.

4. While uploading data, the ADF Table component returns a success or failure code to the executing action set based on the following:

   • If the ADF Table component commits all batches successfully, it returns the success status to the executing action set. If Table.DisplayUploadOptions property is set to True and the end user has selected the Download all rows after successful upload option in Upload Options dialog, the ADF Table component then downloads all rows from the Fusion web application.

   • If the ADF Table component did not commit all batches successfully, the action set invokes the action specified by the RowActions.FailureActionID property, if an action is specified for this property. ADF Desktop Integration returns a failure code to the action set.

If the Table.DisplayUploadOptions property is set to True and the On failure, continue to upload subsequent rows checkbox is selected in the Upload Options dialog, the Upload action returns a success code to the action set even if some individual rows encountered validation failures.

At runtime, if an ADF Table component column's ReadOnly property evaluates to True, the ADF Table component's Upload action ignores all changes in the column's cells.

For information about change tracking, see Evaluating EL Expressions for ReadOnly Properties.

When the ADF Table component starts uploading data, ADF Desktop Integration creates a DataControlFrame savepoint before initiating the upload process (once per batch of uploaded rows). In case of any error, ADF Desktop Integration reverts back to the savepoint, ensuring the integrity of the server-side state of the Fusion web application.

For each row in a batch of uploaded rows, ADF Desktop Integration does the following:

1. Invokes configured actions, applies row attribute value changes, and performs data validation.

2. In case of any error, reverts back to the savepoint state.

Since ADF Desktop Integration uses savepoints to manage model state during upload, any row-level action implementations should avoid calling commit or rollback actions.

For information about savepoints, see Using Trees to Display Master-Detail Objects in Developing Fusion Web Applications with Oracle Application Development Framework.

At runtime, when the end user uploads data from the integrated Excel workbook to the Fusion web application, ADF Desktop Integration continues to upload subsequent data rows in case of any row failure, and does not refresh or download data of all rows after a successful upload.

If required, you can enable or disable the Upload Options dialog, as shown in Figure 7-11, by setting the Table.DisplayUploadOptions property. When DisplayUploadOptions is set to True, ADF Desktop Integration presents the Upload Options dialog.

Figure 7-11 Default Upload Dialog

Description of "Figure 7-11 Default Upload Dialog"

Using the Upload Options dialog, end users can enable or disable the following options:

• Continue to upload subsequent rows on failure. This is the default behavior.

  When disabled, ADF Desktop Integration aborts the upload process in case of any row failure.

• Download all data rows after a successful upload. This behavior is disabled by default.

  When enabled, ADF Desktop Integration downloads the latest data from the view object cache after the successful upload.

  Note:

  If the Download all data rows after a successful upload checkbox is selected, ADF Desktop Integration downloads the data from the view object cache, not from the database.

  Therefore, if another user happens to update the same rows that the end user has updated, the end user will not see the updates made by the other user after downloading data rows.

If the end user clicks Cancel in the Upload Options dialog, ADF Desktop Integration returns an abort code to the executing action set. If the end user clicks OK, the action set continues executing with the options specified in the dialog for the upload operation.

You may also create a custom upload dialog. See How to Create a Custom Upload Dialog.

1. Create a page in the JDeveloper project where you develop the Fusion web application. For information on how to create this page, see Displaying Web Pages from a Fusion Web Application.
2. In addition to the ADFdi_CloseWindow element (for example, a span element) described in Displaying Web Pages from a Fusion Web Application, the page that you create in Step 1 must include the elements described in Table 7-6.

   Table 7-6 Span Elements Required for Custom Upload

   Name	Description
   ADFdi_AbortUploadOnFailure	If you set this element to True, the action set stops uploading if it encounters a failure. If the element references False, the action set attempts to upload all rows and indicates if each row succeeded or failed to upload.
   ADFdi_DownLoadAfterUpload	Set this element to True so the action set downloads data from the Fusion web application to the ADF Table component after the action set uploads modified data.

   Note:

   The page you create must include both elements to prevent ADF Desktop Integration presenting the default upload dialog to end users. Ensure that you specify a boolean value for each element (True or False).

3. Add a Dialog action to invoke the page you created in Step 1 before the action in the action set that invokes the ADF Table component's Upload action.

   For information about displaying pages from a Fusion web application, see Displaying Web Pages from a Fusion Web Application.

When a custom dialog appears, the page from the Fusion web application that you configure the Dialog action in the action set to display appears instead of the default upload dialog.

For information about displaying a page from the Fusion web application, see Displaying Web Pages from a Fusion Web Application. Otherwise, the runtime behavior of the action set that you configure to upload data is as described in What Happens at Runtime: How the ADF Table Component Uploads Data.

1. Open the integrated Excel workbook.
2. Click the Worksheet Properties button in the Oracle ADF tab, and add a ribbon command that the end user uses to invoke the action set at runtime. For information about adding a ribbon command in a worksheet, see How to Configure a Worksheet Ribbon Command for the Runtime Ribbon Tab.
3. Open the Edit Action dialog to configure the action set that invokes the ADF Table component actions.

   For information about action sets, see Using Action Sets.

4. Add the ADF Table component UploadAllOrNothing action to the list of actions that the action set invokes at runtime.
5. Click OK.

If you have chosen the UploadAllOrNothing action, ADF Desktop Integration commits row changes only when all rows are uploaded successfully.

During the UploadAllOrNothing action, ADF Desktop Integration uploads all changed worksheet rows prior to invoking the action specified by CommitBatchActionID. If one, or more, row-level failures occur, the action specified by FailureActionID is invoked and the action specified by CommitBatchActionID is not invoked.

In the event of a failure, all values in the Changed column remain unchanged. The Status column displays failure messages for the rows that contain errors, but remains empty for all rows without errors. When all rows successfully commit, the Changed column values are cleared and the Status column for the uploaded rows reports success.

1. Open the web.xml file of your Fusion web application.
2. Add the UploadAllOrNothing.ChangedDataLimit servlet parameter, as described in Table 7-7.

   Table 7-7 Limiting the Amount of Changed Data That Can be Uploaded

   Property	Value
   Name	Enter the name of the servlet parameter as follows UploadAllOrNothing.ChangedDataLimit
   Value	Specify the total amount of changed data in Kb that can be uploaded.

3. Save the web.xml file.
4. Rebuild and restart your Fusion web application.

<servlet>
  <servlet-name>adfdiRemote</servlet-name>
  <servlet-class>oracle.adf.desktopintegration.servlet.DIRemoteServlet</servlet-class>
  <init-param>
    <param-name>UploadAllOrNothing.ChangedDataLimit</param-name>
    <param-value>10240</param-value>
  </init-param>
</servlet>

1. Open your Fusion web application in JDeveloper.
2. If not present, add a Delete action binding to the page definition file that is associated with the Excel worksheet that hosts the ADF Table component.

   See Working with Page Definition Files for an Integrated Excel Workbook.

3. Open the property inspector for the ADF Table component and set values for the RowActions group of properties as described in Table 7-8.

   Table 7-8 RowActions Properties of ADF Table component

   Set this property...	To...
   DeleteRowActionID	The Delete action binding that the page definition file exposes. The specified Delete action binding is expected to delete the current row in the iterator.
   DeleteRowEnabled	True to enable the ADF Table component to delete rows in the Fusion web application. False is the default value.

   For information about ADF Table component properties, see ADF Table Component Properties and Actions .

4. Click OK.
5. Open the integrated Excel workbook.
6. Click the Worksheet Properties button in the Oracle ADF tab, and add a ribbon command that the end user uses to invoke the action set at runtime. For information about adding a ribbon command in a worksheet, see How to Configure a Worksheet Ribbon Command for the Runtime Ribbon Tab.
7. Add the ADF Table component's DeleteFlaggedRows action to the list of actions that the action set invokes at runtime.

   For information about invoking action sets, see Using Action Sets.

8. (Optional) Set the DeleteFlaggedRows action's Options.AbortOnFailure property to False if you want the action set to continue processing even if it encounters failures. The default value is True.
9. Click OK.

The end user flags rows to delete, as described in Row Flagging in an ADF Table Component. The end user then invokes the action set. The following sequence of events occurs:

1. If specified, the action binding referenced by the BatchOptions.StartBatchActionID property is invoked.

   Failures from this step are treated as errors. An error stops the action set invoking. It also returns the error condition to the action set. If an action binding is specified for the ActionSet.FailureActionID property, the action set invokes the specified action binding.

   For information about configuring batch options, see Batch Processing in an ADF Table Component.

2. For each flagged row in the ADF Table component, the action set positions the tree binding iterator to the correct row, then it invokes the delete-type action binding specified by RowActions.DeleteRowActionID.

   Note:

   Rows inserted since the last invocation of the ADF Table component's Download action but not uploaded to the Fusion web application are ignored even if flagged for deletion.

3. For each flagged row in the ADF Table component, if the delete-type action binding specified by RowActions.DeleteRowActionID fails, the next event depends on the value you specified for the DeleteFlaggedRows action's Options.AbortOnFailure property. If False, the action set attempts to delete all flagged rows without stopping at the first failure it encounters. If the action set fails to delete a flagged row, that row:

   • Remains in the ADF Table component

   • Is marked as Failed in the ADF Table component's Status column

   • Is skipped while the action set commits the batch of successfully deleted flagged rows

   • Remains flagged in the Flagged column cell

   If the DeleteFlaggedRows action's Options.AbortOnFailure property is set to True (the default value), the ADF Table component stops invocation of the DeleteFlaggedRows action.

4. If an action binding is specified for the BatchOptions.CommitBatchActionID property, the action set invokes it. If this step fails, the action set stops processing batches. If no failures occur, the action set processes the next batch by invoking the action binding specified by the BatchOptions.StartBatchActionID property, and so on until the action set processes all batches.

5. If the action set processes all batches successfully, it invokes the action binding specified by its ActionOptions.SuccessActionID property if an action binding is specified for this property. It then removes the rows deleted in the Fusion web application by invocation of the delete-type action binding specified by RowActions.DeleteRowActionID from the worksheet and returns a success code to the action set.

   If failures occur while the action set processes the batches, the action set invokes the action binding specified by its ActionOptions.FailureActionID property if an action binding is specified for this property. This action binding returns a failure code to the action set.

6. If an unexpected exception occurs while the action set invokes its actions, an error code is returned to the action set. All relevant error messages are available in the Status Viewer. See Using the Status Viewer to Report Error Messages to End Users.

1. Open the integrated Excel workbook.
2. Select the cell in the Excel worksheet that references the ADF Table component, and then click the Edit Properties button in the Oracle ADF tab.
3. Set values for the BatchOptions group of properties in the property inspector that appears.

   Table 7-9 BatchOptions Properties

   Set this property...	To...
   BatchSize	Specify how many rows to process before an ADF Table component action (Upload or DeleteFlaggedRows) invokes the action binding specified by CommitBatchActionID. Any value other than a positive integer results in all rows being processed in a single batch. The default value is 100 rows.
   CommitBatchActionID	The action binding to invoke after the ADF Table component processes each batch. Typically, this is the Commit action binding.
   LimitBatchSize	True When True, the ADF Table component processes rows in batches determined by the value of BatchSize. True is the default value. When False, the ADF Table component uploads all modified rows in a single batch. Note that it is not sufficient to set this property to False if you want the ADF Table component to upload all rows or no rows in the case of failure. Instead, you need to invoke the UploadAllOrNothing action, as described in Uploading Changes from an ADF Table Component Using an UploadAllOrNothing Action.
   StartBatchActionID	(Optional) Specify the action binding to invoke at the beginning of each batch.

4. Click OK.

By default, the ADF Table component includes a column, _ADF_FlagColumn, that facilitates the selection of rows for flagged-row processing. Double-clicking a cell of the _ADF_FlagColumn column flags the corresponding row for processing by actions invoked by a component action.

When the end user double clicks a cell of the _ADF_FlagColumn column, a solid circle appears, or disappears, in the cell to indicate that the row is flagged, or not. Figure 7-14 shows an example of a flagged column.

Figure 7-14 Flagged Column in ADF Table Component

The following component actions can be invoked on flagged rows:

• DeleteFlaggedRows

• DownloadFlaggedRows

You can use the FlagAllRows component action to flag all rows, and the UnflagAllRows component action to unflag all rows of the ADF Table component.

Use of these component actions is dependent on the appearance of the _ADF_FlagColumn column in the ADF Table component. If you remove the _ADF_FlagColumn column from the ADF Table component, you cannot invoke any of these component actions. For information about these component actions, see ADF Table Component Actions.

At runtime, the end user can invoke any of the previously listed component actions from an action set. The invoked component action processes all flagged rows. For example, it downloads or deletes all flagged rows. For information about configuring an action set to invoke a component action, see How to Invoke Component Actions in an Action Set.

1. Open the integrated Excel workbook.
2. Select the cell in the Excel worksheet that references the ADF Table component and click the Edit Properties button in the Oracle ADF tab.
3. In the Edit Component: ADF Table dialog, click the browse (...) icon beside the input field for Columns.

   The Edit Columns dialog appears, listing all the columns of the selected ADF Table component.

4. Select the column with ID as _ADF_RowKeyColumn.
5. Change the column properties as desired, but do not change the following properties:

   • DynamicColumn

   • InsertComponent

   • InsertUsesUpdate

   • UpdateComponent

   • ID

   • Visible

6. If desired, change the position of the column using the Up and Down arrow keys and the values of properties that determine the appearance of the column (Label, Tooltip, and Style).
7. Click OK to close Edit Columns dialog.
8. Click OK to close the Edit Component: ADF Table dialog.

1. Open the integrated Excel workbook.
2. Select the cell in the Excel worksheet that references the ADF Table component, and then click the Edit Properties button in the Oracle ADF tab.
3. Add a new column in the ADF Table, and specify the properties as described in Table 7-10. For information about adding a column, see How to Add a Column in an ADF Table Component.

   Table 7-10 Key Column Properties

   Set this property...	To ...
   CellStyleName	Key Cell
   HeaderStyleName	Column Header
   DynamicColumn	False
   HeaderLabel	#{_ADFDIres[COMPONENTS_TABLE_ROWKEY_COL_LABEL]}
   ID	_ADF_RowKeyColumn
   InsertUsesUpdate	True
   UpdateComponent	OutputText The Value property must be empty.
   Visible	True

   If desired, change the position of the column using the Up and Down arrow keys and the values of properties that determine the appearance of the column (Label, Tooltip, and Style).

4. Click OK.

When the ADF Table component's Download or DownloadForInsert action is invoked, the ADF Table component automatically updates the dynamic columns so that they contain an up-to-date set of matching attributes. For each invocation of Download, ADF Desktop Integration requires that all rows must have the same set of attributes for the dynamic column. It may generate errors if the set of attributes changes from row to row during Download.

If a dynamic column supports both Insert and Update operations, you should specify the same EL expression for the Value properties of the dynamic column's InsertComponent and UpdateComponent subcomponents. At runtime, the ADF Table component expands to include a dynamic column that displays the value of the attribute binding returned by the EL expression.

Typically the set of matching attributes does not change between invocation of the ADF Table component's Download and Upload actions. However, if previously downloaded attributes no longer exist in the tree binding when the ADF Table component invokes the Upload action, the integrated Excel workbook prompts the end user to determine if the end user wants to continue to upload data. For information about how to avoid the scenario just described (downloaded attributes no longer exist in the tree binding), see Using an Integrated Excel Workbook Across Multiple Web Sessions.

1. Open the integrated Excel workbook.
2. Select any cell in the ADF Table component and click the Edit Properties button in the Oracle ADF tab.
3. In the Edit Component: ADF Table dialog, configure and set the ResizeColumnsMode property as described in Table 7-11:

   Table 7-11 ResizeColumnsMode Values of the ADF Table Component

   Value	Description
   UseColumnValue	Default. All columns in the table will be resized (or not) based on their Column.ResizeMode property values. Columns with InheritFromTable will not be resized. Individual columns that have Column.ResizeMode properties set to a value other than InheritFromTable are resized accordingly.
   AutoFitAllWithHeader	All columns within the table boundaries are resized to best fit using Excel's AutoFit support. Data values in the columns' cells, including the header cells, are used to determine the best fit. Individual columns that have Column.ResizeMode properties set to a value other than InheritFromTable are resized accordingly. Note that values in the column's cells above or below the table are not considered when finding the best fit.
   AutoFitAllWithoutHeader	All columns within the table boundaries are resized to best fit using Excel's AutoFit support. Data values in the columns' cells, excluding the header cells, are used to determine the best fit. Individual columns that have Column.ResizeMode properties set to a value other than InheritFromTable are resized accordingly. Note that values in the column's cells above or below the table are not considered when finding the best fit.

4. To configure the resizing behavior of a column and override the table-level resizing behavior, set the ResizeMode property.

   In the Edit Component: ADF Table dialog, expand the Columns property and set the ResizeMode property as described in Table 7-12:

   Table 7-12 ResizeMode Values of the ADF Table Column Property

   Value	Description
   Manual	The column is not resized; column width is left at the current setting.
   InheritFromTable	Default. The column is resized based on the table's ResizeColumnsMode setting. If ResizeColumnsMode is set to UseColumnValue, then no resizing occurs.
   AutoFitWithHeader	Including the header cell, the column is resized to best fit using the Excel's AutoFit support.
   AutoFitWithoutHeader	Excluding the header cell, the column is resized to best fit using the Excel's AutoFit support.
   SpecifiedWidth	ADF Desktop Integration uses the Width property to determine the desired width of the column. You can specify a numerical value, or an EL expression.

5. If the ADF Table component's ResizeColumnsMode property is set to UseColumnValue and a column's ResizeMode property is set to SpecifiedWidth, set the Column.Width property to the number of characters you want to display in the column.

   A column's Width property may be set to a literal numerical value or an EL expression that evaluates to a number between 1 and 255, inclusive. An example EL expression for Width that makes use of the UI Hint displayWidth for an attribute is:

   #{bindings.Customers.hints.Name.displayWidth}

   Note:

   • If the expression cannot be evaluated, or if the expression evaluates to less than 1 or greater than 255, the ResizeMode is considered to be Manual and the column is not resized.

   • Use a decimal point regardless of the environment's Region and Language settings if you want to specify a fractional value. A 'decimal comma' (such as is seen in French locales) is not supported.

6. Click OK.

1. Open the integrated Excel workbook.
2. Click the Worksheet Properties button in the Oracle ADF tab, and add a ribbon command, as described in How to Define a Workbook Ribbon Command for the Runtime Ribbon Tab.

   Note:

   Instead of adding a ribbon command, you can configure a worksheet event to invoke the action set at runtime.

3. Open the Edit Action dialog to configure an action set. For information about invoking action sets, see Using Action Sets.
4. Add the ADF Table component ResizeColumns action to the list of actions that the action set invokes at runtime. Note that ResizeColumns is a component action.
5. Click OK.

Figure 7-15 shows the ResizeColumns action at design-time that is configured in the worksheet Events property of the EditCustomers-DT.xlsx workbook.

Note:

If you configure an action set that is invoked by the worksheet Startup event and this action set invokes the ADF Table component's ResizeColumns action after the Download action, make sure that the action set invokes the ADF Table component's Initialize action before the Download action. Figure 7-15 demonstrates this configuration.

Figure 7-15 ResizeColumns Action

The ADF Table columns are resized as the result of running of Table.ResizeColumns component action in an action set (see How to Configure an Action Set to Resize Columns of an ADF Table Component at Runtime).

The entire worksheet columns containing the ADF Table component columns are resized depending on the values in the Table.ResizeColumnsMode and Column.ResizeMode properties. Resizing the table columns affects the contents of the cells or any other components (such as form components) located in the same Excel worksheet column outside of the table's boundaries.

If a worksheet contains two or more ADF Table components configured with action sets to resize columns at runtime, all ADF Table components attempt to resize their columns independently. However, the ADF Table component's ResizeColumns action that runs last sets the column width.

1. Open the integrated Excel workbook.
2. Select the cell in the Excel worksheet that references the ADF Table component and click the Edit Properties button in the Oracle ADF tab.
3. In the Edit Component: ADF Table dialog, click the browse (...) icon of the Columns property.

   The Edit Columns dialog appears, listing all the columns of the selected ADF Table component.

4. In the Edit Columns dialog, select the column that you want to start the group of columns.
5. In the right pane of the Edit Columns dialog, expand the GroupHeader property under the Layout field and configure the properties, as described in Table 7-13.

   Table 7-13 GroupHeader Properties of an ADF Table Component's Group Start Column

   Set this property to ...	This value
   Boundary	Set to start or an EL expression that evaluates to start. This defines the column as the start of a group of columns. If you want to define a dynamic column as the start of a group of columns, we recommend that you define a custom attribute property with a value of start, as described in How to Group Columns that Render in a Dynamic Column. Write an EL expression that retrieves the value of this custom attribute property.
   Label	Set this property to a string or to an EL expression that evaluates to a label in the column group header at runtime. The evaluated value renders in the cell of the start column. The start column in the column group header requires a value for this property. No column group header forms at runtime if you do not specify a value. For information about labels, see Using Labels in an Integrated Excel Workbook. You can also edit this property by editing the Excel cell where the label text appears. Editing the text in the cell directly only affects this property. There is no effect on the Boundary property.
   StyleName	Set this property to a style defined in the workbook or to an EL expression that evaluates to a style name. The named style is applied to the column group's header cell at runtime. For information about styles, see Configuring the Appearance of Your Integrated Excel Workbook.
   Tooltip	(Optional) Specify a tooltip. The tooltip that you specify renders from the extra table header cell of the end column in the group. For information, see What Happens at Runtime: How an ADF Table Component Groups Columns. For information about tooltips, see How to Add a Tool Tip to an ADF Table Component.

   Figure 7-17 shows the values configured for the GroupHeader properties to start the Inventory Details group of columns in EditAllInventory-DT.xlsx workbook shown in Figure 7-16.

   Figure 7-17 Configuring the Start Column of a Group of Columns

   
6. In the Edit Columns dialog, select the column that you want to end the group of columns.

   Note:

   If you do not configure a column to end the group of columns, the column that you configured as the start column in Step 5 renders as a single-column group.

7. In the right pane of the Edit Columns dialog, expand the GroupHeader property under the Layout category and configure the following property:

   • Boundary: Set to end or an EL expression that evaluates to end.

     This defines the column as the end of a group of columns.

     If you want to define a dynamic column as the end of a group of columns, define a custom attribute property with a value of end, as described in How to Group Columns in an ADF Table Component and write an EL expression that retrieves the value of this custom attribute property.

   • Do not set values for the remaining properties in GroupHeader. The values that you set for the start column in Step 5 determine the label, style and tooltip that render in the group of columns' header at runtime.

     Note:

     You do not need to set properties for the columns between the start and end columns.

     If, at runtime, the integrated Excel workbook does not find a start column to the left of the column that you configure as the end column, the value that you specify for the end column is ignored.

8. Click OK.

   Note:

   Remember to leave the row above the ADF Table component empty of data and styles if you want to group columns because, at runtime, existing data and styles will be overwritten to render the extra table header row that will appear above the ADF Table component.

An extra table header row renders above the ADF Table component's regular table header row at runtime if you configure values for the GroupHeader properties. The values you specify for the Label, StyleName and Tooltip properties of the start column in each group determines the label, style and tooltip of the group header. Any values that you configure for those GroupHeader properties of other columns in the column group are ignored.

The style specified by the GroupHeader.StyleName property in the column that you configure as the start column is applied on the extra table header cells of all columns in the group. The horizontal alignment of the group header label centers across the extra table header cells of all columns in the group.

The tooltip defined by the GroupHeader.Tooltip property in the start column renders on the extra table header cell of the end column in the group, as shown in Figure 7-21.

Figure 7-21 Grouped Columns Rendering Styles and Displaying a Tooltip

Description of "Figure 7-21 Grouped Columns Rendering Styles and Displaying a Tooltip"

Make sure that columns you configure as start and end columns render at runtime. If a column that you configure as a start column does not render at runtime, no column group forms. For example, if you configure Column 1 as a start column and Column 3 as an end column and Column 1 does not render at runtime because its Visible property returns false, no column group forms. Similarly, if Column 3 does not render, no column group forms that spans Column 1, Column 2, and Column 3. Instead, Column 1 renders as a single-column group.

1. Open the integrated Excel workbook.
2. Select the cell in the Excel worksheet that references the ADF Table component and click the Edit Properties button in the Oracle ADF tab.
3. In the Edit Component: ADF Table dialog, set the RowActions.UpdateRowEnabled property of the ADF Table component to False.
4. In the Edit Component: ADF Table dialog, click the browse (...) icon of the Columns property.

   The Edit Column dialog appears, listing all the columns of the ADF Table component.

5. Delete the _ADF_ChangedColumn, _ADF_FlagColumn, and _ADF_StatusColumn columns by selecting these columns and clicking Remove in the Edit Columns dialog.

   Note:

   Do not remove the Key column. For information about the Key column, see Configuring ADF Table Component Key Column.

6. (Optional) Consider changing each column's UpdateComponent component type value from ModelDrivenColumnComponent to OutputText.

   This is not necessary if the view object is configured to be read-only. This is because the ReadOnly property of each UpdateComponent is bound to the corresponding readOnly attribute hint by default if you create an ADF Table component from a tree binding. The CustomerSearch-DT.xlsx workbook demonstrates this implementation.

7. (Optional) Consider changing each column's CellStyleName property to Read-only Cell to visually distinguish read-only cells from editable cells.

   See Working with Styles.

8. Click OK.

1. Open the integrated Excel workbook.
2. Select the cell in the Excel worksheet where you want to anchor the component.

   When inserting a table component, you must ensure that the data of two tables does not overlap at runtime, and the selected cell is not a merged cell

3. In the bindings palette, select the binding to create the ADF Read-only Table component, and then click Insert Binding.
4. In the dialog that appears, select ADF Read-only Table.

   Note:

   You can also insert an ADF Read-only Table component by using the components palette or Oracle ADF tab. Select ADF Read-only Table and click Insert Component. If you use the components palette to create the component, you would have to add each column to appear in the component at runtime.

5. Configure properties in the property inspector that appears to determine the columns to appear and the actions the component invokes at runtime.
6. Click OK.

   Note:

   You can modify the properties of the component at a later time by selecting the cell in the worksheet that anchors the component and then displaying the property inspector.

   To remove the table component, use the Delete ribbon command, as described in Removing ADF Desktop Integration Components.

1. Open the integrated Excel workbook.
2. Select the cell in the Excel worksheet that references the table-type component and click the Edit Properties button in the Oracle ADF tab.

   See Using Action Sets.

3. Configure properties for the RowLimit group of properties, as described in Table 7-14. For information about these properties, see Frequently Used Properties in the ADF Desktop Integration.

   Table 7-14 RowLimit Group of Properties

   Set this property to...	This value...
   RowLimit.Enabled	Set to True to limit the number of rows downloaded to the value specified by RowLimit.MaxRows.
   RowLimit.MaxRows	Specify an EL expression that evaluates to the maximum number of rows to download.
   RowLimit.WarningMessage	Write an EL expression for this property to generate a message for the end user if the number of rows available to download exceeds the number specified by RowLimit.MaxRows. If the value for this property is null, the Download action downloads the number of rows specified by RowLimit.MaxRows displaying the default warning message to the end user.

4. Click OK.

Figure 7-22 shows the Edit Component dialog in the EditCustomers-DT.xlsx workbook where the row limit of an ADF Table component is configured.

Figure 7-22 Limiting Number of Rows of an ADF Table Component

Description of "Figure 7-22 Limiting Number of Rows of an ADF Table Component"

When invoked, the Table-type component's Download action downloads the number of rows that you specified as the value for RowLimit.MaxRows from the Fusion web application. A message dialog similar to the one in Figure 7-23 appears if you specify an EL expression for RowLimit.MaxRows or do not modify its default value.

Figure 7-23 Row Limit Exceeded Warning Message

Description of "Figure 7-23 Row Limit Exceeded Warning Message"

During Download, the EL expression is evaluated with the current binding value as expected.

During Upload, or when the end user changes values in the editable table, the EL expression is evaluated differently than Download. Specifically, an empty string is substituted for the binding expression prior to evaluation of the EL expression.

For example, if you have the following EL expression in an editable cell:

=IF("#{row.bindings.color.inputValue}"="RED", True, False)

During Upload, or when the end user changes values in the editable table, the EL expression evaluates to =IF(""="RED", True, False), and always returns False.

During Upload and change tracking, an extra round trip to the server would be required to retrieve the binding values, in order to evaluate the EL expression properly. The extra round trip to the server would impact performance negatively, and could even require a new login if the end user did not have a currently valid session.

Due to the difference in behavior, if possible, you should avoid ReadOnly EL Expressions that contain binding expressions. However, if it is important for a given use case to use an attribute value in the ReadOnly expression, you should consider setting the worksheet protection to Automatic. For information about worksheet protection, see Using Worksheet Protection.

For example, if you have the following EL expression in a cell:

=IF("#{row.bindings.color.inputValue}"="RED", True, False)

During Download, the RED cells in this column will be set to Locked and the end user will not be able to edit those cells.

1. Open the integrated Excel workbook.
2. Select the cell in the Excel worksheet that references the ADF Table component and click the Edit Properties button in the Oracle ADF tab.
3. In the Edit Component: ADF Table dialog, click the browse (...) icon of the Columns property.

   The Edit Columns dialog appears, listing all the columns of the selected ADF Table component.

4. Click Add to add a new column. The new column is inserted at the end of the Members list. To move the column to a specific position, select the column and use the Up and Down arrow keys.
5. Set the value of the ID property to _ADF_ErrorColumn.
6. Leave the following properties using their default values:
   • DynamicColumn
   • InsertComponent
   • InsertUsesUpdate
   • UpdateComponent
   • TriggersRowRefresh
7. Configure other properties for the new column, such as HeaderLabel, HeaderStyleName, and so on as necessary.

   Tip:

   For best results, set the TableComponents.SmartRowFailureReportingEnabled ADF Desktop Integration compatibility property to True.

8. Click OK.