PCDO Transaction eDoc Technical Specification

Jira Tasks

• KITT-235@Jira

Revision History

Version	Date	User	Description
1.0	03/10/2009	Heather Lo	Initial Spec
1.1	03/19/2009	Heather Lo	Modified Spec, Draft
1.2	03/23/2009	Heather Lo	Modified Spec with Development Steps Taken So Far
1.3	04/02/2009	Heather Lo	Modified Spec with More Development Steps
1.4	04/28/2009	Heather Lo	Modified Spec with More Development Steps
1.5	05/01/2009	Heather Lo	Final Spec
2.0	09/16/2009	Heather Lo	Updated Information

Technical Description

There is currently a PCard transactional document (PCDO) in KFS. Sales Tax Amount and Tax Exempt Indicator both exist in the database for each transaction, and these now need to be displayed on the document level as editable fields for each transaction.

Details

• Database Requirements
  1. None; fields already exist.
• UI Design
  1. "Sales Tax Amount" and "Tax Exempt Indicator" displayed as editable fields on PCDO transactional document.
• Development Checklist
  1. Create system parameter ENABLE_SALES_TAX_AMOUNT_TAX_EXEMPT_IND and store SQL in data.sql (in work/db/scripts/arizona).
  2. Add system parameter to our constants file (kfs/sys/AZKFSConstants.java).
  3. Modify ProcurementCardForm.java appropriately.
  4. Modify procurementCardTransactions.tag (currently Sales Tax Amount and Tax Exempt Indicator are hidden) to check the value of the ENABLE_SALES_TAX_AMOUNT_TAX_EXEMPT_IND to see if we need to display Sales Tax Amount and Tax Exempt Indicator.

Development Steps Completed

1. Created ENABLE_SALES_TAX_AMOUNT_TAX_EXEMPT_IND and added SQL to kfs.work.db.scripts.arizona.data.sql.
   excerpt from kfs/work/db/scripts/arizona/data.sql

   insert into KRNS_PARM_T (NMSPC_CD, PARM_DTL_TYP_CD, PARM_NM, OBJ_ID, VER_NBR, PARM_TYP_CD, TXT, PARM_DESC_TXT, CONS_CD) 
   values ('KFS-FP','Procurement Card','ENABLE_SALES_TAX_AMOUNT_TAX_EXEMPT_IND',SYS_GUID(),1,'CONFG','Y','Indicator whether the Sales tax amount and tax exempt indicator fields should display on the Procurement Card Document.','A');

2. Added system parameter to kfs/sys/AZKFSConstants.java.
   excerpt from kfs/sys/AZKFSConstants.java

   public static final String ENABLE_SALES_TAX_AMOUNT_TAX_EXEMPT_IND = "ENABLE_SALES_TAX_AMOUNT_TAX_EXEMPT_IND";  // for KITT-235

3. Created copy of delivered ProcurementCardForm.java in our trunk in the repository by creating branch of original file and switching to the new branch.
4. Modified ProcurementCardForm.java to include getter method for the ENABLE_SALES_TAX_AMOUNT_TAX_EXEMPT_IND system parameter.
   excerpt from kfs/work/src/org/kuali/kfs/fp/document/web/struts/ProcurementCardForm.java

   ...
   /**
    * Customization for UA Sales Tax Amount and Tax Exempt Indicator.
    * This method returns the value of the ENABLE_SALES_TAX_AMOUNT_TAX_EXEMPT_IND system parameter.
    * @return
   */
   public boolean getEnableSalesTaxIndicator() {
       return SpringContext.getBean(ParameterService.class).getIndicatorParameter(ProcurementCardDocument.class, AZKFSConstants.ENABLE_SALES_TAX_AMOUNT_TAX_EXEMPT_IND);
   }

5. Created copy of delivered procurementCardTransactions.tag in our trunk in the repository by creating branch of original file and switching to the new branch.
6. Modified procurementCardTransactions.tag.
   excerpt from kfs/work/web-root/WEB-INF/tags/fp/procurementCardTransactions.tag

   ...
   <!--code for vendorName-->
   <tr>
      <c:if test="${KualiForm.enableSalesTaxIndicator}">
        <th> <div align="right"><kul:htmlAttributeLabel attributeEntry="${transactionAttributes.transactionSalesTaxAmount}"/></div></th>
        <td valign=top><kul:htmlControlAttribute attributeEntry="${transactionAttributes.transactionSalesTaxAmount}" property="document.transactionEntries[${ctr}].transactionSalesTaxAmount" readOnly="false"/></td>
        <th> <div align="right"><kul:htmlAttributeLabel attributeEntry="${transactionAttributes.transactionTaxExemptIndicator}"/></div></th>
        <td valign=top><kul:htmlControlAttribute attributeEntry="${transactionAttributes.transactionTaxExemptIndicator}" property="document.transactionEntries[${ctr}].transactionTaxExemptIndicator" readOnly="false"/></td>
      </c:if>
      <c:if test="${!KualiForm.enableSalesTaxIndicator}">
        <html:hidden write="false" property="document.transactionEntries[${ctr}].transactionSalesTaxAmount"/>
        <html:hidden write="false" property="document.transactionEntries[${ctr}].transactionTaxExemptIndicator"/>
      </c:if>
   </tr> 
   ...

Updates

• The ENABLE_SALES_TAX_AMOUNT_TAX_EXEMPT_IND has been moved to kfs/work/db/scripts/rsmart/data.sql