Export Schema (Sun Identity Manager Deployment Guide)

Sun Identity Manager Deployment Guide

Export Schema

The export schema defines what data can be written to the warehouse. By default, it is limited to a subset of the ObjectClass schema, although the difference between the two is very small. The ObjectClass schema is represented by Java objects, but the export schema must have a bi-directional mapping between Java objects and RDBMS tables.

After you have added an extended attribute to the IDMSchemaConfiguration object, you must define the same attribute in the export schema, which is defined in the $WSHOME/model-export.xml file. Locate the Role or User model in this file and add a field element that defines the attribute. The field element can contain the following parameters.

Table 5–2 Export attribute parameters


Parameter	Description
name	The name of the attribute. This value must match the name assigned in the `IDMSchemaConfiguration` object.
type	The data type of the attribute. You must specify the full Java class name, such as `java.lang.String` or `java.util.List`.
introduced	Optional. Specifies the release that the attribute was added to the schema.
friendlyName	The label that is displayed on the Data Exporter configuration pages.
elementType	If the `type` parameter is `java.util.List`, then this parameter specifies the data type of the items in the list. Common values include `java.lang.String` and `com.sun.idm.object.ReferenceBean`.
referenceType	If the `elementType` parameter is `com.sun.idm.object.ReferenceBean`, then this parameter references to another Identity Manager object or pseudo-object.
forensic	Indicates the attribute is used to determine relationships. Possible values are `User` and `Role`.
exported	When set to false, the attribute is not exported. If you want to hide a default attribute from the Data Exporter data type configuration page, add `exported=’false’` to the attribute definition. You must create a custom WIC library to be able to export an attribute in the default schema that has exporting disabled.
queryable	When set to false, the field is not available for forensic queries.
max-length	The maximum length of a value.

The following example adds an extended attribute named telno to the export schema as part of the User model:

<field name=’telno’
    type=’java.lang.String’
    introduced=’8.0’
   max-length=’20’
   friendlyName=’Telephone Number’>
   <description>The phone number assigned to the user.</description>
</field>