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 change the flow configuration and/or integration services.
The
method used for that is: POST
/api/mytenant/myorganization/integration/pipelines/fullauditpipeline
The data structure, for example (Json), to audit the pipeline synchronization:
1.
{
"pipelineKey": "VK",
"description": "VK->V10: Sync Brands",
"sourceService": "VK",
"targetService": "V10",
"sourceOrganization": "VALUEKEEP",
"targetOrganization": "PRIMAVERA",
"scheduleTime": "60",
"AuditPipelines": [
{
"startDate": "2021-03-01T09:12:18",
"endDate": "2021-03-01T09:12:19",
"SyncAuditPipelines": [
{
"SyncStartDate":
"2021-03-01T09:12:18 PM",
"SyncEndDate": "2021-03-01T09:12:19
PM",
"SyncStatus": 200,
"SourceEntityId":
"E7A384E7-FD6A-403E-94B7-19F6E08AEB9F",
"SourceEntityKey": "VALUEKEEP",
"TargetEntityKey": "VALUEKEEP",
"SourceEntityVersion":
"AAAAAAA",
"SourceEntityVersionNumber": 98384
}
]
}
]
}
Description
of the attributes available on the request:
- PipelineKey:
identifies the pipeline kay (if it doesn't exist, a new pipeline is created);
- Description:
pipeline description (if the pipeline already exists, the description is updated
if it is changed);
- SourceService: source
service identifier (if the pipeline already exists, it is updated if it is
changed);
- TargetService: target
service identifier (if the pipeline already exists, it is updated if it is changed);
- SourceOrganization: source
organization identifier (if the pipeline already exists, it is updated if it is
changed);
- TargetOrganization: target
organization identifier (if the pipeline already exists, it is updated if it is
changed);
- ScheduleTime: pipeline
integration frequency (if the pipeline already exists, it is updated if it
is changed);
- AuditPipelines: optional,
it specifies the collection of pipeline integration (identify only the new
integrations):
- StartDate:
identifies the integration start date;
- EndDate:
identifies the integration end date;
- NextDate:
optional, identifies the date of the next integration;
- ErrorMessage: optional, identifies the
error message, when an error occurs in the integration process;
- SyncAuditPipelines: optional,
it specifies the collection of performed synchronizations (identify only the
new synchronizations):
- SyncStartDate : identifies the synchronization start date;
- SyncEndDate:
identifies the synchronizationend date;
- SyncStatus:
identifies the result (HttpStatus) of the synchronization;
- SyncRequest:
optional, it identifies the request applied on the synchronization;
- SyncErrorMessage: optional, identifies the error
message, when an error occurs on the synchronization process;
- SourceEntityId:
optional, source entity identifier (Id) on the synchronization process;
- TargetEntityId:
optional, target entity identifier (Id) on the synchronization process;
- SourceEntityId:
optional, source entity identifier (Key) on the synchronization process;
- TargetEntityKey: optional, target entity identifier
(Key) on the synchronization process;
- SourceEntityVersion:
optional, source entity identifier (Version) on the synchronization process;
- TargetEntityVersion:
optional, target entity identifier (Version) on the synchronization process;
- SourceEntityVersionNumber:
optional, source entity identifier (VersionNumber) on the synchronization
process;
- TargetEntityVersionNumber:
optional, target entity identifier (VersionNumber) on the synchronization
process.
When this method is executed successfully, it returns HttpStatusCode.OK.
All management is performed internally by the system, for
example:
- Pipeline: the system identifies if the pipeline already exists and performs the corresponding operation (creation vs update);
- AuditPipelines: the system inserts the new integrations and
simultaneously classifies the following attributes:
- IsLastAuditPipeline: the system marks the last integration.
- NSuccessRecords: the system accounts for the number of synchronizations performed successfully on the integration process;
- NErrorRecords: the system accounts for the number of
synchronizations performed with no success on the integration process.
Related Articles
Plugin V10 – Pipelines – Auditing
The PRIMAVERA V10 - Valuekeep Integrator plugin conceptually makes available through information categories, using lists, the possibility of monitoring the execution of all pipelines. This functionality allows the implementer / integrator to control ...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 ...WebApi - Pipeline Hashing Synchronization
Valuekeep Integrator adopts a version control based on a hashing system. Each pipeline has a version control, that is, it has a hashing key that allows to identify if the information subset (hashset) has still not been integrated or if it suffered ...WebApi - Pipeline Hashing Calculation
Valuekeep Integration adopts a version control based on a hashing system. Each pipeline has a version control, that is, it has a hashing key that allows to identify if the information subset (hashset) has still not been integrated or if it suffered ...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 ...