Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adc="http://www.adcom.uci.edu">
   <soapenv:Header/>
   <soapenv:Body>
      <adc:isValidKFSCharts>
         <!--Zero<kfsChartList>
or more repetitions:-->          <kfsChartCodeList>IR<<kfsChartCode>UC</kfsChartCodeList>kfsChartCode>
         <kfsChartCodeList>MC</kfsChartCodeList></kfsChartList>
         <kfsChartList>
  <kfsChartCodeList>XX</kfsChartCodeList>          <kfsChartCodeList>MC</kfsChartCodeList><kfsChartCode>IR</kfsChartCode>
         </adc:isValidKFSCharts>
kfsChartList>
         <kfsChartList>
  </soapenv:Body> </soapenv:Envelope>
Response
Code Block
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">    <soap:Body>    <kfsChartCode>MC</kfsChartCode>
  <ns2:isValidKFSChartsResponse xmlns:ns2="http://www.adcom.uci.edu">      </kfsChartList>
   <return>      <kfsChartList>
      <kfsChartCode>XX</kfsChartCode>      <kfsChartCode>XX</kfsChartCode>
      <valid>false</valid>   </kfsChartList>
      </return>adc:isValidKFSCharts>
      </soapenv:Body>
</soapenv:Envelope>
Response
Code Block
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <return> <soap:Body>
      <ns2:isValidKFSChartsResponse xmlns:ns2="http://www.adcom.uci.edu">
    <kfsChartCode>IR</kfsChartCode>     <return>
       <valid>true</     <kfsChartCode>UC</kfsChartCode>
            <valid>true</valid>
         </return>
         <return>
            <kfsChartCode>MC<<kfsChartCode>XX</kfsChartCode>
            <valid>true<<valid>false</valid>
         </return>
      </ns2:isValidKFSChartsResponse>   <return>
</soap:Body> </soap:Envelope>

Java Client Example

Code Block
DWHServerService dss = new DWHServerService(); DWHServer ds = dss.getDWHServerPortCustom();   List<ChartValidation> resultList0 = ds.isValidKFSCharts(Arrays.asList(new String[]{"IR", "MC", "XX"}));
for (Iterator i = resultList0.iterator(); i.hasNext();) {
	ChartValidation element = (ChartValidation)i.next();
	System.out.println("\t" + element.getKfsChartCode() + ": " + element.isValid());
}

 

getValidKFSCharts(List of kfsChartCode)

This service is used retrieve valid KFS chart codes and related attributes. Returns an XML result set with a list of charts (example getAllValidKFSCharts result). 

Input Specifications

ParameterDescriptionRequired?Data Type (max length)
kfsChartCodeListA list of KFS chart of accounts codeYesA List of String (2)

DB Query

Code Block
SELECT FIN_COA_CD<kfsChartCode>IR</kfsChartCode>
            <valid>true</valid>
         </return>
         <return>
            <kfsChartCode>MC</kfsChartCode>
        ,FIN_COA_DESC    <valid>true</valid>
  ,FIN_COA_ACTIVE_CD       ,FIN_CASH_OBJ_CD</return>
      ,FIN_AP_OBJ_CD</ns2:isValidKFSChartsResponse>
   </soap:Body>
</soap:Envelope>

Java Client Example

Code Block
DWHServerService dss  ,INCBDGT_ELIMOBJ_CD
      ,EXPBDGT_ELIMOBJ_CD
      ,RPTS_TO_FIN_COA_CD
      ,FIN_AR_OBJ_CD
      ,FIN_INT_ENC_OBJ_CD
      ,FIN_EXT_ENC_OBJ_CD
      ,FIN_PRE_ENC_OBJ_CD
      ,ICR_INC_FIN_OBJ_CD
      ,ICR_EXP_FIN_OBJ_CD
      ,FND_BAL_OBJ_CD
  FROM ca_chart_t
WHERE FIN_COA_ACTIVE_CD <> 'N' 
AND FIN_COA_CD IN ('<kfsChartCode1>', '<kfsChartCode2>', etc)

Result Schema: A list of following element (ChartDetails.java)

ParameterDescriptionData TypeExample
kfsChartCodeKFS Chart CodeString (2)'IR'
kfsChartDescriptionKFS Chart DescriptionString (40)'Irvine'
kfsChartActiveCodeKFS Chart Active Code ('Y' for yes, 'N' for no)String (1)'Y'
kfsFinCashObjCodeKFS Cash Object CodeString (4)'0000'
kfsFinAPObjCodeKFS Accounts Payable Object CodeString (4)'0000'
kfsIncBdgtElimObjCodeKFS Income Budget Elimination Object CodeString (4)'0000'
kfsExpBdgtElimObjCodeKFS Expense Budget Elimination Object CodeString (4)'0000'
kfsRptsToChartCodeKFS Reports to Chart CodeString (2)'MC'
kfsARObjCodeKFS Accounts Receivable Object CodeString (4)'0000'
kfsIntEncObjCodeKFS Internal Encumbrances Object CodeString (4)'0000'

kfsExtEncObjCode

KFS External Encumbrances Object CodeString (4)'0000'
kfsPreEncObjCodeKFS Pre Encumbrances Object CodeString (4)'0000'
kfsICRIncObjCodeKFS Indirect Cost Recovery Income Object CodeString (4)'0000'
kfsICRExpObjCodeKFS Indirect Cost Recovery Expense Object CodeString (4)'0000'
kfsFundBalObjCodeKFS Fund Balance Object CodeString (4)'0000'

WS Example

Request
Code Block
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adc="http://www.adcom.uci.edu">
   <soapenv:Header/>
   <soapenv:Body>
      <adc:getValidKFSCharts>= new DWHServerService();
DWHServer ds = dss.getDWHServerPortCustom();
 
ArrayList<ChartParameters> pl0 = new ArrayList<ChartParameters>();
ChartParameters cp01 = new ChartParameters();
cp01.setKfsChartCode("UC");
ChartParameters cp02 = new ChartParameters();
cp02.setKfsChartCode("MC");
ChartParameters cp03 = new ChartParameters();
cp03.setKfsChartCode("IR");
ChartParameters cp04 = new ChartParameters();
cp04.setKfsChartCode("XX");
ChartParameters cp05 = new ChartParameters();
cp05.setKfsChartCode("X");
ChartParameters cp06 = new ChartParameters();
cp06.setKfsChartCode("I");
pl0.add(cp01);
pl0.add(cp02);
pl0.add(cp03);
pl0.add(cp04);
pl0.add(cp05);
pl0.add(cp06);
List<ChartValidation> resultList0 = ds.isValidKFSCharts(pl0);
System.out.println("\nWSClient--isValidKFSCharts()");
for (Iterator i = resultList0.iterator(); i.hasNext();) {
	ChartValidation element = (ChartValidation)i.next();
	System.out.println("\t" + element.getKfsChartCode() + ": " + element.isValid());
}

 

...

getValidKFSCharts(List of kfsChartCode)

This service is used retrieve valid KFS chart codes and related attributes. Returns an XML result set with a list of charts (example getAllValidKFSCharts result). 

Input Specifications

ParameterDescriptionRequired?Data Type (max length)
kfsChartCodeListA list of KFS chart of accounts codeYesA List of String (2)

DB Query

Code Block
SELECT FIN_COA_CD
      ,FIN_COA_DESC
      ,FIN_COA_ACTIVE_CD
      ,FIN_CASH_OBJ_CD
      ,FIN_AP_OBJ_CD
      ,INCBDGT_ELIMOBJ_CD
      ,EXPBDGT_ELIMOBJ_CD
      ,RPTS_TO_FIN_COA_CD
      ,FIN_AR_OBJ_CD
      ,FIN_INT_ENC_OBJ_CD
      ,FIN_EXT_ENC_OBJ_CD
      ,FIN_PRE_ENC_OBJ_CD
      ,ICR_INC_FIN_OBJ_CD
      ,ICR_EXP_FIN_OBJ_CD
      ,FND_BAL_OBJ_CD
  FROM ca_chart_t
WHERE FIN_COA_ACTIVE_CD <> 'N' 
AND FIN_COA_CD IN ('<kfsChartCode1>', '<kfsChartCode2>', etc)

Result Schema: A list of following element (ChartDetails.java)

ParameterDescriptionData TypeExample
kfsChartCodeKFS Chart CodeString (2)'IR'
kfsChartDescriptionKFS Chart DescriptionString (40)'Irvine'
kfsChartActiveCodeKFS Chart Active Code ('Y' for yes, 'N' for no)String (1)'Y'
kfsFinCashObjCodeKFS Cash Object CodeString (4)'0000'
kfsFinAPObjCodeKFS Accounts Payable Object CodeString (4)'0000'
kfsIncBdgtElimObjCodeKFS Income Budget Elimination Object CodeString (4)'0000'
kfsExpBdgtElimObjCodeKFS Expense Budget Elimination Object CodeString (4)'0000'
kfsRptsToChartCodeKFS Reports to Chart CodeString (2)'MC'
kfsARObjCodeKFS Accounts Receivable Object CodeString (4)'0000'
kfsIntEncObjCodeKFS Internal Encumbrances Object CodeString (4)'0000'

kfsExtEncObjCode

KFS External Encumbrances Object CodeString (4)'0000'
kfsPreEncObjCodeKFS Pre Encumbrances Object CodeString (4)'0000'
kfsICRIncObjCodeKFS Indirect Cost Recovery Income Object CodeString (4)'0000'
kfsICRExpObjCodeKFS Indirect Cost Recovery Expense Object CodeString (4)'0000'
kfsFundBalObjCodeKFS Fund Balance Object CodeString (4)'0000'

WS Example

Request
Code Block
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adc="http://www.adcom.uci.edu">
   <soapenv:Header/>
   <soapenv:Body>
      <adc:getValidKFSCharts>
         <kfsChartList>
            <kfsChartCode>UC</kfsChartCode>
         </kfsChartList>
         <kfsChartList>
            <kfsChartCode>IR</kfsChartCode>
         </kfsChartList>
         <kfsChartList>
            <kfsChartCode>MC</kfsChartCode>
         </kfsChartList>
         <kfsChartList>
            <kfsChartCode>XX</kfsChartCode>
         </kfsChartList>
      </adc:getValidKFSCharts>
   </soapenv:Body>
</soapenv:Envelope>
Response
Code Block
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:getValidKFSChartsResponse xmlns:ns2="http://www.adcom.uci.edu">
         <return>
            <kfsARObjCode>0052</kfsARObjCode>
            <kfsChartActiveCode>Y</kfsChartActiveCode>
            <kfsChartCode>UC</kfsChartCode>
            <kfsChartDescription>University of California</kfsChartDescription>
            <kfsExtEncObjCode>9998</kfsExtEncObjCode>
            <kfsFinAPObjCode>0051</kfsFinAPObjCode>
            <kfsFinCashObjCode>CASH</kfsFinCashObjCode>
            <!--Zero or more repetitions:--><kfsFundBalObjCode>0000</kfsFundBalObjCode>
            <kfsChartCodeList>IR</kfsChartCodeList><kfsICRExpObjCode>3800</kfsICRExpObjCode>
            <kfsChartCodeList>MC</kfsChartCodeList><kfsICRIncObjCode>3800</kfsICRIncObjCode>
            <kfsChartCodeList>MC</kfsChartCodeList><kfsIntEncObjCode>9998</kfsIntEncObjCode>
            </adc:getValidKFSCharts><kfsPreEncObjCode>9998</kfsPreEncObjCode>
        </soapenv:Body> </soapenv:Envelope>
Response
Code Block
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  <kfsRptsToChartCode>UC</kfsRptsToChartCode>
 <soap:Body>       <ns2:getValidKFSChartsResponse xmlns:ns2="http://www.adcom.uci.edu"> </return>
         <return>
            <kfsARObjCode>0052</kfsARObjCode>
            <kfsChartActiveCode>Y</kfsChartActiveCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsChartDescription>UC Irvine</kfsChartDescription>
            <kfsExtEncObjCode>9998</kfsExtEncObjCode>
            <kfsFinAPObjCode>0051</kfsFinAPObjCode>
            <kfsFinCashObjCode>CASH</kfsFinCashObjCode>
            <kfsFundBalObjCode>0000</kfsFundBalObjCode>
            <kfsICRExpObjCode>3800</kfsICRExpObjCode>
            <kfsICRIncObjCode>3800</kfsICRIncObjCode>
            <kfsIntEncObjCode>9998</kfsIntEncObjCode>
            <kfsPreEncObjCode>9998</kfsPreEncObjCode>
            <kfsRptsToChartCode>UC</kfsRptsToChartCode>
         </return>
         <return>
            <kfsARObjCode>0052</kfsARObjCode>
            <kfsChartActiveCode>Y</kfsChartActiveCode>
            <kfsChartCode>MC</kfsChartCode>
            <kfsChartDescription>Medical Center</kfsChartDescription>
            <kfsExtEncObjCode>9998</kfsExtEncObjCode>
            <kfsFinAPObjCode>0051</kfsFinAPObjCode>
            <kfsFinCashObjCode>CASH</kfsFinCashObjCode>
            <kfsFundBalObjCode>0000</kfsFundBalObjCode>
            <kfsICRExpObjCode>3800</kfsICRExpObjCode>
            <kfsICRIncObjCode>3800</kfsICRIncObjCode>kfsICRIncObjCode>
            <kfsIntEncObjCode>9998</kfsIntEncObjCode>
            <kfsPreEncObjCode>9998</kfsPreEncObjCode>
            <kfsRptsToChartCode>UC</kfsRptsToChartCode>
         </return>
      </ns2:getValidKFSChartsResponse>
   </soap:Body>
</soap:Envelope>

Java Client Example

Code Block
DWHServerService dss =  <kfsIntEncObjCode>9998</kfsIntEncObjCode>
            <kfsPreEncObjCode>9998</kfsPreEncObjCode>
            <kfsRptsToChartCode>UC</kfsRptsToChartCode>
         </return>
      </ns2:getValidKFSChartsResponse>
   </soap:Body>
</soap:Envelope>

Java Client Example

Code Block
DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPortCustom();
 
List<ChartDetails> resultListnew DWHServerService();
DWHServer ds = dss.getDWHServerPortCustom();
ArrayList<ChartParameters> pl0 = new ArrayList<ChartParameters>();
ChartParameters cp01 = new ChartParameters();
cp01.setKfsChartCode("UC");
ChartParameters cp02 = new ChartParameters();
cp02.setKfsChartCode("MC");
ChartParameters cp03 = new ChartParameters();
cp03.setKfsChartCode("IR");
ChartParameters cp04 = new ChartParameters();
cp04.setKfsChartCode("XX");
ChartParameters cp05 = new ChartParameters();
cp05.setKfsChartCode("X");
ChartParameters cp06 = new ChartParameters();
cp06.setKfsChartCode("I");
pl0.add(cp01);
pl0.add(cp02);
pl0.add(cp03);
pl0.add(cp04);
pl0.add(cp05);
pl0.add(cp06);

List<ChartDetails> resultList1 = ds.getValidKFSCharts(Arrays.asList(new String[]{"IR", "MC", "XX"})pl0);
System.out.println("\nWSClient--getValidKFSCharts()");
for (Iterator i = resultListresultList1.iterator(); i.hasNext();) {
	ChartDetails element = (ChartDetails) i.next();
	System.out.println("\t" + element.getKfsChartCode() + ": " + element.getKfsChartDescription());
}

...