Data Views are responsible for providing a unified view of the underlying data for a specific resource type presented by the server.
The data may be stored in one or many external data stores. The Data View uses Store Adapters to interface with the native stores. It also references a DataViewSchema (stored in the Broker Store) which defines the SCIM schema for the exposed resource type.
↓Relations From this Component
↓Relations To this Component
↓Properties
↓dsconfig Usage
The following components have a direct aggregation relation from Data Views:
The following components have a direct aggregation relation to Data Views:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | ↓ lookthrough-limit |
| ↓ enabled | |
| ↓ dataview-schema-name | |
| ↓ store-adapter |
| Description | A description for this Data View |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the Data View is enabled in the server. If a Data View is not enabled, then its contents are not accessible when processing operations. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
dataview-schema-name (Read-Only)
| Description | Specifies a name to identify the associated DataViewSchema. The name must exactly match the "name" attribute for a DataViewSchema that exists in the Broker Store. Typically the name describes the resource type, such as "User" or "Subscriber" for example. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the Store Adapter(s) that will be used to read and write data through this Data View. The order that Store Adapters are defined here is the order that write operations (i.e. CREATE, UPDATE, and DELETE) will be applied. Read operations may take place in any order, depending on the search criteria and Store Attribute Mappings. |
| Default Value | None |
| Allowed Values | The DN of any Store Adapter. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
lookthrough-limit (Advanced Property)
| Description | Specifies the maximum number of resources that the Identity Broker should "look through" in the course of processing a search request. This setting is provided as a way to bound the upper-limit on searches, so that clients do not exhaust the Identity Broker resources. Every search operation requires that the full result set be passed through the policy engine to figure out which subset of resources will be returned. This is also important in order to provide the client with paging information, such as how many total results they are allowed to access. If the number of raw search results for a given request exceeds this value, an error will be returned to the client indicating that the search matched too many results. |
| Default Value | 500 |
| Allowed Values | An integer value. Lower limit is 1. Upper limit is 2147483647 . |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Data Views:
dsconfig list-data-views
[--property {propertyName}] ...
To view the configuration for an existing Data View:
dsconfig get-data-view-prop
--view-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Data View:
dsconfig set-data-view-prop
--view-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Data View:
dsconfig create-data-view
--view-name {name}
--set enabled:{propertyValue}
--set store-adapter:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Data View:
dsconfig delete-data-view
--view-name {name}