Usage Manual

This page describes how the connector can be used and configured.

Prerequisites

The connector requires access to the Anticipay service. To interact with the service you need to:

• provide the credentials for the authentication:
  • Client ID
  • Client Secret
• provide the information about the company or the natural person making the request:
  • Party TAX Identifier: TAX identifier of the party (person or company)
  • Party VAT Identifier: VAT identifier of the party
• be enabled to use the Land Registry service.

Network requirements:

• CMDBuild must be able to reach the Anticipay service endpoint configured in the plugin (outbound HTTPS calls to {endpoint}/authenticate and {endpoint}/land_registry/*);
• the reports are delivered asynchronously: Anticipay must be able to reach the CMDBuild public gate, which receives the document and attaches it to the card.

Connector dependencies

The connector requires the installation of the Connector utils plugin version 2.0.10 or higher and CMDBuild version 4.3.0 or higher.

The connector also requires:

• the CMDBuild DMS service enabled, because the reports are saved as card attachments;
• the openMAINT data model, containing:
  • the class Unit, with the reference attribute LocationL3 (its card code must be the cadastral code of the municipality), the attributes UrbanSection, Sheet, Plot, Subordinate and the file attribute CadastralCertificate, which is linked to the received report;
  • the class CorporateGroup (a descendant of Company), whose Code attribute contains the tax identifier of the legal entity;
  • the class Location, whose cards with the province code returned by Anticipay are referenced by the requests of subjects;
• the DMS category value CadastralCertificate for both the Unit and CorporateGroup classes.

Configuration

Plugin configuration

The plugin does not use the standard connector configuration (there are no instances nor scheduled synchronizations) and only provides the following configurations:

Config	Default	Description	Notes
endpoint*		Endpoint for the Anticipay Land Registry integration	Base URL of the Anticipay APIs; the paths /authenticate and /land_registry/... are appended to this value
clientId*		Client ID for the Anticipay Land Registry authentication
clientSecret*		Client secret for the Anticipay Land Registry authentication	Password value
partyTaxIdentifier*		Party TAX Identifier for the Anticipay Land Registry requests	Sent in every search request. Maximum 11 characters
partyVatIdentifier*		Party VAT Identifier for the Anticipay Land Registry requests	Sent in every search request. Maximum 11 characters

All configurations are private (not exposed to the user interface) and have no default value: they must be filled in for the plugin to work.

Instance configuration

The connector has no instances: all requests use the plugin configuration.

Plugin usage

The plugin is used through the Land registry request widget, installed on the Corporate Group and Unit classes. When the widget is opened, it shows the date of the last request made for the card (if any) and, after confirmation, sends a cadastral report request whose procedure depends on the class of the card, Corporate Group or Unit. The response is not immediate: the widget shows the details and the state of the request (or requests) just created, which can be reloaded with the refresh button, and, as soon as the cadastral report is attached to the card, a notification is sent to the user who made the request.

A new request aborts any request still being processed for the same card.

Subject (Corporate Group)

For a subject, the report request follows these steps:

1. Search of the legal entity, using the value of the card Code attribute as tax identifier.
2. Retrieval of the list of provinces associated with the subject, using the subject identifier returned by the search.
3. Request of one cadastral report for each province, using the subject identifier and the province.

Only the first subject returned by the search is used. Each received report is attached to the card with category Cadastral certificate.

Property (Unit)

For a property, the report request follows these steps:

1. Search of the property, using the cadastral code of the municipality (code of the card referenced by the LocationL3 attribute, e.g. F205 for Milan), the urban section (UrbanSection attribute, optional), the cadastral sheet (Sheet), the cadastral plot (Plot) and the cadastral subordinate (Subordinate, optional).
2. Request of a cadastral report, using the property identifier returned by the search.

Only the first property returned by the search is used. The received report is attached to the card with category Cadastral certificate and the card CadastralCertificate attribute is linked to it.

Report received notification

When a report is received and attached to the card (request in state SUCCESSFUL), the plugin sends a chat notification to the user who made the request. For a Corporate Group, one notification is sent for each received report, that is one for each province.

No notification is sent when:

• the request has no Requester (no User card with the username of the user who made the request exists);
• the report cannot be associated with a card (state UNSUCCESSFUL), or the request has already been processed or aborted.

Request history

Each request sent to Anticipay is recorded in the Anticipay Italian Cadastre & Land Registry request class (AnticipayLandRegistryRequest), available in the menu under the Anticipay - Italian Cadastre & Land Registry data folder. The request history of a card can also be viewed from the Land registry requests history widget, installed on the Corporate Group and Unit classes.

One card is created for each report requested: one for a Unit, one for each province of a Corporate Group. The card is created when the request is sent and updated when the report is requested and when it is received.

Attribute	Description
Request ID (RequestID)	Identifier of the search returned by Anticipay; shared by all the cards created by the same Corporate Group request
Report ID (ReportID)	Identifier of the report returned by Anticipay; used, together with the Request ID, to match the report received from Anticipay
State (State)	State of the request, see the table below
Card (Card)	Card (Unit or Corporate Group) from which the request was started
Requester (Requester)	CMDBuild user who started the request, if a User card with the same username exists; the notification is sent to this user
Request time (RequestTime)	Date and time of the request
Type (Type)	Type of report: Unit (property report) or Subject (subject report)
Subject ID (SubjectID)	Identifier of the legal entity returned by the search (first result only). Shown only for Subject requests
Province (Province)	Reference to the Location card whose code is the province the report refers to (empty if no such card exists). Shown only for Subject requests
Property ID (PropertyID)	Identifier of the property returned by the search (first result only). Shown only for Unit requests
Filename (Filename)	Name of the received report file, filled in when the state is SUCCESSFUL
Response time (ResponseTime)	Date and time of the report reception, or of the failure (FAILED, UNSUCCESSFUL)
Errors (Errors)	Error message (in Italian) when the state is FAILED, ABORTED or UNSUCCESSFUL

The state of a request can take the following values:

State	Description
CREATING	Request recorded, report request being sent
PROCESSING	Report request accepted by Anticipay, waiting for the report
FAILED	Error while sending the report request (details in the Errors attribute)
ABORTED	Request aborted because a later request was made for the same card
SUCCESSFUL	Report received and attached to the card
UNSUCCESSFUL	Report received, but the card associated with the request could not be found

Additional Information

Known Limitations

• The connector operates in read-only mode.
• The plugin is distributed under a Premium license model. Its usage is tied to an active support and maintenance agreement, which is subject to expiration and must be renewed to remain valid.