Field Order Information
Global Information Record
This is a "header" record that contains information about the extract run as a whole.
Please be aware that if you do not sort your extract file by CIS Sort Key after it is produced, this record will physically be the last record on the extract file.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"0010" |
|
CIS Sort Key |
A187 |
Note: For the Global Record only, the Sort Key is all blanks. |
|
BATCH_CD |
A8 |
CI_BATCH_INST / The CIS Batch Process that called the FO Extract routine |
|
BATCH_NBR |
N10 |
CI_BATCH_INST / A sequence number for serial instances of a Batch Process over time |
|
BATCH_RERUN_NBR |
N10 |
CI_BATCH_INST / The number of times a particular batch has been re-run since its initial run |
|
FO Count [Artificial] |
N10 |
Total number of distinct FO record blocks in an extract |
|
Date/Time [Artificial] |
A26 |
System time of extraction. |
|
FO Id Start [Artificial] |
A10 |
The lowest valid FO ID in a particular thread in the extract. If there is only one thread, this will be '0000000000'. |
|
FO Id End [Artificial] |
A10 |
The highest valid FO ID in a particular thread in the extract. If there is only on thread, this will be '9999999999'. |
|
BATCH_THREAD_NBR |
N10 |
CI_BATCH_THD / Identifies a thread distinctly within a group of threads |
|
Thread Count [Artificial] |
N10 |
Total number of threads in the extract run |
Field Order Record
One record is produced for every field order to be printed.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"0100" |
|
CIS Sort Key |
A187 |
|
|
FO_ID |
A10 |
CI_FO_STG_DWN / System-assigned identifier for a Field Order |
|
PREM_ID |
A10 |
CI_FO / System-assigned identifier for the Premise at which the Field Order will be done |
|
SCHED_DT |
D10 |
CI_FO / The scheduled date of the Field Order |
|
SCHED_TM |
T15 |
CI_FO / The scheduled time of the Field Order (optional) |
|
DISP_GRP_CD |
A8 |
CI_FO / The Dispatch Group to which the Field Order has been assigned |
|
REP_CD |
A8 |
CI_FO / The Representative within the Dispatch Group |
|
DESCR254 |
C254 |
CI_FO / Free-form notes about the Field Order |
|
ACCT_ID |
A10 |
CI_SA / The Account that is/has been/will be paying for services at the Premise |
|
ENTITY_NAME |
A64 |
CI_PER_NAME / The Primary name of the Main customer on the Account identified above |
|
Multiple Account Message [Artificial] |
A10 |
A message item indicating the existence of more than one active Account associated with a Premise. |
|
ADDRESS_SBR |
A361 |
CI_PREM / A sub-record of address information (Defined in detail later in this section) |
|
MR_WARN_CD |
A4 |
CI_PREM / Meter Read Warning code |
|
DESCRIPTION |
A60 |
CI_MR_WARN / Description of the MR Warning code |
|
MR_INSTR_CD |
A4 |
CI_PREM / Meter Read Instruction code |
|
DESCRIPTION |
A60 |
CI_MR_INSTR / Description of the MR Instruction code |
|
MR_INSTR_DETAILS |
A250 |
CI_PREM / For an expanded version of the Meter Read Instruction above, or for information deemed relevant but for which no code exists. |
|
Telephone Info |
Telephone numbers for the Main customer on the Account above. Occurs 3 times per FO Record, consisting of the following three fields: |
|
|
PHONE_TYPE |
A12 |
CI_PER_PHONE / The type of telephone. Typical values are Home, Business, Dormitory, Cellular, Fax. |
|
PHONE |
A24 |
CI_PER_PHONE / Self-explanatory |
|
EXTENSION |
A6 |
CI_PER_PHONE / Self-explanatory |
|
LS_SL_SW |
A1 |
CI_PER / Life Support or Sensitive Load. Set to "Y" if any Person on any active Account associated with this Premise has this type of information on their record. |
|
LS_SL_DESCR |
A254 |
CI_PER / Description of the Life Support/Sensitive Load |
|
LL_ID |
A10 |
CI_PREM / System-assigned identifier for a Premise's landlord (if one exists) |
|
DESCRIPTION |
A60 |
CI_LANDLORD / Description of the Landlord |
|
ACCT_ID |
A10 |
CI_LANDLORD / The Landlord's account number |
|
Geographic Info |
Geographic locator types and their values for the Premise. Occurs 3 times per FO Record, consisting of the following two fields: |
|
|
DESCR |
A60 |
CI_GEO_TYPE / The description of a geographic locator type |
|
GEO_VAL |
A50 |
CI_PREM_GEO / The actual value of the above locator type at a given Premise |
SP Record
One record is produced for every Service Point (SP) that has a field activity on the field order. Up to 15 characteristics and their respective values can be listed for a SP. If there is no Characteristic information for the SP on the database, the fields will be blank.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"2000" |
|
CIS Sort Key |
A187 |
|
|
SP_ID |
A10 |
CI_SP / Unique system-generated identifier for the Service Point |
|
SP_TYPE_CD |
A8 |
CI_SP / The Service Point's type code |
|
DESCR |
A60 |
CI_SP_TYPE / The description of the SP Type |
|
SP_SUBTYPE_FLG |
A2 |
CI_SP_TYPE / The SP Type's sub-type code. Values: M - Meter I - Item U - Unbadged (multi-item) |
|
DESCR |
A60 |
CI_LOOKUP / The description of the sub-type |
|
SP_SRC_STATUS_FLG |
A2 |
CI_SP / The status of the source of the service delivered through a Service Point. |
|
DESCR |
A60 |
CI_LOOKUP / The description of the source status |
|
DISCON_LOC_CD |
A4 |
CI_SP / If the SP has been disconnected, a code for the location of the disconnection |
|
DESCR |
A60 |
CI_LOOKUP / The description of the disconnect location |
|
MTR_LOC_CD |
A4 |
CI_SP / A code for the location at the Premise of the Service Point's Meter |
|
DESCR |
A60 |
CI_MTR_LOC / The description of the location code |
|
MTR_LOC_DETAILS |
A250 |
CI_SP / Detailed information regarding the location of the SP's Meter |
|
SP_MTR_RD_CYCLE |
A30 |
CI_MR_CYC / Description of the SP's Service Cycle |
|
SP_MTR_RD_ROUTE |
A30 |
CI_MR_RTE / Description of the SP's Service Route |
|
SP_FAC_LVL_1 |
A30 |
CI_FAC_LVL_1 / Description of the SP's Level 1 Facility |
|
SP_FAC_LVL_2 |
A30 |
CI_FAC_LVL_2 / Description of the SP's Level 2 Facility |
|
SP_FAC_LVL_3 |
A30 |
CI_FAC_LVL_3 / Description of the SP's Level 3 Facility |
|
Geographic Info |
Geographic locator types and their values for a Service Point. Occurs 3 times per record, consisting of the following two fields: |
|
|
DESCR |
A60 |
CI_GEO_TYPE / The description of a geographic locator type |
|
GEO_VAL |
A50 |
CI_SP_GEO / The actual value of the above locator type at a given Service Point |
|
Characteristic Info |
Occurs 15 times per record, consisting of the following two fields: |
|
|
SP_CHAR |
A30 |
CI_CHAR_TYPE / The description of a Characteristic that the Service Point has been deemed to possess |
|
SP_CHAR_VALUE |
A30 |
CI_CHAR_VAL / The description of the Value of the above Characteristic for this Service Point |
|
MR_WARN_CD |
C4 |
Field Warning code |
|
DESCRIPTION |
C30 |
Description of the Field Warning code |
|
MR_INSTR_CD |
C4 |
Field Instruction code |
|
DESCRIPTION |
C30 |
Description of the Field Instruction code |
|
MR_INSTR_DETAILS |
C250 |
For an expanded version of the Field Instruction above, or for information deemed relevant but for which no code exists |
Item Record
This record is produced if a Service Point is of subtype Item. Because an SP may have at most one badged item installed at any given point in time, there is at most one record for an SP. If there is no Item currently installed, a message is printed to that effect.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"2200" |
|
CIS Sort Key |
A187 |
|
|
ITEM_ID |
A10 |
CI_SP_ITEM_HIST / The system-generated ID of the Item currently installed at the Service Point |
|
BADGE_NBR |
A16 |
CI_ITEM / The Item's badge number |
|
ITEM_TYPE_CD |
A8 |
CI_ITEM / A code specifying the type of the Item |
|
DESCR |
A60 |
CI_ITEM_TYPE / The description of the Item type |
|
MFG_CD |
A8 |
CI_ITEM / A code for the manufacturer of the Item |
|
DESCR |
A60 |
CI_MFG / The actual name of the manufacturer |
|
MODEL_CD |
A8 |
CI_ITEM / The manufacturer's model number for the Item |
|
DESCR |
A60 |
CI_MODEL / The description of the model |
|
SERIAL_NBR |
A16 |
CI_ITEM / Self-explanatory |
|
RECEIVE_DT |
D10 |
CI_ITEM / The date on which the Item was received by the utility from its manufacturer. This is NOT the install date. |
|
DESCR254 |
A254 |
CI_ITEM / A detailed description of the Item (optional). |
|
EVENT_DTTM |
D26 |
CI_SP_ITEM_EV_I / The date and time of the installation of the Item at its current location. |
Meter Record
This record is produced if a Service Point is of subtype Meter. Because an SP may have at most one meter installed at any given point in time, there is at most one record for an SP. If there is no Meter currently installed, a message is printed to that effect.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"2400" |
|
CIS Sort Key |
A187 |
|
|
MTR_ID |
A10 |
CI_MTR_CONFIG / The system-generated identifier for the Meter currently installed at the Service Point. |
|
BADGE_NBR |
A16 |
CI_MTR / The Meter's badge number |
|
MTR_TYPE_CD |
A8 |
CI_MTR / A code for the type of the Meter |
|
MFG_CD |
A8 |
CI_MTR / A code for the manufacturer of the Meter |
|
DESCR |
A60 |
CI_MFG / The actual name of the manufacturer |
|
MODEL_CD |
A8 |
CI_MTR / The manufacturer's model number for the Meter |
|
DESCR |
A60 |
CI_MODEL / A description of the model |
|
SERIAL_NBR |
A16 |
CI_MTR / Self-explanatory |
|
RECEIVE_DT |
D10 |
CI_MTR / The date on which the Meter was received by the utility from its manufacturer. This is NOT the install date. |
|
DESCR254 |
A254 |
CI_MTR / A detailed description of the Meter (optional). |
|
INSTALL_DTTM |
D26 |
CI_CFG_SPMR_VW / The date and time of the installation of the Meter at its current location. |
|
MTR_CONFIG_ID |
A10 |
CI_SP_MTR_HIST / The system-generated identifier for the Meter's current Configuration |
|
EFFDT |
D10 |
CI_MTR_CONFIG / The effective date of the current Configuration |
|
EFF_TM |
T15 |
CI_MTR_CONFIG / The effective time of the current Configuration |
Register Record
One record is produced for every register on the currently effective Meter Configuration.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"2450" |
|
CIS Sort Key |
A187 |
|
|
REG_ID |
A10 |
CI_REG / The system-generated unique identifier for the Register |
|
READ_SEQ |
N2 |
CI_REG / The read sequence of the Register |
|
UOM_CD |
A30 |
CI_REG / The Unit Of Measure in which the Register is calibrated |
|
TOU_CD |
A30 |
CI_REG / The Time Of Use period during which the Register measures consumption |
|
REG_CONST |
N6.6 |
CI_REG / The Register Constant (if any) by which the actual reading is multiplied to calculate consumption |
|
CONSUM_SUB_FLG |
A2 |
CI_REG / A flag that indicates whether the Register is a consumptive or subtractive register |
|
HOW_TO_USE_FLG |
A2 |
CI_REG / A flag that indicates whether the Register's measured consumption is to be added to, subtracted from, or used as a check against the measured consumption of other Registers (if the Register is Subtractive) or measures a peak (maximum) value (if the Register is Consumptive) |
|
NBR_OF_DGTS_LFT |
N1 |
CI_REG / The number of digits to the left of the decimal point on the Register's readout |
|
NBR_OF_DGTS_RGT |
N1 |
CI_REG / The number of digits to the right of the decimal point on the Register's readout |
|
FULL_SCALE |
N9.5 |
CI_REG / The maximum value that can be displayed on the Register's readout before it "turns over" to zero |
|
READ_OUT_TYPE_CD |
A8 |
CI_REG / A code indicating the type of physical readout (dials, digital etc.) employed on the Register |
|
PROTOCOL_CD |
A8 |
CI_REG / A code indicating the means by which the register's consumption information is collected |
|
TOLERANCE |
N9.5 |
CI_REG / Tolerance is used to warn the meter reader that a Register is approaching its maximum permitted value |
|
READ_DTTM |
D26 |
CI_MR / The date and time of the most recent Register reading that is either a Customer Read, Regular read or a Verified read |
|
REG_READING |
N9.6 |
CI_REG_READ / The actual value displayed on the Register's readout when it was most recently read |
|
READ_TYPE_FLG |
A2 |
CI_REG_READ / The type code of the Register reading |
End Meter Record
A "dummy" record used to signal the document composition application that the last Register record for a Meter has been reached.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"2490" |
|
CIS Sort Key |
A187 |
SP/Multi-Item Record
This record is produced if a Service Point is of subtype Unbadged. The Multi-Item record on the database has only two fields, the Service Point ID and the Effective Date, both of which form a composite Prime Key. Since this record always appears subordinate to the SP in the SP Group, only the date field is needed here. This record is stipulated in the CIS database as the parent to the detail item records that are its children.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"2600" |
|
CIS Sort Key |
A187 |
|
|
EFF_DT |
D10 |
CI_SP_MULT_ITEM |
Multi-Item Detail Line Record
One record is produced for each distinct type of item on the effective multi-item configuration at the time of printing. There may be any number of distinct item types and any number of individual items of a given type.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"2620" |
|
CIS Sort Key |
A187 |
|
|
ITEM_TYPE_CD |
A8 |
CI_MULT_ITEM / A code for the type of Item |
|
DESCR |
A60 |
CI_ITEM_TYPE / The description of the Item type |
|
ITEM_CNT |
N9.2 |
CI_MULT_ITEM / The number of individual Items of a given type |
End SP/Multi-Item Step Record
A "dummy" record to signal the document composition application that the last Item record in a Multi-Item configuration has been reached.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"2690" |
|
CIS Sort Key |
A187 |
Field Activity Record
One record is produced for each Pending field activity linked to the field order. Activities in any other Status are ignored.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"3000" |
|
CIS Sort Key |
A187 |
|
|
FA_ID |
A10 |
CI_FA / The unique system-generated identifier for a Field Activity |
|
FA_TYPE_CD |
A8 |
CI_FA / A code specifying the Field Activity's type |
|
DESCR |
A60 |
CI_FA_TYPE / The description of the FA type |
|
FA_PRIORITY_FLG |
A2 |
CI_FA / In the case of several Activities being created for the same SP, the Priority Flag stipulates which should be done first. |
|
FA_CREATED_BY_FLG |
A2 |
CI_FA / A code indicating who or what originated this Field Activity |
|
XLATLONGNAME |
A30 |
CI_LOOKUP / The description of the Created By flag |
|
SCHED_DT |
D10 |
CI_FA / The date on which the Activity is scheduled to be done |
|
SCHED_TM |
T15 |
CI_FA / The time at which the Activity is scheduled to commence (optional). |
|
INSTRUCTIONS |
A254 |
CI_FA / Free form detailed instructions as to exactly what is to be done. |
|
DESCR254 |
A254 |
CI_FA / A more detailed description of the FA Type (optional) |
Credit and Collection Record
One record is produced for a Field Activity that was created by a Severance Process ( i.e., FA_CREATED_BY_FLG = "SE" (Severance Event)).
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"3100" |
|
CIS Sort Key |
A187 |
|
|
SA_ID |
A10 |
CI_SEV_PROC / The Service Agreement for which a Severance Process has issued a Disconnect field activity as a result of a Severance Event |
|
Overdue Amount [Artificial] |
N13.2 |
The program calls another routine (ProgramCIPFFTBN) that calculates this amount based on the Severance Process Arrears Date |
|
Current Amount [Artificial] |
N13.2 |
The program calls another routine (ProgramCIPFFTBN) that calculates this amount using the current date. |
|
Past Severance Processes [Artificial] |
N3 |
The number of Severance Processes issued against this Service Agreement in the past, excluding the one that generated this Activity |
|
ACCT_ID |
A10 |
CI_SA / The Account associated with the Service Agreement above |
|
ENTITY_NAME |
A64 |
CI_PER_NAME / The Primary name of the Main customer on the Account above |
|
BILL_DT |
D10 |
CI_BILL / The date of the most recent bill that is charged to the Account above |
|
CUR_AMT |
N13.2 |
The dollar amount of the most recent bill. Calculated from CI_BILL_SA |
|
PAY_DT |
D10 |
CI_PAY_EVENT / The date of the most recent Frozen payment on the Account of the SA above |
|
PAY_AMT |
N13.2 |
CI_PAY / The amount of the most recent Frozen payment on the Account of the SA above |
|
Credit Rating [Artificial] |
N5 |
Calculated from the Beginning Credit Rating Base on the Installation record or the account’s CIS Division, and CR_RATING_PTS from CI_ACCT_CR_R_VW |
|
Cash-only Switch [Artificial] |
A1 |
Set to "Y" if the Cash-Only score is above the Cash Only Threshold as defined on the Installation record. Calculated from the Cash Only Base Score on the Installation record or the account’s CIS Division, and CASH_ONLY_PTS from CI_ACCT_CR_R_VW |
|
Deposit Amount [Artificial] |
N13.2 |
The program calls another routine (ProgramCIPDFDVN) to calculate this amount |
Field Activity Step Record
One record is produced for each Step within a Field Activity.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"3200" |
|
CIS Sort Key |
A187 |
|
|
STEP_SEQ_NBR |
N3 |
CI_FA_STEP / The sequence of a Step within a Field Activity |
|
FA_STEP_TY_ACT_FLG |
A2 |
CI_FA_STEP / A code indicating the FA Step Type Action. |
|
XLATLONGNAME |
A60 |
CI_LOOKUP / The description of the FA Step Type Action. |
|
FA_STEP_DESCR |
A60 |
CI_FA_STEP_TYPE / Description of the FA Step Type. |
|
OPTIONAL_SW |
A1 |
CI_FA_STEP_TYPE / "Y" indicates that a particular Step is regarded as optional for field activities of this FA Type |
The following field activity step record types (through End Field Order Record) are all "dummy" records that contain no information and exist only to signal the document composition application to print a pre-specified block of text.
Field Activity Step (Enter Meter Badge Number) Record
This record is produced if the step requires space for the field worker to write a meter's badge number.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"3410" |
|
CIS Sort Key |
A187 |
Field Activity Step (Enter Item Badge Number) Record
This record is produced if the step requires space for the field worker to write an item's badge number.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"3430" |
|
CIS Sort Key |
A187 |
Field Activity Step (Enter Customer Contact) Record
This record is produced if the step requires space for the field worker to write customer contact information.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"3450" |
|
CIS Sort Key |
A187 |
Field Activity Step (Enter Reconfigure Register) Record
This record is produced if the step requires space for the field worker to write register configuration information.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"3470" |
|
CIS Sort Key |
A187 |
Field Activity Step (Enter Disconnect Location) Record
This record is produced if the step requires space for the field worker to write disconnect location.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"3490" |
|
CIS Sort Key |
A187 |
Field Activity Step (Enter Register Read) Record
This record is produced if the step requires space for the field worker to write register read information.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"3510" |
|
CIS Sort Key |
A187 |
Field Activity Step (Enter Multi-Item) Record
This record is produced if the step requires space for the field worker to write multi-item information.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"3530" |
|
CIS Sort Key |
A187 |
Field Activity Step (Enter TO Stat) Record
This record is produced if the step requires space for the field worker to write trouble order statistics.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"3550" |
|
CIS Sort Key |
A187 |
Field Activity Step (Enter Changes) Record
This record is produced if the step requires space for the field worker to write free format information.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"3570" |
|
CIS Sort Key |
A187 |
Field Activity Step (Generic) Record
This record is used for consistency on any FA Type that has no other type of FA Step (action) record associated with it.
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"3999" |
|
CIS Sort Key |
A187 |
End Field Activity Step Record
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"6100" |
|
CIS Sort Key |
A187 |
End Field Activity Record
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"6200" |
|
CIS Sort Key |
A187 |
End SP Record
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"6300" |
|
CIS Sort Key |
A187 |
End Field Order Record
|
Field Name |
Format |
Source/Value/Description |
|
Print Key |
A4 |
"9990" |
|
CIS Sort Key |
A187 |
Definition of Address Subrecord (Sbr)
Used in mailing address and service address, total length = 361 bytes
|
Field Name |
Format |
Description |
|
COUNTRY |
A3 |
|
|
ADDRESS1 |
A64 |
|
|
ADDRESS2 |
A64 |
|
|
ADDRESS3 |
A64 |
|
|
ADDRESS4 |
A64 |
|
|
CITY |
A30 |
|
|
NUM1 |
A6 |
|
|
NUM2 |
A4 |
|
|
HOUSE_TYPE |
A2 |
|
|
COUNTY |
A30 |
|
|
STATE |
A6 |
|
|
POSTAL |
A12 |
|
|
GEO_CODE |
A11 |
|
|
IN_CITY_LIMIT |
A1 |