In-Custody Data Extract (ICDE) Utility program

* The ICDE utility program is not automatically provided as part of Crimestar RMS but can be license separately for those who require such an extract utility.  The most common use for this utility is to provide periodic in-custody related data to support the sharing of inmate information with external jail telephone or commissary systems.

The In-Custody Data Extract (ICDE) Utility is a small stand-alone program that has been designed by Crimestar Corporation to open the Crimestar RMS database, select Jail/Arrest/Booking records for subjects shown as “In-Custody” (i.e. Not Released), assemble certain specific data fields into an output file using either a CSV or XML format and place that output file in a pre-defined configurable directory/path specification or FTP that file to a pre-defined FTP host server.  

The program makes use of a simple text based configuration file named “icde.ini” to defined certain information and parameters needed by the ICDE program for proper operation.  This configuration file allows the utility program to be configured with a variety of options detailed below.  The ICDE program can be installed on any machine that has network access to the Crimestar RMS database.  It in not necessary for any other Crimestar software to be installed on the same machine.

The resulting output .CSV file will contain one or more records where each data field is quoted with double quotes and data fields are separated from each other with commas.   This is the standard recognized specification for a .CSV file.  Example:

“0123456789”,”SMITH”,”JAMES”,”WILLIAM”,”19601201”,"M",”JID12345”,”OKITBBEHA”

If an XML file format is selected the resulting output .XML file will contain one or more records where the entire data block is wrapped in <ICDE> tags, data records are wrapped in <INMATE> tags and each data field is wrapped in an xml tag specific to the data field represented.   This is a standard format for XML.  Example:

<?xml version="1.0" encoding="WINDOWS-1252" standalone="yes"?>

<ICDE>

   <INMATE>

     <SSN>123456789</SSN>

     <LAST_NAME>RAMIREZ</LAST_NAME>

     <FIRST_NAME>JOSEPH</FIRST_NAME>

     <MIDDLE_NAME>BRIAN</MIDDLE_NAME>

     <DOB>19901219</DOB>

     <SEX>M</SEX>

     <BOOKING_NO>05-000666</BOOKING_NO>

     <BOOKING_DATE>20050208</BOOKING_DATE>

     <INCIDENT_NO>05-000666</INCIDENT_NO>

     <JAIL_ID>123456789</JAIL_ID>

     <MASTER_INDEX>66634.0000</MASTER_INDEX>

     <LOCAL_ID>12345</LOCAL_NO>

     <STATE_ID>54321</STATE_ID>

     <POD>P1</POD>

     <BLOCK>02</BLOCK>

     <CELL>03</CELL>

     <FACILITY_ID>CRIMESTARTEST</FACILITY_ID>

  </INMATE>

</ICDE>

The output files created are, by default, named using both a prefix name (default: “icde”) followed by a date and time reference in _YYYYMMDDHHMMSS format which represents the date and time that the data extract was performed.  Example:  icde_20131004132133.csv   The output files can be created on demand or at regular time intervals using the "Autorun" configuration option where the interval time is specified in minutes. By using this file naming strategy, each subsequent file that is created is saved without overwriting any previously created files.  Each file created will contain a complete set of records for subjects who are In-Custody at the time that the output file is created.  The ICDE utility can be configured to create output files with a static name when required.  When output files use a static name the icde utility program will first try to delete any existing file, then create a new file with the same name.

The Crimestar RMS Arrest/Booking Module does not have a specific Yes/No data field to indicate if a subject is In-Custody or not.  The implication is that any subject who is booked, is in-custody until the systems expressly indicates that he/she has been released.   This is indicated in the Arrest & Booking Module of the Records Management System (RMS) by a date-time data field labeled “Released Date:” located on the “Release” page of the Booking Module.  When the Released Date data field is empty (or NULL) or contains a future date, the subject is presumed to have not yet been released, thus he/she would still be, by default, in-custody.  Only those arrest/booking records that are presumed as “In-Custody” by this definition are extracted from the Crimestar RMS database.

.

The following is a list of the specific Arrest & Booking data fields extracted and converted by this utility program and represented in the resulting output file.  Because the .CSV file format is position specific the data fields represented in the resulting output file are listed in the same order in which they are listed in the table below:

“icde.ini” Configuration File:  Before the icde.exe program file can perform any actions it needs to know how and where to access the Crimestar RMS database as well as how and where to copy or FTP the resulting output file.  It accomplished this by reading the entries in the icde.ini configuration file.  The icde.ini configuration file should always be located within the same windows directory or folder as the icde.exe program file. The following table is a list of the configuration file [sections] and entries that are recognized within the icde.ini configuration file as well as an explanation for the purpose and use of each respective entry.