Version:

QueryViewSpec Attributes

The following attributes are available within the root QueryViewSpec element on query view specs.

Attribute Value Description
xmlns bb_appfx_queryview The xmlns determines what tags are available.
xmlns:common bb_appfx_commontypes Reference common tools for the SDK.
ID Unique GUID Required. The database ID to use for this item in the catalog table.
Name String Required. A friendly name to use when displaying this item in the catalog browser.
Description String Required. A description of this catalog item.
Author String Required. The author of this catalog item.
AllowAttributeExtension Boolean Optional. Indicates that extension fields should be added to the query view for new attributes with the same record type.
EnforcedRecordAccessSecurity Boolean Optional. For query views that should have record level security enforced this should be set to true. Note that this marker is only an indication that this view is eligible for record level security. Actual enforcement is dependent on the record security modules that are enabled and the filter clauses that they generate for this view.
IsBuiltIn Boolean Optional. Default value = "false". Indicates whether the view represents a standard query view defined by Blackbaud, or if it represents a user-defined customization. It is important to set this field correctly to avoid conflicts with future updates from Blackbaud.
IsRoot Boolean Optional. Default value = "false." Indicates whether this view represents a 'root' query view that uses a top-level area, such as Constituents or Events, as the starting point for the custom query view.
MartKey String Optional. Indicates where all the SQL objects defined in ViewImplementation and TVFImplementation are created. When no option is specified the SQL objects are created in the application database; otherwise, they are created in the OLAP data source provided.
PrimaryKeyField String Optional. Indicates the primary key of the view.
RecordType String Optional. Indicates the record type, which governs how the query can be used as input to other processes in the system.
SecurityUIDisplayFeature Boolean Optional. Indicates whether to show this feature in the security configuration UI. Usually turned off for features that use implied security such as batch data forms.
common:SecurityUIFolder String Optional. The name of the folder to present this feature in the security configuration UI. The folder name has no bearing on the evaluation of security, it is just used to help organize the security configuration UI.
SubGroup String Optional. Creates a sub-group under the current query view's parent in which other child query views can be placed for organization.
UseForExportDefinitionsOnly Boolean Optional. Default value = "false". Indicates whether this query view will be available in the query tree for anything other than export definitions. When set to "true", the query view will show up only for use in export definitions.
UseInReportModelGenerator Boolean Optional. Default value = "false". Indicates whether this query view can be used to create a report model. When set to "true", the Output element must contain an IdentifyingFields element with one or more identifying fields.