Monitorização da Pipeline

Última alteração a 22/08/2024

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):
1. StartDate: identifica a data de início da integração;
2. EndDate: identifica a data de termo da integração;
3. NextDate: opcional, identifica a data da próxima integração;
4. ErrorMessage: opcional, identifica a mensagem de erro quando ocorre um erro no processo de integração;
5. SyncAuditPipelines: opcional, enumera a coleção de sincronizações realizadas (identificar apenas as novas sincronizações):
  1. SyncStartDate: identifica a data de início da sincronização;
  2. SyncEndDate: identifica a data de termo da sincronização;
  3. SyncStatus: identifica o resultado (HttpStatus) da sincronização;
  4. SyncRequest: opcional, identifica o request aplicado na sincronização;
  5. SyncErrorMessage: opcional, identifica a mensagem de erro quando ocorre um erro no processo de sincronização;
  6. SourceEntityId: opcional, identificador (Id) da entidade origem no processo de sincronização;
  7. TargetEntityId: opcional, identificador (Id) da entidade destino no processo de sincronização;
  8. SourceEntityKey: opcional, identificador (Key) da entidade origem no processo de sincronização;
  9. TargetEntityKey: opcional, identificador (Key) da entidade destino no processo de sincronização;
  10. SourceEntityVersion: opcional, identificador (Version) da entidade origem no processo de sincronização;
  11. TargetEntityVersion: opcional,identificador (Version) da entidade destino no processo de sincronização;
  12. SourceEntityVersionNumber: opcional, identificador (VersionNumber) da entidade origem no processo de sincronização;
  13. 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:
1. IsLastAuditPipeline: o sistema assinala para o efeito a última integração;
2. NSuccessRecords: o sistema contabiliza o número de sincronizações realizadas com sucesso no processo de integração;
3. NErrorRecords: o sistema contabiliza o número de sincronizações realizadas sem sucesso no processo de integração.

Adicionar aos favoritos ou partilhar este artigo

Esta página foi útil?

Obrigado pelo seu voto.