Content Comparison

Document Types

• New document names should be consistent with existing KFS documents (e.g., use hyphen for name like Sub-Account)
• Do not use Kuali in the name.
• Do not use the module in the name. (Unless needed to differentiate from a similar object in another module.)
• Do not abbreviate.
• Business object and document class names must be unique across the system.
• Look for naming conflicts and draw the document type approvers attention to them.
• THIS NEEDS UPDATING When you are adding a document type, a help parameter needs to be created to match. You do not need to specify a value. You need to create a jira in the KFS Documentation Feedback queue to ask the help folks to create the help and update the param with the correct value (Issue Type: Other / Component: Online Help). These parameters require approval like any others. Standard is that the name should match the component with the following changes: replace camel caps with underscores, and capitalize all letters. The same guidelines go for renaming of document types. Make sure the doc type table, the workflow doc type definition, and the help parameter are updated and old data is cleaned up. When you are making significant modifications to a document type, you are responsible for notifying the help team via the KFS Documentation Feedback queue.
• Transactional Document Types
  • Should be child of workflow document type parent for module
  • Java document class name = document data dictionary entry name and ends with "Document", e.g. TransferOfFundsDocument
  • Label in document data dictionary entry = label in workflow document type = link in portal and is the class name minus the "Document" suffix and with spaces between the words, e.g. Transfer Of Funds
    
• Maintenance Document Types
  • Two potential parents
    • Complex Maintenance Documents: Generally are maintainable by most users and route for review. 
    • Simple Maintenance Documents: Generally are maintained by Central Admin and do not route.
  • Java business object class name = business object data dictionary entry name
  • Document data dictionary entry name = workflow document type name and is business object name and ends with "MaintenanceDocument", e.g. ObjectCodeMaintenanceDocument
  • Object label in the business object data dictionary entry = label in document data dictionary entry = label in workflow document type = link in portal and is the business object class name minus the "MaintenanceDocument" suffix and with spaces between the words, e.g. Object Code

...