Setting up an interface with an e-citation vendor

Required data format

e_citation_service_producer.xsd  - the XML schema for providing electronic citation data from a single traffic stop/incident.

e_citation_service_producer.html - a human-readable version of the same thing

Testing code values for court-specific data


Use the following values (or let us know if if this isn't possible):
  • Court ORI: IL016025J (Cook County).  It isn't absolutely necessary to set this, since our e-citation ticket import presumes that the e-citation vendor didn't provide the wrong court's data.
  • Agency ORI: IL0030100 (Greenville)- changed this code on 11/28/2016 to one which isn't County (due to FB15477)
  • Officer badge number/name: 999/SMITH, JOSEPH
    • Some test scenario tickets can use other badge numbers and names
  • Hearing courtroom (<Event>/Location)- if the court expects the officer to indicate this, it has be a courtroom number which exists in PC JIMS
  • TownshipCode/TownshipName: 9/Panama

Testing code values for violator/litigant data

Use the following litigant for all citations except the CA/MX test (Test #4):

  • John Q. Smith
  • 999 West 9th Street, Centralia, Illinois, 62801
  • DOB: 01/01/1978
  • DL Number: ILS53047578001
For Test #4, use the following, respectively:
  • Canada:
    • John R. Smythe
    • 465 Victoria Street, Kamloops, BC V2C 2A9, Canada
    • DOB: 01/01/1978
    • DL Number: 1234567
  • Mexico:
    • Juan S. Herrera
    • Perif. Carlos Pellicer Cámara 511, Guayabal, 86080 Villahermosa, Tab., Mexico
    • DOB: 01/01/1978
    • DL Number: H1234

Test scenarios


BEFORE TESTING!  Goodin staff processing the test files shall verify that the client has signed a proposal for our e-citation services.

The e-cation vendor should create the following test citations,  while configured using the testing code values referenced above.  All test data should include the citation PDFs in-line as per the above-referenced schema. 

Revised 12/17/2021

A single test ticket should represent only one scenario

NOTE 1: The e-citation vendor has the option when submitting their tests to affirm that one or more tests aren't even possible with their system or in the given county being tested.

  1. Multiple offenses on the same incident.
    1. One with a CM charge and a TR charge (Expected results: Pre-2022-  two separate cases (a CM and a TR). Post-2022- A single case (type CM) having both charges)
    2. One with two TR charges (Expected results: Pre-2022- JIMS will split-out the two charges onto separate cases.  Post-2022- a single TR case.)
    3. Added 11/8/2021: First offense entered in e-citation system is an MT charge and the second is a TR charge.  GAL must test with our 2022 version.  (Expected results: Pre-2022-  N/A.  Post-2022- A single case (type MT) having both charges)
      1. One possible MT offense: Offense 19382    DL EXPIRED MORE THAN A YEAR   625 ILCS 5 6-101
    4. Added 11/8/2021: First offense entered is a TR charge and second is an MT charge .  GAL must test with our 2022 version.  (Expected results: Pre-2022-  N/A.  Post-2022- A single case (type MT) having both charges)
    5. Modified 12/17/2021: Major traffic test: Use offense code 17614 Speeding 35+ MPH Over Limit , 625 ILCS 5/11-601.5(b) (Expected results: Pre-2022, N/A. Post-2022: An MT case having both charges)
    6. Added 12/17/2021: One QC may-appear offense and one TR may-appear (Expected results: Pre-2022, N/A. Post-2022: A TR case having both charges)
  2. DUI- this should use both "flavors" of DUI offense typically charged (offense codes 14721 and 14722). (Expected results: JIMS will put both charges on the same DT case)
  3. Local ordinance violations:
    1. Statutory/ILCS violations with an AOIC offense code.  Technically, these aren't supposed to be written as ordinance violations, but it still happens occasionally (e.g. underage consumption, minor cannabis possession, dog running at large).Expected results: The XML <Offense>Type should (per the specs) always contains the Case Type assigned to that offense in the AOIC offense table (e.g. TR, MT, CM etc).  As such, the CMS should make a case of that type (see Note 1 above)
    2. Non-ILCS violations such as for weed abatement.  Confirm that the provider will always sends <Charge>Code="0000000" when there is no offense code (Expected results: The XML <Offense>Type for local ordinance violations not in the offense table should always be OV, resulting in the CMS creating an OV case and importing the submitted ordinance violation charge description into the Edit Charges screen. NOTE: If you get an RTE when processing the OV in the Inbox, it is almost always because the XML is missing the Charge Code of "0000000". Ask digiTICKET to fix this.)
    3. A test of both combined into a single citation (Expected results:A TR or MT case, with a count having the submitted local ordinance violation charge description on it)
      1. Note for testing FB19906- if the Inbox manages to do this test correctly, see if a user can MANUALLY create such as case
      2. NOTE: Added 11/05/2021
  4. Foreign (Canadian or Mexican) DL, foreign plates and foreign address (Expected results: JIMS will import the foreign address, including the state/province and country)
  6. Different bond types
    1. Non-cash (Expected results: The bond type chosen will appear in the Edit Case screen (under the Case tab in the "Bond type" drop-down menu))
    2. Cash (needs <Payment> element (Expected results: The bond type chosen will appear as "Cash" in the Edit Case screen (under the Case tab in the "Bond type" drop-down menu) with the amount paid appearing in the "Cash bond set" field, and you will be prompted to receipt the payment upon saving the case)
    3. Both (needs <Payment> element.  This test dropped per Kayte 8/24/2021: DUIs were the only situation in which both a cash and non-cash bond would've been possible.  The bond type called "DUI Bond" was probably added expressly to allow systems to indicate two bond types at once.  So there is no reason for this test.
  7. Do one ticket for a driver with a commercial DL, driving a commercial vehicle and carry hazardous materials. This will use the HazardousMaterialsFlag, DriverPassenger and CommercialVehicleFlag elelments (see for more on these elements and their values). (Expected results: The "Commercial driver license", "Commercial vehicle", and "HazMat vehicle" checkboxes in the Vehicles tab will all be checked)
  8. Violator having ALL of the possible identity info in (Expected results: All of the above-mentioned identity information will appear under the "Litigant" tab in the appropriate field for each. NOTE: All height measurements come in from digiTICKET as inches, and JIMS converts them to feet/inches measurement.)
  9. One test using several items in the schema which have a required list of values (those having an "enumeration"): 
    1. Man, with hazel-colored eyes and no hair at all
    2. Incident took place in an urban district . 
    3. Use offense code 17614 Speeding 35+ MPH Over Limit , 625 ILCS 5/11-601.5(b), to see if the e-citaion XML has <LitigantDetails>AppearanceCode="MUSTAPPEAR"
    4. The passenger was injured (PersonalInjury)
    5. Driver is required to appear in court (AppearanceCode) (Expected results: The eye color appears as such, and the "hair color" comes in as "bald". Items 2 through 4 appear within the Edit Charge screen, with the checkboxes for "Urban" and "Must-Appear" checked, and the dropdown menu for "Injury/Death" reflecting an injury ("Injury"))
  10. A ticket on a township road- as per clarification received from AOIC on 11/4/2016, the township name is  is to be provided whenever the officer sets the township road indicator to reflect that the township maintains the road on which the ticket was issued. (Expected results: The "Pay-to Agency" in the Edit Case screen is changed to the township in question (in this case Panama))
  11. NO LONGER REQUIRED (since ADR doesn't require it)) A ticket involving a passenger (if e-citation system supports that)
  12. NO LONGER REQUIRED ( case is modified as required):  Attempt to create lower-case data where allowed by the e-citation vendor's user interface, on any field containing text (e.g. FullName and AddressLine).  Added 7/19/2016
  13. Create a warning ticket for a litigant named "WARREN, INGE", to make sure that it is not sent to the court.  Added 12/16/2016 (see Note 1 above)
  14. Issues which the e-citation vendor shall affirm during testing that they comply with specs (available here), since these really  can't be tested.
    1. A ticket with no plate state (should have PlateState="")
    2. Not pre-applying a court Clerk file stamp.  Added 1/15/2021 after an issue in Marion County.
    3. Officer badge number data type and max length.   Added 1/22/2021 after an issue in Clay County. As of 1/22/2021, this means numeric with a max length of five.
    4. Ticket number data type and max length.   As of 1/22/2021, this is alpha-numeric with a max of 12 chars.
    5. Plate number- as of 1/22/2021, this is alpha-numeric with a max of 9 chars.

Production code values for court-specific configuration data


The e-citation vendor should work with the court to configure their systems to match up with key data in the court's CMS:
  • Court NCIC/ORI code is available in PC JIMS, but there's an easier way to get it.  Pick the county from the list at, then observe the value of the "court" parameter on the resulting URL
  • Agency NCIC/ORI codes are in the court agency table in JIMS
  • Charge code- e-citation shall use the standard statewide codes found in the AOIC offense table.  In some counties, certain offenses eligible to be written on a uniform complaint (DUIs?) are supposed to go to the State's Attorney rather than getting imported right into PC JIMS. The e-citation vendor is responsible for excluding these from the data for import.
  • Officer badge number/name- check them against the arresting officers set up in PC JIMS.
    • Warning: CMS requires "Lastname, Firstname" format.  Our e-citation importer makes new officers "on the fly" if they aren't in JIMS.  And because badge numbers get re-used, we add any officer whose badge number and name don't match JIMS exactly.  So failure to latch both will result in duplicate officer records.  The same thing will occur if you provide the wrong agency NCIC code for an officer.
  • Hearing courtroom and hearing type (which can show up in the <Event> element in the ticket data)-  if the court wants to use a consistent courtroom for all the hearings, the e-citation vendor will need to know this.  Many court's use a hearing type "20" (First Appearance)
  • Township names and codes- per a conversation with AOIC staff on 11/4/2016,  the township road checkbox is to be checked by the officer whenever the road is maintained by the township.  This causes JIMS to set the township as the Pay To agency so that they get money from the ticket.  Since any given township might handle maintenance, or start to do so at any given time, the e-citation system should be set up with a list of all townships in the county, and officers will have to be trained on when to check off the Township Road box on the ticket based on who is maintaining the road at the time.  To determine the code values the e-citation vendor needs to provide township data to the court:
    • Open the Edit Arresting Agencies screen (under the Technical|Case Management Tables menu)
    • Use the value in the Code column for each township.

Other configuration info for court systems

What tools are required to get the data to the court? This depend on which e-citation vendor you use:
  • DigiTicket-   they provide a program which gets the data
  • APS- GAL installs a program on your GAL PC which uses web services provided by DuPage County to regularly check for new data.

Where should a vendor-provided tools such as DigiTicket's be installed?

It's the court's choice what PC should run a program which gets the data.

Where should the e-citation data be put?
In the same location where the court keeps its Imaging files (since that is reliably available). Where is this?

  • The IP address can be found at http://countyname-judici.clients:8080/gal-nas
  • The share folder is usually \Imaging

For example: \\\Imaging . The e-citation vendor may require a mapped drive in order to access this.  If the vendor's tool is beeing installed on a PC which also runs Imaging, there is a good chance that the PC already has an "I:" drive mapped this address/folder.  If you need help setting up a mapped drive, call us.

GAL moves this data into the PC JIMS Inbox about once a minute, so the XML doesn't stay on the Imaging share for long.