NetIQ does not recommend that you document all Identity Vault schemas unless you need to.
The defaults for Identity Vault schemas have been changed to include custom schemas and any modified changes to the Identity Vault base schema. For application schemas, Designer includes all schemas by default. However, these can be turned off.
Select the Appendix B: Schema heading the in the Style Editor view. This brings up the Appendix B section template in the right side of the Style Editor view.
Figure 12-1 The Appendix B: Schema Section Template
The Appendix B: Schema section has three selections:
Include this section. The Include this section in the final documentation check box allows you to include or not include Appendix B information in the documentation. By default, the box is selected to include this information. Deselect the check box if you do not want to include application or Identity Vault schemas in the document.
Document Custom and Imported Identity Vault Schema. By default, the Identity Vault Schema to be documented selected documents any schema that you import from the Identity Vault or that you create. The choices are Document custom or imported schema, or None.
Document all Application Schema. By default, the Application schema to be documented selection includes all of the application schema. The choices are Document all schema elements, or None.
The Project Configuration heading allows you to include or deselect information on:
Identity Vault
Driver Sets
Drivers
General
The following table shows what type of information can be included or excluded in these areas.
Table 12-1 Project Configuration
Identity Vault |
Information to Select or Deselect |
---|---|
Selected |
Include host information |
Selected |
Include username information |
Selected |
Include deployment context information |
Selected |
Include driver set names |
Selected |
Include policy library on Identity Vaults |
Deselected |
Include e-mail notification templates |
Deselected |
Include XML source while documenting policies under the policy library |
Deselected |
Include XML source while documenting credential provisioning objects under the policy library |
Deselected |
Include XML source while documenting mapping table objects under the policy library |
Driver Set |
Information to select or deselect |
Selected |
Include server information associated with the driver set |
Selected |
Include driver set Global Configuration Value (GCV) |
Selected |
Include the policy library on driver sets |
Selected |
Include job objects on driver sets |
Deselected |
Include the XML source for policies under the policy library |
Deselected |
Include the XML source for credential provisioning objects under the policy library |
Deselected |
Include the XML source for mapping table objects under the policy library |
Deselected |
Include the XML source for job objects |
Driver |
Information to select or deselect |
Selected |
Include the driver filter policy |
Selected |
Include policy set |
Selected |
Include server-specific information for this driver |
Selected |
Include Remote Loader configuration |
Selected |
Include entitlements |
Selected |
Include credential provisioning |
Selected |
Include mapping table |
Selected |
Include ECMAScript resource object |
Selected |
Include job objects |
Deselected |
Include the XML source when documenting entitlement objects |
Deselected |
Include the XML source when documenting credential provisioning objects |
Deselected |
Include the XML source when documenting mapping table objects |
Deselected |
Include the XML source when documenting job objects |
General |
Information to select or deselect |
Deselected |
Include passwords |
Selected |
Page break after this section |
IMPORTANT:Credential provisioning for the XML source might contain passwords that are displayed in clear text. If this option is selected, passwords are displayed in clear text and the documentation includes all passwords in the project.