Page Comparison

Table of Contents

isValidKFSObjects(List of (kfsFiscalYear, kfsChartCode, kfsObjCode))

...

Code Block

DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPort();
 
ArrayList<ObjectParameters> pl10 = new ArrayList<ObjectParameters>();
ObjectParameters op100 = new ObjectParameters();
op100.setKfsFiscalYear("2012");
op100.setKfsChartCode("MC");
op100.setKfsObjCode("1100");
ObjectParameters op101 = new ObjectParameters();
op101.setKfsFiscalYear("2012");
op101.setKfsChartCode("IR");
op101.setKfsObjCode("CASH");
ObjectParameters op102 = new ObjectParameters();
op102.setKfsFiscalYear("2013");
op102.setKfsChartCode("IR");
op102.setKfsObjCode("CASH");
pl10.add(op100);
pl10.add(op101);
pl10.add(op102);
List<ObjectValidation> resultList10 = ds.isValidKFSObjects(pl10);
if (resultList10 != null) {
	for (Iterator i = resultList10.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");
}

...

isValidForOOE(originationCode, kfsChartCode, kfsObjectCode))

This service is used to validate KFS object codes by origination code. Returns an XML result set with a value of true or false (example isValidForOOEResult)

Input Specifications:

Index	Parameter	Description	Required?	Data Type (max length)
0	originationCode	The origination code (e.g. FM)	Yes	String (4)
1	kfsChartCode	The KFS chart code	Yes	String (2)
2	kfsObjectCode	The KFS object code	Yes	String (4)

Result Schema:

Parameter	Description	Data Type	Example
valid	Valid for OOE Rules	boolean	false
matchingRuleId	The ruleId matched (could match on success or failure)	Integer	23

WS Example

Request SOAP

Code Block

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adc="http://www.adcom.uci.edu">
   <soapenv:Header/>
   <soapenv:Body>
      <adc:isValidForOOE>
         <originationCode>FM</originationCode>
         <kfsChartCode>IR</kfsChartCode>
         <kfsObjectCode>3900</kfsObjectCode>
      </adc:isValidForOOE>
   </soapenv:Body>
</soapenv:Envelope>

Response SOAP

Code Block

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:isValidForOOEResponse xmlns:ns2="http://www.adcom.uci.edu" xmlns:ns3="uri:ultima:thule">
         <return>
            <valid>true</valid>
            <matchingRuleId>105</matchingRuleId>
         </return>
      </ns2:isValidForOOEResponse>
   </soap:Body>
</soap:Envelope>

Request REST

Code Block
WebServices/DWHRESTServer/rest/ooe/validate?originationCode=FM&kfsChartCode=IR&kfsObjectCode=3900

Response REST JSON

Code Block
{"valid":true,"matchingRuleId":105}

...

isValidForGOE(kfsChartCode, kfsAccountNumber, kfsObjectCode))

This service is used to validate KFS object code - account number combinations. Returns an XML result set with a value of true or false (example isValidForOOEResult)

Input Specifications:

Index	Parameter	Description	Required?	Data Type (max length)
1	kfsChartCode	The KFS chart code	Yes	String (2)
2	kfsAccountNumber	The KFS account number	Yes	String(7)
3	kfsObjectCode	The KFS object code	Yes	String (4)

Result Schema:

Parameter	Description	Data Type	Example
valid	Valid for GOE Rules	boolean	false
matchingRuleId	The ruleId matched (could match on success or failure)	Integer	23

WS Example

Request SOAP

Code Block

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adc="http://www.adcom.uci.edu">
   <soapenv:Header/>
   <soapenv:Body>
      <adc:isValidForGOE>
         <kfsChartCode>IR</kfsChartCode>
         <kfsAccountNumber>SS11828</kfsAccountNumber>
         <kfsObjectCode>ASTS</kfsObjectCode>
      </adc:isValidForGOE>
   </soapenv:Body>
</soapenv:Envelope>

Response SOAP

Code Block

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:isValidForGOEResponse xmlns:ns2="http://www.adcom.uci.edu" xmlns:ns3="uri:ultima:thule">
         <return>
            <valid>true</valid>
            <matchingRuleId>0</matchingRuleId>
         </return>
      </ns2:isValidForGOEResponse>
   </soap:Body>
</soap:Envelope>

Request REST

Code Block
WebServices/DWHRESTServer/rest/goe/validate?kfsChartCode=IR&kfsAccountNumber=SS11828&kfsObjectCode=ASTS

Response REST JSON

Code Block
{"valid":true,"matchingRuleId":0}

...

getValidKFSObjects(List of (kfsFiscalYear, kfsChartCode, kfsObjCode))

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).

Input Specifications:

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	kfsObjCode	The KFS object code	Yes	String (4)

...

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>
            <kfsChartCode>IR</kfsChartCode>
            <kfsFiscalYear>2012</kfsFiscalYear>
            <kfsObjCode>CASH</kfsObjCode>
         </kfsObjectList>
         <kfsObjectList>
            <kfsChartCode>MC</kfsChartCode>
            <kfsFiscalYear>2012</kfsFiscalYear>
            <kfsObjCode>1100</kfsObjCode>
         </kfsObjectList>
         <kfsObjectList>
            <kfsChartCode>IR</kfsChartCode>
            <kfsFiscalYear>2013</kfsFiscalYear>
            <kfsObjCode>CASH</kfsObjCode>
         </kfsObjectList>
      </adc:getValidKFSObjects>
   </soapenv:Body>
</soapenv:Envelope>

...

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>

...

Parameter	Description	Data Type	Example
kfsFiscalYear	The KFS Fiscal Year	String (4)	2012
kfsChartCode	The 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
kfsObjCode	The 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>
            <fsLocationCode>9</fsLocationCode>
            <fsObjectCode>8096</fsObjectCode>
            <fsSubCode>03</fsSubCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsFiscalYear>2012</kfsFiscalYear>
         </fsObjectList>
         <fsObjectList>
            <fsLocationCode>R</fsLocationCode>
            <fsObjectCode>8096</fsObjectCode>
            <fsSubCode>03</fsSubCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsFiscalYear>2012</kfsFiscalYear>
         </fsObjectList>
         <fsObjectList>
            <fsLocationCode>0</fsLocationCode>
            <fsObjectCode>0000</fsObjectCode>
            <fsSubCode>00</fsSubCode>
            <kfsChartCode>00</kfsChartCode>
            <kfsFiscalYear>0000</kfsFiscalYear>
         </fsObjectList>
      </adc:translateFSObjects>
   </soapenv:Body>
</soapenv:Envelope>

...

This service is used retrieve valid KFS object codes and related attributes for income and balance sheet accounts. Returns an XML result set with a list of objects.

Input Specifications:

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	fsLocationCode	The FS Location Code	Yes	String (1)

...

DB Parameter	Java Parameter	Description	Data Type	Example
UC_LOC_CD	fsLocationCode	FS Location Code	String(1)	9
UC_SUB_CD	fsSubCode	FS Sub Code	String(2)	9H
UC_OBJECT_CD	fsObjCode	FS Object Code	String(4)	3800
UC_ACCT_NBR	fsAccountCode	FS Account Number	String(6)	803000
UNIV_FISCAL_YR	kfsFiscalYear	KFS Fiscal Year	String (4)	2013
FIN_COA_CD	kfsChartCode	KFS Chart Code	String (2)	IR
FIN_OBJECT_CD	kfsObjCode	KFS Object Code	String (4)	3800

WS Example

Request

Code Block

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
	<S:Body>
		<ns2:getAllFSAccountToKFSObject xmlns:ns2="http://www.adcom.uci.edu">
			<accountToObjectTranslateParameters>
				<fsLocationCode>9</fsLocationCode>
				<kfsChartCode>IR</kfsChartCode>
				<kfsFiscalYear>2013</kfsFiscalYear>
			</accountToObjectTranslateParameters>
		</ns2:getAllFSAccountToKFSObject>
	</S:Body>
</S:Envelope>

...

Version	Old Version 45	New Version Current
Changes made by	Jarrod Lannan	Jarrod Lannan
Saved on	Feb 12, 2013	Aug 17, 2016

Versions Compared

Key

isValidKFSObjects(List of (kfsFiscalYear, kfsChartCode, kfsObjCode))

isValidForOOE(originationCode, kfsChartCode, kfsObjectCode))

Input Specifications:

Result Schema:

WS Example

Request SOAP

Response SOAP

Request REST

Response REST JSON

isValidForGOE(kfsChartCode, kfsAccountNumber, kfsObjectCode))

Input Specifications:

Result Schema:

WS Example

Request SOAP

Response SOAP

Request REST

Response REST JSON

getValidKFSObjects(List of (kfsFiscalYear, kfsChartCode, kfsObjCode))

Input Specifications:

WS Example

Request

Result Schema: SAME as getValidKFSObjects

WS Example

Request

WS Example

Request

Input Specifications:

WS Example

Request