Flags
On the first several Configuration subtabs, each property group and individual property can have three flags associated with it. The names of the flags are also listed as they appear on the Text tab.
• Data sources must specify value—(On Text tab, value_required_for_datasource) This flag specifies whether to require that individual data sources specify a value for this property. If the value is True, the property will appear in the data source UI on the Info tab and will be required.
• Data sources may override value—(On Text tab, value_overridable_by_datasource) If this flag is True, this means that the adapter sets the value of this property, but individual data sources can optionally override that value for themselves.
• Display property in data source UI—(On Text tab, display_in_ui) This flag controls whether properties can be seen in the data source UI, and on which tab:
— For required properties (Data sources must specify value is True) this flag will always be True, because required properties must be visible.
— For properties that are neither required nor overrideable by data sources, this flag will be assumed to be False, because read-only properties should not appear in the data source UI.
— If a property is overrideable (Data sources may override value = True) and this flag is True, the property will appear in the data source UI on the Info tab (along with required properties), but the value will not be required.
— If a property is overrideable and this flag is False, the property will not appear on the Info tab, but it will be available for selection in the search box on the Overrides tab of the data source UI.
The display is different for group-level flags and individual property flags. Group-level flags appear as check boxes at the top of each Configuration subtab.
Individual property flags are set from drop-down lists. Setting for these flags to Group default causes them to take their values (true/checked or false/unchecked) from the corresponding group-level flags at the top of the subtab.
Example
On the String Comparison subtab, the “String comparison is case-insensitive” property starts out with these flag values:
• Data sources must specify value—True
• Data sources may override value—Group default
• Display property in data source UI—True
The group-level flags (above the collection of properties) for the String Comparison group have these values:
• Data sources must specify value—False (unchecked)
• Data sources may override value—True (checked)
• Display property in data source UI—False (unchecked)
Because individual property flags override group-level flags, the resulting flag values for the “String comparison is case-insensitive” property are:
• Data sources must specify value—True
• Data sources may override value—True
• Display property in data source UI—True
On the Info tab for a data source instance that uses this extension adapter, the “String comparison is case-insensitive property” is available on the Basic subtab, where the user can override the adapter’s value.
Flag Combinations
The comments describe what happens for each combination of flag settings for a given property.
Data sources... | Comments |
Must specify a value | May override the value | Display
in UI |
False | False | False | Property value can only be specified by the adapter. Does not appear anywhere in data source UI. |
False | False | True | Same as the previous combination; the value of the third flag is ignored. Saving an adapter configuration with this combination results in a message warning that this property will not appear in data source UI. |
False | True | False | Property is available for selection from the search box on the Overrides tab of data source UI. |
False | True | True | Appears on the Info tab of data source UI as an optional property. |
True | False | False | Saving an adapter configuration with this combination results in a message warning that “display in UI” flag for this property will be changed to True. Property will appear on the Info tab as a required property. |
True | False | True | Appears on the Info tab as a required property. |
True | True | False | Saving an adapter configuration with this combination results in a message warning that "display in UI" flag for this property will be changed to True. Property will appear on the Info tab as a required property. |
True | True | True | Appears on the Info tab as a required property. |