mip/Documentation/SupportingDocumentation/WEBMIP_TEX/fs_appendix_data_items.tex

% This file was converted to LaTeX by Writer2LaTeX ver. 0.4
% see http://www.hj-gym.dk/~hj/writer2latex for more info

\svnidlong
{$HeadURL$}
{$LastChangedDate$}
{$LastChangedRevision$}
{$LastChangedBy$}
\svnid{$Id$}

\section{Data Items}
\label{sec:AppendixDataItems}


\subsection{Gas Supplier}

\begin{longtable}[c]{p{0.4\textwidth} p{0.4\textwidth}}
\toprule
Gas Supplier ID (A0064) 
&
A required 10 Character alphabetical code
\\
Gas Supplier Name 
&
A required alphanumerical field of 40 characters in length
\\
Gas Supplier Location 
&
A required address for the gas supplier, including the traditional items
associated with an address
\\
Cust Code 
&
A required 3 digit numerical code, that describes the customer supplier.
\\
Contract Reference
&
The provision and maintenance contract a required alphanumerical code.
Limited to 35 characters.
\\
\bottomrule
\end{longtable}

\subsection{Supplier Agent}

\begin{longtable}[c]{p{0.4\textwidth} p{0.4\textwidth}}
\toprule
Company Name
&
A required 40 character data item to record the agents company name
\\
Title (A0088) 
&
A required 6 character item to collect the individual agents title, e.g.
Dr, Mr, Miss
\\
Initials (A0089) 
&
A required 2 character item to collect the individual agents initials
\\
Contact Name (A0090)
&
A required 10 character data item to hold the individual agents name
\\
Address (A0049,A0106)
&
A required address for the individual agent, including the traditional
items associated with an address
\\
Telephone1(A0049,A0106) 
&
A required initial telephone number to contact the individual, a 30 char
limit.
\\
Telephone2(A0049,A0106) 
&
An optional data item for an alternative telephone number to contact the
individual, a 30 char limit.
\\
Fax(A0049,A0106) 
&
An optional item that allows the agent to specify a fax number, a 30
char limit. 
\\
Email(A0049,A0106) 
&
An mandatory alphanumerical item to accept the individual agents email
address, the value must be a valid email address. A 241 char limit.
\\
\bottomrule
\end{longtable}

\subsection{Job Site Details}

\begin{longtable}[c]{p{0.4\textwidth} p{0.4\textwidth}}
\toprule
Transaction Reference(A0055)
&
An optional 35 character alphanumerical code that the agent can use to
reference to the job enquiry. This value does not have to be unique
within the system, if the user searches for the transaction reference
then multiple enquiries/quotes may be returned.
\\
Agent
&
Only available to the I\&C user and mandatory for the I\&C user. A
list of Agents held within the webMIP system. The user must select
one.
\\
\bottomrule
\end{longtable}

\subsection{Address}

\begin{longtable}[c]{p{0.4\textwidth} p{0.4\textwidth}}
\toprule
Sub{}-Building Name/Number (A0004) 
&
A 40 character alphanumeric item that must contain a data entry if
Building Name/Number is omitted. 
\\
Building Name/Number (A0006) 
&
A 40 character alphanumeric item that must contain a data entry if
Sub{}-Building Name/Number is omitted.
\\
Thoroughfare(Road) (A0008)
&
A 60 character alphabetical data item that must be entered.
\\
Post Town(Town) (A0011)
&
A 40 character alphabetical data item that must be entered.
\\
Post Code (A0013)
&
A 10 character alphanumerical data item that must be entered.
\\
Title (A0088) 
&
A required 6 character item to collect the individual agents title, e.g.
Dr, Mr, Miss to be selected from a list.
\\
Initials (A0089) 
&
A required 4 character item to collect the individual consumer contacts
initials
\\
Contact Name (A0090)
&
A required 30 character data item to hold the individual consumer
contacts name
\\
Telephone1(A0049,A0106) 
&
A required initial telephone number to contact the consumer, a 30 char
limit.
\\
Telephone2(A0049,A0106) 
&
An optional data item for an alternative telephone number to contact the
consumer, a 30 char limit.
\\
Fax(A0049,A0106) 
&
An optional item that allows the agent to specify a fax number, a 30
char limit. 
\\
Email(A0049,A0106)
&
An optional item to accept the individual agents email address, a 241
char limit.
\\
\bottomrule
\end{longtable}

\subsection{Contact Address}

\begin{longtable}[c]{ p{0.4\textwidth} p{0.4\textwidth} }
\toprule
Sub{}-Building Name/Number (A0004) 
&
(only required if job address different to contact address)A 40
character alphanumeric item that must contain a data entry if Building
Name/Number is omitted. 
\\
Building Name/Number (A0006) 
&
(only required if job address different to contact address)\textmd{A 40
character alphanumeric item that must contain a data entry if
Sub{}-Building Name/Number is omitted.}
\\
Thoroughfare(Road) (A0008)
&
(only required if job address different to contact address)A 40
character alphabetical data item that must be entered.
\\
Post Town(Town) (A0011)
&
(only required if job address different to contact address)A 40
character alphabetical data item that must be entered.
\\
Post Code (A0013)
&
(only required if job address different to contact address)A 7 character
alphanumerical data item that must be entered.
\\
Second Contact
&
A boolean entry that allows the user to specify if there is a second
contact for the site.
\\
Title (A0088) 
&
(only required if second contact specified) A required 6
character item to collect the individual agents title, e.g. Dr, Mr,
Miss to be selected from a list.
\\
Initials (A0089) 
&
(only required if second contact specified)A required 4
character item to collect the individual consumer contacts initials
\\
Contact Name (A0090)
&
(only required if second contact specified)A required 30 character data
item to hold the individual consumer contacts name
\\
Telephone1(A0049,A0106) 
&
(only required if second contact specified) A required initial
telephone number to contact the consumer.
\\
Telephone2(A0049,A0106) 
&
(only required if second contact specified) An optional data
item for an alternative telephone number to contact the consumer.
\\
Fax(A0049,A0106) 
&
(only required if second contact specified)An optional item
that allows the agent to specify a fax number.
\\
Email(A0049,A0106)
&
(only required if second contact specified)An optional item to accept
the individual agents email address.
\\
\bottomrule
\end{longtable}

\subsection{Second Contact Address}

Second Contact address is the same as job address/first contact. It is
only required if second contact specified. A selection entry allows the
user to specify whether the address is the same as the site of the
intended works or the first contact.

\begin{longtable}[c]{p{0.4\textwidth} p{0.4\textwidth}}
\toprule
Sub{}-Building Name/Number (A0004)
&
(only required if job address and first contact address different)A 40
character alphanumeric item that must contain a data entry if Building
Name/Number is omitted. 
\\
Building Name/Number (A0006) 
&
(only required if job address and first contact address
different)A 40 character alphanumeric item that must contain a
data entry if Sub{}-Building Name/Number is omitted.
\\
Thoroughfare(Road) (A0008)
&
(only required if job address and first contact address different)A 40
character alphabetical data item that must be entered.
\\
Post Town(Town) (A0011)
&
(only required if job address and first contact address different)A 40
character alphabetical data item that must be entered.
\\
Post Code (A0013)
&
Only required if job address and first contact address different)A 7
character alphanumerical data item that must be entered.
\\
\bottomrule
\end{longtable}

\subsection{Site Detail}

\begin{longtable}[c]{p{0.4\textwidth} p{0.4\textwidth}}
\toprule
Asset Location Code (A0059)
&
A 10 character alphanumerical data item that must be entered, it will be
one value from a list of the following specified entries:

\begin{description}
\item[00] Unknown 
\item[01] Cellar 
\item[02] Under Stairs 
\item[03] Hall 
\item[04] Kitchen 
\item[05] Bathroom 
\item[06] Garage 
\item[07] Canteen 
\item[08] Cloakroom 
\end{description}
\\
&
\begin{description}
\item[09] Cupboard 
\item[10] Domestic Science
\item[11] Front Door 
\item[12] Hall Cupboard 
\item[13] Kitchen Cupboard 
\item[14] Kitchen under sink 
\item[15] Landing 
\item[16] Office 
\item[17] Office Cupboard 
\item[18] Outside WC 
\item[19] Pantry 
\item[20] Porch 
\item[21] Public Bar 
\item[22] Rear of Shop 
\item[23] Saloon Bar 
\item[24] Shed 
\end{description}
\\
&
\begin{description}
\item[25] Shop Front 
\item[26] Shop Window 
\item[27] Staff Room 
\item[28] Store Room 
\item[29] Toilet 
\item[30] Under Counter 
\item[31] Waiting Room 
\item[32] Meter box Outside
\item[98] Other 
\item[99] Outside
\end{description}
\\
Care category
&
An optional 2 character numerical data type for all job types the user
can select from the following list:

03 SEUC Unclassified

04 Aged 60+

05 Blind

06 Braille User

07 Poor Sight

08 Deaf

09 Poor Hearing

10 Poor Speech

11 Poor Sense of Smell

12 Arthritic Hands

13 Arthritic All

14 Poor Walking

15 Wheelchair

16 Bedridden

17 Mental Handicap

18 Confused

19 Serious Illness

20 Other

21 Heart Condition

22 Breathing Difficulty
\\
Asset Location notes (A0158)
&
Mechanism for delivering Location notes.\newline
A optional selectable list of values including Post, Fax, Email and
Upload. \ Depending on the selected option the system will provide
either the Coventry Address for I\&C, the I\&C fax number, A mailto
link to the I\&C mailbox or a file upload option.
\\
Attach files 
&
(only required if Mechanism for delivering Location notes is set to
Upload)An optional data item that allows users to attach a number of
photos,drawings,plans etc. to the enquiry, the file size limit will be
10 megabytes in total with individual files being restricted to 3
megabytes.
\\
Access Instructions (A0075)
&
An optional data item of 210 alphanumerical characters.
\\
Access Password
&
An optional 30 character alphanumerical data item.
\\
MPRN (A0072)
&
An optional 30 digit numerical data item. \ The MPRN is optional, but
ideally I\&C would like to collect the number. \ New installs do not
require the number to be entered because the number may not have been
generated at the time of the enquiry. \ However for all other jobs this
should normally be entered, but sometimes it is unavailable. \ The user
must enter additional information in these instances.
\\
Additional Information, including UIP reference
&
Required only if MPRN is left blank and the job type is not a new
install. A 250 character alphanumerical data item.
\\
\bottomrule
\end{longtable}

\paragraph{Job Information}

The job information section records data relating to the job
requirements including meter requirements and the meters environment.
Like the job site details, once the job information details are
submitted they are stored by the system so that the agent or I\&C users
can then refer back to them. Each enquiry must have just one
associated set of job information.

\begin{longtable}[c]{p{0.5\columnwidth} p{0.5\columnwidth}}
\toprule
Job Type (Q5)
&
A list of possible jobs (Install, Exchange, Removal, Alteration, OFMAT,
EMS, AMR, Capacity Change, Adversarial, Standard Install, Standard
Exchange, Standard Removal, Other), if the user selects
{\textquotesingle}Other{\textquotesingle} then they must provide some
data for the Other Type data item. The Job Type can be changed on the
enquiry until the enquiry is submitted for quotation.

The Standard job types are categorised differently by webMIP, they show
the users intention to create a standard quotation for an automatic
quote. Standard job types exempt the user from entering certain
questions in the enquiry questionnaire.
\\
Other Type 
&
Required only when the user selects
{\textquotesingle}Other{\textquotesingle} from the Job Type list. An
alphanumerical data item of 30 characters.
\\
Internal Job Type Reference
&
A hidden field automatically generated by the webMIP system. Only when
the questionnaire has been successfully completed will webMIP attempt
to generate the Job Type Reference. The Job Type Reference is an
alphanumerical field of 40 characters in length. The webMIP system will
use the Job Type and Service pressure data items on the questionnaire
to determine the Job Reference Code, the result will be one of the
following values :-

\begin{description}
\item [FIX QO LP]
Install Low Pressure Meter Module
\item [FIX QO MP]
Install Medium Pressure Meter Module
\item [EXC QO LP]
Exchange Low Pressure Meter Module
\item [EXC QO MP]
Exchange Medium Pressure Meter Module
\item [EXC QI MP]
Pressure Increase of Medium Pressure Meter Module
\item [REM QO LP]
Removal of Low Pressure Meter Module
\item [REM QO MP]
Removal of Medium Pressure Meter Module
\end{description}

If webMIP is unable to determine a Job Reference Code then the value
will remain blank(null).
\\
Gas Act Owner(GAO)
&
A drop-down list of:
\begin{itemize}
\item Supplier,
\item GT,
\item Consumer.
\end{itemize}
will be presented to the end-user as guidance.

Required if the Job Type is of Exchange, Removal, Standard Exchange or
Standard Removal, otherwise it should be optional. A 1 character
alphabetical data item.
\\
Supplier
&
Required if the Job Type is of Exchange, Removal, Standard Exchange or
Standard Removal otherwise it should be optional. A 210 character
alphanumerical data item.
\\
Consumer
&
Required if the Job Type is of Exchange, Removal, Standard Exchange or
Standard Removal otherwise it should be optional. A 40 character
alphanumerical data item.
\\
Appointment preference 
&
Only relevant to the Standard job types that will be automatically
quoted. An optional data item that allows the user to specify an
preferred time in the day for the visit. The default value will be
8am-8pm. Users can select one value from a list of the following
options: 

\begin{enumerate}
\item 8am-1pm, 
\item 12pm-8pm, 
\item 8am-8pm.
\end{enumerate}

\\
Service Pressure (Q6)
&
User will be able
to select one option from a list of the following items, LP, MP35,
MP65, MP105, MP180, MP270, IP. The service pressure is not needed for
Standard (automatically quoted)Job Types as an assumed pressure
category is taken. Only one Service Pressure can be associated with an enquiry.
\\
IP details 
&
Required if the service pressure is IP. A 250 character alphanumerical
data item. The default value is blank(null).
\\
IP mbar
&
Optional, available when service pressure is set to IP. A Numerical
data item that allows up to 3 decimal places. The values that are
accepted must be between 2000 and 7000. The default value is
blank(null).
\\
Required Meter Pressure (A0164) (Q7)
&
A required numerical data item for jobs, except all standard jobs, which will default to 21mbar.  Allows numbers between 0 and 7000 and 3 decimal places are permitted.  The value to be stored will be in mbar.  If the service pressure is 'LP' then the default for meter pressure will also be 21.  The following service pressures also place further constraints on the accepted meter pressure values:

\begin{enumerate}

\item MP35
\begin{enumerate}
\item Calculaton for Constraint 0.8 x 35
\item Constraint \textless= 28
\end{enumerate}

\item MP65
\begin{enumerate}
\item Calculation for Constraint 0.8 x 65
\item Constraint \textless=84
\end{enumerate}

\item MP180
\begin{enumerate}
\item Calculation for Constraint 0.8 x 180
\item Constraint \textless=144
\end{enumerate}

\item MP70
\begin{enumerate}
\item Calculation for Constraint 0.8 x 270
\item Constraint \textless=216
\end{enumerate}

\end{enumerate}

\\
Annual Quantity (AQ) (Q8)
&
A Required numerical data item for all jobs . The value for annual
quantity will be recorded as KWh. The default value for is
blank(null). If the field contains a value over 732,000 the enquiry
will be not be automatically quoted.
\\
Specific conversion factor
&
A 1 Character hidden field that is used to determine if a conversion
factor is required. This will typically be associated to jobs that
require a large capacity. The user will not interact with this field
as webMIP will determine the value. The default value is
{\textquotesingle}N{\textquotesingle} if the Annual Quantity field is
greater than 732,000 KWh then the value will be
{\textquotesingle}Y{\textquotesingle}
\\
Booster/Compressor (Q9)
&
A boolean data entry with a default status of null. The user will
specify a {\textquotesingle}Y{\textquotesingle} or
{\textquotesingle}N{\textquotesingle} value. A value is required for
all job types, however booster/compressor is not needed for Standard
Job Types. If the user answers {\textquotesingle}Y{\textquotesingle}
the enquiry will become bespoke and a manual quotation will need to be
provided.
\\
Indicative Substantial Completion Date(A0138) (Q10)
&
A date format data item, dates will be entered in the format dd/mm/yy,
e.g. 21/10/07. This is an optional item for all job types. The date
will be stored in webMIP in the format
{\textquotesingle}YYYYMMDD{\textquotesingle} the value will be 8
characters in length.
\\
Other Related Jobs(Project Reference) (Q11)
&
An optional alphanumerical data item of 40 characters.
\\
Additional Services (Q12)
&
A list of options that the user has to request or decline. All of the
additional services require a mandatory response. Each option requires
the user to select {\textquotesingle}Y{\textquotesingle} or
{\textquotesingle}N{\textquotesingle}, by default the options will be
blank(null). \ The options that will be available are as follows :

\begin{enumerate}
\item Housing - If {\textquotesingle}N{\textquotesingle} is selected
the user must fill in an associated alphanumerical data item of 250
characters
\item Base
\item Converter. If a Converter exists and the enquiry is not Removal/ Std Removal/ Adversarial Removal, then a manual quote is required. If a Converter exists and the enquiry is Removal/Std Removal/Adversarial Removal, then an automatic quote is required. 
\item Logger. If a logger is attached and the enquiry type is an Exchange, then a manual quote is required. If a logger is attached and the enquiry type is not an Exchange, then a standard caveat is attached to the quote.
\item AMR. The AMR option will only be available for Tripartite users.
\item EMS
\item By-pass. One of the following
data items must be selected
\begin{enumerate}
\item Not Required
\item Essential (Hospital, prison, etc.)
\item Institution (School, college, etc.)
\item Animal welfare
\item Manufacturing process requirement
\item Complicated pipework system
\item Other. If {\textquotesingle}Other{\textquotesingle} is selected
then the user must fill in an associated alphanumerical data item of 40
characters, to describe the reason.
\end{enumerate}
\item Twin stream.
\end{enumerate}
\\
Logger/Converter
&
A 1 character alphabetical data item that is hidden from the user. The
webMIP system will select the value for this field. If Logger is
selected from the additional services data item then webMIP will store
a {\textquotesingle}L{\textquotesingle} if Converter is selected then
webMIP will record a {\textquotesingle}C{\textquotesingle}. The
default value will be blank (null).
\\
Job Description/Special Instructions (Q9a)
&
An optional 500 character alphanumerical data item that the user can
specify any job specific requirements. If the user has entered data
in the job description/special instructions data item then an automatic
quote will not be possible, the users should be warned of this prior to
submitting their data. 
\\
Measuring Capacity QMAX (A0112) (Q13)
&
A mandatory numeric data item that accepts numbers between the range of
0 to 999,999.999, up to 3 decimal places are allowed. Should not be available for standard jobs. The default
value will be blank(null). The value stored will be measured in KWh.
\\
Measuring Capacity QMIN (A0112) (Q13)
&
An optional numerical data item that accepts numbers between the range
of 0 to 999,999.999, up to 3 decimal places are allowed. The default
value for QMIN is blank(null). The value stored will be measured in
KWh.

A warning message will pop up to the end user if they select a design with a Qmin that is higher than the Qmin indicated on the enquiry. It will say:

\begin{quote}
Please note!  The module you have selected has a minimum flow rate that is greater than the requirement input on the enquiry screen. 
\end{quote}
\\
Load Control Type (Q13a)
&
Mandatory for all install and exchange job types(including standard),
optional for all other job types. The default value will be
blank(null). The user will be able to select one item from the
following list:

\begin{enumerate}
\item Constant
\item On/Off
\item Modulating
\end{enumerate}
\\
Meter Size (Q14)
&
Only relevant for the Standard Install Job Type, an optional data item.
If Qmax is empty then Meter Size must have a value selected. The
user can select one item from the following list:

\begin{enumerate}
\item U16
\item U25
\item U40
\item U65
\item U100
\item U160
\item Other
\end{enumerate}
\\
Meter Type Existing(A0025) (Q15)
&
Mandatory for all job types except for Standard Install, Install, EMS,
AMR, Other job types, optional for all other job types. The user is
able to select one item from the following list:

\begin{description}
\item [D] Diaphragm (unknown material)
\item [L] Leather
\item [S] Synthetic
\item [U] Ultrasonic
\item [Z] Unknown
\item [R] Rotary
\item [T] Turbine
\end{description}
The data item will be restricted to 8 characters in length.
\\
Existing Meter Size (Q15)
&
Mandatory for all job types except for Standard Install, Install, EMS,
AMR, Other job types, optional for all other job types. The user needs
to select one from the following list:

\begin{enumerate}
\item U16
\item U25
\item U40
\item U65
\item U100
\item U160
\item Rotary/Turbine 2''
\item Rotary/Turbine 3''
\item Rotary/Turbine 4''
\item Rotary/Turbine 6''
\item Other
\end{enumerate}
If other is selected then the job will be bespoke.
\\
Existing Pressure Category(Q15)
&
Mandatory for all job types except for Standard Install, Install, EMS, AMR, Other job types, optional for all other job types. The user needs to select one from the following list:
\begin{enumerate}
\item LP
\item MP
\item IP
\item HP
\end{enumerate}
\\
Existing Asset Serial Number (A0022) 
&
A 30 character alphanumerical data item that is Mandatory for the
following job types: Exchange, Standard Exchange, Removal, Standard
Removal, OFMAT, Alteration, EMS and AMR. The default value will be
blank(null)
\\
Existing Model Code/Number(A0083) 
&
A 20 character alphanumerical data item that is optional for all data
types, however it is not relevant to the
{\textquotesingle}install{\textquotesingle} or
{\textquotesingle}Standard Install{\textquotesingle} job types.
\\
Market Sector Code(A0161) 
&
An optional data item for all job types, defaulting to the value
{\textquotesingle}I{\textquotesingle}. The user can select one item
from the following list:

\begin{description}
\item [I] Industrial and Commercial
\item [D] Domestic
\end{description}

\\
Other Information 
&
A 250 character alphanumerical data item that is optional for all job
types. In addition the facility to add relevant files to the enquiry
will also be made available.
\\
\bottomrule
\end{longtable}