System Admin - Data Dictionary Override

Data Dictionary Override Feature

Related Parameter(s): DATA_DICTIONARY_RUNTIME_OVERRIDE

The Data Dictionary Override is a powerful feature that allows a user with the appropriate technical knowledge to modify the display of field labels and other aspects of screen display without a direct modification to the base code.

Using the Data Dictionary Override to make a change:

• Prepare an XML file (Kuali can advise on the correct structure of the file, based on the change the user would like to make).
• Select System Admin > System Admin > Miscellaneous: Data Dictionary Override.
• Select Create New.
• Enter a description for the maintenance document.
• Use the Override Beans File field to upload your XML file.
• Use the Active indicator to indicate whether the change you’d like to make should be active at this time.
• Click Submit.

Your change will be active in the application either immediately or upon the next server restart. This is governed by the parameter DATA_DICTIONARY_RUNTIME_OVERRIDE. If the parameter is set to ‘Y’ then the DD override changes are applied immediately when the document is finalized. If it is set to ’N’ then they are applied on the next server restart.  It's recommended to set this parameter to N as default when not needing to apply a DD override immediately since it can cause some performance lags.

Using the Data Dictionary Override to view or inactivate past changes:

• Select System Admin > System Admin > Miscellaneous: Data Dictionary Override.
• Use the search screen to search for the maintenance document you wish to locate.
• Click Edit to open the document and view the XML file previously uploaded.
• Use the active indicator to deactivate the change, if needed.
• Click Submit.

Caution! 

This is a very powerful feature, and should only be used by a technical resource familiar with XML, Spring Beans, and the structure of the Kuali Research application. If you’d like more information or guidance on how to make a change to the display of your application, please submit a support request to Kuali for assistance.

Notes

• The Data Dictionary In Use feature allows you to view current data dictionary XML files prior to update/edit.  See Data Dictionary In Use article for more information on this functionality
• Oracle users - if seeing a STE upon search you may need to set the RESULTS_DISTINCT parameter to 'N' to clear.
• Recommend always testing changes in a non production environment first before thinking about deploying to a PRD instance.
• Please reach out to us for more information or if you have any questions around these types of changes.

Best Practices for Using the Data Dictionary Override 

As a best practice, always include only the specific beans that need to be overridden when uploading Data Dictionary Override files. Uploading the entire XML file can introduce risks, such as hardcoding data, which may lead to unintended issues or unexpected behavior across the application. Additional best practices include: 

• Always test changes in a non-production environment before applying them to production. 
• The DATA_DICTIONARY_RUNTIME_OVERRIDE parameter is set to N by default so changes apply on the next server restart rather than immediately; if immediate application is needed, temporarily change the parameter to Y to apply the changes right before uploading the updated XML, and then set it back to N. 
• Document each override clearly, including the purpose, the specific beans modified, who implemented the change, when it was applied, and the filename of the uploaded XML. 
• Restrict access to the Data Dictionary Override feature to technical team members familiar with XML, Spring Beans, and the Kuali Research application. 
• Coordinate with Kuali Support when making significant or nonstandard changes to ensure proper implementation and avoid unforeseen issues. 
• Monitor the system closely after applying overrides to catch any unintended impacts or performance issues early.