EXOR Enquiry Manager API › Assetwise › cont › Docs › 4… · User Options are similar to Product Options but values are specific to a single User and not all Users of the

EXOR

Enquiry Manager API

February 2014

Version: 4.7

Submitted by:

Bentley Systems (UK) Ltd.,

9th Floor,

20 Gracechurch Street,

London

EC3V 0BG

EXOR

ENQUIRY MANAGER API

DOCUMENT TRACKER

Version: 4.7 i

CONFIDENTIALITY STATEMENT

The contents of this document, including system ideas and concepts, are confidential and proprietary in nature and are not to be distributed in any form without the prior written consent of Bentley, Inc.

EXOR Enquiry Manager API

Trademark

Bentley and the "B" Bentley logo are either registered or unregistered trademarks or service marks of

Bentley Systems, Incorporated, or one of its direct or indirect wholly-owned subsidiaries.

Other brands and product names are trademarks of their respective owners.

Copyright

Copyright © 2013 Bentley Systems, Incorporated.

All Rights Reserved.

Including software, file formats, and audiovisual displays; may only be used pursuant to applicable

software license agreement; contains confidential and proprietary information of Bentley Systems,

Incorporated and/or third parties which is protected by copyright and trade secret law and may not be

provided or otherwise made available without proper authorization.

Restricted Rights Legend

If this software is acquired for or on behalf of the United States of America, its agencies and/or

instrumentalities ("U.S. Government"), it is provided with restricted rights. This software and

accompanying documentation are "commercial computer software" and "commercial computer software

documentation", respectively, pursuant to 48 C.F.R. 12.212 and 227.7202, and "restricted computer

software" pursuant to 48 C.F.R. 52.227-19(a), as applicable. Use, modification, reproduction, release,

performance, display or disclosure of this software and accompanying documentation by the U.S.

Government are subject to restrictions as set forth in this Agreement and pursuant to 48 C.F.R. 12.212,

52.227-19, 227.7202, and 1852.227-86, as applicable.

Contractor/Manufacturer is Bentley Systems, Incorporated, 685 Stockton Drive, Exton, PA 19341-0678.

Unpublished - rights reserved under the Copyright Laws of the United States and International treaties.

EXOR

ENQUIRY MANAGER API

DOCUMENT TRACKER

Version: 4.7 ii



Document Tracker

Document Details

File:

Enquiry Manager API V4.7.docx

Prepared by:

C Stewart

Manual Name:

Enquiry Manager API

Reviewed by:

G Anns

Version:

1.0

Approved for issue by:

C Stewart

Date of Issue:

Feb 2014

Product Manager:

I Skinner

File Name:

Document Centre/Exor/Product Manuals/4.7 Product Manuals/4.7 completed documentation/Enquiry Manager API V4.7.docx

Document Version Control

Revision Date By Chapter/Page Description

1 29-January CS Page 5 and 5 Missing Parameter – CE_DOC_REFERENCE added

2 24-Feb CS Various New NI14 parameters added to create and update Enquiry procedures.

3 17-Sep-2010 CLB Various Addition of CE_CAT, CE_CLASS, CE_ENQUIRY_TYPE and CE_COMPL_ACTION to update_enquiry API.

Also addition of APIs:

create_enquiry_contact

create_enquiry_contact_address

update_enquiry_contact

update_enquiry_contact_address

4 Oct 2012 CLB Page 12 CE_LOCALITY length corrected

5 Feb 2014 BA/IS All Re-formatted into Bentley template for 4.7 release

EXOR

ENQUIRY MANAGER API

TABLE OF CONTENTS

Version: 4.7 iii



Table of Contents

1 Introduction ........................................................................................................................................... 1

1.1 Exor System Options .................................................................................................................... 1

1.1.1 Product/User Options ............................................................................................................ 1

2 PEM Package ........................................................................................................................................ 2

2.1 CREATE_ENQUIRY ................................................................................................................... 2

2.1.1 Admin Units for Enquiries .................................................................................................... 2

2.1.2 Procedure Parameters – Quick Reference ............................................................................. 3

2.1.3 Procedure .............................................................................................................................. 5

2.1.4 Procedure Parameters – Detailed Reference ......................................................................... 8

2.1.5 Usage Example ................................................................................................................... 29

2.1.6 Usage Example – Enquiry Located on Street ..................................................................... 32

2.2 CREATE_ENQUIRY_CONTACT ............................................................................................ 34

2.2.1 Procedure ............................................................................................................................ 35

2.2.2 Procedure Parameters – Detailed Reference ....................................................................... 36

2.2.3 Usage Example ................................................................................................................... 42

2.3 CREATE_ENQUIRY_CONTACT_ADDRESS ........................................................................ 44

2.3.1 Procedure Parameters - Quick Reference ........................................................................... 44

2.3.2 Procedure ............................................................................................................................ 45


2.3.4 Usage Example ................................................................................................................... 50

2.3.5 Usage Example – Matching existing Postcode Details ....................................................... 52

2.4 UPDATE_ENQUIRY ................................................................................................................. 54

2.4.1 Procedure Parameters – Quick Reference ........................................................................... 55

2.4.2 Procedure ............................................................................................................................ 56


2.4.4 Usage Example ................................................................................................................... 64

2.5 UPDATE_ENQUIRY_CONTACT ............................................................................................ 66


2.5.2 Procedure ............................................................................................................................ 67


2.5.4 Usage Example ................................................................................................................... 73

2.6 UPDATE_ENQUIRY_CONTACT_ADDRESS ........................................................................ 75


2.6.2 Procedure ............................................................................................................................ 76


2.6.4 Usage Example – Matching Address Point data ................................................................. 81

EXOR

ENQUIRY MANAGER API

TABLE OF CONTENTS

Version: 4.7 iv



2.6.5 Usage Example – Matching existing address data .............................................................. 83

2.6.6 Usage Example ................................................................................................................... 85

EXOR

ENQUIRY MANAGER API

INTRODUCTION

Version: 4.7 1



1 Introduction

Enquiry Manager can be supplied with an Application Programming Interface (API) in order that external applications

may interact with the Exor Database and Enquiry Manager in particular.

An important part of Best Value delivery is offering a seamless service to the Public. When considering this requirement

and the needs of e-Government, it has become imperative that local authorities manage all public contact in a consistent

and professional manner.

Many Local Authorities have chosen the Exor Enquiry Manager product for the logging and management of all forms of

contact by the public, e.g., telephone calls, letters, emails etc. It has proven to be a very powerful tool for this purpose

helping to deliver a true seamless service particularly for highways departments where its integration with the other Exor

highways system offers huge benefits.

These existing Users have asked Exor to provide a product that will enable them as part of their e-Government delivery to

offer a Web Site where members of the public can record their enquiry and it can automatically create an Enquiry within

the PEM Database. In addition to this many Local Authorities are now deploying centralised CRM solutions and want to

integrate this CRM with Enquiry Manager. Using the CREATE and UPDATE APIs described in this document this can

be easily achieved with a minimum amount of development effort and more importantly in a supportable fashion.

This facility needs to be part of the seamless delivery and should not just create an EMAIL that then has to be entered

manually (involving duplication of effort) into a back end office system.

This document describes only the API calls themselves and assumes the User is familiar with Oracle Objects, PL/SQL,

SQL*Plus and Enquiry Manager already and its structure and functionality.

As such this document will not comprehensively document the functionality of Enquiry Manager and the User should

refer to the relevant Admin or User Guide for specific details of Enquiry Manager functionality.

1.1 Exor System Options

1.1.1 Product/User Options

Product Options allow ‘switches’ or default values to be set, which define how certain functionality operates within the

Exor suite of Products. User Options are similar to Product Options but values are specific to a single User and not all

Users of the System as is the case for a Product Option.

The Product and User options detailed within the Enquiry Manager System Admin Guide should be set to suit your

Organistaional requirements.

It is recommended that when using the API to create Enquiries from a public facing Web site for example, a ‘proxy’ or

dummy User is created within Highways. This is the User that would be used when connecting to the Oracle Database. In

this situation the appropriate User Options should be defined for this User.

Note: The HIG_USER role should be granted to this ‘proxy’ User.

Product Options are set using HIG9130 – Product Options. Users are created in Users – HIG1832 and User Options are

maintained using User Options - HIG1838

Refer to the General System Admin Guide for further information on these modules.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 2



2 PEM Package

The Enquiry Manager API is a PL/SQL procedure which resides in the ORACLE database. It can be called via an

ODBC/ORACLE connection with the parameters outlined in this Chapter.

The PEM package includes the following procedures for creating and updating an Enquiry, and associated Contact and

Contact Address details, via the API.

CREATE_ENQUIRY

CREATE_ENQUIRY_CONTACT

CREATE_ENQUIRY_CONTACT_ADDRESS

UPDATE_ENQUIRY

UPDATE_ENQUIRY_CONTACT

UPDATE_ENQUIRY_CONTACT_ADDRESS

2.1 CREATE_ENQUIRY

This procedure provides an insert API call which allows for the creation of an Enquiry. The procedure returns a numeric

value which is the unique Enquiry Id that has been created. If a parameter is omitted then it will take a default value if a

PRODUCT or USER OPTION exists otherwise it will take a NULL value.

Note: When contact details are provided within the API, a new Contact Record is created. This may mean that there

are multiple occurences of the same Contact within the Database.

2.1.1 Admin Units for Enquiries

Figure 1 - Admin Unit

The Admin Unit of an Enquiry (the mechanism used to determine which Exor Users have access to an Enquiry) is derived

based upon the values passed into the CE_RESP_OF (page 17) and CE_COMPL_USER_TYPE (page 25) respectively.

If the CE_COMPL_USER_TYPE value is either null or ‘USER’, then the Admin Unit of the Enquiry will be set to the

Admin Unit of the Exor User passed into the CE_RESP_OF parameter.

Note: In this case the value passed into the CE_RESP_OF parameter must be in the HUS_USERNAME column from

HIG_USERS.

If the CE_COMPL_USER_TYPE value is ‘CONT’, i.e., a Contact and NOT an Exor User, then the Admin Unit of the

Enquiry will be set to the Admin Unit of the Exor User used when the API call connects to the Oracle Database.

Note: In this case the value passed into the CE_RESP_OF parameter must be in the form of A OTHER, i.e., a space

between the first initial and surname.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 3



2.1.2 Procedure Parameters – Quick Reference

Parameter Name Type Data Type Use

CE_CAT IN VARCHAR2 Enquiry Category

CE_CLASS IN VARCHAR2 Enquiry Class

CE_TITLE IN VARCHAR2 Reserved for future use

CE_CONTACT_TITLE IN VARCHAR2 Contact Title

CE_FORENAME IN VARCHAR2 Contact Forename

CE_SURNAME IN VARCHAR2 Contact Surname

CE_CONTACT_TYPE IN VARCHAR2 Contact Type

CE_FLAG IN VARCHAR2 Reserved for future use

CE_PCODE_ID IN VARCHAR2 Address Point Id of Contact

CE_POSTCODE IN VARCHAR2 Post Code of Contact Address

CE_BUILDING_NO IN VARCHAR2 Building Number

CE_BUILDING_NAME IN VARCHAR2 Building Name

CE_STREET IN VARCHAR2 Street Name of Cont. Address

CE_LOCALITY IN VARCHAR2 Locality

CE_TOWN IN VARCHAR2 Town

CE_COUNTY IN VARCHAR2 County

CE_ORGANISATION IN VARCHAR2 Organization

CE_WORK_PHONE IN VARCHAR2 Contact Work Phone Number

CE_EMAIL IN VARCHAR2 Contact E-mail

CE_LOCATION IN VARCHAR2 Location of Enquiry

CE_DESCRIPTION IN VARCHAR2 Enquiry Description

CE_ENQUIRY_TYPE IN VARCHAR2 Enquiry Type

CE_SOURCE IN VARCHAR2 Enquiry Source

CE_INCIDENT_DATETIME IN DATE Incident Date and Time

CE_CPR_ID IN VARCHAR2 Enquiry Priority

CE_ASSET_ID IN VARCHAR2 Internal Id of associated Asset

CE_RSE_HE_ID IN VARCHAR2 Internal Identifier of Network

CE_X IN NUMBER X Coord (Easting) of pem

CE_Y IN NUMBER Y Coord (Northing) of pem

CE_DATE_EXPIRES IN VARCHAR2 Reserved for future use

CE_DOC_REFERENCE IN VARCHAR2 External Document Reference

CE_ISSUE_NUMBER IN NUMBER Reserved for future use

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 4




CE_CATEGORY IN VARCHAR2 Reserved for future use

CE_STATUS_DATE IN VARCHAR2 Reserved for future use

CE_RESP_OF IN VARCHAR2 Responsible Person

CE_COMPL_ACK_FLAG IN VARCHAR2 Acknowledge flag for report

CE_COMPL_ACK_DATE IN DATE Acknowledgement date

CE_COMPL_FLAG IN VARCHAR2 Reserved for future use

CE_COMPL_PEO_DATE IN VARCHAR2 Reserved for future use

CE_COMPL_TARGET IN DATE Target date

CE_COMPL_COMPLETE IN DATE Complete date

CE_COMPL_REFERRED_TO IN VARCHAR2 Reserved for future use

CE_COMPL_POLICE_NOTIF_FLAG IN VARCHAR2 Police notified

CE_COMPL_DATE_POLICE_NOTIF IN VARCHAR2 Date notified for police

CE_COMPL_FROM IN DATE From

CE_COMPL_TO IN DATE To

CE_COMPL_CLAIM IN VARCHAR2 claim ? flag

CE_COMPL_CORRESP_DATE IN DATE Correspondence date

CE_COMPL_CORRESP_DELIV_DATE IN DATE Correspondence delivery date

CE_COMPL_NO_OF_PETITIONERS IN NUMBER No of petitioners

CE_COMPL_REMARKS IN VARCHAR2 Action/remarks

CE_COMPL_CAUSE IN VARCHAR2 Reserved for future use

CE_COMPL_INJURIES IN VARCHAR2 Injuries

CE_COMPL_DAMAGE IN VARCHAR2 Damage

CE_COMPL_ACTION IN VARCHAR2 Reserved for future use

CE_COMPL_LITIGATION_FLAG IN VARCHAR2 Litigation

CE_COMPL_LITIGATION_REASON IN VARCHAR2 Litigation reason expand

CE_COMPL_CLAIM_NO IN VARCHAR2 Claim/Enquiries id

CE_COMPL_DETERMINATION IN VARCHAR2 Determination

CE_COMPL_EST_COST IN NUMBER Estimated cost

CE_COMPL_ADV_COST IN NUMBER Advance cost

CE_COMPL_ACT_COST IN NUMBER Actual cost

CE_COMPL_FOLLOW_UP1 IN DATE Follow up 1/woolf 1



CE_COMPL_INSURANCE_CLAIM IN VARCHAR2 Insurance claim flag

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 5




CE_COMPL_SUMMONS_RECEIVED IN VARCHAR2 Summons received

CE_COMPL_USER_TYPE IN VARCHAR2 ‘USER’ or ‘CONT’

CE_HCT_VIP IN VARCHAR2 VIP flag

CE_HCT_HOME_PHONE IN VARCHAR2 Contact home phone

CE_HCT_MOBILE_PHONE IN VARCHAR2 Contact mobile phone

CE_HCT_FAX IN VARCHAR2 Contact fax

CE_HAD_SUB_BUILD_NAME_NO IN VARCHAR2 Sub Building Name

CE_HAD_PROPERTY_TYPE IN VARCHAR2 Property type

CE_STATUS_CODE IN VARCHAR2 Enquiry Status Code

CE_DATE_TIME_ARRIVED IN DATE Date and Time arrived on Site

CE_REASON_FOR_LATE IN VARCHAR2 Reason for Late Arrival

CE_DOC_OUTCOME IN VARCHAR2 NI14 Enquiry Outcome value

CE_DOC_OUTCOME_REASON IN VARCHAR2 NI14 Enquiry Outcome reason

ERROR_VALUE OUT NUMBER Error Number

ERROR_PRODUCT OUT VARCHAR2 Error Product (DOC)

CE_DOC_ID OUT NUMBER Enquiry Id

2.1.3 Procedure

pem.create_enquiry

(ce_cat IN VARCHAR2 DEFAULT NVL(hig.get_useopt('ENQCAT', USER),

hig.get_sysopt('ENQCAT'))

,ce_class IN VARCHAR2 DEFAULT

NVL(hig.get_useopt('ENQCLASS',USER),

hig.get_sysopt('ENQCLASS'))

,ce_title IN VARCHAR2 DEFAULT NULL

,ce_contact_title IN VARCHAR2 DEFAULT NULL

,ce_forename IN VARCHAR2 DEFAULT NULL

,ce_surname IN VARCHAR2 DEFAULT NULL

,ce_contact_type IN VARCHAR2 DEFAULT

NVL(hig.get_useopt('ENQCONTYPE',USER),

hig.get_sysopt('ENQCONTYPE'))

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 6



,ce_flag IN VARCHAR2 DEFAULT 'Y'

,ce_pcode_id IN VARCHAR2 DEFAULT NULL

,ce_postcode IN VARCHAR2 DEFAULT NULL

,ce_building_no IN VARCHAR2 DEFAULT NULL

,ce_building_name IN VARCHAR2 DEFAULT NULL

,ce_street IN VARCHAR2 DEFAULT NULL

,ce_locality IN VARCHAR2 DEFAULT NULL

,ce_town IN VARCHAR2 DEFAULT NULL

,ce_county IN VARCHAR2 DEFAULT NULL

,ce_organisation IN VARCHAR2 DEFAULT NULL

,ce_work_phone IN VARCHAR2 DEFAULT NULL

,ce_email IN VARCHAR2 DEFAULT NULL

,ce_location IN VARCHAR2 DEFAULT NULL

,ce_description IN VARCHAR2 DEFAULT NULL

,ce_enquiry_type IN VARCHAR2 DEFAULT NVL(hig.get_useopt('ENQDEFENQT',

USER),

hig.get_sysopt('ENQDEFENQT'))

,ce_source IN VARCHAR2 DEFAULT NVL(hig.get_useopt('ENQDEFSRCE',

USER),

hig.get_sysopt('ENQDEFSRCE'))

,ce_incident_datetime IN DATE

,ce_cpr_id IN VARCHAR2 DEFAULT NULL

,ce_asset_id IN VARCHAR2 DEFAULT NULL

,ce_rse_he_id IN VARCHAR2 DEFAULT NULL

,ce_x IN NUMBER DEFAULT NULL

,ce_y IN NUMBER DEFAULT NULL

,ce_date_expires IN DATE DEFAULT NULL

,ce_doc_reference IN VARCHAR2 DEFAULT NULL

,ce_issue_number IN NUMBER DEFAULT NULL

,ce_category IN VARCHAR2 DEFAULT NULL

,ce_status_date IN DATE DEFAULT NULL

,ce_resp_of IN VARCHAR2 DEFAULT NULL

,ce_compl_ack_flag IN VARCHAR2 DEFAULT NULL

,ce_compl_ack_date IN DATE DEFAULT NULL

,ce_compl_flag IN VARCHAR2 DEFAULT NULL

,ce_compl_peo_date IN DATE DEFAULT NULL

,ce_compl_target IN DATE DEFAULT NULL

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 7



,ce_compl_complete IN DATE DEFAULT NULL

,ce_compl_referred_to IN VARCHAR2 DEFAULT NULL

,ce_compl_police_notif_flag IN VARCHAR2 DEFAULT 'N'

,ce_compl_date_police_notif IN VARCHAR2 DEFAULT NULL

,ce_compl_from IN DATE DEFAULT NULL

,ce_compl_to IN DATE DEFAULT NULL

,ce_compl_claim IN VARCHAR2 DEFAULT NULL

,ce_compl_corresp_date IN DATE DEFAULT NULL

,ce_compl_corresp_deliv_date IN DATE DEFAULT NULL

,ce_compl_no_of_petitioners IN NUMBER DEFAULT NULL

,ce_compl_remarks IN VARCHAR2 DEFAULT NULL

,ce_compl_cause IN VARCHAR2 DEFAULT NULL

,ce_compl_injuries IN VARCHAR2 DEFAULT NULL

,ce_compl_damage IN VARCHAR2 DEFAULT NULL

,ce_compl_action IN VARCHAR2 DEFAULT NULL

,ce_compl_litigation_flag IN VARCHAR2 DEFAULT 'N'

,ce_compl_litigation_reason IN VARCHAR2 DEFAULT NULL

,ce_compl_claim_no IN VARCHAR2 DEFAULT NULL

,ce_compl_determination IN VARCHAR2 DEFAULT NULL

,ce_compl_est_cost IN NUMBER DEFAULT NULL

,ce_compl_adv_cost IN NUMBER DEFAULT NULL

,ce_compl_act_cost IN NUMBER DEFAULT NULL

,ce_compl_follow_up1 IN DATE DEFAULT NULL



,ce_compl_insurance_claim IN VARCHAR2 DEFAULT NULL

,ce_compl_summons_received IN VARCHAR2 DEFAULT NULL

,ce_compl_user_type IN VARCHAR2 DEFAULT 'USER'

,ce_hct_vip IN VARCHAR2 DEFAULT NULL

,ce_hct_home_phone IN VARCHAR2 DEFAULT NULL

,ce_hct_mobile_phone IN VARCHAR2 DEFAULT NULL

,ce_hct_fax IN VARCHAR2 DEFAULT NULL

,ce_had_sub_build_name_no IN VARCHAR2 DEFAULT NULL

,ce_had_property_type IN VARCHAR2 DEFAULT NULL

,ce_status_code IN VARCHAR2 DEFAULT NULL

,ce_date_time_arrived IN DATE DEFAULT NULL

,ce_reason_late IN VARCHAR2 DEFAULT NULL

,ce_doc_outcome IN VARCHAR2 DEFAULT NULL

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 8



ce_doc_outcome_reason IN VARCHAR2 DEFAULT NULL

,error_value OUT NUMBER

,error_product OUT VARCHAR2

,ce_doc_id OUT NUMBER);

2.1.4 Procedure Parameters – Detailed Reference

Parameter Type Data Type Default Value

CE_CAT IN VARCHAR2 Product/User Option - ENQCAT

This parameter is used to pass in the Enquiry Category. If the parameter is not used within the API call the value populated within the Enquiry will be determined by the value defined for User/Product Option ENQCAT. Refer to the Enquiry Manager System Admin Guide for more information on Enquiry Categories and User/Product Options.

The select statement below shows how an LOV may be generated for this parameter. The example selects the Enquiry Category (dtp_code), e.g., CLAM and the Enquiry Category Name (dtp_name), e.g., CLAIM.

select dtp_code,dtp_name from doc_types

where DTP_ALLOW_COMPLAINTS ='Y'

The value passed into the API must be in upper case.


CE_CLASS IN VARCHAR2 Product/User Option - ENQCLASS

This parameter is used to pass in the Enquiry Class. If the parameter is not used within the API call the value populated within the Enquiry will be determined by the value defined for User/Product Option ENQCLASS. Refer to the Enquiry Manager System Admin Guide for more information on Enquiry Class and User/Product Options.

The select statement below shows how an LOV may be generated for this parameter. The example selects the Enquiry Class (dcl_code) and the Enquiry Class Name. Note that the value for dcl_dtp_code is the seelcted value for the CE_CAT parameter.

select dcl_code,dcl_name from doc_class

where dcl_dtp_code='CLAM'


EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 9




CE_TITLE IN VARCHAR2 NULL

This parameter is not currently used within the Enquiry Mananger API.


CE_CONTACT_TITLE IN VARCHAR2 NULL

This parameter is used to pass in the Title of the Enquiry Contact, e.g., MR, MRS, etc. Contact Titles are defined using Domains – HIG9120. The required Domain is named CONTACT_TITLE.

The select statement below shows how an LOV may be generated for this parameter. The example selects the Contact Title (hco_code) and Title meaning (hco_meaning).

select hco_code,hco_meaning from hig_codes

where hco_domain='CONTACT_TITLE'



CE_FORENAME IN VARCHAR2 NULL

This parameter is used to pass in the Forename of the Enquiry Contact. A maximum of 30 character is allowed. The value passed into the API must be in upper case.


CE_SURNAME IN VARCHAR2 NULL

This parameter is used to pass in the Surname of the Enquiry Contact. A maximum of 30 character is allowed. The value passed into the API must be in upper case.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 10




CE_CONTACT_TYPE IN VARCHAR2 Product/User Option - ENQCONTYPE

This parameter is used to pass in the Enquiry Contact Type. If the parameter is not used within the API call the value populated within the Enquiry will be determined by the value defined for User/Product Option ENQCONTYPE. Contact Types are defined using Domains – HIG9120. The required Domain is named CONTACT_PERSON_TYPE. Refer to the Enquiry Manager System Admin Guide for more information User/Product Options.

The select statement below shows how an LOV may be generated for this parameter. The example selects the Contact Type (hco_code) and Type meaning (hco_meaning).


where hco_domain='CONTACT_PERSON_TYPE'



CE_FLAG IN VARCHAR2 Y



CE_PCODE_ID IN VARCHAR2 NULL

This parameter contains the OSAPR (Ordnance Survey Address Point Ref, Unique) of the Contact Address. It’s used to identify any address currently defined with the same Address Point Id, for assignement as the Contact Address.


CE_POSTCODE IN VARCHAR2 NULL

This parameter is used to pass in the Post Code of the Enquiry Contacts address. If User/Product Option ENQFREEPC is set yo ‘Y’, the postcode format will be validated. Refer to the Enquiry Manager System Admin Guide for more information User/Product Options.


EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 11




CE_BUILDING_NO IN VARCHAR2 NULL

This parameter is used to pass in the Building Number of the Enquiry Contacts address. A maximum of 6 characters is allowed. Any non numeric characters used must be passed into the API in upper case.


CE_BUILDING_NAME IN VARCHAR2 NULL

This parameter is used to pass in the Building Name of the Enquiry Contacts address. A maximum of 60 characters is allowed. The value passed into the API must be in upper case.


CE_STREET IN VARCHAR2 NULL

This parameter is used to pass in the Street Name of the Enquiry Contacts address. A maximum of 80 characters is allowed. The value passed into the API must be in upper case.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 12




CE_LOCALITY IN VARCHAR2 NULL

This parameter is used to pass in the Locality of the Enquiry Contacts address. A maximum of 60 characters is allowed. The value passed into the API must be in upper case.


CE_TOWN IN VARCHAR2 NULL

This parameter is used to pass in the Town of the Enquiry Contacts address. A maximum of 60 characters is allowed. The value passed into the API must be in upper case.


CE_COUNTY IN VARCHAR2 NULL

This parameter is used to pass in the County of the Enquiry Contacts address. A maximum of 60 characters is allowed. The value passed into the API must be in upper case.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 13




CE_ORGANISATION IN VARCHAR2 NULL

This parameter is used to pass in the Organisation to which the Enquiry Contact belongs. A maximum of 60 characters is allowed. The value passed into the API must be in upper case.


CE_WORK_PHONE IN VARCHAR2 NULL

This parameter is used to pass in the Work phone number of the Enquiry Contact. A maximum of 25 characters is allowed.


CE_EMAIL IN VARCHAR2 NULL

This parameter is used to pass in the E-mail address of the Enquiry Contact. A maximum of 50 characters is allowed.


CE_LOCATION IN VARCHAR2 NULL

This parameter is used to pass in the Location of the Enquiry. A maximum of 254 characters is allowed.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 14




CE_DESRIPTION IN VARCHAR2 NULL

This parameter is used to pass in the Description of the Enquiry. A maximum of 2000 characters is allowed.


CE_ENQUIRY_TYPE IN VARCHAR2 Product/User Option - ENQDEFENQT

This parameter is used to pass in the Enquiry Type. If the parameter is not used within the API call the value populated within the Enquiry will be determined by the value defined for User/Product Option ENQDEFENQT. Refer to the Enquiry Manager System Admin Guide for more information on Enquiry Type and User/Product Options.

The select statement below shows how an LOV may be generated for this parameter. The example selects the Enquiry Type (dcl_code) and the Enquiry Type Name. Note that the value for det_dtp_code is the selected value for the CE_CAT parameter and the value for det_dcl_code is the selected value for the CE_CLASS parameter.

select det_code,det_name from doc_enquiry_types where

det_dtp_code='COMP' and det_dcl_code='FRML’



CE_SOURCE IN VARCHAR2 Product/User Option - ENQDEFSRCE

This parameter is used to pass in the Enquiry Source, e.g., ‘T’ – Telephone, ‘W’ – Walk In. If the parameter is not used within the API call the value populated within the Enquiry will be determined by the value defined for User/Product Option ENQDEFSRCE. Enquiry Sources are defined using Domains – HIG9120. The required Domain is named COMPLAINT_SOURCE. Refer to the Public Enquiry System Admin Guide for more information User/Product Options.

The select statement below shows how an LOV may be generated for this parameter. The example selects the Source (hco_code) and Source meaning (hco_meaning).


where hco_domain= ‘COMPLAINT_SOURCE’

he value passed into the API must be in upper case.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 15




CE_INCIDENT_DATETIME IN DATE NO DEFAULT VALUE

This parameter is used to pass in the Incident Date & Time of the Enquiry. The date and time should be passed into the API call in the format of ‘DD-MON-YYYY HH:MM’, e.g., 01-MAR-2003 14:30. If no time value is supplied a value of ‘00:00’ will be populated by the system.


CE_CPR_ID IN VARCHAR2 NULL

This parameter is used to pass in the Enquiry Priority. Enquiry Priorities are defined using DOC0132. Refer to the Enquiry Manager System Admin Guide for details of this module.

The select statement below shows how an LOV may be generated for this parameter. The example selects the Priority (cpr_id) and meaning (cpr_name).

select cpr_id,cpr_name from COMPLAINT_PRIORITIES


CE_ASSET_ID IN VARCHAR2 NULL

This parameter is not normally used within the PEM API. It is the internal id of an Asset Item to which an Enquiry may be associated. If this feature is required advice should be sought from Exor Support staff.


CE_RSE_HE_ID IN VARCHAR2 NULL

This parameter is used to pass in the internal id (NE_ID) of a Network Section or Group and represents the Road to which the Enquiry relates as opposed to the Contacts Address. The use of this paramEter relies on Road Sections or Groups already being created within Network Manager. If this is the case the User could be presented with a list of Streets for example selected from Street Gazetteer Manager. The selected value may then be passed into a function call return the internal id of the Network Group or Section.

The select statement below shows how a list of ‘Streets’ may be generated for use with this parameter. For explanation purposes a Street is a Group of Type ‘ OFFN’. The query will return the internal id (ne_id) the USRN (ne_number) and Street Description (ne_descr)

select ne_id,ne_number,ne_descr from nm_elements

where ne_gty_group_type='OFFN'

order by ne_descr

The rse_he_id (ne_id) value can be passed directly into the API or the ne_unique of the record selected may then be passed into a function call as shown below to get the internal id (ne_id) for the group.

select nm3net.get_ne_id(7369971,'NSGN') from dual

An example of this function call being used within the Enquiry Manager API may be found on page 32.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 16




CE_X IN NUMBER NULL

This parameter is used to pass in the X Coordinate or Easting of the Enquiry.


CE_Y IN NUMBER NULL

This parameter is used to pass in the Y Coordinate or Northing of the Enquiry.


CE_DATE_EXPIRES IN VARCHAR2 NULL



CE_DOC_REFERENCE IN VARCHAR2 NULL

This parameter is used to pass an ‘external’ document reference number for the Enquiry.


CE_ISSUE_NUMBER IN VARCHAR2 NULL


EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 17




CE_STATUS_DATE IN VARCHAR2 NULL



CE_RESP_OF IN VARCHAR2 NULL

This parameter is used to populate the ‘Responsibility Of’ field and is used in conjunction with the value passed into the API from the CE_COMPL_USER_TYPE parameter (page 25). If the CE_COMPL_USER_TYPE is null or ‘USER’, then the ‘Responsibility of’ field will be set as per the value passed in via this parameter. Note that if the CE_COMPL_USER_TYPE parameter is ‘USER’ or null, the value passed into the CE_RESP_OF parameter must be in the HUS_USERNAME from HIG_USERS.

In this case the Admin Unit of the Enquiry will be derived from the Admin Unit associated with the ‘Responsibility Of’ User.

If the CE_COMPL_USER_TYPE value is ‘CONT’ the ‘Responsibilty Of’ value will be generated as follows.

The first character of the parameter value and the value from the 3rd character to the string end are compared with the First character of the First Name field and the Surname field respectively within the HIG_CONTACTS table (these records are displayed using the Enquiry Contacts - HIG1815 module). The matching record will then be used as the ‘Responsibility Of’ value.

Note that if the CE_COMPL_USER_TYPE parameter is ‘CONT’, i.e., a Contact, the value passed into the CE_RESP_OF parameter must be in the form of A OTHER, i.e., a space between the first initial and surname.

In this case the Admin Unit of the Enquiry will be derived from the Admin Unit of the User used when connecting to the Oracle Database.


CE_COMPL_ACK_FLAG IN VARCHAR2 NULL

This parameter is not used within the PEM API. This flag is set when the Enquiry is included when running the Enquiry Acknowledgements - DOC0160 report. It ensures that the Enquiry is not included multiple times when running the ‘Acknowledgements’ report.


CE_COMPL_ACK_DATE IN DATE NULL

This parameter is not used within the PEM API. It is the Date on which an Acknowledgement was issued to the Enquirer. The Date entered here may generate Dates for the Woolf 2 and Woolf 3 dates if the Enquiry Class is of the type specified in Product Option WENQWLFCLAS. This Date is also set when the Enquiry is included when running the Enquiry Acknowledgements - DOC0160 report. It is the date on which the ‘Acknowledgements’ report is run. Refer to the Enquiry Manager User guide for more information on WOOLF dates.


CE_COMPL_ FLAG IN VARCHAR2 NULL


EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 18




CE_COMPL_ PEO_DATE IN DATE NULL



CE_COMPL_ TARGET IN DATE NULL

This parameter is used to pass in the Enquiry Target Date.

Note that if this parameter is not used within the API it will be generated automatically when the Enquiry is modified within the Enquiry Manager application module providing that an Enquiry Prioriy has been populated.


CE_COMPL_ COMPLETE IN DATE NULL

This parameter is used to pass in the Enquiry Complete Date (which includes the Completion Time. If this parameter is used the date and time should be passed into the API call in the format of ‘DD-MON-YYYY HH:MM’, e.g., 01-MAR-2003 14:30. If no time value is supplied a value of ‘00:00’ will be populated by the system.


CE_COMPL_ REFERRED_TO IN VARCHAR2 NULL



CE_COMPL_POLICE_NOTIF_FLAG IN VARCHAR2 N

This parameter is used to pass in a flag to indicate that the Police have been Notified. This flag is displayed in the ‘Further Details’ tab. Values of ‘Y’ and ‘N’ are allowed.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 19




CE_COMPL_DATE_POLICE_NOTIF IN VARCHAR2 NULL

This parameter is used to pass in the Date on which the Police were Notified of the incident and should be used in conjunction with the previous parameter. If used the date should be passed into the API call in the format DD-MON-YYYY, e.g., 01-JAN-2004. This date is displayed within the ‘Further Details’ tab.


CE_COMPL_FROM IN DATE NULL

This parameter is used to pass in the From Date which is displayed in the ‘Further Details’ Tab. This may be used to define the period for ‘licenced’ work such as Skip’s being left on a Highway. If used the date should be passed into the API call in the format DD-MON-YYYY, e.g., 01-JAN-2004.


CE_COMPL_TO IN DATE NULL

This parameter is used to pass in the To Date which is displayed in the ‘Further Details’ Tab. This may be used to define the period for ‘licenced’ work such as Skip’s being left on a Highway. If used the date should be passed into the API call in the format DD-MON-YYYY, e.g., 01-JAN-2004.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 20




CE_COMPL_CLAIM IN VARCHAR2 NULL

This parameter is used to indicate that a Claim is being pursued for the Enquiry. This flag is displayed in the ‘Further Details’ Tab. Values of ‘Y’ and ‘N’ are allowed.


CE_COMPL_CORRESP_DATE IN DATE NULL

This parameter is used to pass in the Correspondence Date. The correspondence date should not be before the Incident Date. If used the date should be passed into the API call in the format DD-MON-YYYY, e.g., 01-JAN-2004.


CE_COMPL_CORRESP_DELIV_DATE IN VARCHAR2 NULL

This parameter is used to pass in the Corr Received Date and should be used in conjunction with the previous parameter. If used the date should be passed into the API call in the format DD-MON-YYYY, e.g., 01-JAN-2004.


CE_COMPL_NO_OF_PETITIONERS IN NUMBER NULL

This parameter is used to pass in a value for the No. of Petitioners field which is displayed in the ‘Further Details’ window called by pressing the [Expand] button on the menu toolbar.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 21




CE_COMPL_REMARKS IN VARCHAR2 NULL

This parameter is used to pass in a value for the Notes. A maximum of 254 characters are allowed. The Notes field is displayed within the ‘Further Details’ tab.


CE_COMPL_ CAUSE IN VARCHAR2 NULL



CE_COMPL_INJURIES IN VARCHAR2 NULL

This parameter is used to enter a textural description of any Injuries sustained by the Enquirer. This parameter should only be used if the value for the ‘CE_CAT’ parameter (page 8) is the same as the setting defined for Product Option ENQCLMCAT.


CE_COMPL_DAMAGE IN VARCHAR2 NULL

This parameter is used to enter a textural description of any Damage caused to Street furniture or Vehicles for example. This parameter should only be used if the value for the ‘CE_CAT’ parameter (page 8) is the same as the setting defined for Product Option ENQCLMCAT. Refer to the Public Enquiry System Admin Guide for more information User/Product Options.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 22




CE_COMPL_ ACTION IN VARCHAR2 NULL

This parameter is used to pass textural data into the Action/Remarks field. A maximum of 2000 characters is allowed.


CE_COMPL_LITIGATION_FLAG IN VARCHAR2 N

This parameter is used to pass in a flag to indicate that the Enquiry has resulted in Litigation. This flag is displayed in the ‘Further Details’ tab. Values of ‘Y’ and ‘N’ are allowed.


CE_COMPL_LITIGATION_REASON IN VARCHAR2 NULL

This parameter is used to pass in textural ‘Reason’ as to why litigation has ensued and should be used in conjunction with the previous parameter. This field is displayed in the ‘Further Details’ Tab. A maximum of 254 characters are allowed.


CE_COMPL_CLAIM_NO IN VARCHAR2 NULL

This parameter is used to pass in reference Id for the Enquiry. This field is displayed in the ‘Further Details’ Tab. A maximum of 20 characters are allowed. Note that the boiler plate text for this field is determined by Product Option ENQTITLE. Refer to the Enquiry Manager System Admin Guide for more information User/Product Options.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 23




CE_COMPL_DETERMINATION IN VARCHAR2 NULL

This parameter is used to pass in a value for the Enquiry Determination. Valid Determinations are defined using Domains – HIG9120. The required Domain is named DETERMINATION. This field is displayed in the ‘Further Details’ Tab.

The select statement below shows how an LOV may be generated for this parameter. The example selects the Determination (hco_code) and meaning (hco_meaning).


where hco_domain= ‘COMPLAINT_SOURCE’



CE_COMPL_EST_COST IN NUMBER NULL

This parameter is used to pass in a value for the Estimated Cost of the Equiry or Claim and is displayed in the ‘Further Details’ Tab. Values may be entered upto 2 decimal places.


CE_COMPL_ADV_COST IN NUMBER NULL

This parameter is used to pass in a value for the Advanced Cost of the Equiry or Claim and is displayed in the ‘Further Details’ Tab. Values may be entered upto 2 decimal places.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 24




CE_COMPL_ACT_COST IN NUMBER NULL

This parameter is used to pass in a value for the Actual Cost of the Equiry or Claim and is displayed in the ‘Further Details’ Tab. Values may be entered upto 2 decimal places.


CE_COMPL_FOLLOW_UP1 IN DATE NULL

This parameter is used to enter the first Follow Up date if required. If used the date should be entered ina format of DD-MON-YYYY, e.g., 01-JAN-2004.


CE_COMPL_FOLLOW_UP2 IN DATE NULL

This parameter is used to enter the second Follow Up date if required. If used the date should be entered ina format of DD-MON-YYYY, e.g., 01-JAN-2004.


CE_COMPL_FOLLOW_UP3 IN VARCHAR2 NULL

This parameter is used to enter the third Follow Up date if required. If used the date should be entered ina format of DD-MON-YYYY, e.g., 01-JAN-2004.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 25




CE_COMPL_INSURANCE_CLAIM IN VARCHAR2 NULL

This parameter is used to pass in a flag to indicate that the Enquiry has resulted in an Insurance Claim. This flag is displayed in the ‘Further Details’ Tab. Values of ‘Y’ and ‘N’ are allowed.


CE_COMPL_SUMMONS_RECEIVED IN VARCHAR2 NULL

This parameter is used to pass in a flag to indicate that a Summons has been received in connection with the Enquiry. This flag is displayed in the ‘Further Details’ Tab. Values of ‘Y’ and ‘N’ are allowed.


CE_COMPL_USER_TYPE IN VARCHAR2 USER

This parameter is used in conjunction with the CE_RESP_OF (Responsibility Of) parameter (page 17). Valid entries are ‘USER’ or ‘CONT’.


CE_HCT_VIP IN VARCHAR2 NULL

This parameter is used to pass in an ‘important person categories’ (VIP) flag. Valid Flags are defined using Domains – HIG9120. The required Domain is named CONTACT_VIP.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 26




CE_HCT_HOME_PHONE IN VARCHAR2 NULL

This parameter is used to pass in the Home phone number of the Enquiry Contact. A maximum of 25 characters is allowed.


CE_HCT_MOBILE_PHONE IN VARCHAR2 NULL

This parameter is used to pass in the Mobile phone number of the Enquiry Contact. A maximum of 25 characters is allowed.


CE_HCT_FAX IN VARCHAR2 NULL

This parameter is used to pass in the Fax number of the Enquiry Contact. A maximum of 25 characters is allowed.


CE_HAD_SUB_BUILD_NAME_NO IN VARCHAR2 NULL

This parameter is used to pass in the Sub building name or number of the Enquiry Contact. A maximum of 60 characters is allowed. The value passed into the API must be in upper case.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 27




CE_HAD_PROPERTY_TYPE IN VARCHAR2 NULL

This parameter is used to pass in the 'Property Type' for the Contacts Address, e.g., 'Backcourt'. Valid Types are defined using Domains – HIG9120. The required Domain is named PROPERTY_TYPE.

The select statement below shows how an LOV may be generated for this parameter. The example selects the Property Type Code (hco_code) and meaning (hco_meaning).


where hco_domain= ‘PROPERTY_TYPE’



CE_STATUS_CODE IN VARCHAR2 NULL

This parameter is used to pass in the 'Status Code' for the Enquiry, e.g., ‘RE’ - received. Valid codes are defined using Status Codes – HIG9110. The required Domain is named ‘COMPLAINTS’.

If a NULL value is passed into the API, the value will be defaulted to the Status Code which has Feature 1 set to ‘Y’ for the COMPLAINTS Status Domain



CE_DATE_TIME_ARRIVED IN DATE NULL

This parameter is used to pass in the 'date and time arrived on site’ value. It must be provided in the form of DD-MON-YYYY HH:MM.


CE_REASON_LATE IN VARCAHR2 NULL

This parameter is used to pass in the ‘Reason for Late Arrival’ and is used in conjunction with the CE_DATE_TIME_ARRIVED parameter. A maximum of 255 characters is allowed

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 28




CE_DOC_OUTCOME IN VARCAHR2 NULL

This parameter is used to pass in the NI14 Outcome Value. If Used, valid codes are defined using Domains – HIG9120. The required Domain is named OUTCOME_OPTIONS.

The select statement below shows how an LOV may be generated for this parameter. The example selects the Outcome Code (hco_code) and meaning (hco_meaning).


where hco_domain= ‘OUTCOME_OPTIONS


Note that the NI14 functionality is only available when Product Option ENQOUTCOME is set to ‘Y’.


CE_DOC_OUTCOME_REASON IN VARCAHR2 NULL

This parameter is used to pass in the NI14 Outcome reason. A maximum of 254 characters is allowed. The Outcome reason is added within the DOC0150 form when a new value is added for the outcome, in the same manner as the ‘Reason for Change’ value when the Status Code is changed. The Outcome and Outcome reason are both displayed within the Enquiry History.



ERROR_VALUE OUT NUMBER

If an error occurs during the API transaction the error number will be returned. This value is stored in the HER_NO column of a table named HIG_ERRORS. For example, error ‘64’ - Corresp. Date must not be before Incident and not after Corresp. Delivery or Date Recorded.


ERROR_PRODUCT OUT VARCHAR2

If an error occurs during the API transaction the Product Code will be returned. This value will always be ‘DOC’.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 29




CE_DOC_ID OUT NUMBER

This will be the Enquiry Id created by the Enquiry API transaction.

2.1.5 Usage Example

DECLARE

l_error_value NUMBER;

l_error_product VARCHAR2(10);

l_ce_doc_id NUMBER;

BEGIN

PEM.create_enquiry

( ce_cat => 'ENQ'

, ce_class => 'FRML'

, ce_contact_title => 'MR'

, ce_forename => 'CLIFF'

, ce_surname => 'STEWART'

, ce_contact_type => 'ENQUIRER'

, ce_postcode => 'BS11EJ'

, ce_building_no => '1'

, ce_building_name => 'CLIFTON HEIGHTS'

, ce_street => 'HIGH STREET'

, ce_town => 'BRSITOL'

, ce_work_phone => '0117 600 4200'

, ce_email => '[email protected]'

, ce_location => 'Outside Flying Horse Public House'

, ce_description => 'Large Pothole'

, ce_enquiry_type => 'CD'

, ce_source => 'T'

, ce_incident_datetime => TO_DATE('01-JAN-2004 11:00',

'DD-MON-YYYY HH24:MI')

, ce_cpr_id => '1'

, ce_compl_target => '08-JAN-2004'

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 30



, ce_compl_corresp_date => '02-JAN-2004'

, ce_compl_corresp_deliv_date => '02-JAN-2004'

, ce_compl_user_type => 'USER'

,ce_resp_of => 'GBOWLER'

, ce_hct_vip => 'CO'

, ce_hct_home_phone => '0117 900 6201'

, ce_hct_mobile_phone => '07111 1111111'

, ce_doc_outcome =>’FC’

, ce_doc_outcome_reason => ‘First Contact’

, error_value => l_error_value

, error_product => l_error_product

, ce_doc_id => l_ce_doc_id

);

END;

/

This example would result in an Enquiry record (Figure 2) and a Contact record (Figure 3) being created within Enquiry

Manager.

Code text

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 31



Figure 2 - Enquiry & Contact Record (Enquiries)

Figure 3 - Contact Record (Contacts)

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 32



2.1.6 Usage Example – Enquiry Located on Street

DECLARE

l_error_value NUMBER;

l_error_product VARCHAR2(10);

l_ce_doc_id NUMBER;

BEGIN

PEM.create_enquiry

( ce_cat => 'ENQ'

, ce_class => 'FRML'

, ce_contact_title => 'MR'

, ce_forename => 'CLIFF'

, ce_surname => 'STEWART'

, ce_contact_type => 'ENQUIRER'

, ce_postcode => 'BS11EJ'

, ce_building_no => '1'

, ce_building_name => 'CLIFTON HEIGHTS'

, ce_street => 'HIGH STREET'

, ce_town => 'BRSITOL'

, ce_work_phone => '0117 600 4200'

, ce_email => '[email protected]'

, ce_location => 'Outside Flying Horse Public

House'

, ce_description => 'Large Pothole'

, ce_enquiry_type => 'CD'

, ce_source => 'T'

, ce_incident_datetime =>TO_DATE('01-JAN-2004 11:00',

'DD-MON-YYYY HH24:MI')

, ce_cpr_id => '5'

, ce_rse_he_id => nm3net.get_ne_id('1200D90970/09001','L')

, ce_compl_target => '08-JAN-2004'

, ce_compl_corresp_date => '02-JAN-2004'

, ce_compl_corresp_deliv_date => '02-JAN-2004'

, ce_compl_user_type => 'USER'

, ce_resp_of => 'GBOWLER'

, ce_hct_vip => 'CO'

, ce_hct_home_phone => '0117 900 6201'

, ce_hct_mobile_phone => '07111 1111111'

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 33



, ce_doc_outcome =>’FC’

, ce_doc_outcome_eason => ‘First Contact’

, error_value => l_error_value

, error_product => l_error_product

, ce_doc_id => l_ce_doc_id

);

END;

/

This example would result in an Enquiry record being created and located on a Section as shown in Figure 4

Figure 4 - Enquiry Example

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 34



2.2 CREATE_ENQUIRY_CONTACT

This procedure provides an insert API call which allows for the creation of an Enquiry Contact, for a given Enquiry Id

(DOC_ID). If this is the first contact added to the enquiry, a Primary Contact will be created, otherwise a Non-Primary

Contact will be added.

The procedure returns a numeric value which is the unique Contact Id that has been created. If a parameter is omitted then

it will take a default value if a PRODUCT or USER OPTION exists otherwise it will take a NULL value.

Procedure Parameters – Quick Reference


CE_DOC_ID IN NUMBER Enquiry Id

CE_DEC_TYPE IN VARCHAR2 Contact Type

CE_HCT_ORG_OR_PERSON_FLAG IN VARCHAR2 Organisation or Person Flag

CE_HCT_VIP IN VARCHAR2 VIP Flag

CE_HCT_TITLE IN VARCHAR2 Contact Title

CE_HCT_SALUTATION IN VARCHAR2 Salutation

CE_HCT_FIRST_NAME IN VARCHAR2 First Name

CE_HCT_MIDDLE_INITIAL IN VARCHAR2 Middle Initial

CE_HCT_SURNAME IN VARCHAR2 Surname

CE_HCT_ORGANISATION IN VARCHAR2 Organisation

CE_HCT_HOME_PHONE IN VARCHAR2 Home Telephone No.

CE_HCT_WORK_PHONE IN VARCHAR2 Work Telephone No.

CE_HCT_MOBILE_PHONE IN VARCHAR2 Mobile Phone No.

CE_HCT_FAX IN VARCHAR2 Fax No.

CE_HCT_PAGER IN VARCHAR2 Pager No.

CE_HCT_EMAIL IN VARCHAR2 Email Address

CE_HCT_OCCUPATION IN VARCHAR2 Occupation

CE_HCT_EMPLOYER IN VARCHAR2 Employer

CE_HCT_DATE_OF_BIRTH IN DATE Date of Birth

CE_HCT_START_DATE IN DATE Start Date

CE_HCT_END_DATE IN DATE End Date

CE_HCT_NOTES IN VARCHAR2 Notes

CE_HCT_ID OUT NUMBER Contact Id

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 35



2.2.1 Procedure

pem.create_contact_enquiry

(ce_doc_id IN NUMBER

,ce_dec_type IN VARCHAR2 DEFAULT

NVL(hig.get_useopt('ENQCONTYPE', g_hus.hus_username),

hig.get_sysopt('ENQCONTYPE'))

,ce_hct_org_or_person_flag IN VARCHAR2 DEFAULT 'P'


,ce_hct_title IN VARCHAR2 DEFAULT NULL

,ce_hct_salutation IN VARCHAR2 DEFAULT NULL

,ce_hct_first_name IN VARCHAR2 DEFAULT NULL

,ce_hct_middle_initial IN VARCHAR2 DEFAULT NULL

,ce_hct_surname IN VARCHAR2 DEFAULT NULL

,ce_hct_organisation IN VARCHAR2 DEFAULT NULL


,ce_hct_work_phone IN VARCHAR2 DEFAULT NULL



,ce_hct_pager IN VARCHAR2 DEFAULT NULL

,ce_hct_email IN VARCHAR2 DEFAULT NULL

,ce_hct_occupation IN VARCHAR2 DEFAULT NULL

,ce_hct_employer IN VARCHAR2 DEFAULT NULL

,ce_hct_date_of_birth IN DATE DEFAULT NULL

,ce_hct_start_date IN DATE DEFAULT NULL

,ce_hct_end_date IN DATE DEFAULT NULL

,ce_hct_notes IN VARCHAR2 DEFAULT NULL

,ce_hct_id OUT NUMBER

)

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 36





CE_DOC_ID IN NUMBER

This will be the Unique numeric Id defined for the enquiry, for which the Enquiry Contact will be created.


CE_DEC_TYPE IN VARCHAR2 Product/User Option - ENQCONTYPE

This parameter is used to pass the Contact Type. If the parameter is not used within the API call the default value defined for User/Product Option ENQCONTYPE will be used. Refer to the Enquiry Manager System Admin Guide for more information on Contact Type and User/Product Options.

Valid Types are defined using Domains – HIG9120. The Contact Type is defined by Domains CONTACT_PERSON_TYPE or CONTACT_ORG_TYPE, depending on whether the contact is a Person or an Organisation.

The select statement below shows how an LOV may be generated for this parameter. The example selects the Contact Type Code (hco_code) and meaning (hco_meaning).


where hco_domain in (‘CONTACT_PERSON_TYPE’,’ CONTACT_ORG_TYPE’);



CE_HCT_ORG_OR_PERSON_FLAG IN VARCHAR2 ‘P’

This parameter defines whether the contact is a person ‘P’, or organisation ‘O’.

If the parameter is not used within the API the value will default to ‘P’ (ie. Person) .


EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 37






The select statement below shows how an LOV may be generated for this parameter. The example selects the VIP flag (hco_code) and meaning (hco_meaning).


where hco_domain= ‘CONTACT_VIP’



CE_HCT_TITLE IN VARCHAR2 NULL







CE_HCT_SALUTATION IN VARCHAR2 NULL

This parameter is used to pass in the any salutation details for the contact


EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 38




CE_HCT_FIRST_NAME IN VARCHAR2 NULL

This parameter is used to pass in the First Name of the Enquiry Contact. A maximum of 30 characters is allowed.



CE_HCT_MIDDLE_INITIAL IN VARCHAR2 NULL

This parameter is used to pass in the Middle Initial of the Enquiry Contact.



CE_HCT_SURNAME IN VARCHAR2 NULL

This parameter is used to pass in the Surname of the Enquiry Contact. A maximum of 30 characters is allowed.



CE_HCT_ORGANISATION IN VARCHAR2 NULL

This parameter is used to pass in the Contact Organisation details. A maximum of 60 characters is allowed.


EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 39







CE_HCT_WORK_PHONE IN VARCHAR2 NULL

This parameter is used to pass in the Business phone number of the Enquiry Contact. A maximum of 25 characters is allowed.








CE_HCT_PAGER IN VARCHAR2 NULL

This parameter is used to pass in the Pager number of the Enquiry Contact. A maximum of 25 characters is allowed.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 40




CE_HCT_EMAIL IN VARCHAR2 NULL

This parameter is used to pass in the Email address of the Enquiry Contact. A maximum of 50 characters is allowed.


CE_HCT_OCCUPATION IN VARCHAR2 NULL

This parameter is used to pass in the Occupation of the Enquiry Contact. A maximum of 50 characters is allowed.


CE_HCT_EMPLOYER IN VARCHAR2 NULL

This parameter is used to pass in the Employer of the Enquiry Contact. A maximum of 50 characters is allowed.


CE_HCT_DATE_OF_BIRTH IN DATE NULL

This parameter is used to pass in the Enquiry Contact Date of Birth value. It must be provided in the form of DD-MON-YYYY.


CE_START_DATE IN DATE NULL

This parameter is used to pass in the Date from which this Enquiry Contact is Active. It must be provided in the form of DD-MON-YYYY.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 41




CE_HCT_END_DATE IN DATE NULL

This parameter is used to pass in the Date when this Enquiry Contact becomes inactive. It must be provided in the form of DD-MON-YYYY.


CE_HCT_NOTES IN VARCHAR2 NULL

This parameter is used to pass in any Notes, associated with the Enquiry Contact


CE_HCT_ID OUT VARCHAR2

This will be the Enquiry Contact Id created by the Create Enquiry Contact API transaction.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 42



2.2.3 Usage Example

DECLARE

lv_hct_id hig_contacts.hct_id%TYPE;

BEGIN

pem.create_enquiry_contact

(ce_doc_id => 255807

,ce_dec_type => 'THIRD_PARTY'

,ce_hct_vip => 'CC'

,ce_hct_title => 'MR'

,ce_hct_first_name => 'FRANK'

,ce_hct_middle_initial => 'L'

,ce_hct_surname => 'RICHARDS'

,ce_hct_organisation => 'Cheshire County Council'

,ce_hct_home_phone => '01612457666'

,ce_hct_work_phone => '01612223333'

,ce_hct_date_of_birth => '03-FEB-1948'

,ce_hct_id =>lv_hct_id

);

END;

/

This example would result in an Enquiry Contact record being created for Enquiry Id 255807. Figure 5 shows the details

displayed in the main Enquiries Manager screen (DOC0150) and Figure 6 displays details displayed in form HIG1815, on

pressing the ‘View Contact Det.’ Button, in DOC0150.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 43



Figure 5 - Contact Details Example (Enquiries)

Figure 6 - Contact Details Example (Contacts)

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 44



2.3 CREATE_ENQUIRY_CONTACT_ADDRESS

This procedure provides an insert API call which allows for the creation of an Enquiry Contact Address, for a given

Enquiry Contact Id (HCT_ID).

The procedure returns a numeric value which is the unique Contact Address Id that has been created. If a parameter is

omitted then it will take a default value if a PRODUCT or USER OPTION exists otherwise it will take a NULL value.

The API will initially attempt to identify any address details that may already exist, by matching the Address Point Id, or

the Postcode and Building No. or Building Name. If a unique address is identified, this will be assigned to the Enquiry, as

the Enquiry Contact Address. Otherwise, new address details will be created, and associated with the Enquiry.

2.3.1 Procedure Parameters - Quick Reference


CE_HCT_ID IN NUMBER Enquiry Contact Id

CE_HAD_DEPARTMENT IN VARCHAR2 Department

CE_HAD_PO_BOX IN VARCHAR2 PO Box

CE_HAD_ORGANISATION IN VARCHAR2 Organisation

CE_HAD_SUB_BUILDING_NAME_NO IN VARCHAR2 Sub Building Name/No

CE_HAD_BUILDING_NAME IN VARCHAR2 Building Name

CE_HAD_BUILDING_NO IN VARCHAR2 Building No

CE_HAD_DEPENDENT_THOROUGHFARE IN VARCHAR2 Dependent Thoroughfare

CE_HAD_THOROUGHFARE IN VARCHAR2 Street

CE_HAD_DOUBLE_DEP_LOCAL_NAME IN VARCHAR2 Estate

CE_HAD_DEPENDENT_LOCALITY_NAME IN VARCHAR2 Locality

CE_HAD_POST_TOWN IN VARCHAR2 Town

CE_HAD_COUNTY IN VARCHAR2 County

CE_HAD_POSTCODE IN VARCHAR2 Postcode

CE_HAD_OSAPR IN VARCHAR2 Address Pont Id

CE_HAD_XCO IN NUMBER X Coord (Easting)

CE_HAD_YCO IN NUMBER Y Coord (Northing)

CE_HAD_NOTES IN VARCHAR2 Notes

CE_HAD_PROPERTY_TYPE IN VARCHAR2 Property Type

CE_HAD_ID OUT NUMBER Contact Address Id

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 45



2.3.2 Procedure

pem.create_enquiry_contact_address

(ce_hct_id IN NUMBER

,ce_had_department IN VARCHAR2 DEFAULT NULL

,ce_had_po_box IN VARCHAR2 DEFAULT NULL

,ce_had_organisation IN VARCHAR2 DEFAULT NULL

,ce_had_sub_building_name_no IN VARCHAR2 DEFAULT NULL

,ce_had_building_name IN VARCHAR2 DEFAULT NULL

,ce_had_building_no IN VARCHAR2 DEFAULT NULL

,ce_had_dependent_thoroughfare IN VARCHAR2 DEFAULT NULL

,ce_had_thoroughfare IN VARCHAR2 DEFAULT NULL

,ce_had_double_dep_local_name IN VARCHAR2 DEFAULT NULL

,ce_had_dependent_locality_name IN VARCHAR2 DEFAULT NULL

,ce_had_post_town IN VARCHAR2 DEFAULT NULL

,ce_had_county IN VARCHAR2 DEFAULT NULL

,ce_had_postcode IN VARCHAR2 DEFAULT NULL

,ce_had_osapr IN VARCHAR2 DEFAULT NULL

,ce_had_xco IN NUMBER DEFAULT NULL

,ce_had_yco IN NUMBER DEFAULT NULL

,ce_had_notes IN VARCHAR2 DEFAULT NULL


,ce_had_id OUT NUMBER)

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 46





CE_HCT_ID IN NUMBER

This will be the Unique numeric Id defined for the enquiry, for which the Enquiry Contact will be created.


CE_HAD_DEPARTMENT IN VARCHAR2 NULL

This parameter is used to pass in the Department details. A maximum of 60 characters is allowed.



CE_HAD_PO_BOX IN VARCHAR2 NULL

This parameter is used to pass in the Post Office Box details. A maximum of 6 characters is allowed.



CE_HAD_ORGANISATION IN VARCHAR2 NULL

This parameter is used to pass in the Organisation details. A maximum of 60 characters is allowed.



CE_HAD_SUB_BUILDING_NAME_NO IN VARCHAR2 NULL

This parameter is used to pass in the Sub-Building Name/No details. A maximum of 60 characters is allowed.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 47




CE_HAD_BUILDING_NAME IN VARCHAR2 NULL

This parameter is used to pass in the Building Name details. A maximum of 60 characters is allowed.



CE_HAD_BUILDING_NO IN VARCHAR2 NULL

This parameter is used to pass in the Building No details. A maximum of 6 characters is allowed.


CE_HAD_DEPENDENT_THOROUGHFARE IN VARCHAR2 NULL

This parameter is used to pass in the Dependent Thoroughfare details. A maximum of 80 characters is allowed.



CE_HAD_THOROUGHFARE IN VARCHAR2 NULL

This parameter is used to pass in the Street details



CE_HAD_DOUBLE_DEP_LOCAL_NAME IN VARCHAR2 NULL

This parameter is used to pass in the Estate details. A maximum of 60 characters is allowed.


EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 48




CE_HAD_DEPENDENT_LOCALITY_NAME IN VARCHAR2 NULL

This parameter is used to pass in the Locality details. A maximum of 60 characters is allowed.



CE_HAD_POST_TOWN IN VARCHAR2 NULL

This parameter is used to pass in the Post Town details. A maximum of 60 characters is allowed.



CE_HAD_COUNTY IN VARCHAR2 NULL

This parameter is used to pass in the County details. A maximum of 60 characters is allowed.



CE_HAD_POSTCODE IN VARCHAR2 NULL

This parameter is used to pass in the Post Code of the Enquiry Contact Address. If User/Product Option ENQFREEPC is set yo ‘Y’, the postcode format will be validated. Refer to the Enquiry Manager System Admin Guide for more information User/Product Options.



CE_HAD_OSAPR IN VARCHAR2 NULL


EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 49




CE_HAD_XCO IN VARCHAR2 NULL

This parameter is used to pass in the X Coordinate or Easting of the Contact Enquiry Address.


CE_HAD_YCO IN VARCHAR2 NULL

This parameter is used to pass in the Y Coordinate or Northing of the Enquiry Contact Enquiry Address.


CE_HAD_NOTES IN VARCHAR2 NULL

This parameter is used to pass in any Notes relating to the Enquiry Contact address



This parameter is used to pass in the Property Type of the Enquiry Contact Address. Property Type details are defined using Domains – HIG9120. The required Domain is named PROPERTY_TYPE.

The select statement below shows how an LOV may be generated for this parameter. The example selects the Property Type (hco_code) and meaning (hco_meaning).


where hco_domain=’PROPERTY_TYPE’



CE_HAD_ID OUT VARCHAR2

This will be the Enquiry Contact Address Id created by the Create Enquiry Contact Address API transaction.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 50



2.3.4 Usage Example

DECLARE

lv_had_id hig_address.had_id%TYPE;

BEGIN


(ce_hct_id => 133670

,ce_had_department => 'MAIN OFFICE'

,ce_had_building_name => 'SHED 2'

,ce_had_building_no => '235'

,ce_had_thoroughfare => 'ENGINEERING TERRACE'

,ce_had_post_town => 'TELFORD'

,ce_had_county => 'SHROPSHIRE'

,ce_had_postcode => 'TE1 1LA'

,ce_had_property_type => 'NORM'

,ce_had_id => lv_had_id);

END;

/

This example would result in an Enquiry Contact Address record being created for Enquiry Contact Id 133670. Figure 7

shows the details displayed in the main Enquiries Manager screen (DOC0150) and Figure 8 displays details displayed in

form HIG1815, on pressing the ‘View Contact Det.’ Button, in DOC0150.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 51



Figure 7 - Contact Address Details (Enquiries)

Figure 8 - Contact Address Details (Contacts)

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 52



2.3.5 Usage Example – Matching existing Postcode Details

DECLARE


BEGIN


(ce_hct_id => 133669

,ce_had_building_name => 'FLAT 3'


,ce_had_postcode => 'TA204JL'

,ce_had_id => lv_had_id);

END;

/

This example would result in an Enquiry Contact Address record being created for Enquiry Contact Id 133669. Address

details already exist for the postcode and Building Number supplied. Figure 9 shows the details displayed in the main

Enquiries Manager screen (DOC0150) and Figure 10 displays details displayed in form HIG1815, on pressing the ‘View

Contact Det.’ Button, in DOC0150.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 53



Figure 9 - Matching Existing Postcode (Enquiries)

Figure 10 - Matching Existing Postcode (Contacts)

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 54



2.4 UPDATE_ENQUIRY

This procedure provides an update API call which allows for the update of selected attributes on a given Enquiry. The

procedure returns an Error Value string with the reason for failure. If a parameter is omitted the existing value within the

record will be preserved. Null values are ignored, i.e., an existing value cannot be updated to a Null value. For each

updated field passed there will be a separate Change History record.

The update API will currently allow the following fields to be updated. For those fields that relate to a Contact it will only

update the details of the PRIMARY contact. Exor Enquiry Manager does allow the recording of multiple contacts for an

Enquiry so for those fields that relate to a Contact (marked with an *) it will only update the details of the PRIMARY

contact.

Category †

Class †

Enquiry Type †

Status

Complete Date

Location

Description

Action/Remarks

Notes

Priority

Incident Date/Time

Email *

Home Phone *

Work Phone *

Mobile Phone *

Road Id **

Asset Id***

Responsibility Of

Date and Time Arrived on Site

Reason for Late Arrival

NI14 Enquiry Outcome ****

NI14 Enquiry Outcome Reason ****

† Update to Category/Class/Enquiry Type will be prevented under the following conditions:

Category/Class/Enquiry Type is an invalid combination

Associated defects exist

Third Party Claims application is active

Planning application is active

* Will only update the PRIMARY contact recorded on the enquiry

** Road Id will be the internal NE_ID identifier for the Road Section, Street or Group to which the Enquiry has been

related. It will only be recorded on the Enquiry if it is currently null.

*** Asset Id is the internal Identifier for the Asset to which this enquiry relates. It will only be recorded if it is

currently null on the enquiry.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 55



**** The NI14 ‘Avoidable Contact’ Indicator functionality is only available when product option ENQOUTCOME is

set to ‘Y’.

These will be expanded over time however these are the critical fields in terms of CRM systems passing updates back to

Enquiry Manager. In addition to these core fields Change Date and Reason can also be supplied to supplement the change

history records.



CE_DOC_ID IN NUMBER Unique Reference for the Enquiry to be updated

CE_CHANGE_DATE IN DATE The date at which the changes will be marked in the history Record (default to SYSDATE)

CE_CAT IN VARCHAR2 Enquiry Category

CE_CLASS IN VARCHAR2 Enquiry Class

CE_ENQUIRY_TYPE IN VARCHAR2 Enquiry Type

CE_STATUS IN VARCHAR2 The Status Code to which the enquiry should be updated. Will be validated against a set of Status Codes.

CE_STATUS_REASON IN VARCHAR2 If the status is to be updated then this is a textual field describing why the status was changed. If null then a default will be used.

CE_COMPL_COMPLETE IN DATE If the status code supplied effectively Completes the Enquiry then this is the Date/Time at which the enquiry was completed. If STATUS is a complete status and this field is null it will default to SYSDATE/TIME.

CE_LOCATION IN VARCHAR2 The updated Location Details (up to 254 chars). Will replace existing location details in their entirety. History log will contain original value and date passed in CE_STATUS_DATE.

CE_DESCRIPTION IN VARCHAR2 Updated Description Details. Will replace existing Description details in their entirety. History Log will contain original value and date passed in CE_STATUS_DATE.

CE_COMPL_ACTION IN Updating the Action/Remarks field (will be concatenated onto end of existing Action/Remarks). History log will contain the Remark Added.

CE_COMPL_REMARKS IN VARCHAR2 Updated the Notes field (will be concatenated onto end of existing Notes).

CE_CPR_ID IN VARCHAR2 Enquiry Priority. An update to this field will also update the Target Completion Date.

CE_INCIDENT_DATETIME IN DATE Incident Date/Time. This can be a date and time Before the date/time the Enquiry was recorded

CE_EMAIL IN VARCHAR2 Email address of the primary contact.

CE_HOME_PHONE IN VARCHAR2 Home Phone number of the primary contact

CE_WORK_PHONE IN VARCHAR2 Work Phone number of the primary contact

CE_MOBILE_PHONE IN VARCHAR2 Mobile Phone number of the primary contact

CE_RSE_HE_ID IN NUMBER Unique Identifier of the Network to which this Enquiry relates. Will only be updated if the current value is null.

CE_ASSET_ID IN NUMBER Unique Identifier of the Asset to which this Enquiry is associated. Will only be updated if the current value is null.

CE_RESPONSIBILITY_OF IN VARCHAR2 These are the initials of the responsible person

CE_DATE_TIME_ARRIVED IN DATE The date and time arrived on site

CE_REASON_FOR_LATE IN VARCHAR2 Reason for later Arrival on Site

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 56




CE_DOC_OUTCOME IN VARCHAR2 NI14 Enquiry Outcome value

CE_DOC_OUTCOME_REASON IN VARCHAR2 NI14 Outcome reason. A maximum of 254 characters is allowed.

ERROR_VALUE OUT NUMBER Error Number. Calling program should examine this variable. If it is null then Update Procedure has completed successfully. If it is not null then the text in ERR_TEXT should be output to the calling application/user.

ERROR_TEXT OUT VARCHAR2 Error Text

2.4.2 Procedure

Pem.update_enquiry

( ce_doc_id IN NUMBER

, ce_change_date IN DATE DEFAULT sysdate

, ce_cat IN VARCHAR2 DEFAULT NULL

, ce_class IN VARCHAR2 DEFAULT NULL

, ce_enquiry_type IN VARCHAR2 DEFAULT NULL

, ce_status IN VARCHAR2 DEFAULT NULL

, ce_status_reason IN VARCHAR2 DEFAULT NULL

, ce_compl_complete IN DATE DEFAULT NULL

, ce_location IN VARCHAR2 DEFAULT NULL

, ce_description IN VARCHAR2 DEFAULT NULL

, ce_compl_action IN VARCHAR2 DEFAULT NULL

, ce_compl_remarks IN VARCHAR2 DEFAULT NULL

, ce_cpr_id IN VARCHAR2 DEFAULT NULL

, ce_incident_datetime IN DATE DEFAULT NULL

, ce_email IN VARCHAR2 DEFAULT NULL

, ce_home_phone IN VARCHAR2 DEFAULT NULL

, ce_work_phone IN VARCHAR2 DEFAULT NULL

, ce_mobile_phone IN VARCHAR2 DEFAULT NULL

, ce_rse_he_id IN NUMBER DEFAULT NULL

, ce_asset_id IN NUMBER DEFAULT NULL

, ce_responsibility_of IN VARCHAR2 DEFAULT NULL

, ce_date_time_arrived IN DATE DEFAULT NULL

, ce_reason_late IN VARCHAR2 DEFAULT NULL

, ce_doc_outcome IN VARCHAR2 DEFAULT NULL

, ce_doc_outcome_reason IN VARCHAR2 DEFAULT NULL

, error_value OUT NUMBER

, error_text OUT VARCHAR2

) ;

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 57





CE_DOC_ID IN NUMBER

This will be the Unique numeric Id for the Enquiry to be updated. If the enquiry ID does not exist an error will be produced. If the Enquiry has a completed STATUS then the update will be completed without an error.


CE_CHANGE_DATE IN DATE SYSDATE

Will be the date and time used in the History change Record. If it is not supplied it will default to the current date and time at the point the API is called.


CE_CAT IN VARCHAR2 NULL

This parameter is used to pass in the Enquiry Category. The value passed will be validated against DOC_TYPES values. If the value is invalid the procedure will fail with a relevant error message.

If the current value matches User/Product option ENQCLAMCAT, Injuries/Damage details may have been defined. These will be removed as a result of the update.

If the Third Party Claims application is active (ie User/Product Option TPCCATE contains an Enquiry Category value), and the current Enquiry Category matches this value, update of Enquiry Type will not be permitted.

If the Planning application is active (ie User/Product Option PLACATE contains an Enquiry Category value), and the current Enquiry Category matches this value, update of Enquiry Type will not be permitted.

The select statement below shows how an LOV may be generated for this parameter. The example selects the Enquiry Category (dtp_code), e.g., CLAM and the Enquiry Category Name (dtp_name), e.g., CLAIM.

select dtp_code,dtp_name from doc_types

where DTP_ALLOW_COMPLAINTS ='Y'


EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 58




CE_CLASS IN VARCHAR2 NULL

This parameter is used to pass in the Enquiry Class. The value passed will be validated against DOC_CLASS values, and must be valid for the Enquiry Category. If the value is invalid the procedure will fail with a relevant error message

The select statement below shows how an LOV may be generated for this parameter. The example selects the Enquiry Class (dcl_code) and the Enquiry Class Name. Note that the value for dcl_dtp_code is the selcted value for the CE_CAT parameter.

select dcl_code,dcl_name from doc_class

where dcl_dtp_code='CLAM'



CE_ENQUIRY_TYPE IN VARCHAR2 NULL

This parameter is used to pass in the Enquiry Type. The value passed will be validated against DOC_ENQUIRY_TYPES values, and must be valid for the Enquiry Category and Enquiry Class. If the value is invalid the procedure will fail with a relevant error message

If a contract had been specified against the current Enquiry Type, in DOC0110, Document Items (DOC_ITEMS) entries may have been created. These will be deleted as a result of the update.

The select statement below shows how an LOV may be generated for this parameter. The example selects the Enquiry Type (dcl_code) and the Enquiry Type Name. Note that the value for det_dtp_code is the selected value for the CE_CAT parameter and the value for det_dcl_code is the selected value for the CE_CLASS parameter.

select det_code,det_name from doc_enquiry_types where

det_dtp_code='COMP' and det_dcl_code='FRML’



CE_STATUS IN VARCHAR2 NULL

If the calling program wishes to change the status of the Enquiry this is the Status Code to update it to. It will be validated against the STATUS Domain (HIG_STATUS_CODES) and if invalid procedure will fail with relevant error message. If the Status effectively re-opens a closed enquiry then the API will allow this to happen and the Completion Date will be set to null. Details of the change will be stored in the Change history log.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 59




CE_STATUS_REASON IN VARCHAR2 STATUS_DESCRIPTION

If the status code is being updated then this field will contain a textual description of WHY the status is changing. It will default to the description of the STATUS code value itself. Ie. If updating an Enquiry from RE (ceived) to UI (under investigation), and this field was null it would be defaulted to ‘Under Investigation’.


CE_COMPL_ COMPLETE IN DATE NULL

This parameter is used to pass in the Enquiry Complete Date (which includes the Completion Time. If this parameter is used the date and time should be passed into the API call in the format of ‘DD-MON-YYYY HH:MM’, e.g., 01-MAR-2003 14:30. If no time value is supplied a value of ‘00:00’ will be populated by the system. This should only be passed if the Enquiry is being updated to a Valid ‘COMPLETE’ Status. It will default to sysdate if null and STATUS update is a ‘complete’ status.


CE_LOCATION IN VARCHAR2 NULL

This parameter is used to pass in the updated Location of the Enquiry. A maximum of 254 characters is allowed. The Location field will be overwritten with the details in this Parameter. If the field exceeds 254 then the API will take the first 254 Characters and continue the update. The original value will be placed in the Change History.


CE_DESCRIPTION IN VARCHAR2 NULL

This parameter is used to pass in updated Description of the Enquiry. The Description field will be overwritten with the details in this Parameter. If the field exceeds 2000 characters then the API will take the first 2000 Characters and continue the update. The original value will be placed in the change History.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 60




CE_COMPL_ACTION IN VARCHAR2 NULL

Any value in this parameter will be CONCATENATED onto the end of the existing value. This field differs from Description and Location as we expect multiple actions to be recorded so a concatenation seems more appropriate.


CE_COMPL_REMARKS IN VARCHAR2 NULL

Any value in this parameter will be CONCATENATED onto the end of the existing value. This field differs from Description and Location as we expect multiple actions to be recorded so a concatenation seems more appropriate.


CE_CPR_ID IN VARCHAR2 NULL

This parameter is used to pass in the Enquiry Priority. Enquiry Priorities are defined using DOC0132. Refer to the Enquiry Manager System Admin Guide for details of this module.

The select statement below shows how an LOV may be generated for this parameter. The example selects the Priority (cpr_id) and meaning (cpr_name).

select cpr_id,cpr_name from COMPLAINT_PRIORITIES


CE_INCIDENT_DATETIME IN DATE NO DEFAULT VALUE

This parameter is used to pass in the Incident Date & Time of the Enquiry. The date and time should be passed into the API call in the format of ‘DD-MON-YYYY HH:MM’, e.g., 01-MAR-2003 14:30. If no time value is supplied a value of ‘00:00’ will be populated by the system.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 61




CE_EMAIL IN VARCHAR2 NULL

This parameter is used to pass in the E-mail address of the Enquiry Contact. A maximum of 50 characters is allowed.





CE_WORK_PHONE IN VARCHAR2 NULL

This parameter is used to pass in the Work phone number of the Enquiry Contact. A maximum of 25 characters is allowed.




EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 62




CE_RSE_HE_ID IN VARCHAR2 NULL

This parameter is used to pass in the internal id (NE_ID) of a Network Section or Group and represents the Road to which the Enquiry relates as opposed to the Contacts Address. The use of this paramEter relies on Road Sections or Groups already being created within Network Manager. If this is the case the User could be presented with a list of Streets for example selected from Street Gazetteer Manager. The selected value may then be passed into a function call return the internal id of the Network Group or Section.

The select statement below shows how a list of ‘Streets’ may be generated for use with this parameter. For explanation purposes a Street is a Group of Type ‘ OFFN’. The query will return the internal id (ne_id) the USRN (ne_number) and Street Description (ne_descr)

select ne_id,ne_number,ne_descr from nm_elements

where ne_gty_group_type='OFFN'

order by ne_descr

The rse_he_id (ne_id) value can be passed directly into the API or the ne_unique of the record selected may then be passed into a function call as shown below to get the internal id (ne_id) for the group.

select nm3net.get_ne_id(7369971,'NSGN') from dual


CE_ASSET_ID IN VARCHAR2 NULL

Enquiries can be associated to a specific asset rather than a network. For instance a Street lighting Fault may will be recorded on a specific Lighting Unit, or a Bridge problem on a specific Bridge Name or Number. In these instances the API can be used to pass an Asset Id (Internal Id from Exor Asset Register) to the existing Enquiry. It will only be updated if the current value on the enquiry is null. For more information on how to derive an Exor Internal Asset Id please consult your Exor representative.


CE_RESPONSIBILITY_OF IN VARCHAR2 NULL

This parameter is used to populate the ‘Responsibility Of’ field. This must either be the initials of an Exor ‘User’ or in the case of a Contact record the value will be generated as follows:

The first character of the parameter value and the value from the 3rd character to the string end are compared with the First character of the First Name field and the Surname field respectively within the HIG_CONTACTS table (these records are displayed using the Enquiry Contacts - HIG1815 module). The matching record will then be used as the ‘Responsibility Of’ value.


CE_DATE_TIME_ARRIVED IN DATE NULL

This parameter is used to pass in the 'date and time arrived on site’ value. It must be provided in the form of DD-MON-YYYY HH:MM.


CE_REASON_LATE IN VARCAHR2 NULL

This parameter is used to pass in the ‘Reason for Late Arrival’ and is used in conjunction with the CE_DATE_TIME_ARRIVED parameter. A maximum of 255 characters is allowed

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 63




CE_DOC_OUTCOME IN VARCAHR2 NULL

This parameter is used to pass in the NI14 Outcome Value. If Used, valid codes are defined using Domains – HIG9120. The required Domain is named OUTCOME_OPTIONS.

The select statement below shows how an LOV may be generated for this parameter. The example selects the Outcome Code (hco_code) and meaning (hco_meaning).


where hco_domain= ‘OUTCOME_OPTIONS




CE_DOC_OUTCOME_REASON IN VARCAHR2 NULL

This parameter is used to pass in the NI14 Outcome reason. A maximum of 254 characters is allowed. The Outcome reason is added within the DOC0150 form when a new value is added for the outcome, in the same manner as the ‘Reason for Change’ value when the Status Code is changed. The Outcome and Outcome reason are both displayed within the Enquiry History.



ERROR_VALUE OUT NUMBER

If an error occurs during the API transaction the error number will be returned. This value is stored in the HER_NO column of a table named HIG_ERRORS. For example, error ‘64’ - Corresp. Date must not be before Incident and not after Corresp. Delivery or Date Recorded.


ERROR_TEXT OUT VARCHAR2

If an error occurs during the API transaction this will contain a text message that can be delivered to the user or calling application to help resolve the problem.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 64



2.4.4 Usage Example

DECLARE

error_value NUMBER;

error_text VARCHAR2 (50);

BEGIN

pem.update_enquiry

(ce_doc_id => 202430

,ce_change_date => to_date('10-OCT-2007','DD-MON-YYYY')

,ce_status => 'DD'

,ce_status_reason => 'Awaiting Police Report'

,ce_location => 'Outside Flying Horse Public House'

,ce_description => 'Large Pothole'

,ce_cpr_id => '5'

,ce_incident_datetime => to_date('01-JAN-2004 11:00','DD-MON-YYYY

HH24:MI')

,ce_email => '[email protected]'

,ce_home_phone => '0117 900 6201'

,ce_work_phone => '0117 600 4200'

,ce_mobile_phone => '07111 1111111'

,error_value => ERROR_VALUE

,error_text => ERROR_TEXT

) ;

END;

/

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 65



Figure 11 - Updated Enquiry

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 66



2.5 UPDATE_ENQUIRY_CONTACT

This procedure provides an update API call which allows for the update of selected attributes for an Enquiry Contact. The

Enquiry Contact Id (HCT_ID) passed as a parameter, will be used to identify the details to be updated.

Only Non-NULL values, passed as parameters, will be used to update existing details. . If a parameter is omitted the

existing value within the record will be preserved. Null values are ignored, i.e., an existing value cannot be updated to a

Null value.




CE_HCT_ORG_OR_PERSON_FLAG IN VARCHAR2 Organisation or Person Flag

CE_HCT_VIP IN VARCHAR2 VIP Flag

CE_HCT_TITLE IN VARCHAR2 Contact Title

CE_HCT_SALUTATION IN VARCHAR2 Salutation

CE_HCT_FIRST_NAME IN VARCHAR2 First Name

CE_HCT_MIDDLE_INITIAL IN VARCHAR2 Middle Initial

CE_HCT_SURNAME IN VARCHAR2 Surname

CE_HCT_ORGANISATION IN VARCHAR2 Organisation

CE_HCT_HOME_PHONE IN VARCHAR2 Home Telephone No.

CE_HCT_WORK_PHONE IN VARCHAR2 Work Telephone No.

CE_HCT_MOBILE_PHONE IN VARCHAR2 Mobile Phone No.

CE_HCT_FAX IN VARCHAR2 Fax No.

CE_HCT_PAGER IN VARCHAR2 Pager No.

CE_HCT_EMAIL IN VARCHAR2 Email Address

CE_HCT_OCCUPATION IN VARCHAR2 Occupation

CE_HCT_EMPLOYER IN VARCHAR2 Employer

CE_HCT_DATE_OF_BIRTH IN DATE Date of Birth

CE_HCT_START_DATE IN DATE Start Date

CE_HCT_END_DATE IN DATE End Date

CE_HCT_NOTES IN VARCHAR2 Notes

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 67



2.5.2 Procedure

pem.update_contact_enquiry


,ce_hct_org_or_person_flag IN VARCHAR2 DEFAULT NULL


,ce_hct_title IN VARCHAR2 DEFAULT NULL

,ce_hct_salutation IN VARCHAR2 DEFAULT NULL

,ce_hct_first_name IN VARCHAR2 DEFAULT NULL

,ce_hct_middle_initial IN VARCHAR2 DEFAULT NULL

,ce_hct_surname IN VARCHAR2 DEFAULT NULL

,ce_hct_organisation IN VARCHAR2 DEFAULT NULL


,ce_hct_work_phone IN VARCHAR2 DEFAULT NULL



,ce_hct_pager IN VARCHAR2 DEFAULT NULL

,ce_hct_email IN VARCHAR2 DEFAULT NULL

,ce_hct_occupation IN VARCHAR2 DEFAULT NULL

,ce_hct_employer IN VARCHAR2 DEFAULT NULL

,ce_hct_date_of_birth IN DATE DEFAULT NULL

,ce_hct_start_date IN DATE DEFAULT NULL

,ce_hct_end_date IN DATE DEFAULT NULL

,ce_hct_notes IN VARCHAR2 DEFAULT NULL

)

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 68





CE_HCT_ID IN NUMBER

This will be the Unique numeric Id defined for the Enquiry Contact, this will have been assigned on creation of the Enquiry Contact


CE_HCT_ORG_OR_PERSON_FLAG IN VARCHAR2 NULL

This parameter defines whether the contact is a person ‘P’, or organisation ‘O’.





The select statement below shows how an LOV may be generated for this parameter. The example selects the VIP flag (hco_code) and meaning (hco_meaning).


where hco_domain= ‘CONTACT_VIP’



CE_HCT_TITLE IN VARCHAR2 NULL






EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 69




CE_HCT_SALUTATION IN VARCHAR2 NULL

This parameter is used to pass in the any salutation details for the contact



CE_HCT_FIRST_NAME IN VARCHAR2 NULL

This parameter is used to pass in the First Name of the Enquiry Contact. A maximum of 30 characters is allowed.



CE_HCT_MIDDLE_INITIAL IN VARCHAR2 NULL

This parameter is used to pass in the Middle Initial of the Enquiry Contact.



CE_HCT_SURNAME IN VARCHAR2 NULL

This parameter is used to pass in the Surname of the Enquiry Contact. A maximum of 30 characters is allowed.


EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 70




CE_HCT_ORGANISATION IN VARCHAR2 NULL

This parameter is used to pass in the Contact Organisation details. A maximum of 60 characters is allowed.






CE_HCT_WORK_PHONE IN VARCHAR2 NULL

This parameter is used to pass in the Business phone number of the Enquiry Contact. A maximum of 25 characters is allowed.







EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 71




CE_HCT_PAGER IN VARCHAR2 NULL

This parameter is used to pass in the Pager number of the Enquiry Contact. A maximum of 25 characters is allowed.


CE_HCT_EMAIL IN VARCHAR2 NULL

This parameter is used to pass in the Email address of the Enquiry Contact. A maximum of 50 characters is allowed.


CE_HCT_OCCUPATION IN VARCHAR2 NULL

This parameter is used to pass in the Occupation of the Enquiry Contact. A maximum of 50 characters is allowed.


CE_HCT_EMPLOYER IN VARCHAR2 NULL

This parameter is used to pass in the Employer of the Enquiry Contact. A maximum of 50 characters is allowed.


CE_HCT_DATE_OF_BIRTH IN DATE NULL

This parameter is used to pass in the Enquiry Contact Date of Birth value. It must be provided in the form of DD-MON-YYYY.

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 72




CE_START_DATE IN DATE NULL

This parameter is used to pass in the Date from which this Enquiry Contact is Active. It must be provided in the form of DD-MON-YYYY.


CE_HCT_END_DATE IN DATE NULL

This parameter is used to pass in the Date when this Enquiry Contact becomes inactive. It must be provided in the form of DD-MON-YYYY.


CE_HCT_NOTES IN VARCHAR2 NULL

This parameter is used to pass in any Notes, associated with the Enquiry Contact

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 73



2.5.4 Usage Example

DECLARE

BEGIN

pem.update_enquiry_contact

(ce_hct_id => 133670

,ce_hct_title => 'MR'

,ce_hct_first_name => 'ERNIE'

,ce_hct_middle_initial => 'G'

,ce_hct_surname => 'BONDS'

,ce_hct_home_phone => '01612345678'

,ce_hct_work_phone => '01612223333'

,ce_hct_date_of_birth => '03-FEB-1956'

);

END;

/

This example would result in the Enquiry Contact details shown inFigure 12, being updated, for Enquiry Contact Id

133670, as shown in Figure 13. Figure 14 shows the same detail, displayed in the Enquiry Manager form (DOC0150)

Figure 12 - Existing Details (Contacts)

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 74



Figure 13 - Updated Details (Contacts)

Figure 14 - Updated Details (Enquiries)

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 75



2.6 UPDATE_ENQUIRY_CONTACT_ADDRESS

This procedure provides an update API call which allows for the update of selected attributes for an Enquiry Contact

Address. The Enquiry Contact Id (HCT_ID) passed as a parameter, will be used to identify the details to be updated.

Only Non-NULL values, passed as parameters, will be used to update existing details. . If a parameter is omitted the

existing value within the record will be preserved. Null values are ignored, i.e., an existing value cannot be updated to a

Null value.

If an Address Point Id is passed as a parameter, the API will initially attempt to identify Address Point data defined for the

value passed. Any details identified will be used as the basis for the address details, using any additional parameter values

to update the details, before recording this as the contact address.

If no Address Point Id parameter is provided, but a Postcode and Building No., or Building Name, is provided these

values will be used to identify any existing contact address details matching. If a unique entry is identified this will be

used as the basis for the contact address Any additional parameter values provided will be used to update the details,

before recording this as the contact address.

If an existing address could not be identified, the parameter values provided will be used to update the existing contact

address.




CE_HAD_DEPARTMENT IN VARCHAR2 Department

CE_HAD_PO_BOX IN VARCHAR2 PO Box

CE_HAD_ORGANISATION IN VARCHAR2 Organisation

CE_HAD_SUB_BUILDING_NAME_NO IN VARCHAR2 Sub Building Name/No

CE_HAD_BUILDING_NAME IN VARCHAR2 Building Name

CE_HAD_BUILDING_NO IN VARCHAR2 Building No

CE_HAD_DEPENDENT_THOROUGHFARE IN VARCHAR2 Dependent Thoroughfare

CE_HAD_THOROUGHFARE IN VARCHAR2 Street

CE_HAD_DOUBLE_DEP_LOCAL_NAME IN VARCHAR2 Estate

CE_HAD_DEPENDENT_LOCALITY_NAME IN VARCHAR2 Locality

CE_HAD_POST_TOWN IN VARCHAR2 Town

CE_HAD_COUNTY IN VARCHAR2 County

CE_HAD_POSTCODE IN VARCHAR2 Postcode

CE_HAD_OSAPR IN VARCHAR2 Address Pont Id

CE_HAD_XCO IN NUMBER X Coord (Easting)

CE_HAD_YCO IN NUMBER Y Coord (Northing)

CE_HAD_NOTES IN VARCHAR2 Notes

CE_HAD_PROPERTY_TYPE IN VARCHAR2 Property Type

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 76



2.6.2 Procedure



,ce_had_department IN VARCHAR2 DEFAULT NULL

,ce_had_po_box IN VARCHAR2 DEFAULT NULL

,ce_had_organisation IN VARCHAR2 DEFAULT NULL

,ce_had_sub_building_name_no IN VARCHAR2 DEFAULT NULL

,ce_had_building_name IN VARCHAR2 DEFAULT NULL

,ce_had_building_no IN VARCHAR2 DEFAULT NULL

,ce_had_dependent_thoroughfare IN VARCHAR2 DEFAULT NULL

,ce_had_thoroughfare IN VARCHAR2 DEFAULT NULL

,ce_had_double_dep_local_name IN VARCHAR2 DEFAULT NULL

,ce_had_dependent_locality_name IN VARCHAR2 DEFAULT NULL

,ce_had_post_town IN VARCHAR2 DEFAULT NULL

,ce_had_county IN VARCHAR2 DEFAULT NULL

,ce_had_postcode IN VARCHAR2 DEFAULT NULL

,ce_had_osapr IN VARCHAR2 DEFAULT NULL

,ce_had_xco IN NUMBER DEFAULT NULL

,ce_had_yco IN NUMBER DEFAULT NULL

,ce_had_notes IN VARCHAR2 DEFAULT NULL


,ce_had_id OUT NUMBER)

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 77





CE_HCT_ID IN NUMBER

This will be the Unique numeric Id defined for the Enquiry Contact, for which the address details are to be modified. This will have been assigned on creation of the Enquiry Contact


CE_HAD_DEPARTMENT IN VARCHAR2 NULL

This parameter is used to pass in the Department details. A maximum of 60 characters is allowed.



CE_HAD_PO_BOX IN VARCHAR2 NULL

This parameter is used to pass in the Post Office Box details. A maximum of 6 characters is allowed.



CE_HAD_ORGANISATION IN VARCHAR2 NULL

This parameter is used to pass in the Organisation details. A maximum of 60 characters is allowed.


EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 78




CE_HAD_SUB_BUILDING_NAME_NO IN VARCHAR2 NULL

This parameter is used to pass in the Sub-Building Name/No details. A maximum of 60 characters is allowed.


CE_HAD_BUILDING_NAME IN VARCHAR2 NULL

This parameter is used to pass in the Building Name details. A maximum of 60 characters is allowed.



CE_HAD_BUILDING_NO IN VARCHAR2 NULL

This parameter is used to pass in the Building No details. A maximum of 6 characters is allowed.


CE_HAD_DEPENDENT_THOROUGHFARE IN VARCHAR2 NULL

This parameter is used to pass in the Dependent Thoroughfare details. A maximum of 80 characters is allowed.



CE_HAD_THOROUGHFARE IN VARCHAR2 NULL

This parameter is used to pass in the Street details


EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 79




CE_HAD_DOUBLE_DEP_LOCAL_NAME IN VARCHAR2 NULL

This parameter is used to pass in the Estate details. A maximum of 60 characters is allowed.



CE_HAD_DEPENDENT_LOCALITY_NAME IN VARCHAR2 NULL

This parameter is used to pass in the Locality details. A maximum of 60 characters is allowed.



CE_HAD_POST_TOWN IN VARCHAR2 NULL

This parameter is used to pass in the Post Town details. A maximum of 60 characters is allowed.



CE_HAD_COUNTY IN VARCHAR2 NULL

This parameter is used to pass in the County details. A maximum of 60 characters is allowed.


EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 80




CE_HAD_POSTCODE IN VARCHAR2 NULL

This parameter is used to pass in the Post Code of the Enquiry Contact Address. If User/Product Option ENQFREEPC is set yo ‘Y’, the postcode format will be validated. Refer to the Enquiry Manager System Admin Guide for more information User/Product Options.



CE_HAD_OSAPR IN VARCHAR2 NULL



CE_HAD_XCO IN VARCHAR2 NULL

This parameter is used to pass in the X Coordinate or Easting of the Contact Enquiry Address.


CE_HAD_YCO IN VARCHAR2 NULL

This parameter is used to pass in the Y Coordinate or Northing of the Enquiry Contact Enquiry Address.


CE_HAD_NOTES IN VARCHAR2 NULL

This parameter is used to pass in any Notes relating to the Enquiry Contact address



This parameter is used to pass in the Property Type of the Enquiry Contact Address. Property Type details are defined using Domains – HIG9120. The required Domain is named PROPERTY_TYPE.

The select statement below shows how an LOV may be generated for this parameter. The example selects the Property Type (hco_code) and meaning (hco_meaning).


where hco_domain=’PROPERTY_TYPE’


EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 81



2.6.4 Usage Example – Matching Address Point data

DECLARE

BEGIN

pem.update_enquiry_contact_address

(ce_hct_id => 133670

,ce_had_osapr => 'APT41U8L50P5174GNT'

,ce_had_building_name => 'CHIPS GARAGE'

);

END;

/

This example would result in an Enquiry Contact Address record being updated for Enquiry Contact Id 133670. Figure 15

shows the details displayed prior to the update. Figure 16 shows the updated address details, which are also shown in the

Enquiries Manager screen (DOC0150), in Figure 17.

Address details, matching Address Point Id 'APT41U8L50P5174GNT', have been used as the basis for the address, with

the Building Name value being updated with the additional parameter passed.

Figure 15 – Existing Details (Contacts)

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 82



Figure 16 – Updated Details (Contacts)

Figure 17 – Updated Details (Enquiries)

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 83



2.6.5 Usage Example – Matching existing address data

DECLARE

BEGIN


(ce_hct_id => 133670


,ce_had_double_dep_local_name => 'BLACON'

,ce_had_postcode => 'BH207BG'

,ce_had_property_type => 'NORM'

);

END;

/




Address details, matching Postcode ‘BH207BG’ and Building No. ‘81’, have been used as the basis for the address, with

the Locality and Type values being updated with the additional parameters passed.

Figure 18 – Existing Details (Contacts)

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 84



Figure 19 – Updated Details (Contacts)

Figure 20 – Updated Details (Enquiries)

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 85



2.6.6 Usage Example

DECLARE


BEGIN


(ce_hct_id => 133670


,ce_had_double_dep_local_name => 'BLACON'

,ce_had_postcode => 'BH207BG'

,ce_had_property_type => 'NORM');

END;

/




No matching address details exist, so the parameter values passed hve been used to update existing Contact Address

details.

Figure 21 - Existing Details (Contacts)

EXOR

ENQUIRY MANAGER API

PEM PACKAGE

Version: 4.7 86



Figure 22 - Updated Details (Contacts)

Figure 23 - Updated Details (Enquiries)

Documents

EXOR Enquiry Manager API › Assetwise › cont › Docs › 4… · User Options are similar to Product Options but values are specific to a single User and not all Users of the