Business Gateway Vendor Guide
User Manual:
Open the PDF directly: View PDF 
.
Page Count: 8
Information Systems
Seaton Court
2 William Prance Road
Plymouth
Devon
PL6 5WS
www.landregistry.gov.uk
Version 1.1
Business Gateway
vendor test guide
Page 2
Contents
1. Background 3
2. Purpose 3
3. Overview 3
4. Appendices 3
4.1. Vendor test strategy 3
4.2. Exceptions 4
4.3. Role based access control (RBAC) 4
4.4. Network security 5
4.5. Availability 5
4.6. Support 5
5. Business services available 5
5.1. Information services 5
5.1.1. Title number enquiry by property description 5
5.1.2. Official search of whole with priority 5
5.1.3. Land charges bankruptcy search 6
5.1.4. Official copy – title known 6
5.1.5. Register extract 6
5.1.6. Official search of part with priority 6
5.1.7. Land charges full search 7
5.1.8. Daylist Enquiry 7
5.1.9. Search of the Index Map 7
5.2. Outstanding Requests 7
5.2.1. Outstanding Requests Service 7
5.3 Network Services 7
5.3.1 eDocument Registration Services 7
5.4 Verification Services 8
5.4.1 Online Ownership Verification Service 8
6. Getting started 8
6.1. Vendor entry criteria and checklist 8
6.2. Overview of the test scenarios 8
Page 3
1. Background
The test guide is part of the developer pack available to all software development
companies (vendors) who have signed a Business Gateway developer licence. Land
Registry provides a test facility that they can use to test their integration with the
business gateway services. Whenever new services are introduced, additional details
will be added to this document and the associated test data.
2. Purpose
This document is intended for software developers using Land Registry web services. It
should assist them to test their interface with the web services before deploying
software to use the production business gateway.
It should be read in conjunction with the associated document, Business Gateway
vendor test data, to be used when running the tests.
3. Overview
Support for conveyancers using Business Gateway will normally be through the supplier
of their CMS. The supplier will report any production issues to Land Registry’s
Customer Support.
When conveyancers contact Customer Support with what appears to be an issue with
their CMS system, rather than the Business Gateway service, the details will still be
recorded but they will be instructed to contact the technical support of their CMS
supplier.
The first line of support for software developers while they are integrating Business
Gateway services, as well as for any other technical queries, will be the Information
Services (IS) service desk.
4. Appendices
4.1. Vendor test strategy
Testing will be achieved by:
submission of calls (conforming to defined XML submission criteria) from a vendor
system to Land Registry via a simulated version of the business gateway installed in
the production environment
validation against the schema and business rules. No e-services will be initiated
Page 4
sending of appropriate response messages (successful and unsuccessful) which
are hard coded in the simulated business gateway application (conforming to
defined XML schemas).
External testers will be able to connect to a live environment to perform the tests listed
in the test data document. The requests they submit will be processed using stubs that
mirror the live services. The stubs will not perform any database accesses, but will send
validated responses based on the data received.
The stubbed architecture will allow concurrent accesses by testers within the availability
published below.
4.2. Exceptions
The response times that are provided by this test service will be different from those in
the live services, as there are no back-end Enterprise Java Bean (EJB) calls and
database calls. The test environment will also have a lower processing priority than the
production system. It is not intended that vendors can use the test service for
performance testing.
An acknowledgement response will contain the same poll back time for subsequent out
of hour requests. For example, if the first acknowledgement that is sent to a user shows
a poll time of 07:10:10, then if the user sends another request using the same
combination of data the response will be the same i.e. the poll time will not change
automatically.
N.B. The acknowledgement responses for Information Services and Network Services
will have different times.
Although Land Registry will provide the test service, there will be no testing of vendor’s
products by Land Registry and no form of accreditation of vendor software.
The following scenarios will not be tested:
role-based access for different services
saving of requests and responses (as there are no database interactions)
4.3. Role based access control (RBAC)
In the production system Business Gateway uses portal login details. Portal will be
required to setup initial password and shared secret questions to make the user login
‘active’.
There are multiple portal roles available but for Business Gateway services, the only
roles required are either:
the conveyancer C4 role, a conveyancer who has a Network Access Agreement
and the permission to edit and submit transactions.
a register extract service role, which requires an additional Register Extract Service
Agreement.
Page 5
It will be possible to use the login details in the portal at the same time as being used
through Business Gateway.
In the test system the test stubs do not have any RBAC limitations, as the user
credentials are not validated. All tests use the specified user ID and password.
4.4. Network security
The security structure for vendors connecting to the test service will be the same as if
they were connecting to the live system i.e. an SSL tunnel will be established using a
Land Registry certificate. Any user connecting to the business gateway will need an
appropriate SSL certificate to be stored on their machine to allow them to use either the
production or the test service.
4.5. Availability
The test service will be available 08.00 – 17.30 Monday to Friday excluding national
public holidays.
4.6. Support
Technical support will be available 09.00 – 16.00 on the days the system is available.
The contact details for technical support are published on the Business Gateway web
page.
5. Business services available
This section summarises the services that are currently available in the test service.
5.1. Information services
5.1.1. Title number enquiry by property description
This service provides the ability for the external system to search for a title number by
providing a property description. It will retrieve a list of all properties matching the
supplied property description (maximum of 50) along with their title number and tenure.
The result will be returned in the response message.
5.1.2. Official search of whole with priority
This service provides the ability for the external system to request an OS1. Whenever
possible the requested official search certificate is made available to the external
system as a PDF.
The process involves validation of inputs and confirmation that the title is in an
appropriate state for an official search to be entered.
Page 6
5.1.3. Land charges bankruptcy search
This service provides the ability for the external system to make a K16 application for a
bankruptcy search against private individuals and complex names.
The certificate of search result against a private individual will be returned electronically
as a PDF. The certificate of search result against a complex name will be returned by
post.
5.1.4. Official copy – title known
This service provides the ability for the external system to submit a request for an
official copy using the title number. There are two web services for official copies:
an OC1 when requesting an official copy of the register, title plan or certificate in
form CI
an OC2 when requesting other documents referred to in the register (that have not
been designated exempt).
Whenever possible the requested official copy is made available to the external system
as a PDF. However, if an electronic version of the official copy cannot be supplied, it is
sent through the post.
If the external system has requested more than one type of official copy documents
(OC2), the system will deliver electronic versions of the documents that can be
electronically returned, other documents will be sent through the post. For official copy
title documents (OC1) the documents will be delivered together. For example, if register
and title plan are requested electronically, and the register cannot be provided
electronically, both will be sent by post.
A certificate in form CI will always be delivered by post.
5.1.5. Register extract
This service provides the ability for the external system to submit a request for an
official copy using the title number. As well as returning the PDF result as above, some
of the information contained in the register is returned in a XML format (OCXML).
The OCXML service will only be available when an official copy of the register has been
ordered and if it can be provided electronically.
5.1.6. Official search of part with priority
This service provides the ability for the external system to request an OS2. Whenever
possible the requested official search certificate is made available to the external
system as a PDF.
The process involves validation of inputs and confirmation that the title is in an
appropriate state for an official search to be entered.
Page 7
5.1.7. Land charges full search
This service provides the ability for the external system to make a K15 application for a
full search against private individuals, public limited companies, local authorities and
complex names.
The certificate of search result against a private individual or public limited company will
be returned electronically as a PDF. The certificate of search result against a local
authority or complex name will be returned by post.
5.1.8. Daylist Enquiry
This service provides the ability for the external system to view a snapshot of a titles’
Daylist. This will reveal any pending applications that are lodged against the title. This is
not historical, and is a view of what is there at that moment in time.
The process involves validation of inputs and confirmation that the title is in an
appropriate state for the Daylist to be viewed.
5.1.9. Search of the Index Map
This service provides the ability for the external system to request a SIM. Whenever
possible the requested search result will be made available to the external system as a
PDF.
The process involves validation of inputs and confirmation that the information provided
is appropriate for a search to be processed.
5.2. Outstanding Requests
5.2.1. Outstanding Requests Service
This service provides the ability for the external system to submit a request to view the
status of any of their outstanding requests. The response will show details of which
requests the organisation has submitted that have not had a final response issued.
If an application has been sent for manual processing, then the request will show in the
response as not having a new response. Once the application has been completed, it
will then show as a New Response, which will allow the external system to submit a poll
request to collect their response.
5.3 Network Services
5.3.1 eDocument Registration Services
These services provide the ability for the external system to submit a request to change
the register.
The process involves validation of all the input data collation of details to generate an
AP1 and then returning the results with electronic documents as well as an xml copy of
the register.
Page 8
5.4 Verification Services
5.4.1 Online Ownership Verification Service
The Online Ownership Verification service identifies any titles associated with the
supplied address and then checks if the supplied name matches any of the proprietors
for those titles. If a title number is supplied this will be used. The match result will be
returned in the response message.
6. Getting started
6.1. Vendor entry criteria and checklist
The following list has the steps that a vendor would need to have taken before using the
test service:
sign a Business Gateway development licence
use the Business Gateway developer pack to develop their interface to Business
Gateway
unit test their software, taking particular attention to field lengths being matched
correctly
apply for, and install a test SSL certificate from Land Registry (this process for
fulfillment is documented on the web page)
understand what is required and have raised any questions or concerns.
6.2. Overview of the test scenarios
Each web service has a basic set of tests for the main flows:
a successful completion
an out of hours situation
a poll response
an error situation.
The number of test scenarios will increase in the future.
