Fullscreen Image

Refrigerant Register

This document is the functional specification to implement a web service to generate an XML document to be uploaded to the Refrigerant Registration and Reporting System (R3).

ClosedBackground

Under AB 32, the Air Resources Board (ARB) requires registration and annual reporting for facilities that are subject to the act. Companies are required to register, providing information about the company, each facility, their refrigeration systems, Automatic Leak Detection (ALD) systems, and annual reporting of refrigeration system service and leak repair information.

To assist in automating data entry to the R3 program, companies may upload data directly into the program for registration and for facility annual reporting. To test the import of data into the R3 program, ARB provides a test location for companies and developers to test the upload of their XML data document.

A vx Suite web service is provided to generate the XML document and download it to your machine.

Closedvx Suite Implementation

The following tasks are needed to implement the web service and associated components:

  • Create a data mapping of the R3 XML document to the data source from the vx Suite database.

  • Create a web service to extract refrigerant data from the vx Suite database and create a customer-specific XML file.

  • An hta program will be provided by vx Suite to initiate a web service request to the vx Suite web service to download the XML data.

  • You will initiate web service requests to download the XML data using the hta program that resides on your machine.

  • An html test program will be created to test the web service and show the generated XML document.

  • A browser-based URL will be provided by California Air Resources to provide an upload method for you to send the XML file from your local machine to the ARB R3 program.

ClosedTest

The California Air Resource Board has a site to test the data XML for upload. It may be found at the following URL: http://www.arb.ca.gov/r3test

This URL contains a way to upload and test the generated XML, as well as links to download the latest XSD and sample XML.

The system does not expect a company profile in the XML document—since the company profile is already established during the initial account creation process, the user will be logged in under that company or a facility of the company. Therefore, the company information is never needed. Facility data can be uploaded to create the facilities under the company in addition to refrigeration systems and service records.

ClosedFor Production data uploads

https://ssl.arb.ca.gov/rmp-r3//r3test is a test platform. The sample XSD and XML should come from the production site. You can use the test platform for testing your design, but real data should be verified and uploaded through the production site.

Important!

Do not put test data on the production platform or in our reports. We do not check if the data is test data or real, so test data will clutter reports and invalidate conclusions we derive from examining the data.

Refrigerant Reporting Web Service Test Programs

Client programs have been created for testing web service GetRefrigerantReportingEvents.

HTA programs

Refrigerant Registration and Reporting System HTA Flat File

Several HTTP request options are available to control the XML output.

Parameter names and description:

  • name="Retail Co": Required. Client Name

  • client_id=1234": Required. Client ID

  • ein_code="0": Optional. EIN code. If the value is "0", this field will be ignored.

  • sic_code="123456": Required

  • naics_code="123456": Required

  • site_name="A0140": Optional. Enter a site name to limit the XML output to a specific Site.

  • site_state="CA": Required. Site state from addresses (default "CA")

  • full_charge="50": Required. Minimum full charge in pounds of refrigerant systems (default "50")

  • validate_xml="true | false": Optional. If the value is True, then validate the generated R3 XML. The validation results are appended to the XML output stream. For debugging only. (default "false")

  • show_errors="true | false": Optional. If the value is True, then show data errors at end of XML output (default "false"). For debugging only.

  • include_service_record_list="true | false": Required. If the value is True, then include service records in the XML output.

ClosedClient Names and Staging URLs

To run a test program, you need the Client's web service userid and password.

Client Name Staging URL
Bashas https://staging.vx Suite.com/DataNett/test/webservices/test_getRefrigerateReportingEvents_Bashas.html
Bristol Farms https://staging.vx Suite.com/DataNett/test/webservices/test_getRefrigerateReportingEvents_BristolFarms.html
Costco Wholesale https://staging.vx Suite.com/DataNett/test/webservices/test_getRefrigerateReportingEvents_Costco.html
Restaurant Depot https://staging.vx Suite.com/DataNett/test/webservices/test_getRefrigerateReportingEvents_RestaurantDepot.html
Retail Co https://staging.vx Suite.com/DataNett/test/webservices/test_getRefrigerateReportingEvents_retailco.html
Safeway Foods https://staging.vx Suite.com/DataNett/test/webservices/test_getRefrigerateReportingEvents_SafewayFoods.html
SaveMart Supermarkets https://staging.vx Suite.com/DataNett/test/webservices/test_getRefrigerateReportingEvents_SaveMart.html
Stater Brothers https://staging.vx Suite.com/DataNett/test/webservices/test_getRefrigerateReportingEvents_StaterBrothers.html
Supervalu https://staging.vx Suite.com/DataNett/test/webservices/test_getRefrigerateReportingEvents_Supervalu.html
Target https://staging.vx Suite.com/DataNett/test/webservices/test_getRefrigerateReportingEvents_target.html
Trader Joe's https://staging.vx Suite.com/DataNett/test/webservices/test_getRefrigerateReportingEvents_TraderJoes.html
Wal-Mart https://staging.vx Suite.com/DataNett/test/webservices/test_getRefrigerateReportingEvents_walmart.html

To run a test program, open an internet browser and enter the following URL:

Environment URL
Customer Staging staging.vx Suite.com/DataNett/test/webservices/test_program.html
UAT uat.vx Suite.com/DataNett/test/webservices/test_program.html
Tomcat Staging tstage.vx Suite.com/DataNett/test/webservices/test_program.html
Production wbs.vx Suite.com/DataNett/test/webservices/test_program.html