This appendix includes the following sections:
Lists alphabetically properties in ADF Desktop Integration that many components reference.
Table A-1 Frequently Used Properties in ADF Desktop Integration
Name | Type | EL | Description |
---|---|---|---|
|
N |
For information about action sets, see Action Set Properties. |
|
|
String |
N |
Use this field to enter a comment about the component's use in the worksheet. Comments you enter have no effect on the behavior of the workbook. They are the equivalent of code comments. |
|
String |
N |
ADF Desktop Integration generates this string to uniquely identify each instance of an ADF component in an integrated Excel workbook. |
|
String |
Y |
Specify an EL expression that is evaluated at runtime. For information about EL expressions in ADF Desktop Integration, see ADF Desktop Integration EL Expressions. For information about using labels, see Using Labels in an Integrated Excel Workbook. |
|
N |
This property defines the upper-left corner of the Oracle ADF component in the integrated Excel workbook. |
|
|
Boolean |
Y |
Set this property to To avoid end user confusion, apply styles to the cells where you set |
|
String |
Y |
Specifies the style in the current Excel workbook to apply when the Oracle ADF component is rendered. For information, see Working with Styles. |
|
String |
Y |
Specify the hint message about the content or function of the ADF form component, or table column, to appear when the mouse hovers the component, or the column. For information, see Displaying Tooltips in ADF Desktop Integration Components. |
|
Varies |
Y |
This property typically references an EL binding value expression that gets evaluated during the invocation of the ADF Table component's |
Many label-type properties are optional and default to empty. At runtime, if the value of such properties is empty, ADF Desktop Integration provides a default, localized value. If you want the value of the property to appear as empty, set its value to a single space character, or provide an EL expression that evaluates to an empty string.
Lists alphabetically the properties of the ADF Input Text component.
Table A-2 ADF Input Text Component Properties
Name | Description |
---|---|
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
Specifies the action set invoked when a user double-clicks the cell. For information about action sets, see Action Set Properties . |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
Lists alphabetically the properties of the ADF Output Text component.
Table A-3 ADF Output Text Component Properties
Name | Description |
---|---|
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
Specifies the action set invoked when a user double-clicks the cell. For information about action sets, see Action Set Properties . |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
The ADF Label component displays a static string value at runtime. ADF Desktop Integration generates the value when the EL expression that the Label
property references is evaluated.
For information about using labels, see Using Labels in an Integrated Excel Workbook.
Table A-4 lists alphabetically the properties that the ADF Label component references.
Table A-4 ADF Label Component Properties
Name | Description |
---|---|
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
Lists the properties of the ADF List of Values component.
For information about creating lists of values in your integrated Excel workbook, see Working with Lists of Values .
Table A-5 ADF List of Values Component Properties
Name | Type | EL | Description |
---|---|---|---|
|
For information about this property, see Table A-1. |
||
|
For information about this property, see Table A-1. |
||
|
List binding |
N |
Select the list binding whose value at runtime determines the choices available in the dependent list of values at runtime. The list binding that you select can be a model-driven list. For information about dependent list of values, see Creating Dependent Lists of Values in an Integrated Excel Workbook. |
|
List binding |
N |
Select the list binding that defines the values available in the list of values. The list binding that you select can be a model-driven list. |
|
Boolean |
N |
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
||
|
For information about this property, see Table A-1. |
||
|
String |
Y |
For information about this property, see Table A-1. |
Lists the properties of the ADF Image component which displays an image at runtime.
For information about adding an ADF Image component, see Inserting an ADF Image Component.
Table A-6 ADF Label Component Properties
Name | Description |
---|---|
|
Enter the absolute, or relative, URL of the image file. |
|
Enter the EL expression that resolves to the alternate text of the image component. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
Lists alphabetically the properties of the ADF Input Date component.
For information about the ADF Input Date component, see Inserting an ADF Input Date Component.
Table A-7 ADF Input Date Component Properties
Name | Description |
---|---|
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
Specify an EL expression that resolves to a date-time value at runtime. For information about ADF Input Date component, see Inserting an ADF Input Date Component. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
Describes the properties that you configure for the ModelDrivenColumnComponent subcomponent.
The ModelDrivenColumnComponent
subcomponent does not appear in the components palette of the ADF Desktop Integration task pane. Instead, you configure properties for this subcomponent when you specify ModelDrivenColumnComponent
as the subcomponent to invoke for the ADF Table component's UpdateComponent
or InsertComponent
table column properties described in ADF Table Component Column Properties.
The column subcomponent type is determined at runtime by the column's attribute Control Type hint specified on the server. For example, if there is a model-driven list associated with the attribute, then the column uses a dropdown list containing the model-driven list items at runtime. See Adding a ModelDrivenColumnComponent Subcomponent to Your ADF Table Component.
Table A-8 ModelDrivenColumnComponent Subcomponent Properties
Name | Type | EL | Description |
---|---|---|---|
|
Specifies the action set invoked when a user double-clicks the cell. For information about action sets, see Action Set Properties . |
||
|
Boolean |
Y |
Set the If you create the ADF Table component by double-clicking a tree binding in the Bindings palette, the property's value is set to an EL expression in the following format that evaluates to
For example, For information about this property, see Table A-1. |
|
Varies |
Y |
For information about this property, see Table A-1. |
Describes the properties that you configure for the TreeNodeList
subcomponent.
Note:
The ModelDrivenColumnComponent
subcomponent also renders dropdown menus for tree binding attributes that have a model-driven list. Consider using a ModelDrivenColumnComponent
subcomponent rather than a TreeNodeList
subcomponent. See ModelDrivenColumnComponent Subcomponent Properties.
The TreeNodeList
is an ADF Table subcomponent that renders dropdown menus in columns of the ADF Table component at runtime. It provides the same functionality to end users as the ADF List of Values component. For information about creating lists of values in your integrated Excel workbook, see Working with Lists of Values .
The TreeNodeList
subcomponent does not appear in the components palette of the ADF Desktop Integration task pane. Instead, you configure properties for this subcomponent when you specify TreeNodeList
as the subcomponent to invoke for the ADF Table component's UpdateComponent
or InsertComponent
table column properties described in ADF Table Component Column Properties.
Table A-9 TreeNodeList Subcomponent Properties
Name | Type | EL | Description |
---|---|---|---|
|
Tree binding attribute or List binding |
Y |
Specify the tree binding attribute or list binding that serves as the parent list of values in a dependent list of values. Note that the tree binding attribute you specify must be associated with a model-driven list. For information about dependent list of values, see Creating Dependent Lists of Values in an Integrated Excel Workbook. |
|
Tree binding attribute |
Y |
Specify the tree binding attribute associated with a model-driven list that defines the values available in the runtime dropdown menu to appear in the ADF Table component's column. |
|
Boolean |
Y |
Always set this property's value to |
The ADF Table component uses the properties and component actions listed here.
Table A-10 lists alphabetically the properties the ADF Table component uses.
Table A-10 ADF Table Component Properties
Name | Type | EL | Description |
---|---|---|---|
|
For information about this property, see Table A-1. |
||
|
This group of properties enables you to configure batch options for the ADF Table component. For information about how you use these properties, see Batch Processing in an ADF Table Component. |
||
|
Integer |
N |
Specifies how many rows to process before an ADF Table component action ( A value for this property is required. |
|
Action binding |
N |
Specify an action binding to invoke when the number of rows specified by |
|
Boolean |
N |
Set this property to |
|
Action binding |
N |
Specify an action binding to invoke at the beginning of each batch. For example, this property might be used for an operation like "start transaction", if required by a particular database. A value for this property is optional. |
|
Boolean |
N |
Set to |
|
An array of columns. For information about the properties that each column in the array supports, see ADF Table Component Column Properties. |
||
|
For information about this property, see Table A-1. |
||
|
For information about this property, see Table A-1. |
||
|
Controls whether and how the columns in the entire table are resized. See Configuring an ADF Table Component to Resize Columns Based on Data at Runtime. |
||
|
This group of properties allows you specify which actions are enabled and can be invoked. |
||
|
Boolean |
N |
When Set to |
|
Method action binding |
N |
Specify a method action binding to invoke when an end user triggers a row refresh by editing a cell in a column that has its By default, no value is set for this property. See Configuring Automatic Row Refresh in an ADF Table Component. |
|
Boolean |
N |
When See Configuring Automatic Row Refresh in an ADF Table Component. |
|
Action binding |
N |
Specify an action binding to invoke for each row flagged for deletion. A value for this property is optional. |
|
Boolean |
N |
Set to A value for this property is required. |
|
Action binding |
N |
Specify an action binding to invoke if failures occur during the processing of rows. A value for this property is optional. |
|
Action binding |
N |
Specify an action binding to invoke for each row inserted using the ADF Table component A value for this property is optional. |
|
Action binding |
N |
Specify an action binding to invoke for each row inserted using the A value for this property is optional. |
|
Boolean |
N |
Set to If you set this property to Typically, a Fusion web application uses the For information about inserting rows in an ADF Table component, see Inserting Data in an ADF Table Component. |
|
Boolean |
N |
Set to The property is ignored if |
|
Action binding |
N |
When configured, this action is invoked to create a temporary row during row-level action set execution for insert rows. |
|
Action binding |
N |
Specify an action binding to invoke for each row updated. A value for this property is optional. |
|
Boolean |
N |
Set to A value for this property is required. |
|
Set values for the Set a value for the |
||
|
Array |
N |
Specify values for the properties in this array to determine the attributes for which data is cached. Each
The table Note: A cached attribute value will override any edits the end user makes to the same attribute binding exposed in a column component. Therefore, you should not configure the same attribute in For information about using the |
|
Attribute Binding |
Y |
Specify an EL expression that evaluates to a row-specific tree attribute binding value. The attribute value is used to determine if a row has been modified by another user since the row was last downloaded to your integrated Excel workbook. See Handling Data Conflicts When Uploading Data from a Workbook. |
|
This group of properties allows you configure the number of rows that the ADF Table component or ADF Read-only Table component download and display. See Limiting the Number of Rows Your Table-Type Component Downloads . |
||
|
Boolean |
N |
Set to A value for this property is required. |
|
Integer |
Y |
Specify an EL expression that evaluates to the maximum number of rows to download. The component evaluates the EL expression when it invokes its Note that setting the value of |
|
String |
Y |
(Optional) Write an EL expression to generate a message to display to the end user if the number of rows available to download exceeds the number specified by You can specify a string key from a custom resource bundle to use, instead of the default value. If desired, you may supply a custom message to replace the default one. Any custom message must contain For information about resource bundles, see Using Resource Bundles in an Integrated Excel Workbook. |
|
Binding |
N |
Specify a tree binding from the current worksheet's page definition file. You must specify a value for this property so that row downloads and uploads function properly. For information about the page definition requirements for an integrated Excel workbook, see Table 4-1. |
|
Attribute binding |
Y |
Specify an EL expression that evaluates to a unique row-specific tree attribute binding value. The value of this attribute is cached in the integrated Excel workbook during the ADF Table component's Note that this value is required only when the underlying tree binding iterator does not expose a key attribute. This value is optional when either of the following conditions is true:
|
Table A-11 describes the properties that a column in the TableColumn array can use.
Table A-11 ADF Table Component Column Properties
Name | Type | EL | Description |
---|---|---|---|
|
For information about this property, see Table A-1. |
||
|
String |
Y |
Write an EL expression that resolves to an Excel style name that is applied to each cell in the column. |
|
String |
Y |
For information about this property, see Table A-1. |
|
Boolean |
N |
Set to |
|
String |
Y |
Write an EL expression that, when evaluated at runtime, displays a label in the column header. |
|
Configure the GroupHeader properties to group together columns that render in an ADF Table component by displaying an extra table header row above the ADF Table component's regular table header row at runtime. See Grouping Columns Together in an ADF Table Component. |
||
|
String |
Y |
Set to |
|
String |
Y |
Write an EL expression that, when evaluated at runtime, displays a label in the grouped header. |
|
String |
Y |
Write an EL expression that resolves to an Excel style name that is applied to each cell in the grouped header. |
|
For information about the tooltip property, see Table A-1. |
||
|
String |
Y |
Write an EL expression that resolves to an Excel style name that is applied to each cell in the column header. |
|
String |
N |
Assign a name to the column to identify it and its purpose. The value that you assign for this property has no functional impact. However, you must specify a value and the value that you specify must be unique within the list of columns. It serves to help you keep track of columns in the ADF Table component. The following IDs are reserved to the default columns in the ADF Table component:
For information about these columns, see Special Columns in the ADF Table Component . |
|
ADF component |
N |
Specifies the properties of the component that represents the binding for insert operations. This component can be one of the following:
When |
|
Boolean |
N |
Set to The default value is |
|
Specifies how ADF Desktop Integration changes the column width at runtime when the See Configuring an ADF Table Component to Resize Columns Based on Data at Runtime. |
||
|
Boolean |
Y |
Set to By default, no value is set for this property. This equals See Configuring Automatic Row Refresh in an ADF Table Component. |
|
ADF component |
N |
Specifies the properties of the component that represents the binding for update and download operations. This component can be one of the following:
|
|
Boolean |
Y |
Write an EL expression that resolves to If you make a column dynamic, the ADF Table component ignores the value of the |
|
Double |
Y |
Specify the width of the column in number of characters. You can specify an EL expression that evaluates to a number or a literal numerical value to determine the width of the column. The value can be a fractional value using a decimal point. A character is the unit of the width. The value is used when See Configuring an ADF Table Component to Resize Columns Based on Data at Runtime. |
Table A-12 describes the component actions available for use with the ADF Table component.
Table A-12 ADF Table Component Actions
Component Action | Description |
---|---|
|
Clears the values of cached attributes for the current row of the ADF Table component. Only a |
|
Invokes a specified action on each of a set of flagged rows in the ADF Table component and then removes these rows from the ADF Table component. The See Deleting ADF Table Component Rows in the Fusion Web Application. |
|
Displays error details for the current row in the ADF Table component if error details are available. This action should only be invoked from a column's action set in an ADF Table component. By default, the |
|
Displays a list of errors that occurred during batch processing. This action is deprecated. It is no longer necessary. All relevant error messages can be viewed using the Status Viewer described in Using the Status Viewer to Report Error Messages to End Users. |
|
Download the rows corresponding to the current state of |
|
Downloads the flagged rows from the tree binding specified by This action applies to the downloaded rows only, and inserted rows are ignored. See Handling Data Conflicts When Uploading Data from a Workbook. |
|
This action is obsolete. See What You May Need to Know About DownloadForInsert Action. |
|
Sets the flag for all rows. Invoke this action to set a flag character in all rows of the
It appears as a solid circle. For information about the |
|
This action performs the following actions:
If the ADF Table component contains pending changes that have not been saved in the integrated Excel workbook, a dialog appears to the end user that allows cancellation of invocation of this action. |
|
Specify this component action to mark all rows in the table as changed in |
|
Specify this component action to clear all flags from the |
|
Resizes the table columns depending on the values of the See Configuring an ADF Table Component to Resize Columns Based on Data at Runtime. |
|
Synchronizes data from the row in the ADF Table component's iterator in the Fusion web application that corresponds to the current worksheet row to the worksheet. As this action acts upon the current worksheet row, only a The ADF Table component does not evaluate or apply the value of a column's |
|
Synchronizes any pending changes in the current worksheet row that the ADF Table component references to the Fusion web application. |
|
It is a variant of |
|
Removes flags from cells in the For information about the |
|
Uploads to the Fusion web application all rows marked as changed for this table. See Uploading Changes from an ADF Table Component . For information about resolving data conflict between the Excel workbook and the Fusion web application, see Handling Data Conflicts When Uploading Data from a Workbook. |
|
Uploads to the Fusion web application all rows marked as changed for this table. Commits successful rows only if none of the rows fail. For information about |
Describes the TreeID
and other properties that the ADF Read-only Table component supports, including the properties that a column in the ReadOnlyColumn
array can use.
The ADF Read-only Table component exposes one action, Download
. This action downloads the current rows in the table identified by the ADF Read-only Table property, TreeID
.
For information about the ADF Read-only Table component, see Creating an ADF Read-Only Table Component.
Table A-13 ADF Read-only Table Component Properties
Name | Type | EL | Description |
---|---|---|---|
|
For information about this property, see Table A-1. |
||
|
Array |
N |
References an array of read-only columns. For information about the properties that a column in this array can support, see Table A-14. |
|
For information about this property, see Table A-1. |
||
|
For information about this property, see Table A-1. |
||
|
For information about this group of properties, see Table A-10. |
||
|
Tree binding |
N |
References a tree binding ID from the page definition file associated with the current worksheet if the ADF Read-only Table component was created by inserting a tree binding into the worksheet. |
Table A-14 lists alphabetically the properties that a column in the ReadOnlyColumn
array can use.
Table A-14 ADF Read-only Table Component Column Properties
Name | Type | EL | Description |
---|---|---|---|
|
For information about this property, see Table A-1. |
||
|
String |
Y |
Write an EL expression that resolves to an Excel style name that is applied to each cell in the column. |
|
String |
Y |
Write an EL expression that resolves to a label for the column header. |
|
String |
Y |
Write an EL expression that resolves to an Excel style name that is applied to each cell in the column header. |
|
String |
N |
Assign a name to the column to identify it and its purpose. The value that you assign for this property has no functional impact. However, you must specify a value and the value that you specify must be unique within the list of columns. It serves to help you keep track of columns in the ADF Read-only Table component. |
|
ADF Component |
For information about the properties that this component supports, see ADF Output Text Component Properties . |
Lists alphabetically the properties that you can configure for an action set.
For information about action sets, see Using Action Sets.
Table A-15 Action Set Properties
Name | Type | EL | Description |
---|---|---|---|
|
This group of properties specifies options for invoking local and remote actions. |
||
|
Boolean |
N |
When set to |
|
Action binding |
N |
Specify the action binding to invoke if an action set does not complete successfully. For example, you could specify an action binding that rolls back changes made during the unsuccessful invocation of the action set. |
|
Boolean | N |
Set to |
|
Action binding |
N |
Specify an action binding to invoke if an action set completes successfully. A value for this property is optional. |
|
Array |
N |
Specifies an ordered array of actions. An action can be one of the following:
|
|
This group of properties determines if and how an alert-style dialog appears to the user to indicate that the action set is complete. The dialog that appears contains one button that allows the user to acknowledge the message and dismiss the dialog. For information about how to display an alert message, see How to Provide an Alert After the Invocation of an Action Set. Many properties in this group make use of EL expressions to retrieve string values from resource bundles. For information about using EL expressions, see Using Resource Bundles in an Integrated Excel Workbook. |
||
|
Boolean |
N |
Set to For information, see How to Provide an Alert After the Invocation of an Action Set. |
|
String |
Y |
(Optional) Specify an EL expression that evaluates to a message to appear in the dialog if errors occur during execution of the action set. |
|
String |
Y |
(Optional) Specify an EL expression that evaluates to a message to appear in the OK button of the dialog. |
|
String |
Y |
(Optional) Specify an EL expression that evaluates to a message to appear in the dialog if no errors occur during the execution of the action set. |
|
String |
Y |
(Optional) Specify an EL expression that evaluates to a message to appear in the title area of the dialog. |
|
For information about |
||
|
String |
Y |
(Optional) Specify an EL expression that evaluates to a message to appear to the end user if the action set fails. A default message appears if you do not specify an EL expression. For information, see How to Configure Error Handling for an Action Set. |
|
This group of properties determines if and how a status message appears during the execution of an action set. For information about how to display a status message, see How to Display a Progress Bar while an Action Set Executes. Many properties in this group make use of EL expressions that reference string keys defined in resource bundles. For information, see Using Resource Bundles in an Integrated Excel Workbook. |
||
|
Boolean |
N |
If For information, see How to Display a Progress Bar while an Action Set Executes. |
|
Boolean |
N |
If |
|
String |
Y |
Specify an EL expression to evaluate and display in the status window while the action set runs. |
|
String |
Y |
Specify an EL expression to evaluate and display in the title area of the status window while the action set runs. |
|
String |
N |
Choose the visual appearance of progress bars. The valid values are |
|
String |
Y |
Specify an optional EL expression or literal value that evaluates to a status message to appear as the associated action progresses. |
Table A-16 lists alphabetically the properties that the Confirmation
action in the array of Actions
of an action set supports. For information about the other properties the array of Actions
and action sets use, see Table A-15.
For information, see How to Invoke a Confirmation Action in an Action Set.
Table A-16 Confirmation Action Properties
Name | Type | EL | Description |
---|---|---|---|
|
(Optional) For information about |
||
|
String |
Y |
(Optional) An EL expression that is evaluated and displayed in the Cancel button at runtime. By default, no value is specified. |
|
String |
Y |
(Optional) An EL expression that is evaluated and displayed in the OK button at runtime. By default, no value is specified. |
|
String |
Y |
(Optional) An EL expression that is evaluated and displayed in the main area of the confirmation dialog at runtime. By default, no value is specified. |
|
String |
Y |
(Optional) An EL expression that is evaluated and displayed in the title area of the confirmation dialog at runtime. By default, no value is specified. |
Table A-17 describes the properties that the Dialog
action in the array of Actions
of an action set supports. For information about the other properties the array of Actions
and action sets use, see Table A-15.
For information about how to use the properties in Table A-17 to invoke a web page from a Fusion web application, see Displaying Web Pages from a Fusion Web Application.
Table A-17 Dialog Action Properties
Name | Type | EL | Description |
---|---|---|---|
|
String |
N |
For information about this property, see Table A-1. |
|
String |
N |
Specify the web page that the action invokes. Relative and absolute URLs are valid values. |
|
Boolean |
N |
Set to |
|
List |
N |
Specifies how the web page the action invokes is rendered. Select:
|
|
String |
Y |
Write an EL expression that resolves to the title of the |
|
Integer |
N |
Specify the initial size in pixels of the dialog that appears to the user. Valid values range from |
Describes the actions that a workbook can invoke.
For information about configuring ribbon commands to invoke these actions, see How to Define a Workbook Ribbon Command for the Runtime Ribbon Tab.
Table A-18 Workbook Actions
Action | Description |
---|---|
|
When invoked, this action creates a new session between the integrated Excel workbook and the Fusion web application. If invoked when a session has already been established, it first invokes the |
|
When invoked, ADF Desktop Integration sends a request to the Fusion web application to invalidate the session between the integrated Excel workbook and the Fusion web application. After invoking this action, the end user must be authenticated the next time the Excel workbook accesses the Fusion web application. |
|
When invoked, this action clears all data entered by the user from cells that reference Oracle ADF bindings. Tables, such as those created by the ADF Table component, will be truncated so that they only display header rows with labels cleared. Values in cells that reference the Input Text or Output Text components are cleared. Column headers and labels are cleared as well. References to all resource bundles that the integrated Excel workbook uses are cleared. Worksheets that do not contain bindings or reference a page definition file remain unchanged. A dialog prompts the end user to confirm invocation of this action. Once the end user confirms invocation, ADF Desktop Integration runs the following events after invocation of the action:
Invocation of the |
|
When invoked, this action launches a dialog that shows the current value of the If the end user chooses to change the value of
|
|
When invoked, this action launches a dialog called About that displays information defined in the |
|
When invoked, this action shows or hides a Status Viewer in Excel's task pane to display status information to end users. The ribbon command that end users click to invoke this action shows and hides the Status Viewer. See Using the Status Viewer to Report Error Messages to End Users. |
Table A-19 lists alphabetically the ADF Desktop Integration properties that an Excel workbook can use.
Table A-19 Workbook Properties
Name | Type | EL | Description |
---|---|---|---|
|
String |
N |
Specify the absolute path to the directory that is the root for the JDeveloper application workspace ( For example, the value of this property in a workbook integrated with the Summit sample application for ADF Desktop Integration could be something similar to the following: D:\Oracle\Applications\Summit_ADFdi ADF Desktop Integration may prompt you to specify a value for this property the first time that you open an integrated Excel workbook. |
|
Boolean |
N |
Set to See Using the Status Viewer to Report Error Messages to End Users. |
|
Array |
N |
An array of name-value pairs of literal string or EL resources expressions (for example, For information about branding your integrated Excel workbook, see Branding Your Integrated Excel Workbook. |
|
Array |
N |
Ensures that workbooks created with a different release of ADF Desktop Integration version that did not include a particular feature do not change their behavior in another release. For information about compatibility properties, see ADF Desktop Integration Compatibility Properties. |
|
Boolean |
N |
Specify whether the workbook is customizable. If For information about enabling customization, see Customizing Workbook Integration Metadata at Runtime. |
|
Integer |
N |
Specify the initial size in pixels of the login dialog that appears to the user. Valid values range from |
|
Array |
N |
An array of workbook parameters that you configure to pass the parameters from a page in a Fusion web application to an integrated Excel workbook. You can define multiple workbook parameters in the Fusion web application's page. Each workbook parameter (parameter that matches a URL argument) that you define in a page must be specified in a Each element in the array supports the following properties:
For information about using this property, see Passing Parameter Values from a Fusion Web Application Page to a Workbook. |
|
String |
N |
Specify the name of a JDeveloper project in the current JDeveloper workspace. ADF Desktop Integration attempts to load the When you open an integrated Excel workbook for the first time in design mode, ADF Desktop Integration searches for a ADF Desktop Integration loads the names of the available projects from the application_name.jws file specified by |
|
String |
N |
Specify the path to the ADF Desktop Integration remote servlet. This path must be relative to the value specified for
|
|
Array |
N |
Specifies an array of resource bundles to register with the workbook. Each element in the array supports the following properties:
|
|
- |
- |
This group of properties defines whether and how a ribbon tab appears in Excel at runtime. The following entries in this table describe the properties in the |
|
String |
N |
For information about this property, see Frequently Used Properties in the ADF Desktop Integration. |
|
Boolean |
N |
If |
|
String |
Y |
Specify an EL expression that evaluates to the title that appears for the ribbon tab in the title area. Excel imposes a maximum limit of 1024 characters for ribbon tab titles. Ensure that the runtime value of the EL expression you specify does not exceed 1024 characters as ADF Desktop Integration truncates the value so that Excel does not generate an error message. If you choose to assign a key tip character using the |
|
Array |
N |
Each element in this array corresponds to a workbook command at runtime. Each element in the array uses the following properties:
|
|
String |
N |
A fully qualified URL to the Fusion web application's root. |
|
String |
N |
Specify the path to the directory that contains the web pages that you intend to use with your integrated Excel workbooks. The value that you specify for the path must be relative to the value of |
|
String |
N |
A unique identifier for the integrated Excel workbook. ADF Desktop Integration generates the unique identifier when you open the workbook for the first time in design mode. The value cannot be modified. However, ADF Desktop Integration can generate a new value if you use the Reset WorkbookID link in the Edit Workbook Properties dialog. The value of this property is used during tamper check, as described in Checking the Integrity of an Integrated Excel Workbook's Metadata. |
Describes the worksheet-level actions that action sets can invoke and the ADF Desktop Integration properties that an Excel worksheet can use.
Action sets, as described in Using Action Sets, can invoke the following worksheet-level actions:
UpSync
Synchronizes any pending changes from the ADF Input Text and ADF List of Values components in the worksheet to the Fusion web application.
DownSync
Downloads data values from the Fusion web application to the ADF Input Text, ADF Output Text, and ADF List of Values components in the worksheet.
DisplayWorksheetErrors
Displays a list of error messages from the most recent action set invocation.
Note:
This action is deprecated. It is no longer necessary. All relevant error messages are available via the Status Viewer, as described in Using the Status Viewer to Report Error Messages to End Users.
When you configure a ribbon command to invoke an action binding or method action binding, the action set to invoke when a user clicks the ribbon command at runtime is populated as follows by default:
UpSync
Action or method action binding that you specify for the ribbon command
DownSync
If the first action that you invoke on a worksheet with an empty form is the UpSync
worksheet action, you may encounter errors. For this reason, ensure that the first action invoked is the DownSync
worksheet action. You can configure the ribbon command's action set or one of the worksheet events (Startup
or Activate
) described in Table A-20 to invoke the DownSync
worksheet action first.
For information about configuring ribbon commands, see Configuring the Runtime Ribbon Tab.
Table A-20 describes the ADF Desktop Integration properties that an Excel worksheet can use.
Table A-20 Worksheet Properties
Name | Type | EL | Description |
---|---|---|---|
|
String |
N |
For information about this property, see Table A-1. |
|
Boolean |
N |
Specifies whether custom attribute properties defined in a view object on the server are supported in EL expressions. The default value of this property is False. See Using ADF Desktop Integration EL-based Properties with Custom Attribute Properties. |
|
Array |
N |
Each element in this array specifies an action set to invoke if the associated worksheet event occurs. For information about action sets, see Action Set Properties. For information about worksheet events, see the entry in this table for The following entries in this table prefaced by Events.n describe the properties that an element in this array supports where n refers to a specific element in the array. |
|
ActionSet |
N |
For information about the properties of action sets, see Action Set Properties . |
|
Boolean |
N |
The default value of this property is When set to |
|
String |
N |
For information about the annotation property, see Table A-1. |
|
List |
N |
The worksheet supports the following events that you can configure to invoke an action set:
Note that the worksheet events complete execution even if the action sets that they invoke fail. For information about worksheet events and action sets, see How to Invoke an Action Set from a Worksheet Event. |
|
List |
N |
The worksheet provides two options:
The default value for this property is |
|
String |
N |
Specify a password to prevent end-users from turning off sheet protection at runtime. The maximum password length allowed by Excel is 255 characters. |
|
Array |
N |
Specify one or more actions that appear as worksheet ribbon commands at runtime. Each command is an element in the
For information about the If you want the See How to Configure a Worksheet Ribbon Command for the Runtime Ribbon Tab. |
|
String |
N |
Specify the page definition file to associate with the worksheet. The fully qualified path to the page definition file must be less than the Windows maximum path length of 260 characters. For information about page definition files, see Working with Page Definition Files for an Integrated Excel Workbook. |
|
Array |
N |
An array of parameters defined in this worksheet's page definition file and bound here to workbook parameters. Each element in the array supports the following properties:
For information about using this property, see Passing Parameter Values from a Fusion Web Application Page to a Workbook. |
|
Set values for the Set a value for the See Using an Integrated Excel Workbook Across Multiple Web Sessions. |
||
|
Array |
N |
Specify values for the properties in this array to determine the attributes for which data is cached. Each
|
|
Binding |
N |
Specify the row-specific attribute of the tree binding used to determine if a row has been modified by another user since the row was last downloaded by to your integrated Excel workbook. See Handling Data Conflicts When Uploading Data from a Workbook. |
|
This group of properties references the attribute bindings that uniquely identify the row displayed in the current worksheet so that you can reestablish server data context across multiple sessions. |
||
|
Array |
N |
Add elements to the
|
|
Binding |
N |
Specifies an attribute binding that uniquely identifies the row displayed in the current worksheet. This property is used at runtime to determine whether the server context has been reestablished properly for non-table type components in the worksheet. |
|
Boolean |
N |
The default value of this property is When set to |
|
Binding |
N |
Specify the A value for this property is optional. If two, or more, worksheets are using the same page definition, the action binding specified for the last worksheet will be invoked. Hence, create a page definition for each worksheet and do not specify a page definition to multiple worksheets. |
|
String |
Y |
Specifies an EL expression that resolves to a string and sets the name of the worksheet. At design time, the EL expression can be of any length and can include the following special characters:
At runtime, the evaluated string can display a maximum of 31 characters and ignores the above special characters. If the length of the evaluated string exceeds 31 characters, the extra characters are truncated and are not displayed. Note that the Ensure that the EL expressions you write for the |
Various ADF Desktop Integration features have been added in different releases of the product. The compatibility properties ensure that workbooks created with ADF Desktop Integration versions that did not include a given feature do not change their behavior.
Table A-21 lists the ADF Desktop Integration compatibility properties. Integrated Excel workbook developers may want to review these properties and the associated feature to determine whether to enable them. To access these properties in your integrated Excel workbook, click Workbook Properties in the Workbook group of the Oracle ADF tab to display the Edit Workbook Properties and expand the Behavior and Compatibility properties.
Table A-21 ADF Desktop Integration Compatibility Properties
Name | Type | EL | Description |
---|---|---|---|
|
Boolean |
N |
Specifies whether ADF Desktop Integration performs data entry validation. See Providing Data Entry Validation for an Integrated Excel Workbook. |
|
Boolean |
N |
Specifies whether ADF Desktop Integration rejects Excel cell error values that integrated Excel workbooks send to the Fusion web application. The default value is See Providing Data Entry Validation for an Integrated Excel Workbook. |
|
Boolean |
N |
Specifies whether the date picker can be used in model-driven columns. See Inserting an ADF Input Date Component and Adding a ModelDrivenColumnComponent Subcomponent to Your ADF Table Component. |
|
Boolean |
N |
Specifies whether model-driven columns can leverage existing Model layer metadata and provide a Search and Select user interface in a picker dialog. See Adding a Model-Driven List Picker to an ADF Table Component. |
|
Boolean |
N |
Specifies whether row-level action sets can manage the server-side model state. |
|
Boolean |
N |
The default value ( |