Example SSO XML Instance Document Alabama Department of Environment Management P.O. Box 301463 Montgomery, Alabama 36130-1463 Tel: (334) 279-3049 Fax: (334) 271-7950 email: [email protected] ADEM Example SSO XML Instance Document Table of Contents 1 Introduction ............................................................................................................................................................... 3 2 SSO XML Template File ............................................................................................................................................ 4 2.1 Download Facility Specific “Blank” SSO XML Template File from E2 ................................................................. 4 2.2 Generate SSO XML Template from SSO Schema .............................................................................................. 4 3 SSO XML File Population ......................................................................................................................................... 6 3.1 Meta Data Section ................................................................................................................................................ 6 3.2 Receiver Data Section ......................................................................................................................................... 7 3.3 Facility Identification Section ................................................................................................................................ 8 3.4 Report Identification Section ................................................................................................................................ 8 3.5 Monitoring Data Section ....................................................................................................................................... 9 3.6 Example SSO Instance XML File ....................................................................................................................... 15 4 Appendix Reference for Receiving water ID & Names ........................................................................................ 18 Version Date: 20171015 Page 2 of 135 ADEM Example SSO XML Instance Document 1 Introduction This document contains examples of an instance document used in the SSO (Sanitary Sewer Overflow) Report submission on Alabama Department of Environmental Management’s (ADEM) online electronic environmental (E2) reporting system. For instruction on how to submit SSO-data filled XML file in E2, please see SSO User Guide document. Facility user may download the latest eSSO User Guide & Example XML Instance Document on the E2 login page. Clicking the “eSSO User Guide” link or “Example SSO XML Instance Document” link opens the applicable document in a PDF file. Version Date: 20171015 Page 3 of 135 ADEM Example SSO XML Instance Document 2 SSO XML Template File 2.1 Download Facility Specific “Blank” SSO XML Template File from E2 Facility user may download a “blank” SSO XML Temple with selected Facility and Permit information populated in E2’s “Create New Report” page. Please open the ‘Create a New Report’ page, select ‘SSO Event Report’ as Report Type, and select the desired facility, then click ‘Download SSO XML Template’ button to download the XML template file. 2.2 Generate SSO XML Template from SSO Schema After login into E2, a link is available on the “Home” page for you to download SSO XML Schema. From the SSO XML Schema, you may generate a completely blank SSO XML template for submission. If you are starting/using your own blank SSO XML template, please populate the facility information and permit number data elements/tags accordingly. Version Date: 20171015 Page 4 of 135 ADEM Example SSO XML Instance Document Version Date: 20171015 Page 5 of 135 ADEM Example SSO XML Instance Document 3 SSO XML File Population The SSO XML file includes the following main sections: Meta Data Receiver Submission o Facility . Facility Identification . Report Report Identification Monitoring Data Specific details for each section is reviewed in sections below. 3.1 Meta Data Section For the Meta Data Section <MetaData>, please include the following: <MetaData> <SchemaIdentification>e-SSO Schema version 1.0</SchemaIdentification> <SchemaDescription>e-SSO Work Group Schema version 1.0</SchemaDescription> <SchemaPurpose>Sanitary Sewer Overflow Report submissions</SchemaPurpose> <SchemaVersion>1</SchemaVersion> <SchemaCreateDate>2011-04-29</SchemaCreateDate> <SchemaLastUpdateBy>e-SSO XML Schema Work Group</SchemaLastUpdateBy> <SchemaLastUpdateDate>2011-04-29</SchemaLastUpdateDate> <SchemaContactInformation>[email protected]</SchemaContactInformation> </MetaData> Version Date: 20171015 Page 6 of 135 ADEM Example SSO XML Instance Document 3.2 Receiver Data Section For the Receiver Section <Receiver>, please include the following: <Receiver> <AgencyName>ADEM</AgencyName> <ReceivercontactName>PCS-Data Entry</ReceivercontactName> <ReceivercontactTitle>ADEM</ReceivercontactTitle> <ReceiverMailAddress> <MailingAddressText>1400 Coliseum Blvd.</MailingAddressText> <SupplementalAddressText>P.O. Box 301463</SupplementalAddressText> <MailingAddressCityName>Montgomery</MailingAddressCityName> <MailingAddressStateUSPSCode>AL</MailingAddressStateUSPSCode> <MailingAddressStateName>Alabama</MailingAddressStateName> <MailingAddressCountryName>USA</MailingAddressCountryName> <MailingAddressZIPCode>36110</MailingAddressZIPCode> </ReceiverMailAddress> </Receiver> Version Date: 20171015 Page 7 of 135 ADEM Example SSO XML Instance Document 3.3 Facility Identification Section For the Facility Identification Section <FacilityIdentification>, please include the following: 3.4 Report Identification Section For the Report Identification Section <ReportIdentification>, please include the following: Please make sure to have the correct permit number populated in the <PermitNumber> tag and “SSO” as the <ReportType> Version Date: 20171015 Page 8 of 135 ADEM Example SSO XML Instance Document 3.5 Monitoring Data Section For the Monitoring Data Section <MonitoringData>, please include the following: Please note that “minimum” information required for submission is indicated in “Bold”. 1. <Facility_SSO_Report_ID /> Facility SSO Report ID Mandatory field for report submission Accept Alphanumeric value: minimum one character and maximum 20 characters Please note that: a) It is Facility User’s responsibility to keep track of their own Facility SSO Report ID on the SSO XML file. b) For every new SSO report, Facility User will need to use a “new” unique Facility SSO Report ID on the SSO XML file c) If the Facility User submits a SSO XML file with a Facility SSO Report ID that has been previously submitted in E2, E2 will treat this eSSO submission as a REVISION. d) It is up to the facility user to use the “same” Facility SSO Report ID to revise a previously submitted eSSO report in E2 2. <Date_SSO_Began /> Date/Time SSO Began Mandatory field for report submission Accept date time value in MM/DD/YYYY 00:00:00 AM/PM, null value is not allowed 3. <SSO_OnGoing_Ind /> Is SSO currently ongoing? Mandatory field for report submission Accept one text character value of ‘Y’ for Yes, ‘N’ for No 4. <Date_SSO_Stopped /> Date/Time SSO Stopped Mandatory field for report submission if <SSO_OnGoing_Ind /> tag’s value = ‘N’ Accept date time value in MM/DD/YYYY 00:00:00 AM/PM 5. <Wet_Weather_Ind /> Did the SSO occur during wet weather? Accept one text character value of ‘Y’ for Yes, ‘N’ for No, or null 6. <Extreme_Weather_Event_Ind /> Was the SSO caused by an extreme weather event (e.g. hurricane)? Accept one text character value of ‘Y’ for Yes, ‘N’ for No, or null 7. <Extreme_Weather_Event_Text /> If Yes, describe of the nature of the extreme weather event Accept up to 2000 text characters value 8. <Est_Volume_Range_Value_CD /> Report Estimated Volume as Estimated Value or Range Value Accept one text character value of ‘V’ for Estimated Value, ‘R’ for Range and null 9. <Est_Volume_Range_ID /> Estimated Volume: Accept numeric value from 6 to 15 (to represent the corresponding range value 6: <1,000 gal 7: 1,000 >= gallons < 10,000 8: 10,000 >= gallons < 25,000 9: 25,000 >= gallons < 50,000 10: 50,000 >= gallons < 75,000 11: 75,000 >= gallons < 100,000 Version Date: 20171015 Page 9 of 135 ADEM Example SSO XML Instance Document 12: 100,000 >= gallons < 250,000 13: 250,000 >= gallons < 500,000 14: 500,000 >= gallons < 750,000 15: 750,000 >= gallons < 1,000,000 10. <Est_Volume_Value /> Estimated Volume in gallons Accept up to 18 digit numeric value with two decimal places 11. <Department_Notify_Ind /> Was the Department notified within 24 hours? Accept one text character value of ‘Y’ for Yes, ‘N’ for No and null 12. < Department_Notify_Date /> Date/Time notified for <Department_Notify_Ind /> above Mandatory field if < Verbal_Notify_Ind /> tag’s value = ‘Y’ Accept date time value in MM/DD/YYYY 00:00:00 AM/PM 13. < Department_Notify_Method /> Method of notification for the question, “Was the Department notified within 24 hours?” Mandatory field if < Verbal_Notify_Ind /> tag’s value = ‘Y’ Accept two letter text character value as follows: o VT: Verbal/Telephone, o EE: Electronic via eSSO, o OT: Other 14. <Verbal_Notify_Other_Text> Text for Other Method of Notification: Mandatory field if < Verbal_Notify_Method /> tag’s value = ‘OT’ Accept up to 100 text characters value 15. <Verbal_Notify_Person /> Person that verbally notified: Mandatory