SET Validation Technical Specification

Jira Tasks

KITT-360@Jira

Revision History

Version	Date	User	Description
1.0	08/13/2009	Heather Lo	Initial Spec
2.0	08/14/2009	Heather Lo	Spec with Development Steps
2.1	08/28/2009	Heather Lo	Spec with More Development Steps
2.2	08/31/2009	Heather Lo	Spec with Final Development Steps
3.0	11/02/2009	Heather Lo	Spec Including Year-End SET
3.1	11/09/2009	Heather Lo	Spec Including Year-End SET Development Steps
3.2	11/12/2009	Heather Lo	Spec with Final Development Steps for YEST

Technical Description

The Salary Expense Transfer (SET) is used to transfer salary expenses from one account to another. The SET needs to display an Error Certification tab to justify expenses. The fields in the tab are required if one of three conditions are met: 1) if the fiscal period of a transaction is greater than the number of fiscal periods for a federal account, 2) if the fiscal year of a transaction is not in the current fiscal year, or 3) for all other accounts, if the transaction is older than a default number of fiscal periods. Two new system parameters are needed to help control the requirement of data in this tab. Additionally, when any field is completed in this tab, all fields must be completed.

Furthermore, the fiscal officer or delegate must click yes after reading the error certification statement when transferring to the accounts associated with sub-funds specified in the parameter.

All of this also needs to be applied to the year-end salary expense transfer.

Details

Database Requirements
1. Four new system parameters:
  - DEFAULT_NUMBER_OF_FISCAL_PERIODS_ERROR_CERTIFICATION_TAB_REQUIRED and ERROR_CERTIFICATION_DEFAULT_OVERRIDE_BY_SUB_FUND
    - Use parameter component "SalaryExpenseTransfer".
    - Use namespace KFS-LD.
  - DEFAULT_NUMBER_OF_FISCAL_PERIODS_ERROR_CERTIFICATION_TAB_REQUIRED and ERROR_CERTIFICATION_DEFAULT_OVERRIDE_BY_SUB_FUND
    - Use parameter component "YearEndSalaryExpenseTransfer".
    - Use namespace KFS-LD.
2. Add error certification to LD_EXP_TRNFR_DOC_T.
  - Add ERROR_CERT_ID from FP_ERROR_CERT_T as a constraint on the table.
UI Design
1. Error Certification tab
2. Error Certification Statement
Development Checklist
1. Create the four new system parameters.
  - Write SQL to add parameters to database. Add to work/db/scripts/arizona/data.sql.
  - Run SQL in SQuirrel or a similar program.
  - Add constant declarations to edu/arizona/kfs/sys/AZKFSConstants.java.
2. Modify existing SET Document java class to include Error Certification.
  - Create edu.arizona version of SalaryExpenseTransferDocument.java that extends the org.kuali version.
  - Make sure to declare that ErrorCertifiable is being implemented.
  - Include a method that gets/sets an ErrorCertification object.
3. Modify existing SET Form java class to include Error Certification.
  - Create edu.arizona version of SalaryExpenseTransferForm.java that extends the org.kuali version.
  - Create a new ErrorCertification object in our new SET document object in the constructor.
4. Modify work/web-root/WEB-INF/struts-config.xml so that the LaborSalaryExpenseTransferForm references our version of the form.
5. Update the data dictionary.
  - Create edu/arizona/kfs/module/ld/document/datadictionary/SalaryExpenseTransferDocument.xml and redefine the documentClass property to point to our version of SalaryExpenseTransferDocument.java
6. Modify database schema.
  - Write SQL to alter LD_EXP_TRNFR_DOC_T. Add the primary key from FP_ERROR_CERT_T as a table constraint.
  - Run SQL in SQuirrel or a similar program.
  - Add SQL to work/db/scripts/arizona/schema-oracle.sql.
7. Modify edu/arizona/kfs/module/ld/ojb-ld.xml.
  - Define the reference to the error certification business object in the SalaryExpenseTransferDocument business object through a field descriptor and a reference descriptor.
8. Modify edu/arizona version of spring-ld.xml to include our data dictionary packages and ojb mapping.
9. Write code to add Error Certification tab to SET Document.
  - Add new tag reference for errorCertification .tag to kfs/work/web-root/jsp/module/ld/SalaryExpenseTransfer.jsp.
10. Write java class for validation on the Error Certification Tab (SalaryExpenseTransferErrorCertificationValidation.java).
  - Checks the fiscal periods from the source accounting lines, sub funds in the target accounting lines, and the parameters (DEFAULT_NUMBER_OF_FISCAL_PERIODS_ERROR_CERTIFICATION_TAB_REQUIRED and ERROR_CERTIFICATION_DEFAULT_OVERRIDE_BY_SUB_FUND system parameters) to see if the error certification fields are required when the doc is submitted.
11. Add error message for fiscal period & incomplete fields. (Modify edu/arizona/kfs/sys/KFSKeyConstants.java and arizona-ApplicationResources.properties.)
12. Modify the data dictionary to reference the new validations.
  - Modify edu/arizona/kfs/module/ld/document/validation/configuration/SalaryExpenseTransferDocumentValidations.xml. Define validation beans that reference SalaryExpenseTransferErrorCertificationValidation.java and ErrorCertificationValidation.java.
  - List merge the new validations in the SalaryExpenseTransferDocument-routeDocumentValidation bean definition.
13. Add validation to edu/arizona/kfs/fp/spring-ld.xml.
14. Create pre-rules class for the Error Certification Statement. (SalaryExpenseTransferDocumentPreRules.java)
  - Implement the doPrompts method.
  - Examine all of the target accounting lines to compare the sub funds and fiscal periods to the ERROR_CERTIFICATION_DEFAULT_OVERRIDE_BY_SUB_FUND parameter.
  - Check the current route node to check if it is the fiscal officer or delegate.
15. Modify data dictionary (edu/arizona/kfs/module/ld/document/datadictionary/SalaryExpenseTransferDocument.xml) to include pre-rules class.
16. Modify existing year-end SET Document java class to include Error Certification.
  - Create edu.arizona version of YearEndSalaryExpenseTransferDocument.java that extends the edu.arizona version of SalaryExpenseTransferDocument.
17. Modify existing year-end SET Form java class to include Error Certification.
  - Create edu.arizona version of YearEndSalaryExpenseTransferForm.java that extends the edu.arizona version of SalaryExpenseTransferForm.
18. Modify work/web-root/WEB-INF/struts-config.xml so that the LaborYearEndSalaryExpenseTransferForm references our version of the form.
19. Update the data dictionary.
  - Create edu/arizona/kfs/module/ld/document/datadictionary/YearEndSalaryExpenseTransferDocument.xml and redefine the documentClass property to point to our version of YearEndSalaryExpenseTransferDocument.java
20. Modify edu/arizona/kfs/module/ld/ojb-ld.xml.
  - Define the reference to the error certification business object in the YearEndSalaryExpenseTransferDocument business object through a field descriptor and a reference descriptor.
21. Write code to add Error Certification tab to SET Document.
  - Add new tag reference for errorCertification .tag to kfs/work/web-root/jsp/module/ld/YearEndSalaryExpenseTransfer.jsp.
22. Write java class for validation on the Error Certification Tab (YearEndSalaryExpenseTransferErrorCertificationValidation.java).
  - Checks the fiscal periods from the source accounting lines, sub funds in the target accounting lines, and the parameters (DEFAULT_NUMBER_OF_FISCAL_PERIODS_ERROR_CERTIFICATION_TAB_REQUIRED and ERROR_CERTIFICATION_DEFAULT_OVERRIDE_BY_SUB_FUND system parameters) to see if the error certification fields are required when the doc is submitted.
23. Modify the data dictionary to reference the new validations.
  - Create edu/arizona/kfs/module/ld/document/validation/configuration/YearEndSalaryExpenseTransferValidations.xml. Define validation beans that reference YearEndSalaryExpenseTransferErrorCertificationValidation.java and ErrorCertificationValidation.java.
24. Add validation to edu/arizona/kfs/fp/spring-ld.xml.
25. Create pre-rules class for the Error Certification Statement. (YearEndSalaryExpenseTransferDocumentPreRules.java)
  - Implement the doPrompts method.
  - Examine all of the target accounting lines to compare the sub funds and fiscal periods to the ERROR_CERTIFICATION_DEFAULT_OVERRIDE_BY_SUB_FUND parameter.
  - Check the current route node to check if it is the fiscal officer or delegate.
26. Modify data dictionary (edu/arizona/kfs/module/ld/document/datadictionary/YearEndSalaryExpenseTransferDocument.xml ) to include pre-rules class.

Development Steps Completed

Created the two new system parameters.
1. Wrote and added SQL to work/db/scripts/arizona/data.sql. Ran SQL to insert parameters in database.
2. Added constant declaration for parameter to edu/arizona/kfs/sys/AZKFSConstants.java.
Modified existing SET Document java class to include Error Certification.
1. Created edu.arizona version of SalaryExpenseTransferDocument.java that extends the org.kuali version.
2. Added "implements ErrorCertifiable".
3. Included methods that get/set an ErrorCertification object and an Error Certification ID.

Modified existing SET Form java class to include Error Certification.

Created edu.arizona version of SalaryExpenseTransferForm.java that extends the org.kuali version.

Created a new ErrorCertification object in our new SET document object in the constructor.

excerpt from edu/arizona/kfs/module/ld/document/web/struts/SalaryExpenseTransferForm.java

import edu.arizona.kfs.fp.businessobject.ErrorCertification;
import edu.arizona.kfs.module.ld.document.SalaryExpenseTransferDocument;

public class SalaryExpenseTransferForm extends org.kuali.kfs.module.ld.document.web.struts.SalaryExpenseTransferForm {
    public SalaryExpenseTransferForm() {
        super();
        SalaryExpenseTransferDocument document = new SalaryExpenseTransferDocument();
        document.setErrorCertification(new ErrorCertification());
        setDocument(document); 
    }  
}

Modified work/web-root/WEB-INF/struts-config.xml so that the LaborSalaryExpenseTransferForm references our version of the form.
Updated the data dictionary.
1. Created edu/arizona/kfs/module/ld/document/datadictionary/SalaryExpenseTransferDocument.xml and redefine the documentClass property to point to our version of SalaryExpenseTransferDocument.java
Modified database schema.
1. Wrote SQL to alter LD_EXP_TRNFR_DOC_T. Added the primary key from FP_ERROR_CERT_T as a table constraint.
2. Ran SQL in SQuirrel or a similar program.
3. Added SQL to work/db/scripts/arizona/schema-oracle.sql.
Modified edu/arizona/kfs/module/ld/ojb-ld.xml.
1. Modified the class in the class-descriptor to refer to our edu.arizona version of the document.
2. Defined the reference to the error certification business object in the SalaryExpenseTransferDocument business object through a field descriptor and a reference descriptor.
Modified edu/arizona version of spring-ld.xml to include our data dictionary packages and ojb mapping.
Wrote code to add Error Certification tab to SET Document.
1. Add new tag reference for errorCertification .tag to kfs/work/web-root/jsp/module/ld/SalaryExpenseTransfer.jsp.
  excerpt from kfs/work/web-root/jsp/module/ld/SalaryExpenseTransfer.jsp
```
<fp:errorCertification documentAttributes="${DataDictionary.ErrorCertification.attributes}" />
```
Wrote java class for validation on the Error Certification Tab (SalaryExpenseTransferErrorCertificationValidation.java).
1. Checks the fiscal periods from the source accounting lines, sub funds in the target accounting lines if the fiscal period calls for it, and the parameters (DEFAULT_NUMBER_OF_FISCAL_PERIODS_ERROR_CERTIFICATION_TAB_REQUIRED and ERROR_CERTIFICATION_DEFAULT_OVERRIDE_BY_SUB_FUND system parameters) to see if the error certification fields are required when the doc is submitted.
Added error message for fiscal period & incomplete fields. (Modify edu/arizona/kfs/sys/KFSKeyConstants.java and arizona-ApplicationResources.properties.)
Modified the data dictionary to reference the new validations.
1. Modified edu/arizona/kfs/module/ld/document/validation/configuration/SalaryExpenseTransferDocumentValidations.xml. Define validation beans that reference SalaryExpenseTransferErrorCertificationValidation.java and ErrorCertificationValidation.java.
2. List merged the new validations in the SalaryExpenseTransferDocument-routeDocumentValidation bean definition.
Added validation to edu/arizona/kfs/fp/spring-ld.xml.
Created pre-rules class for the Error Certification Statement. (SalaryExpenseTransferDocumentPreRules.java)
1. Implemented the doPrompts method.
2. Examine all of the target accounting lines to compare the sub funds and fiscal periods to the ERROR_CERTIFICATION_DEFAULT_OVERRIDE_BY_SUB_FUND parameter.
3. Check the current route node to check if it is the fiscal officer or delegate.
Modified data dictionary (edu/arizona/kfs/module/ld/document/datadictionary/SalaryExpenseTransferDocument.xml) to include pre-rules class.
Modified existing year-end SET Document java class to include Error Certification.
1. Created edu.arizona version of YearEndSalaryExpenseTransferDocument.java that extends the edu.arizona version of SalaryExpenseTransferDocument.
2. By extending the edu.arizona version, it will inherit the ErrorCertification object.
Modified existing year-end SET Form java class to include Error Certification.
1. Created edu.arizona version of YearEndSalaryExpenseTransferForm.java that extends the edu.arizona version of SalaryExpenseTransferForm.
2. The ErrorCertification object will be set in the YEST document object in the constructor because we extended the edu.arizona version of SETForm.
Modified work/web-root/WEB-INF/struts-config.xml so that the LaborYearEndSalaryExpenseTransferForm references our version of the form.
Updated the data dictionary.
1. Created edu/arizona/kfs/module/ld/document/datadictionary/YearEndSalaryExpenseTransferDocument.xml.
2. Redefined the documentClass property to point to our version of YearEndSalaryExpenseTransferDocument.java
3. Redefined the promptBeforeValidationClass property to reference the SET pre-rules class.
4. Redefined the validations bean (but has the same content as the foundation version).
Modified edu/arizona/kfs/module/ld/ojb-ld.xml.
1. Defined the reference to the error certification business object in the YearEndSalaryExpenseTransferDocument business object through a field descriptor and a reference descriptor.