IntegraçõesGeral
Geral
Voltar | Lista de artigos
Monitorização da Pipeline
O Valuekeep Integrator, conceptualmente, possibilita a monitorização da execução de todos os pipelines. Esta funcionalidade, permite ao implementador / integrador controlar a execução dos fluxos de integração e inclusive identificar situações anómalas que requerem eventualmente alteração na configuração dos fluxos e/ou serviços de integração.
O método utilizado para o efeito é: POST /api/mytenant/myorganization/integration/pipelines/fullauditpipeline
A estrutura dos dados, um exemplo (Json), para auditar a sincronização de um pipeline:
- {"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","SyncEndDate": "2021-03-01T09:12:19","SyncStatus": 200,"SourceEntityId": "E7A384E7-FD6A-403E-94B7-19F6E08AEB9F","SourceEntityKey": "VALUEKEEP","TargetEntityKey": "VALUEKEEP","SourceEntityVersion": "AAAAAAA","SourceEntityVersionNumber": 98384}]}]}
Descrição dos atributos disponíveis no pedido:
- PipelineKey: identifica a chave do pipeline (caso não exista, é criado um novo pipeline);
- Description: descrição do pipeline (caso o pipeline já exista, é atualizada a descrição no caso de ter sido alterado);
- SourceService: identificador do serviço origem (caso o pipeline já exista, é atualizado no caso de ter sido alterado);
- TargetService: identificador do serviço destino (caso o pipeline já exista, é atualizado no caso de ter sido alterado);
- SourceOgranization: identificador da organização origem (caso o pipeline já exista, é atualizado no caso de ter sido alterado);
- TargetOrganization: identificador da organização destino (caso o pipeline já exista, é atualizado no caso de ter sido alterado);
- ScheduleTime: frequência de integração do pipeline (caso o pipeline já exista, é atualizado no caso de ter sido alterado);
- AuditPipelines: opcional, enumera a coleção de integrações do pipeline (identificar apenas as novas integrações):
- StartDate: identifica a data de início da integração;
- EndDate: identifica a data de termo da integração;
- NextDate: opcional, identifica a data da próxima integração;
- ErrorMessage: opcional, identifica a mensagem de erro quando ocorre um erro no processo de integração;
- SyncAuditPipelines: opcional, enumera a coleção de sincronizações realizadas (identificar apenas as novas sincronizações):
- SyncStartDate: identifica a data de início da sincronização;
- SyncEndDate: identifica a data de termo da sincronização;
- SyncStatus: identifica o resultado (HttpStatus) da sincronização;
- SyncRequest: opcional, identifica o request aplicado na sincronização;
- SyncErrorMessage: opcional, identifica a mensagem de erro quando ocorre um erro no processo de sincronização;
- SourceEntityId: opcional, identificador (Id) da entidade origem no processo de sincronização;
- TargetEntityId: opcional, identificador (Id) da entidade destino no processo de sincronização;
- SourceEntityKey: opcional, identificador (Key) da entidade origem no processo de sincronização;
- TargetEntityKey: opcional, identificador (Key) da entidade destino no processo de sincronização;
- SourceEntityVersion: opcional, identificador (Version) da entidade origem no processo de sincronização;
- TargetEntityVersion: opcional,identificador (Version) da entidade destino no processo de sincronização;
- SourceEntityVersionNumber: opcional, identificador (VersionNumber) da entidade origem no processo de sincronização;
- TargetEntityVersionNumber: opcional, identificador (VersionNumber) da entidade destino no processo de sincronização.
Quando este método é executado com sucesso devolve um HttpStatusCode.OK.
Toda a gestão é efetuada internamente pelo sistema, nomeadamente:
- Pipeline: o sistema identifica se o pipeline já existe ou não e efetua a respetiva operação (criação vs atualização);
- AuditPeiplines: o sistema insere as novas integrações e simultaneamente classifica os seguintes atributos:
- IsLastAuditPipeline: o sistema assinala para o efeito a última integração;
- NSuccessRecords: o sistema contabiliza o número de sincronizações realizadas com sucesso no processo de integração;
- NErrorRecords: o sistema contabiliza o número de sincronizações realizadas sem sucesso no processo de integração.
Esta página foi útil?
Obrigado pelo seu voto.