How does the pipeline versioning work?

How does the pipeline versioning work?

The VALUEKEEP V3 - Valuekeep Integrator plugin adopts a versioning control based on a hashing system. Each pipeline has a versioning control, that is, it has a hashing key that allows identifying if the subset of information (hashset) has not yet been integrated or if it has eventually suffered some change in its data, requiring a new integration.

This hashing technique is applied to an information segment (hashset), that is, it allows identifying which attributes compose the hashing key (thus ignoring integration requests when the entity undergoes changes in attributes that are not part of the key's composition).

All pipelines have a hashing key (defined using user fields - custom aatributes) in the source system and a hashing file (defined in JSON format), for versioning control. If a physical entity (table) has several pipelines, as many hashing keys should be created as the number of pipelines derived from that table (they may eventually share the hashing file).


Composition (User Fields - Custom Attributes) of the Hashing Key of a Pipeline:
  1. SourceHash: attribute used to calculate the hash in the source system (calculated every time a read request is made);
  2. TargetHash: attribute used to preserve the hash value in the source system (updated whenever a successful integration is performed);
  3. IsSync: attribute used as a conditional filter (this attribute indicates if the record has already been integrated, it is controlled by comparing the values of the "SourceHash" and "TargetHash" attributes);

 

Composition of the Hashing File of a Pipeline:

  1. Algorithm: identifies the hashing algorithm (when ignored, the system assumes MD5);
  2. BaseEntity: identifies the base entity, i.e. the main table (mandatory setting);
  3. LyncEntities: identifies the related entities, including the main entity (when ignored, the system assumes BaseEntity);
  4. Attributes: identifies attributes that constitute the hashing key (when ignored, the system assumes all attributes of the base entity and related ones if applicable);
  5. Filter: identifies the conditional filter to apply in the hash calculation (when ignored, the system does not apply any conditional);
  6. FieldSourceHash: identifies the SourceHash attribute (when ignored, the system assumes SourceHash);
  7. FieldTargetHash: identifies the TargetHash attribute (when ignored, the system assumes TargetHash);
  8. FieldSyncHash: identifies the IsSync attribute (when ignored, the system assumes IsSync).




The following image shows the conceptual methodology of the hashing process supported by the plugin.




    • Related Articles

    • How to set up the pipeline execution (Windows Service)?

      The host is the process runtime than instantiates the Valuekeep Integrator engine (PipelineEngine) to manage the pipeline execution (using a scheduling procedure or using a specific on-demand context). The platform provides a Windows Service ...
    • How to customize the pipeline tags for the request URL?

      In Valuekeep, there are "POST" requests, which come from keys, as shown below: The method used to create a follow-up report in a work order is: POST ...
    • What is a Pipeline?

      A Pipeline is a sequence of activities that are executed in a flow (workflow). Conceptually, Valuekeep Integrator is a generic and abstract platform that allows implementing any scenario of data or system integration (in different technologies). The ...
    • Example of a custom pipeline configuration

      The Valuekeep pipelines can be customized and configured based on the business model being implemented. Next, we show an example as a webinar:
    • WebApi - Auditing Pipeline

      The Valuekeep Integrator conceptually allows to monitor the execution of all pipelines. This feature allows the implementing agent/integrator to control the execution of integration flows and identify irregular situations that require to eventually ...