enneo Integration Options
When it comes to integrating your contract and customer database with enneo, you have multiple options to choose from. Let's explore each option in detail:
1. Contract import to enneo via API
If you prefer to maintain control over your contract list while still leveraging the capabilities of enneo, the custom contract import method is a great choice. In this method, enneo acts as a secondary data store for your contracts, and you are responsible for triggering enneo API calls to create, update, or delete contracts whenever there is a change. This allows you to have full control over the data synchronization between your ERP system and enneo. To implement this method effectively, you can combine it with custom code in cron jobs to set up periodic imports from your ERP system. By doing so, you can ensure that the contract data in enneo is always up to date.
2. Real-time Contract Search via API
With custom real-time contract search, enneo does not store any contracts directly but instead invokes a custom executor to retrieve the data. This method provides you with the flexibility to fetch contract data from an external API that you expose. To implement this method, you need to create the following APIs and connect them to enneo:
- Get a contract by contract ID: This API is used when enneo needs to refresh a contract with the latest data. It allows enneo to retrieve the most up-to-date information for a specific contract.
- Get a customer by customer ID: This API is used when enneo wants to refresh a contract with the latest data. It enables enneo to fetch the most recent customer information associated with a contract.
- Search contracts by search parameter: This API is used when enneo's AI is searching for specific data extracted from emails. For example, enneo's AI might search for first name, last name, address, meter number, or email information from the contracts. By providing this API, you enable enneo's AI to perform accurate and efficient searches.
- Search contracts by search string: This API is used when an agent uses the "search" input field. The API should be capable of handling search queries based on email, name, or any other data that you want to use for search purposes. By implementing this API, you empower your agents to quickly find the contracts they need.
Each of these 4 API endpoints needs to return contracts in the enneo standard contract data structure, as defined in the API specification object Contract
. Similarly, the customer data should adhere to the Customer
data type specified by enneo. This ensures smooth and consistent data exchange between your systems and enneo.
3. Natively supported ERP solutions
3.1 Powercloud
This method is specifically designed for users who are already using Powercloud as ERP. With native Powercloud integration, enneo can seamlessly connect to your Powercloud contract list. This option is recommended if you are using Powercloud because it is natively supported by enneo. To set up this integration, you need to follow these steps:
- Access the enneo platform and navigate to the Settings section.
- In the Settings section, locate the ERP system settings and set it to "Powercloud".
- Provide your Powercloud API key and Powercloud host in the ERP settings of enneo.
- Additionally, you have the option to set up the enneo endpoint demo.enneo.ai/api/mind/webhook/powercloud as the export target for Powercloud events. By doing so, enneo will receive new events from Powercloud, invalidate the contract data, and fetch the latest information. This ensures that the agents always have access to the most recent copy of the customer data.
Technically, enneo caches the client’s contract list in a nightly batch job. With event-pushing mentioned above, enneo ensures that data is up to date in realtime and the agent never sees outdated information. As powercloud only provides limited and slow customer/contract search opportunities, this method allows searching by e.g. meter number, telephone number, email, or arbitary free-text terms quickly and reliably.
As alternative, clients can also specify custom searching logic/endpoints that enneo will use instead (see option 3). This requires the client to perform the search operations on their infrastructure. This is typically chosen if customers have > 1.5 Million contracts OR in cases where not all customers are in powercloud but in third-party CRM or ERP systems.
3.2 LynqTech
This method is specifically designed for users who are already using LynqTech as their ERP system. With native LynqTech integration, enneo can seamlessly connect to your LynqTech contract list. This option is recommended if you are using LynqTech because it is natively supported by enneo. To set up this integration, you need to follow these steps:
- Access the enneo platform and navigate to the Settings section.
- In the Settings section, locate the ERP system settings and set it to "LynqTech".
- Provide your LynqTech API key and LynqTech host in the ERP settings of enneo.