...
Table of Contents |
---|
isValidKFSCharts(List of kfsChartCode)
This service is used to validate KFS chart codes. Returns an XML result set with a value of true or false (example isValidKFSCharts result) for each chart
Input Specifications
...
Parameter | Description | Required? | Data Type (max length) |
---|---|---|---|
kfsChartCode | The KFS chart of accounts code | Yes | String (2) |
...
DB Query
Code Block |
---|
select distinct 'IR', case when not exists (select * FROM SELECT FIN_COA_CD, FIN_COA_ACTIVE_CD FROM dwhs_ods..ca_chart_tt a where a.fin_coa_cd= 'IR' AND a.FIN_COA_ACTIVE_CD <> 'N' ) then 'false' else 'true' end SELECT FIN_COA_CD, FIN_COA_ACTIVE_CD FROM dwhs_ods..ca_chart_t WHERE fin_coa_cd IN ('IR', 'MCWHERE FIN_COA_ACTIVE_CD <> 'N' AND FIN_COA_CD IN ('IR', 'MC', 'UC', 'XX', 'X', 'I'); |
Result Schema: A list of following element
...
chart code and true or false
...
(ChartValidation.java)
Parameter | Description | Data Type | Example |
---|---|---|---|
kfsChartCode | KFS Chart Code | String (2) | 'IR' |
isValid | Is the Chart Active for that Fiscal Period? | boolean | true |
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:isValidKFSCharts> <!--Zero or more repetitions:--> <kfsChartList> <kfsChartCodeList>IR</kfsChartCodeList> <kfsChartCodeList>MC</kfsChartCodeList><kfsChartCode>UC</kfsChartCode> <kfsChartCodeList>XX</kfsChartCodeList></kfsChartList> <kfsChartList> <kfsChartCodeList>MC</kfsChartCodeList> </adc:isValidKFSCharts> </soapenv:Body> </soapenv:Envelope> |
Response
Code Block |
---|
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <kfsChartCode>IR</kfsChartCode> <soap:Body> <ns2:isValidKFSChartsResponse xmlns:ns2="http://www.adcom.uci.edu"> </kfsChartList> <return> <kfsChartCode>XX</kfsChartCode> <kfsChartList> <valid>false</valid> </return> <kfsChartCode>MC</kfsChartCode> <return> <kfsChartCode>IR<</kfsChartCode>kfsChartList> <valid>true</valid> <kfsChartList> </return> <return> <kfsChartCode>MC<<kfsChartCode>XX</kfsChartCode> <valid>true<</valid>kfsChartList> </return> </ns2adc:isValidKFSChartsResponse>isValidKFSCharts> </soapsoapenv:Body> </soapsoapenv:Envelope> |
...
Response
Code Block |
---|
DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPort();
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:
Parameter | Description | Required? | Data Type (max length) |
---|---|---|---|
kfsChartCodeList | A list of KFS chart of accounts code | Yes | A List of String (2) |
Logic:
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
Parameter | Description | Data Type | Example |
---|---|---|---|
kfsChartCode | KFS Chart Code | String (2) | 'IR' |
kfsChartDescription | KFS Chart Description | String (40) | 'Irvine' |
kfsChartActiveCode | KFS Chart Active Code ('Y' for yes, 'N' for no) | String (1) | 'Y' |
kfsFinCashObjCode | KFS Cash Object Code | String (4) | '0000' |
kfsFinAPObjCode | KFS Accounts Payable Object Code | String (4) | '0000' |
kfsIncBdgtElimObjCode | KFS Income Budget Elimination Object Code | String (4) | '0000' |
kfsExpBdgtElimObjCode | KFS Expense Budget Elimination Object Code | String (4) | '0000' |
kfsRptsToChartCode | KFS Reports to Chart Code | String (2) | 'MC' |
kfsARObjCode | KFS Accounts Receivable Object Code | String (4) | '0000' |
kfsIntEncObjCode | KFS Internal Encumbrances Object Code | String (4) | '0000' |
kfsExtEncObjCode | KFS External Encumbrances Object Code | String (4) | '0000' |
kfsPreEncObjCode | KFS Pre Encumbrances Object Code | String (4) | '0000' |
kfsICRIncObjCode | KFS Indirect Cost Recovery Income Object Code | String (4) | '0000' |
kfsICRExpObjCode | KFS Indirect Cost Recovery Expense Object Code | String (4) | '0000' |
kfsFundBalObjCode | KFS Fund Balance Object Code | String (4) | '0000' |
getAllKFSCharts()
No input parameter, ALL charts will return in result set.
Logic:
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<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:isValidKFSChartsResponse xmlns:ns2="http://www.adcom.uci.edu"> <return> <kfsChartCode>UC</kfsChartCode> <valid>true</valid> </return> <return> <kfsChartCode>XX</kfsChartCode> <valid>false</valid> </return> <return> <kfsChartCode>IR</kfsChartCode> <valid>true</valid> </return> <return> <kfsChartCode>MC</kfsChartCode> <valid>true</valid> </return> </ns2:isValidKFSChartsResponse> </soap:Body> </soap:Envelope> |
Java Client Example
Code Block |
---|
DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPort();
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
Parameter | Description | Required? | Data Type (max length) |
---|---|---|---|
kfsChartCodeList | A list of KFS chart of accounts code | Yes | A List of String (2) |
DB Query
Code Block |
---|
SELECT FIN_COA_CD ,FIN_ARCOA_OBJ_CDDESC ,FIN_INTCOA_ENC_OBJACTIVE_CD ,FIN_EXT_ENCCASH_OBJ_CD ,FIN_PRE_ENCAP_OBJ_CD ,ICRINCBDGT_INC_FIN_OBJELIMOBJ_CD ,EXPBDGT_ELIMOBJ_CD ,ICRRPTS_EXPTO_FIN_OBJCOA_CD ,FNDFIN_BALAR_OBJ_CD FROM ca_chart_t WHERE FIN_COA_ACTIVE_CD <> 'N' |
Result Schema: A list of following element
...
kfsExtEncObjCode
...
,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)
Parameter | Description | Data Type | Example |
---|---|---|---|
kfsChartCode | KFS Chart Code | String (2) | 'IR' |
kfsChartDescription | KFS Chart Description | String (40) | 'Irvine' |
kfsChartActiveCode | KFS Chart Active Code ('Y' for yes, 'N' for no) | String (1) | 'Y' |
kfsFinCashObjCode | KFS Cash Object Code | String (4) | '0000' |
kfsFinAPObjCode | KFS Accounts Payable Object Code | String (4) | '0000' |
kfsIncBdgtElimObjCode | KFS Income Budget Elimination Object Code | String (4) | '0000' |
kfsExpBdgtElimObjCode | KFS Expense Budget Elimination Object Code | String (4) | '0000' |
kfsRptsToChartCode | KFS Reports to Chart Code | String (2) | 'MC' |
kfsARObjCode | KFS Accounts Receivable Object Code | String (4) | '0000' |
kfsIntEncObjCode | KFS Internal Encumbrances Object Code | String (4) | '0000' |
kfsExtEncObjCode | KFS External Encumbrances Object Code | String (4) | '0000' |
kfsPreEncObjCode | KFS Pre Encumbrances Object Code | String (4) | '0000' |
kfsICRIncObjCode | KFS Indirect Cost Recovery Income Object Code | String (4) | '0000' |
kfsICRExpObjCode | KFS Indirect Cost Recovery Expense Object Code | String (4) | '0000' |
kfsFundBalObjCode | KFS Fund Balance Object Code | String (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>
<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>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>
<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.getDWHServerPort();
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(pl0);
System.out.println("\nWSClient--getValidKFSCharts()");
for (Iterator i = resultList1.iterator(); i.hasNext();) {
ChartDetails element = (ChartDetails) i.next();
System.out.println("\t" + element.getKfsChartCode() + ": " + element.getKfsChartDescription());
} |
...
getAllKFSCharts()
No input parameter, ALL charts will return in result set.
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' |
Result Schema: Same as getValidKFSCharts
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:getAllKFSCharts/>
</soapenv:Body>
</soapenv:Envelope> |
Response
Code Block |
---|
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:getAllKFSChartsResponse xmlns:ns2="http://www.adcom.uci.edu">
<return>
<kfsARObjCode>0052</kfsARObjCode>
<kfsChartActiveCode>Y</kfsChartActiveCode>
<kfsChartCode>FD</kfsChartCode>
<kfsChartDescription>Foundation</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>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>
<kfsIntEncObjCode>9998</kfsIntEncObjCode>
<kfsPreEncObjCode>9998</kfsPreEncObjCode>
<kfsRptsToChartCode>UC</kfsRptsToChartCode>
</return>
<return>
<kfsARObjCode>0052</kfsARObjCode>
<kfsChartActiveCode>Y</kfsChartActiveCode>
<kfsChartCode>PL</kfsChartCode>
<kfsChartDescription>Plant</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>SW</kfsChartCode>
<kfsChartDescription>Systemwide</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>UC</kfsChartCode>
<kfsChartDescription>University of California</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>
</ns2:getAllKFSChartsResponse>
</soap:Body>
</soap:Envelope> |
Java Client Example
Code Block |
---|
DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPort();
List<ChartDetails> resultList1 = ds.getAllKFSCharts();
for (Iterator i = resultList1.iterator(); i.hasNext();) {
ChartDetails element = (ChartDetails)i.next();
System.out.println("\t" + element.getKfsChartCode() + ": " + element.getKfsChartDescription());
} |