Modules:CapencyIntegration
Contents |
Introduction
This module provides an integration between the Data Quality Management infrastructure of Openbravo and the service provided by Capency.
- License: Commercial
- Category: Module
The POS of Openbravo allows the user to manually introduce contact information in the Customer and Address Views
In order to help the user to introduce this information Openbravo does allow to implement different Data Quality Management (DQM) solutions.
DQM solutions are used to validate that the information introduced by the user is correct (the Phone number has the required number of characters, the Email has a valid domain, etc) or to suggest possible information based on the data already introduced by the user (suggest an Email based on the Name and Last Name of the user)
Since 3.0RR20.Q1 Openbravo offers an infrastructure that allows to implement different DQM solutions.
Capency is a company that provides a DQM solution that allows to validate contact information like Email or Phone and that allows to suggest information like Postal Code or Street name.
This module provides an integration with the DQM infrastructure provided by Openbravo and the DQM solution provided by Capency.
Installation and Configuration
Installation
This module can be installed using the Module Management Window as System Administrator.
Go to Module Management Window, Add Modules Tab and search for DQM Capency Integration Module.
Then follow the steps described by the application to complete the installation process.
Configuration
After the installation of the module is completed it is required to define the configuration in order to be able to use the functionality. The configuration requires two steps.
Organization
First it is necessary to inform to the system that the Capency DQM is going to be used.
For each Organization that is going to use this DQM it is necessary to include this configuration
This is done through the Organization window, Data Quality Management tab.
The infrastructure provided by Openbravo allows to configure several DQM services to run at the same time, in this case the priority field will indicate to the system which service will be executed first.
Capency
The configuration that is specific to the Capency service can be defined in the Capency window.
This configuartion includes:
- URL: The URL used to connect to the Capency service
- Username and Password: The username and password provided by Capency to connect to their service
- Cap Address ID, Cap Mail ID, Cap Phone ID: The Id's provided by Capency for each one of their services.
- Enable Checks: It is possible to enable or disable each of the options provided by this module.
- Phone Format: Defines if the Phone number will be formatted with a National or International format.
User Guide
This module provides functionality to validate and/or suggest contact information for each of this four areas.
This module allows to validate the Email address introduced at the same time that it provides suggestions based on the information already introduced by the user.
Validation
This module validates that the Email address introduced by the user is correct. This includes checks like verifying that the domain has been introduced and is correct, the format of the mail address is valid, etc
Suggestions
This module can propose suggestions to the user to complete the Email address based on the information already introduced.
This suggestions can take the Name and the Last Name of the user into account to propose more accurate suggestions.
Also, this suggestions take into account the Country introduced in the address field to propose more accurate domains for the Email address.
Phone
This module allows to execute validations for fields Phone and Alternative Phone Number.
This validations are done to ensure that the format of the Phone Number introduced is valid in the Country selected by the user.
The Country information is required in order to properly validate the number, that is why the Country set by the user in the Address fields is used to validate the Phone Number.
Also, the number is properly formatted after it has been introduced by the user. It is possible to configure how this formatting will behave by selecting to use National or International formatting.
Address
To help the user to introduce the Address related information, this module can propose Address related suggestions.
The system can propose suggestions for the Postal Code, the City name and the Street name.
Postal Code
The proposals for the Postal Code includes both the number of the Postal Code and the name of the City.
Also, when a record is selected, both the Postal Code and City fields are filled based on the selected information.
City
Based on the Postal Code introduced by the user, the system can propose City names of cities that belong to that Postal Code.
The suggestions are based on the Postal Code, not in the data introduced by the user in the City field.
If no Postal Code is introduced then the system will not show any suggestions.
Street
Based on the Postal Code and Cities introduced by the user, the system can propose Street names of streets that belong to that Postal Code.
The suggestions take into account the information introduced by the user in the Address field.
Only the Street name is suggested, the missing Address data like the block number must be introduced manually by the user.
If no Postal Code is introduced then the system will not show any suggestions.
Name
This module can provide suggestions for the Name and Last Name fields.
This suggestions are based on the Country selected by the user in the Address fields.