Which Readers does the API Valuekeep V3 have available?
The readers provided by the plugin aim to provide the VALUEKEEP system with
a mechanism that reduces the number of requests and allows the
implementer/integrator to easily customize the read requests according to the
requested business processes.
The aim of the reader is to identify in the source system (VALUEKEEP ) the
subset of information that requires integration with the target system,
preserving performance and service issues.
To leverage these principles the following methodology was adopted:
- Hashing: the information subset is controlled by
a hashing technique applied on the source system. Additional information about
this technique can be found in the article Pipelines - Hashing;
- OData: the result of the information subset is
obtained using the OData technology. However, due to some limitations arising
from the use of OData technology in the Valuekeep V3 API, the use of the
hashing methodology is recommended.
The following image illustrates the technique applied in the plugin to
obtain the information that will be subject to integration.
The plugin provides the following readers that should
be used depending on feasibility and technique applied:
- VK3HashListReader:
uses the hashset configuration (defined in the hashing file) to get the
information to synchronize / integrate. The transmitted information is
restricted exclusively to the attributes provided in the hashset,
including the applied filters;
- VK3FullHashListReader:
uses the hashset configuration (defined in the hashing file) to obtain the
information to synchronize / merge. The transmitted information
corresponds to a get request from the entity, i.e. the hashset
configuration is only used to get the subset (conditional filter).
- VK3ODataReader:
uses the configuration of an OData query (defined in file) to obtain the
information to synchronize/integrate. The transmitted information is
restricted exclusively to the information provided in the ODATA query,
including the applied filters;
The following image exemplifies the use of a reading
service.
Related Articles
What is Valuekeep Integrator?
Valuekeep Integrator recommends a conceptual model of data integration and consequent functional logic between systems. As a solution for integration between systems, Valuekeep Integrator brings together a set of characteristics which are considered ...
Which Writers does the API Valuekeep V3 have available?
The writers provided by the plugin use the VALUEKEEP V3 API resources to integrate (write) the data coming from a source system into the target system (VALUEKEEP), meanwhile transformed according to the mapping file defined in the pipeline. The ...
How to obtain consumption records via by OData?
In all Entities we have the possibility of making Odata requests. In Odata requests you must pay attention to the following syntax: $select: expression that determines which request fields are included in the result; $filter: expression used to ...
How to obtain a list of work orders by OData?
In all Entities we have the possibility of making Odata requests. In Odata requests you must pay attention to the following syntax: $select: expression that determines which request fields are included in the result; $filter: expression used to ...
WEBAPI - API Documentation
Valuekeep has an exposed webAPI that allows interaction with the product. Through the link below you can access the methods of the API. https://apidocs.helpcenter.valuekeep.com/ In subscriptions with company access restrictions, the WebAPI does not ...