isValidKFSObjects(List of (kfsFiscalYear, kfsChartCode, kfsObjectCode))
This service is used to validate KFS object codes. Returns an XML result set with a value of true or false (example isValidKFSCharts result) for each chart
Index | Parameter | Description | Required? | Data Type (max length) |
---|
0 | kfsFiscalYear | The KFS Fiscal Year (e.g. 2013) | Yes | String (4) |
1 | kfsChartCode | The KFS chart code | Yes | String (2) |
2 | kfsObjCode | The KFS object code | Yes | String (4) |
DB Query:
Code Block |
---|
OLD:
SELECT UNIV_FISCAL_YR, FIN_COA_CD, FIN_OBJECT_CD FROM dwhs_ods..ca_object_code_t WHERE UNIV_FISCAL_YR in ('2012') and fin_coa_cd IN ('IR', 'MC') and FIN_OBJECT_CD IN ('CASH');
NEW:
SELECT CONVERT(varchar(4),UNIV_FISCAL_YR) AS UNIV_FISCAL_YR, FIN_COA_CD, FIN_OBJECT_CD
FROM
dwhs_ods..ca_object_code_t
WHERE (
(UNIV_FISCAL_YR = '2012' AND FIN_COA_CD = 'IR' AND FIN_OBJECT_CD = 'CASH') OR
(UNIV_FISCAL_YR = '2012' AND FIN_COA_CD = 'MC' AND FIN_OBJECT_CD = '1100') OR
(UNIV_FISCAL_YR = '2013' AND FIN_COA_CD = 'IR' AND FIN_OBJECT_CD = 'CASH')
); |
Result Schema: A list of following element (ObjectValidation.java)
Parameter | Description | Data Type | Example |
---|
kfsFiscalYear | The KFS Fiscal Year | String (4) | '2013' |
kfsChartCode | The KFS chart of accounts code | String (2) | 'IR' |
kfsObjCode | KFS Object Code | String (4) | 'CASH' |
isValid | Is the Object Active? | 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:isValidKFSObjects>
<kfsObjectList>
<item>2012</item>
<item>IR</item>
<item>CASH</item>
</kfsObjectList>
<kfsObjectList>
<item>2012</item>
<item>MC</item>
<item>1100</item>
</kfsObjectList>
<kfsObjectList>
<item>2013</item>
<item>IR</item>
<item>CASH</item>
</kfsObjectList>
</adc:isValidKFSObjects>
</soapenv:Body>
</soapenv:Envelope> |
Response
Code Block |
---|
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:isValidKFSObjectsResponse xmlns:ns2="http://www.adcom.uci.edu">
<return>
<kfsChartCode>IR</kfsChartCode>
<kfsFiscalYear>2012</kfsFiscalYear>
<kfsObjectCode>CASH</kfsObjectCode>
<valid>true</valid>
</return>
<return>
<kfsChartCode>MC</kfsChartCode>
<kfsFiscalYear>2012</kfsFiscalYear>
<kfsObjectCode>1100</kfsObjectCode>
<valid>true</valid>
</return>
<return>
<kfsChartCode>IR</kfsChartCode>
<kfsFiscalYear>2013</kfsFiscalYear>
<kfsObjectCode>CASH</kfsObjectCode>
<valid>false</valid>
</return>
</ns2:isValidKFSObjectsResponse>
</soap:Body>
</soap:Envelope> |
Java Client Example
Code Block |
---|
DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPortCustom();
StringArray sa90 = new StringArray();
sa90.getItem().add("2012");
sa90.getItem().add("IR");
sa90.getItem().add("CASH");
StringArray sa91 = new StringArray();
sa91.getItem().add("2012");
sa91.getItem().add("MC");
sa91.getItem().add("1100");
StringArray sa92 = new StringArray();
sa92.getItem().add("2013");
sa92.getItem().add("IR");
sa92.getItem().add("CASH");
List<ObjectValidation> resultList9 = ds.isValidKFSObjects(Arrays.asList(sa90, sa91, sa92));
if (resultList9 != null) {
for (Iterator i = resultList9.iterator(); i.hasNext();) {
ObjectValidation element = (ObjectValidation)i.next();
System.out.println("isValidObj-FiscalYr / ChartCode / ObjCode : isValid" + element.getKfsFiscalYear() + "/" + element.getKfsChartCode() + "/" + element.getKfsObjCode() + " : " + element.isValid());
}
} else {
System.out.println("something bad happened...please check your query");
} |
...
getValidKFSObjects(List of (kfsFiscalYear, kfsChartCode, kfsObjectCode))
This service is used retrieve valid KFS object codes and related attributes. Returns an XML result set with a list of charts (example getAllValidKFSObjects result).
Index | Parameter | Description | Required? | Data Type (max length) |
---|
0 | kfsFiscalYear | The KFS Fiscal Year (e.g. 2013) | Yes | String (4) |
1 | kfsChartCode | The KFS chart of accounts code | Yes | String (2) |
2 | kfsObjectCode | The KFS object code | Yes | String (4) |
DB Query:
Code Block |
---|
SELECT CONVERT(varchar(4),UNIV_FISCAL_YR) AS UNIV_FISCAL_YR
,FIN_COA_CD
,FIN_OBJECT_CD
,FIN_OBJ_CD_NM
,FIN_OBJ_CD_SHRT_NM
,FIN_OBJ_LEVEL_CD
,RPTS_TO_FIN_COA_CD
,RPTS_TO_FIN_OBJ_CD
,FIN_OBJ_TYP_CD
,FIN_OBJ_SUB_TYP_CD
,HIST_FIN_OBJECT_CD
,FIN_OBJ_ACTIVE_CD
,FOBJ_BDGT_AGGR_CD
,FOBJ_MNXFR_ELIM_CD
,FIN_FED_FUNDED_CD
,NXT_YR_FIN_OBJ_CD
,RSCH_BDGT_CTGRY_CD
,RSCH_OBJ_CD_DESC
,RSCH_ON_CMP_IND
FROM dwhs_ods..ca_object_code_t
WHERE FIN_OBJ_ACTIVE_CD <> 'N' AND
((UNIV_FISCAL_YR = '2012' AND FIN_COA_CD = 'IR' AND FIN_OBJECT_CD = 'CASH') OR
(UNIV_FISCAL_YR = '2012' AND FIN_COA_CD = 'MC' AND FIN_OBJECT_CD = '1100') OR
(UNIV_FISCAL_YR = '2013' AND FIN_COA_CD = 'IR' AND FIN_OBJECT_CD = 'CASH')); |
Result Schema: A list of following element (ObjectDetails.java)
DB Parameter | Java Parameter | Description | Data Type | Example |
---|
UNIV_FISCAL_YR | kfsFiscalYear | KFS Fiscal Year | String (4) | 2012 |
FIN_COA_CD | kfsChartCode | KFS Chart Code | String (2) | 'IR' |
FIN_OBJECT_CD | kfsObjCode | KFS Object Code | String (4) | 'CASH' |
FIN_OBJ_CD_NM | kfsObjCodeName | KFS Object Code Name | String (40) | |
FIN_OBJ_CD_SHRT_NM | kfsObjCodeShortName | KFS Object Code Short Name | String (12) | |
FIN_OBJ_LEVEL_CD | kfsObjLevelCode | KFS Object Level Code | String (4) | |
RPTS_TO_FIN_COA_CD | kfsReportToChartCode | KFS Reports To Chart Code | String (2) | |
RPTS_TO_FIN_OBJ_CD | kfsReportToObjCode | KFS Reports To Object Code | String (4) | |
FIN_OBJ_TYP_CD | kfsObjTypeCode | KFS Object Type Code | String (2) | |
FIN_OBJ_SUB_TYP_CD | kfsObjSubTypeCode | KFS Object Sub Type Code | String (2) | |
HIST_FIN_OBJECT_CD | kfsHistoryObjCode | KFS History Object Code | String (4) | |
FIN_OBJ_ACTIVE_CD | kfsObjActiveCode | KFS Object Active Code | String (1) | |
FOBJ_BDGT_AGGR_CD | kfsFObjBudgetAggrCode | KFS FObject Budget Aggregation Code | String (1) | |
FOBJ_MNXFR_ELIM_CD | kfsFObjMnxferElimCode | KFS FObject Minimum Transfer Elimination Code | String (1) | |
FIN_FED_FUNDED_CD | kfsFedFundedCode | KFS Federal Funded Code | String (1) | |
NXT_YR_FIN_OBJ_CD | kfsNextYearObjCode | KFS Next Year Object Code | String (4) | |
RSCH_BDGT_CTGRY_CD | kfsResearchBudgetCatCode | KFS Research Budget Category Code | String (3) | |
RSCH_OBJ_CD_DESC | kfsResearchObjCodeDesc | KFS Research Object Code Description | String (200) | |
RSCH_ON_CMP_IND | kfsResearchOnCampusCode | KFS Research On Campus Indicator | String (1) | |
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:getValidKFSObjects>
<kfsObjectList>
<item>2012</item>
<item>IR</item>
<item>CASH</item>
</kfsObjectList>
<kfsObjectList>
<item>2012</item>
<item>MC</item>
<item>1100</item>
</kfsObjectList>
<kfsObjectList>
<item>2013</item>
<item>IR</item>
<item>CASH</item>
</kfsObjectList>
</adc:getValidKFSObjects>
</soapenv:Body>
</soapenv:Envelope> |
Response
Code Block |
---|
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:getValidKFSObjectsResponse xmlns:ns2="http://www.adcom.uci.edu">
<return>
<kfsChartCode>IR</kfsChartCode>
<kfsFObjBudgetAggrCode>C</kfsFObjBudgetAggrCode>
<kfsFObjMnxferElimCode>N</kfsFObjMnxferElimCode>
<kfsFedFundedCode>N</kfsFedFundedCode>
<kfsFiscalYear>2012</kfsFiscalYear>
<kfsNextYearObjCode>0</kfsNextYearObjCode>
<kfsObjActiveCode>Y</kfsObjActiveCode>
<kfsObjCode>CASH</kfsObjCode>
<kfsObjCodeName>ACH BANK OF NEW YORK MELLON BANK</kfsObjCodeName>
<kfsObjCodeShortName>ACH BNYM</kfsObjCodeShortName>
<kfsObjLevelCode>CASH</kfsObjLevelCode>
<kfsObjSubTypeCode>CA</kfsObjSubTypeCode>
<kfsObjTypeCode>CH</kfsObjTypeCode>
<kfsReportToChartCode>UC</kfsReportToChartCode>
<kfsReportToObjCode>9999</kfsReportToObjCode>
</return>
<return>
<kfsChartCode>MC</kfsChartCode>
<kfsFObjBudgetAggrCode>C</kfsFObjBudgetAggrCode>
<kfsFObjMnxferElimCode>N</kfsFObjMnxferElimCode>
<kfsFedFundedCode>N</kfsFedFundedCode>
<kfsFiscalYear>2012</kfsFiscalYear>
<kfsHistoryObjCode>1100</kfsHistoryObjCode>
<kfsNextYearObjCode>0</kfsNextYearObjCode>
<kfsObjActiveCode>Y</kfsObjActiveCode>
<kfsObjCode>1100</kfsObjCode>
<kfsObjCodeName>Mgmt/Supervisors</kfsObjCodeName>
<kfsObjCodeShortName>Mgmt/Superv</kfsObjCodeShortName>
<kfsObjLevelCode>SWST</kfsObjLevelCode>
<kfsObjSubTypeCode>SW</kfsObjSubTypeCode>
<kfsObjTypeCode>EX</kfsObjTypeCode>
<kfsReportToChartCode>IR</kfsReportToChartCode>
<kfsReportToObjCode>1100</kfsReportToObjCode>
</return>
</ns2:getValidKFSObjectsResponse>
</soap:Body>
</soap:Envelope> |
Java Client Example
Code Block |
---|
DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPortCustom();
System.out.println("\nWSClient--getValidKFSObjects()");
StringArray sa100 = new StringArray();
sa100.getItem().add("2012");
sa100.getItem().add("IR");
sa100.getItem().add("CASH");
StringArray sa101 = new StringArray();
sa101.getItem().add("2012");
sa101.getItem().add("MC");
sa101.getItem().add("1100");
StringArray sa102 = new StringArray();
sa102.getItem().add("2013");
sa102.getItem().add("IR");
sa102.getItem().add("CASH");
List<ObjectDetails> resultList10 = ds.getValidKFSObjects(Arrays.asList(sa100, sa101, sa102));
if (resultList10 != null) {
for (Iterator i = resultList10.iterator(); i.hasNext();) {
ObjectDetails element = (ObjectDetails)i.next();
System.out.println("getValidObj-FiscalYr / ChartCode / ObjCode : ObjCodeName" + element.getKfsFiscalYear() + "/" + element.getKfsChartCode() + "/" + element.getKfsObjCode() + " : " + element.getKfsObjCodeName());
}
} else {
System.out.println("something bad happened...please check your query");
} |
...
getAllKFSObjects()
No input parameter, ALL objects will return in result set.
DB Query:
Code Block |
---|
SELECT CONVERT(varchar(4),UNIV_FISCAL_YR) AS UNIV_FISCAL_YR
,FIN_COA_CD
,FIN_OBJECT_CD
,FIN_OBJ_CD_NM
,FIN_OBJ_CD_SHRT_NM
,FIN_OBJ_LEVEL_CD
,RPTS_TO_FIN_COA_CD
,RPTS_TO_FIN_OBJ_CD
,FIN_OBJ_TYP_CD
,FIN_OBJ_SUB_TYP_CD
,HIST_FIN_OBJECT_CD
,FIN_OBJ_ACTIVE_CD
,FOBJ_BDGT_AGGR_CD
,FOBJ_MNXFR_ELIM_CD
,FIN_FED_FUNDED_CD
,NXT_YR_FIN_OBJ_CD
,RSCH_BDGT_CTGRY_CD
,RSCH_OBJ_CD_DESC
,RSCH_ON_CMP_IND
FROM dwhs_ods..ca_object_code_t
WHERE FIN_OBJ_ACTIVE_CD <> 'N' |
Result Schema: SAME as getValidKFSObjects
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:getAllKFSObjects/>
</soapenv:Body>
</soapenv:Envelope> |
Response
Code Block |
---|
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:getAllKFSObjectsResponse xmlns:ns2="http://www.adcom.uci.edu">
<return>
<kfsChartCode>IR</kfsChartCode>
<kfsFObjBudgetAggrCode>C</kfsFObjBudgetAggrCode>
<kfsFObjMnxferElimCode>N</kfsFObjMnxferElimCode>
<kfsFedFundedCode>N</kfsFedFundedCode>
<kfsFiscalYear>2012</kfsFiscalYear>
<kfsHistoryObjCode>1000</kfsHistoryObjCode>
<kfsNextYearObjCode>0</kfsNextYearObjCode>
<kfsObjActiveCode>Y</kfsObjActiveCode>
<kfsObjCode>1000</kfsObjCode>
<kfsObjCodeName>SALARIES & WAGES ACADEMIC</kfsObjCodeName>
<kfsObjCodeShortName>SALARIES & W</kfsObjCodeShortName>
<kfsObjLevelCode>SWAC</kfsObjLevelCode>
<kfsObjSubTypeCode>SW</kfsObjSubTypeCode>
<kfsObjTypeCode>EX</kfsObjTypeCode>
<kfsReportToChartCode>UC</kfsReportToChartCode>
<kfsReportToObjCode>9999</kfsReportToObjCode>
</return>
<return>
<kfsChartCode>IR</kfsChartCode>
<kfsFObjBudgetAggrCode>C</kfsFObjBudgetAggrCode>
<kfsFObjMnxferElimCode>N</kfsFObjMnxferElimCode>
<kfsFedFundedCode>N</kfsFedFundedCode>
<kfsFiscalYear>2012</kfsFiscalYear>
<kfsHistoryObjCode>1091</kfsHistoryObjCode>
<kfsNextYearObjCode>0</kfsNextYearObjCode>
<kfsObjActiveCode>Y</kfsObjActiveCode>
<kfsObjCode>1091</kfsObjCode>
<kfsObjCodeName>1991-92 FACULTY MERITS AND PROMOTION</kfsObjCodeName>
<kfsObjCodeShortName>1991-92 FACU</kfsObjCodeShortName>
<kfsObjLevelCode>SGEN</kfsObjLevelCode>
<kfsObjSubTypeCode>SW</kfsObjSubTypeCode>
<kfsObjTypeCode>EX</kfsObjTypeCode>
<kfsReportToChartCode>UC</kfsReportToChartCode>
<kfsReportToObjCode>9999</kfsReportToObjCode>
</return>
...
...
</ns2:getAllKFSObjectsResponse>
</soap:Body>
</soap:Envelope> |
Java Client Example
Code Block |
---|
DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPortCustom();
List<ObjectDetails> resultList11 = ds.getAllKFSObjects();
if (resultList11 != null) {
System.out.println("getAllObj-total size: " + resultList11.size());
System.out.println("getAllObj-1st item FiscalYr / ChartCode / ObjCode: " + ((ObjectDetails)resultList11.get(0)).getKfsFiscalYear() + " / " + ((ObjectDetails)resultList11.get(0)).getKfsChartCode() + " / " + ((ObjectDetails)resultList11.get(0)).getKfsObjCode());
} else {
System.out.println("something bad happened...please check your query");
} |
translateFSObjects(List of (fiscalYear, kfsChartCode, fsLocationCode, fsSubCode, fsObjectCode))
This service is used to translate legacy FS object to KFS object codes.
Index | Parameter | Description | Required? | Data Type (max length) |
---|
0 | fiscalYear | Fiscal Year | Yes | String (4) |
1 | kfsChartCode | The KFS Chart Code | Yes | String (2) |
2 | fsLocationCode | The FS Location Code | Yes | String (2) |
3 | fsObjectCode | The FS Object Code | Yes | String (4) |
4 | fsSubCode | The FS Sub Code | Yes | String (2) |
DB Query
Code Block |
---|
SELECT UNIV_FISCAL_YR, FIN_COA_CD, FIN_OBJECT_CD, UC_LOC_CD, UC_OBJECT_CD, UC_SUB_CD
FROM uci_ca_object_code_xw_t
WHERE ACTIVE_IND <> 'N' AND
(
(UNIV_FISCAL_YR = '2012' AND FIN_COA_CD = 'IR' AND UC_LOC_CD = '9' AND UC_OBJECT_CD = '8096' AND UC_SUB_CD = '03') OR
(UNIV_FISCAL_YR = '2012' AND FIN_COA_CD = 'IR' AND UC_LOC_CD = 'R' AND UC_OBJECT_CD = '8088' AND UC_SUB_CD = '03') OR
(UNIV_FISCAL_YR = '0000' AND FIN_COA_CD = '00' AND UC_LOC_CD = '0' AND UC_OBJECT_CD = '0000' AND UC_SUB_CD = '00')
) |
Result Schema: A list of following elements (FS2KFSObjectDetails.java)
Parameter | Description | Data Type | Example |
---|
fiscalYear | Fiscal Year | String (4) | 2012 |
kfsChartCode | KFS Chart Code | String (2) | IR |
fsLocationCode | The FS location code | String (2) | 9 |
fsSubCode | The FS Sub Code | String (2) | 03 |
fsObjectCode | The FS Object Code | String (4) | 8096 |
kfsObjectCode | KFS Object Code | String (4) | 8160 |
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:translateFSObjects>
<fsObjectList>
<item>2012</item>
<item>IR</item>
<item>9</item>
<item>8096</item>
<item>03</item>
</fsObjectList>
<fsObjectList>
<item>2012</item>
<item>IR</item>
<item>R</item>
<item>8096</item>
<item>03</item>
</fsObjectList>
<fsObjectList>
<item>0000</item>
<item>00</item>
<item>0</item>
<item>0000</item>
<item>00</item>
</fsObjectList>
</adc:translateFSObjects>
</soapenv:Body>
</soapenv:Envelope> |
Response
Code Block |
---|
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:translateFSObjectsResponse xmlns:ns2="http://www.adcom.uci.edu">
<return>
<fiscalYear>2012</fiscalYear>
<fsLocationCode>9</fsLocationCode>
<fsObjectCode>8096</fsObjectCode>
<fsSubCode>03</fsSubCode>
<kfsChartCode>IR</kfsChartCode>
<kfsObjectCode>8160</kfsObjectCode>
</return>
<return>
<fiscalYear>2012</fiscalYear>
<fsLocationCode>R</fsLocationCode>
<fsObjectCode>8096</fsObjectCode>
<fsSubCode>03</fsSubCode>
<kfsChartCode>IR</kfsChartCode>
<kfsObjectCode>8160</kfsObjectCode>
</return>
</ns2:translateFSObjectsResponse>
</soap:Body>
</soap:Envelope> |
Java Client Example
Code Block |
---|
DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPortCustom();
StringArray sa330 = new StringArray();
sa330.getItem().add("2012");
sa330.getItem().add("IR");
sa330.getItem().add("9");
sa330.getItem().add("8096");
sa330.getItem().add("03");
StringArray sa331 = new StringArray();
sa331.getItem().add("2012");
sa331.getItem().add("IR");
sa331.getItem().add("R");
sa331.getItem().add("8096");
sa331.getItem().add("03");
StringArray sa332 = new StringArray();
sa332.getItem().add("0000");
sa332.getItem().add("00");
sa332.getItem().add("0");
sa332.getItem().add("0000");
sa332.getItem().add("00");
List<Fs2KFSObjectDetails> resultList33 = ds.translateFSObjects(Arrays.asList(sa330,sa331,sa332));
if (resultList33 != null) {
for (Iterator i = resultList33.iterator(); i.hasNext();) {
Fs2KFSObjectDetails element = (Fs2KFSObjectDetails)i.next();
System.out.println("\t" + element.getFiscalYear() + "/" + element.getKfsChartCode() + "/" + element.getFsLocationCode() + "/" + element.getFsObjectCode() + "/" + element.getFsSubCode() + " : " + element.getKfsObjectCode());
}
} else {
System.out.println("something bad happened...please check your query");
} |