if408 iog-ar outbound interface
TRANSCRIPT
-
8/13/2019 IF408 IOG-AR Outbound Interface
1/13
IF408 - AR Outbound Interface IOG
South Carolina Enterprise Information System
Interface Operations Guide (IOG)
IF408 - ! Out"ound Interface
1 | P a g e
-
8/13/2019 IF408 IOG-AR Outbound Interface
2/13
IF408 - AR Outbound Interface IOG
Introduction
Document Purpose and Organization
The Interface Operations Guide IOG! contains the interface specific infor"ation re#uired for$tate of $outh %aro&ina Agencies to integrate 'ith the $%(I$ s)ste"* (ach interface 'i&&contain a separate IOG 'ith specific infor"ation* The IOG infor"ation 'i&& inc&ude the A+$nu"ber, description, fi&e na"es!, ea"p&es of &oad reports, fre#uenc), run schedu&e, errorconditions, etc* Additiona&&), the IOG 'i&& contain the fi&e &a)out for the interface*
Genera& s)ste" updates can be found on the $%(I$ 'ebsite, http.//'''*sceis*sc*go
| P a g e
http://www.sceis.sc.gov/http://www.sceis.sc.gov/ -
8/13/2019 IF408 IOG-AR Outbound Interface
3/13
IF408 - AR Outbound Interface IOG
! Out"ound Interface
Interface #S $um"er IF408
In"ound%Out"ound Outbound
Interface &itle AR Outbound Interface
Interface #escription This outbound interface 'i&& supp&) $%(I$ AR inoice data toagenc) &egac) s)ste"s on a dai&) basis*
$%(I$ 'i&& proide the data in a co""on for"at for agencies topic2 up ia FTP or "anua& retriea&*
The $AP docu"ent nu"ber is the 2e) fie&d for identif)ing inoicedocu"ents* If agencies hae other 2e) fie&ds such as AR bi&&ing&egac) nu"ber!, it 'i&& be their responsibi&it) to popu&ate this datain the inoice docu"ent* This cou&d be in a reference or tet
fie&d* It 'i&& a&so be the agenc)3s responsibi&it) to "ap this datato the appropriate &egac) fie&ds!*
Outbound interface fi&es 'i&& be created b) usiness Area*
'ersion 5ersion *0
SCEIS oint of Contact
Source System $%(I$
#estination System $tate Agenc) $ubs)ste"s
Interface &ype Tab-de&i"ited tet fi&eode As)nchronous
Fre*uency $%(I$ 'i&& produce the fi&es during a night&) batch c)c&e*
File $ame(s) Outbound interface fi&e.6business area7*if408*ardata*outbound*6date/ti"e sta"p7
(a"p&e.e10*if408*ardata*outbound*0090:08;01
F& ath /6business area7/aroutb
; | P a g e
-
8/13/2019 IF408 IOG-AR Outbound Interface
4/13
IF408 - AR Outbound Interface IOG
'ersion Control
'ersion #escription of Chan+e #ate
1*0 Initia& 5ersion 01/1/011
1*
-
8/13/2019 IF408 IOG-AR Outbound Interface
5/13
IF408 - AR Outbound Interface IOG
File ,ayout
$o Field $ame &ype Si.e Format #escription
1 usiness Area %=AR 4 >4! usiness Area
+ocu"ent $tatus %=AR 1 > $tatus of the $AP docu"ent.?13 @ AR inoice, I+T bi&& has been posted*(OS&E#)?3 @ $AP doc has been reersed*(!E'E!SE#)?;3 - The $AP docu"ent has been eitherpaid pa)"ent docu"ent or cash receiptdocu"ent! in fu&& or partia&&) paid and has ac&earing docu"ent* (I#)
?43 @ The $AP %&earing docu"ent has beenreset and reersed due to an error* This ison&) done "anua&&) in $AP* (!ESE& $#
!E'E!S#-/$&)?3 @ The $AP docu"ent has beendeposited, approed and posted in $TAR$*This is done "anua&&)* (#EOSI&E#)?:3 - The $TO has reBected the deposit* The$AP deposit docu"ent is reset andreersed* This is reBected "anua&&) and thereset and reersa& is auto"atica&&) triggeredb) 'or2 f&o'* (!ESE& $# !E'E!SE# #EOSI&)
; +ocu"ent Cu"ber %=AR 10 >10! $AP docu"ent nu"ber
4 Dine Ite" Cu"ber CE% ; Identifies the detai& &ines 'ithin the $AP
docu"ent*
+ebit/%redit Indicator %=AR 1 > ?+3 +ebit H ?%3 %redit
: Genera& Dedger Account %=AR 10 >10! $%(I$ Genera& Dedger Account
9 G/D Account Ca"e %=AR 0 >0! +escription of Genera& Dedger account
8 +ocu"ent %&eared %=AR 10 >10! $AP docu"ent nu"ber
%usto"er Cu"ber %=AR 10 >10! $%(I$ custo"er nu"ber
10 +ocu"ent T)pe %=AR >> $AP docu"ent t)pe
11 +ocu"ent +ate +AT( 8 ++ %usto"er inoice date
1 Posting +ate +AT( 8 ++ Represents financia& posting date*%ontro&s posting period and fisca& )ear*effectie date!
| P a g e
-
8/13/2019 IF408 IOG-AR Outbound Interface
6/13
IF408 - AR Outbound Interface IOG
1; (ntr) +ate +AT( 8 ++ +ate the docu"ent 'as created in $AP
14 Reference %=AR 1: >1:! Represents %usto"er inoice nu"ber*The fie&d in $AP is 1: chars*
1 Gross Inoice A"ount +(% 14 11!* Gross inoice a"ount fie&d is 14 digits
inc&uding deci"a& point and deci"a&p&aces!
1: Reference Je) %=AR 0 >0! Reference Je) used for $AP interna& 2e)
19 =eader Tet %=AR >! For agenc) use to "ap &egac) infor"ation
18 +ate of Dast +ocu"ent%hange
+AT( 8 ++ The date that the docu"ent 'as &astchanged @ the date that the docu"ent'as posted in $AP*
1 +ate of Dast +ocu"entEpdate
+AT( 8 ++ The date that the docu"ent 'as &astupdated 0 updates refer to additions oftet infor"ation such as chec2infor"ation, 'arrant nu"bers, etc*
0 Reference Je) 1 %=AR 0 >0! Reference Je) 1 Interna& for +ocu"ent=eader
1 Reference Je) %=AR 0 >0! Reference Je) Interna& for +ocu"ent=eader
%&eared GD Account %=AR 10 >10! $%(I$ Genera& Dedger Account
; %&eared GD AccountCa"e
%=AR 0 >0! +escription of Genera& Dedger account
4 %&eared +ebit/%reditIndicator
%=AR 1 > ?+3 +ebit H ?%3 %redit
%&eared Dine Ite" CE% ; $AP &ine ite" nu"ber
: Dine Ite" A"ount +(% 14 11!* Dine ite" a"ount fie&d is 14 digitsinc&uding a deci"a& point and deci"a&p&aces!
9 Kuantit) KEAC 1 >1! Kuantit)
8 Enit of easure ECIT ; >;! Enit of easure
(ar"ar2ed Funds %=AR 10 >10! +ocu"ent Cu"ber for (ar"ar2ed Fund
;0 (ar"ar2ed Dine Ite" CE% ; (ar"ar2ed Funds. +ocu"ent Ite"
;1 %ost %enter %=AR 10 >10! +iision/+epart"ent
; Functiona& Area %=AR 1: >1:! Progra"/ini %ode
;; Fund %=AR 10 >10! Fund
: | P a g e
-
8/13/2019 IF408 IOG-AR Outbound Interface
7/13
IF408 - AR Outbound Interface IOG
;4 Grant %=AR 0 >0! Grant
; Order Cu"ber %=AR 1 >1! If app&icab&e, Interna& Order Cu"ber
;: L$ (&e"ent %=AR 4 >4! If app&icab&e, L$ (&e"ent @ ProBect
$)ste"s proBect nu"ber
;9 Dine Ite" Tet %=AR 0 >0! For agenc) use to "ap &egac) infor"ation
;8 $a&es Ta %ode %=AR >> T)pe of ta
; Assign"ent Cu"ber %=AR 18 >18! %ontains &egac) infor"ation and/or inoicenu"ber
40 Transaction T)pe %=AR ; >>> $ho's the historica& dee&op"ent of afinancia& state"ent ite"*
41 $a&es +ocu"ent %=AR 10 >10! $a&es +ocu"ent Cu"ber
4 $a&es +ocu"ent Ite" CE% : :! $a&es +ocu"ent Ite"
4; ateria& Cu"ber %=AR 18 >18! ateria& Cu"ber
44 P&ant %=AR 4 >4! P&ant Cu"ber
4 Reersa& +ocu"entCu"ber
%=AR 10 >10! Reersa& docu"ent nu"ber
4: Reersa& Reason %=AR >> Reersa& reason
49 %usto"er Ca"e 1 %=AR ; >;! %usto"er Ca"e app&icab&e on&) if One
Ti"e %usto"er 'as used on inoice!48 %usto"er Ca"e %=AR ; >;! %usto"er na"e fie&d app&icab&e on&) if
One Ti"e %usto"er 'as used on inoice!
4 %usto"er =ouseCu"ber M $treet
%=AR ; >;! %usto"er street address app&icab&e on&)if One Ti"e %usto"er 'as used oninoice!
0 %usto"er %it) %=AR ; >;! %usto"er cit) app&icab&e on&) if One Ti"e%usto"er 'as used on inoice!
1 %usto"er Region %=AR ; >>> %usto"er state app&icab&e on&) if OneTi"e %usto"er 'as used on inoice!
%usto"er Posta& %ode %=AR 10 >10! %usto"er Nip code app&icab&e on&) if One
Ti"e %usto"er 'as used on inoice!; %usto"er %ountr) %=AR ; >>> %usto"er countr) app&icab&e on&) if One
Ti"e %usto"er 'as used on inoice!
4 (tract +ate +AT( 8 ++ +ate that the outbound interface 'aseecuted
(tract Ti"e CE% : ==$$ Ti"e that the outbound interface 'aseecuted
9 | P a g e
-
8/13/2019 IF408 IOG-AR Outbound Interface
8/13
IF408 - AR Outbound Interface IOG
rocess Flo1chart
8 | P a g e
-
8/13/2019 IF408 IOG-AR Outbound Interface
9/13
IF408 - AR Outbound Interface IOG
!eport E2amples
A notification report 'i&& be e"ai&ed to se&ected agenc) users 'hen the interface is eecuted*The report disp&a)s su""ar) interface infor"ation and is sent as an e"ai& attach"ent in aP+F for"at*
The fo&&o'ing is an ea"p&e of the interface notification report.
| P a g e
-
8/13/2019 IF408 IOG-AR Outbound Interface
10/13
IF408 - AR Outbound Interface IOG
iscellaneous rocessin+ $otes
The output fi&e for"at is a TA-de&i"ited tet fi&e*
%ontact e"ai& addresses 'i&& need to be proided to $%(I$ for each agenc) using the
AR Outbound interface* Cotification reports containing su""ar) infor"ation 'i&& bee"ai&ed to these users 'hen the interface is eecuted each da)*
To hae an IF408 fi&e resent to )our agenc) fo&der, e"ai& interfacessceis*sc*go*
P&ease note that each fi&e that is recreated can contain on&) one da)3s outbound data*
To hae a docu"ent resent on an IF408 fi&e, e"ai& interfacessceis*sc*go'ith the
docu"ent nu"bers! to be resent on the net regu&ar outbound run*
To ie' data that has been sent on the fi&e, the agenc) 'ith the appropriate ro&es can
use the interface "onitoring too&* The transaction is QAG(C%QICT(RFA%($* Theactiit) report can be ie'ed 'hen pressing the IF408 AR Outbound InterfaceS button*
10 | P a g e
mailto:[email protected]:[email protected]:[email protected]:[email protected]:[email protected] -
8/13/2019 IF408 IOG-AR Outbound Interface
11/13
IF408 - AR Outbound Interface IOG
The IF408 AR Outbound InterfaceS Actiit) Report 'i&& then &oo2 &i2e this.
11 | P a g e
-
8/13/2019 IF408 IOG-AR Outbound Interface
12/13
IF408 - AR Outbound Interface IOG
Lith this report, )ou can sort, fi&ter, print, dri&& do'n in a docu"ent for detai&, etc*
1 | P a g e
-
8/13/2019 IF408 IOG-AR Outbound Interface
13/13
IF408 - AR Outbound Interface IOG
General F& rocessin+ $otes
The preferred "ethod of data transfer 'i&& be ia secure FTP, and $%(I$ 'i&& host an FTP$serer for this purpose*
There 'i&& be a fo&der structure set up on the serer for each business area* $ecurit) 'i&& be setup appropriate&) on the fo&ders so that users 'i&& on&) hae access to their data* The fi&es forthis outbound interface 'i&& be 'ritten to an ?/aroutb3 fo&der under the "ain fo&der for thebusiness area* An ea"p&e FTP fi&e structure is sho'n be&o'*
/e10/ar/ap
/apoutb/aroutb
/e1:0/aroutb/""
/e00/aroutb
To send fi&es to $%(I$inbound or receie fi&es fro" $%(I$outbound interfaces, FTP$ c&ientsoft'are 'i&& be used on the agenc) side* (a"p&e FTP connection options are sho'n in thefo&&o'ing print screen* Esing the %oreFTP des2top c&ient soft'are @ in other c&ients, theoptions "a) be s&ight&) different*!
For #uestions or concerns regarding the Fi&e Transfer Protoco& procedures, p&ease contact the$%(I$ interface tea" at interfacessceis*sc*go*
1; | P a g e
mailto:[email protected]:[email protected]