Interface Files |
Top Previous Next |
These are the layouts for the upload/download files. There are two types of file available.
ACSII file layouts
All fields are string type fields. All fields may be sent and they will be loaded. Where a new Exporter is to be created, all the data sent will be updated into the new Exporter Record. This also applies to Consignees, Establishments, Ports and Countries. Where partial information is sent for these tables the record will be created using the data provided.
Where there are new fields these have been usually been added at the end of each record layout. This makes things look a bit untidy but it helps when identifying changes. Be aware that there could be local variations to this layout depending on which release of the software added the new file.
The controlling field is RFP. A unique number allocated by the software generating the file. Re-sending the data will update the RFP provided the Status of the RFP is not greater than ORDR.
Multiple Line Items per RFP. Must have at least one Line Item per RFP. This file is keyed on RFP and LINE NUMBER.
RFP Import Permits (RFPXPERM.TXT)
May have many records per RFP.
RFP Load Ports (RFPXLOAD.TXT)
May have many records per RFP. (use for Commodities that allow multiple Discharge Ports)
RFP Discharge Ports (RFPXDISC.TXT)
May have many records per RFP. (use for Commodities that allow multiple Discharge Ports)
RFP Transit Countries (RFPXTRAN.TXT)
May have many records per RFP. (only used when Commodity is Dairy)
May have many records per RFP. (use for Commodities that allow multiple Consignees)
May have many records per RFP Line Item.
Multiple Process Times per Line Item. Must have at least one Slaughter Process Time and one Packing Process Time. Other Process Times are as required by AQIS.
EDN Header file (EDNXHEAD.TXT)
The controlling field is EDN. A unique number allocated by the software generating the file. Re-sending the data will update the EDN but will not override the Status or CAN.
EDN Line Item file (EDNXLINE.TXT)
Must have at least one record but may have many records per EDN.
May have many records per EDN Line Item.
EDN Line Temporary Permits (EDNXTPERM.TXT)
May have many records per EDN Line Item.
May have many records per EDN Line Item.
PRA Header (PRAXHEAD.TXT)
May have many records per PRA.
May have many records per PRA.
May have many records per PRA.
The XML based Data Transfer is controlled by schema files that are generated in XML format. This provides for easier review of the schema files. When the Schema files are generated, they are stored in the ...\Woodwind\Data\XML Schema directory and the names of the files explain their purpose.
Some rules
The following layouts are provided as a convenient method of documentation and developers should contact the Help Desk if they would like copies of these to use as base Schema files.
These are not the import files themselves, but the schema files. If you would like examples of the actual files for importing or exporting the best option available is for you to configure the schema files within edisoft, and then export data to XML to view the output. This can then be used as an example for creating import files.
CRN Data Transfer Schema
<?xml version="1.0"?> <CRN.Data.Transfer> <CRN.Header> <USERREF>User.Reference</USERREF> <VERSION>Version.for.ICS</VERSION> <TYPE>CRN.Type</TYPE> <CRNNUMBER>CRN.Number</CRNNUMBER> <TRANSPMODE>Transport.Mode</TRANSPMODE> <NILCARGO>Nil.Cargo.Indicator</NILCARGO> <DEPTDATE>Departure.Date</DEPTDATE> <EMPTYCOUNT>Empty.Container.Count</EMPTYCOUNT> <STATUS>CRN.Status</STATUS> <Line.Item> <LINENO>Line.Number</LINENO> <REFTYPE>Type.of.CAN</REFTYPE> <CANREF>CAN.Number</CANREF> <EXEMPTREF>Exempt.Code.Reference</EXEMPTREF> <EXPONAME>Exporter.Name</EXPONAME> <FINLCTRYNA>Final.Country.Name</FINLCTRYNA> <FINLCTRYCD>Final.Country.UN.LOCODE</FINLCTRYCD> <DESCRIPT>Description.of.Goods</DESCRIPT> <PACKCOUNT>Package.Count</PACKCOUNT> <CONTCOUNT>Container.Count</CONTCOUNT> </Line.Item> </CRN.Header> </CRN.Data.Transfer>
EDN Data Transfer Schema
<?xml version="1.0"?> <EDN.Data.Transfer> <EDN.Header> <USERREF>User.Reference</USERREF> <VERSION>Version.for.ICS</VERSION> <CONFSTATUS>Confirming.status</CONFSTATUS> <AGENT>Agent.Indicator</AGENT> <EDNNUMB>EDN.Number</EDNNUMB> <PRESCRIBED>Prescribed.Goods</PRESCRIBED> <EXCISABLE>Excisable.Goods</EXCISABLE> <EXISEWHSE>Excise.Warehouse.Number</EXISEWHSE> <EXPONAME>Exporter.Name</EXPONAME> <CONSNAME>Consignee.Name</CONSNAME> <CONSKEY>Consignee.Key</CONSKEY> <DESTCTRYNA>Destination.Country.Name</DESTCTRYNA> <DESTCTRYCD>Destination.Country.COde</DESTCTRYCD> <LOADNAME>Load.Port.Name</LOADNAME> <LOADCODE>Load.Port.UN.LOCODE</LOADCODE> <DISCHNAME>Discharge.Port.Name</DISCHNAME> <DISCHCODE>Discharge.Port.UN.LOCODE</DISCHCODE> <VESSELNAME>Vessel.Name</VESSELNAME> <VESSELID>Vessel.Lloyds.Number</VESSELID> <VOYAGE>Voyage</VOYAGE> <EXPORTDATE>Export.Date</EXPORTDATE> <CARGOCODE>Cargo.Type.Code</CARGOCODE> <GOODSCODE>Goods.Type.Code</GOODSCODE> <INVCURRCD>Invoice.Currency.Code</INVCURRCD> <FOBCURRCD>FOB.Currency.Code</FOBCURRCD> <PACKCOUNT>Package.Count</PACKCOUNT> <CONTCOUNT>Container.Count</CONTCOUNT> <INVOICED>Invoiced.in.EdiSoft</INVOICED> <STATUS>Status.with.ICS</STATUS> <Line.Item> <LINENO>Line.Number</LINENO> <AHECCCODE>AHECC.Code</AHECCCODE> <ORIGCTRYNA>Origin.Country.Name</ORIGCTRYNA> <ORIGCTRYCD>Origin.Country.Code</ORIGCTRYCD> <ORIGSTATE>Origin.State</ORIGSTATE> <NETQTY>Net.Quantity</NETQTY> <WEIGHTUOM>Weight.Unit.of.Measure</WEIGHTUOM> <WEIGHT>Weight</WEIGHT> <LINEFOB>LIne.FOB.Value</LINEFOB> <DESCRIPT>Description.of.Goods</DESCRIPT> <Permit> <LINENO>Line.Number</LINENO> <PERMITNO>Permit.Number</PERMITNO> </Permit> <Temporary.Permit> <LINENO>Line.Number</LINENO> <PERMITNO>Temporary.Permit.Number</PERMITNO> </Temporary.Permit> <Assay> <LINENO>Line.Number</LINENO> <ELEMENT>Element.Symbol.Code</ELEMENT> <CONCENT>Element.Concentration</CONCENT> </Assay> </Line.Item> </EDN.Header> </EDN.Data.Transfer>
RFP Data Transfer Schema
<?xml version="1.0"?> <RFP.Data.Transfer> <RFP.Header> <USERREF>User.Reference</USERREF> <ORDERRFP>ORDR.this.RFP</ORDERRFP> <CUSTAGENT>AQIS.as.Agent</CUSTAGENT> <EXPONAME>Exporter.Name</EXPONAME> <EXPODPIE>Exporter.Number</EXPODPIE> <EXPOTYPE>Exporter.Type</EXPOTYPE> <CONSNAME>Consignee.Name</CONSNAME> <CONSSTREET>Consignee.Street.1</CONSSTREET> <CONSSTR2>Consignee.Street.2</CONSSTR2> <CONSTOWN>Consignee.Town</CONSTOWN> <CONSSTATE>Consignee.State</CONSSTATE> <CONSCTRYIS>Consignee.Country.UN.LOCODE</CONSCTRYIS> <CONSREP>Consignee.Representative</CONSREP> <CONSREF>Consignee.Reference.ECERT</CONSREF> <CONSKEY>Consignee.External.Key</CONSKEY> <COMMODCD>Commodity.Code</COMMODCD> <INSPNAME>Inspection.Establishment.Name</INSPNAME> <INSPESTAB>Inspection.Establishment.Number</INSPESTAB> <INSPAQA>Inspection.Establishment.is.AQA</INSPAQA> <INSPREQ>Inspection.Requested.Date</INSPREQ> <INSPSTART>Inspection.Start.Date</INSPSTART> <INSPDATE>Inspected.Date</INSPDATE> <INSPTIME>Inspection.Time</INSPTIME> <INSPDETS>Inspector.Comments</INSPDETS> <HCPRINT>HC.Print.Mode</HCPRINT> <HCNAME>HC.Print.Location.Name</HCNAME> <HCLOCN>HC.Print.Location.Code</HCLOCN> <HCSPLITCON>Split.HC.on.Container</HCSPLITCON> <HCSPLITMAR>Split.HC.on.Marks</HCSPLITMAR> <HCSPLITPAC>Split.HC.on.Package</HCSPLITPAC> <LOADNAME>Load.Port.Name</LOADNAME> <LOADCODE>Load.Port.UN.LOCODE</LOADCODE> <TRANMODE>Transport.Mode</TRANMODE> <VESSNAME>Vessel.Name</VESSNAME> <VOYAGE>Voyage.Flight</VOYAGE> <EXPODATE>Export.Date</EXPODATE> <PACKDATE>Packed.Date</PACKDATE> <LOTNUMBER>Lot.Number</LOTNUMBER> <DISCHNAME>Discharge.Port.Name</DISCHNAME> <DISCHCODE>Discharge.Port.Code</DISCHCODE> <BORDERNAME>Border.Port.Name</BORDERNAME> <BORDERCODE>Border.Port.UN.LOCODE</BORDERCODE> <CTRYNAME>Final.Country.Name</CTRYNAME> <CTRYCODE>Final.Country.UN.LOCODE</CTRYCODE> <FINALCITY>Final.City.Name</FINALCITY> <RFPNUMB>RFP.Number</RFPNUMB> <PERMNUMB>Permit.Number</PERMNUMB> <PERMDATE>Permit.Date</PERMDATE> <SEALSTART>Seal.Start.Date</SEALSTART> <SEALEND>Seal.End.Date</SEALEND> <ECNNUMB>EDN.Number</ECNNUMB> <ECNSTAT>EDN.Status</ECNSTAT> <INVCURR>Invoice.Currency.Code</INVCURR> <FOBCURR>FOB.Currency.Code</FOBCURR> <RFPSTATUS>RFP.Status</RFPSTATUS> <TEMPERATUR>Transhipment.Temperature</TEMPERATUR> <MINTEMP>Minimum.Transhipment.Temperature</MINTEMP> <MAXTEMP>Maximum.Transhipment.Temperature</MAXTEMP> <TEMPUOM>Temperature.Unit.of.Measure</TEMPUOM> <EXPODECL>Exporter.Declaration</EXPODECL> <INSPID>Inspector.ID</INSPID> <EMBARGO>Embargo.Status</EMBARGO> <ORIGNAME>Product.Source.Country.Name</ORIGNAME> <ORIGCODE>Product.Source.Country.UN.LOCODE</ORIGCODE> <SHIPSTOR>Ships.Stores.Indicator</SHIPSTOR> <SHIPCOMP>Shipping.Company.Name</SHIPCOMP> <QUOTAIND>Quota.Indicator</QUOTAIND> <AQISREGNNA>AQIS.Region.Name</AQISREGNNA> <AQISREGNCD>AQIS.Region.Code</AQISREGNCD> <LCNOTIFY>LC.Notify.Party</LCNOTIFY> <LCTEXT>LC.Text</LCTEXT> <ADDITINFO>Additional.Information</ADDITINFO> <CATCHZONE>Catching.Zone</CATCHZONE> <EDIUSERNAM>EDI.User.Name</EDIUSERNAM> <EDIUSERCOD>EDI.User.Number</EDIUSERCOD> <TOTPACKS>Total.Packages</TOTPACKS> <TOTWEIGHT>Total.Weight</TOTWEIGHT> <TOTLINES>Total.Lines</TOTLINES> <Load.Port> <PORTNAME>Load.Port.Name</PORTNAME> <PORTCODE>Load.Port.UN.LOCODE</PORTCODE> </Load.Port> <Discharge.Port> <PORTNAME>Discharge.Port.Name</PORTNAME> <PORTCODE>Discharge.Port.UN.LOCODE</PORTCODE> </Discharge.Port> <Transit.Country> <CTRYNAME>Transit.Country.Name</CTRYNAME> <CTRYCODE>Transit.Country.UN.LOCODE</CTRYCODE> </Transit.Country> <Vessel.Hold> <COMPARTMEN>Compartment</COMPARTMEN> <PORT>Port.Inspected.Name</PORT> <INSPDATE>Inspection.Date</INSPDATE> </Vessel.Hold> <Import.Permit> <LINENO>Import.Permit.Sequence.in.RFP</LINENO> <IMPPERM>Import.Permit.Number</IMPPERM> <PERMDATE>Import.Permit.Date</PERMDATE> </Import.Permit> <Line.Item> <LINENO>Line.Number</LINENO> <PRESTYPE>Preservation.Type</PRESTYPE> <PRODTYPE>Product.Type</PRODTYPE> <PACKTYPE>Package.Type</PACKTYPE> <SUPPCODE>Supplementary.Code</SUPPCODE> <PACKCOUNT>Outer.Package.Count</PACKCOUNT> <PACKUOM>Outer.Package.Unit.of.Measure</PACKUOM> <PACKACCUR>Accuracy.of.Outer.Package.Weight</PACKACCUR> <PACKWEIGH>Outer.Package.Weight</PACKWEIGH> <PACKWTUOM>Outer.Package.Weight.Unit.of.Measure</PACKWTUOM> <INTERCOUNT>Intermediate.Package.Count</INTERCOUNT> <INTERUOM>Intermediate.Package.Unit.of.Measure</INTERUOM> <INTERACCUR>Accuracy.of.Intermediate.Package.Weight</INTERACCUR> <INTERWEIGH>Intermediate.Package.Weight</INTERWEIGH> <INTERWTUOM>Intermediate.Package.Weight.Unit.of.Measure</INTERWTUOM> <INNERCOUNT>Inner.Package.Count</INNERCOUNT> <INNERUOM>Inner.Package.Unit.of.Measure</INNERUOM> <INNERACCUR>Accuracy.of.Inner.Package.Weight</INNERACCUR> <INNERWEIGH>Inner.Package.Weight</INNERWEIGH> <INNERWTUOM>Inner.Package.Weight.Unit.of.Measure</INNERWTUOM> <SHIPMARKS>Shipping.Marks</SHIPMARKS> <NETMETWT>Net.Metric.Weight</NETMETWT> <NETMETUOM>Net.Metric.Unit.of.Measure</NETMETUOM> <GROSSMETWT>Gross.Metric.Weight</GROSSMETWT> <GROSSMETUO>Gross.Metric.Weight.Unit.of.Measure</GROSSMETUO> <NETIMPWT>Net.Imperial.Weight</NETIMPWT> <NETIMPUOM>Met.Imperial.Weight.Unit.of.Measure</NETIMPUOM> <BEEFVEAL>Beef.Veal.Indicator</BEEFVEAL> <AMLCAPPNO>AMLC.Approval.Number</AMLCAPPNO> <CUTCODE>Cut.or.Category.Code</CUTCODE> <CHEMLEAN>Chemical.Lean.Indicator</CHEMLEAN> <PERFOWNER>Performance.Owner.Name</PERFOWNER> <PERFOWNNO>Performance.Owner.Number</PERFOWNNO> <GROWERNUMB>Grower.Number</GROWERNUMB> <INSPDESC>Health.Certificate.Description.N.A</INSPDESC> <EXPODESC>Exporter.Defined.Description</EXPODESC> <HCDESC>Health.Certificate.Description</HCDESC> <ADDPRODDES>Additional.Product.Description</ADDPRODDES> <COMMPROD>Commercial.Product.Description</COMMPROD> <HCFORMAT>HC.Format</HCFORMAT> <HCENDORSE>HC.Endorsement</HCENDORSE> <HCNUMBER>Health.Certificate.Number</HCNUMBER> <USEBYSTART>Use.by.Start.Date</USEBYSTART> <USEBYEND>Use.by.End.Date</USEBYEND> <LABLAPPRNO>Label.Approval.Number</LABLAPPRNO> <AHECCCD>AHECC.Code</AHECCCD> <FOBAMOUNT>FOB.Value</FOBAMOUNT> <RELAUTH>Relative.Permit.Authority</RELAUTH> <RELPERM>Relative.Permit.Number</RELPERM> <RELDATE>Relative.Permit.Date</RELDATE> <CONCCODE>Concession.Code</CONCCODE> <SOURCESTAT>Product.Source.State</SOURCESTAT> <MILKPROTPC>Pilk.Protein.Percent</MILKPROTPC> <MILKFATPC>Milk.Fat.Percent</MILKFATPC> <DRAINWT>Drained.Weight</DRAINWT> <DRAINWTUOM>Drained.Weight.Unit.of.Measure</DRAINWTUOM> <ADDDECL>Additional.Declaration</ADDDECL> <SACKINSDAT>Sack.Inspection.Date</SACKINSDAT> <EMPTINSDAT>Empty.Container.Inspection.Date</EMPTINSDAT> <SALTDATE>Salting.Date</SALTDATE> <STATTEXT>Statement.Text</STATTEXT> <STATCODES>Statement.Codes</STATCODES> <REQEXTCERT>Requested.Extra.Certificates</REQEXTCERT> <ALLEXTCERT>Allocated.Extra.Certificates</ALLEXTCERT> <IMPAUTHCD>Import.Authority.Code</IMPAUTHCD> <Process.Time> <LINENO>Line.Number</LINENO> <PROCTYPE>Process.Type</PROCTYPE> <ESTABNAME>Process.Establishment.Name</ESTABNAME> <ESTABNO>Process.Establishment.Number</ESTABNO> <ESTABAQA>Process.Establishment.is.AQA</ESTABAQA> <DATESTART>Process.Start.Date</DATESTART> <DATEEND>Process.End.Date</DATEEND> <TREATMENT>Treatment.Code</TREATMENT> <TREATINFO>Treatment.Information</TREATINFO> <HARVEST>Harvest.Area</HARVEST> <LEASENO>Lease.Number</LEASENO> <DEPURDATE>Depuration.Date</DEPURDATE> </Process.Time> <Container> <LINENO>Line.Number</LINENO> <CONTNO>Container.Number</CONTNO> <NETWGHT>IMA1.Container.Net.Weight</NETWGHT> <GROSSWGHT>IMA1.Container.Gross.Weight</GROSSWGHT> <PRODDESC>IMA1.Product.Description</PRODDESC> <SERIALNO>IMA1.Serial.Number</SERIALNO> <INVOICENO>IMA1.Invoice.Number</INVOICENO> <INVOICEDAT>IMA1.Invoice.Date</INVOICEDAT> <QUOTAYEAR>IMA1.Quota.Year</QUOTAYEAR> <SEAL>Seal.Number</SEAL> </Container> </Line.Item> </RFP.Header> </RFP.Data.Transfer>
PRA Data Transfer Schema
<?xml version="1.0"?> <PRA.Data.Transfer> <PRA.Header> <USERREF>User.Reference</USERREF> <STEVNAME>Stevedore.Name</STEVNAME> <CONTAINERN>Container.Number</CONTAINERN> <CONTTYPE>Container.Type</CONTTYPE> <BOOKINGREF>Booking.Reference</BOOKINGREF> <CARRNAME>Carrier.Name</CARRNAME> <CARRIDCODE>Carrier.Code</CARRIDCODE> <CARRABN>Carrier.ABN</CARRABN> <CARRIERREF>Carrier.Reference</CARRIERREF> <CARRIERTRU>Carrier.Booking</CARRIERTRU> <CARRIERBOO>Carrier.Truck.No</CARRIERBOO> <RECVTRNAME>Receiving.Terminal.Name</RECVTRNAME> <RECVTRCODE>Receiving.Terminal.Code</RECVTRCODE> <RECEIPTEDD>Estimated.Departure.Date.from.Receiving</RECEIPTEDD> <RECEIPTETD>Estimated.Departure.Time.from.Receiving</RECEIPTETD> <LOADEDA>Estimated.Arrival.Date.at.Loading</LOADEDA> <LOADETA>Estimated.Arrival.Time.at.Loading</LOADETA> <LOADTRNAME>Loading.Terminal.Name</LOADTRNAME> <LOADTRCODE>Loading.Terminal.Code</LOADTRCODE> <SHIPCONAME>Shipping.Company.Name</SHIPCONAME> <SHIPCOACOS>Shipping.Company.ACOS.Code</SHIPCOACOS> <VESSNAME>Vessel.Name</VESSNAME> <VOYAGE>Voyage</VOYAGE> <DISCHNAME>Discharge.Port.Name</DISCHNAME> <DISCHCODE>Discharge.Port.UN.LOCODE</DISCHCODE> <DESTNAME>Destination.Name</DESTNAME> <DESTCODE>Destination.UN.LOCODE</DESTCODE> <EXPONAME>Exporter.Name</EXPONAME> <EXPODPIE>Exporter.Number</EXPODPIE> <EXPOTYPE>Exporter.Type</EXPOTYPE> <CANNUMBER>CAN.Number</CANNUMBER> <ISOSIZE>Container.ISO.Size</ISOSIZE> <EMPTY>Empty.Container.Indicator</EMPTY> <ACOSCOMMCD>ACOS.Commodity.Code</ACOSCOMMCD> <ACOSCOMMDE>ACOS.Commodity.Description</ACOSCOMMDE> <GROSSWT>Container.Gross.Weight</GROSSWT> <NETTWT>Container.Net.Weight</NETTWT> <HUMIDITY>Humidity.Setting</HUMIDITY> <VENT>Vent.Setting</VENT> <VENTMEAS>Container.Vent.Measure</VENTMEAS> <OVERFRONT>Front.Oversize</OVERFRONT> <OVERBACK>Back.Oversize</OVERBACK> <OVERLEFT>Left.Oversize</OVERLEFT> <OVERRIGHT>Right.Oversize</OVERRIGHT> <OVERHEIGHT>Height.Oversize</OVERHEIGHT> <SHORTDESC>Short.Description.of.Goods</SHORTDESC> <TRANSPTEMP>Transshipment.Temperature</TRANSPTEMP> <STATUS>PRA.Acceptance.Status</STATUS> <PRIORSTATU>Prior.Status</PRIORSTATU> <ACCEPTEDDA>Accepted.Date</ACCEPTEDDA> <SENTDATE>Sent.Date</SENTDATE> <SENTTIME>Sent.Time</SENTTIME> <SENTOUT>Sent.to.External.System</SENTOUT> <SENTOUTDAT>Sent.to.External.Date</SENTOUTDAT> <MESSAGES>Messages</MESSAGES> <Attached.Equipment> <CODE>Equipment.Code</CODE> <SERIALNO>Serial.Number</SERIALNO> </Attached.Equipment> <Container.Seal> <SEALNUMB>Seal.Number</SEALNUMB> <SEALAUTH>Seal.Authority</SEALAUTH> <DAMAGED>Damaged.Seal.Indicator</DAMAGED> </Container.Seal> <Dangerous.Goods> <DGCONTACT>Dangerous.Goods.Contact</DGCONTACT> <DGPHONE>Dangerous.Goods.Contact.Phone</DGPHONE> <DGFAX>Dangerous.Goods.Contact.Fax</DGFAX> <DGEMAIL>Dangerous.Goods.Email</DGEMAIL> <DGTECHNAME>Technical.Name</DGTECHNAME> <DGIMCLASS>IMDG.Class</DGIMCLASS> <DGUNNUMB>UN.Number</DGUNNUMB> <DGFLASHPT>Flash.Point</DGFLASHPT> <DGPACKGROU>Packing.Group</DGPACKGROU> <DGWEIGHT>Weight</DGWEIGHT> </Dangerous.Goods> </PRA.Header> </PRA.Data.Transfer> |