WebApi - Monitorização da Pipeline

WebApi - Monitorização da Pipeline

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:
  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",
              "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:

  1. PipelineKey: identifica a chave do pipeline (caso não exista, é criado um novo pipeline);
  2. Description: descrição do pipeline (caso  o pipeline já exista, é atualizada a descrição no caso de ter sido alterado);
  3. SourceService: identificador do serviço origem (caso  o pipeline já exista, é atualizado no caso de ter sido alterado);
  4. TargetService: identificador do serviço destino (caso  o pipeline já exista, é atualizado no caso de ter sido alterado);
  5. SourceOgranization: identificador da organização origem (caso  o pipeline já exista, é atualizado no caso de ter sido alterado);
  6. TargetOrganization: identificador da organização destino (caso  o pipeline já exista, é atualizado no caso de ter sido alterado);
  7. ScheduleTime: frequência de integração do pipeline  (caso  o pipeline já exista, é atualizado no caso de ter sido alterado);
  8. 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:
  1. Pipeline: o sistema identifica se o pipeline já existe ou não e efetua a respetiva operação (criação vs atualização);
  2. 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.


    • Related Articles

    • WebAPI - Como obter o registo da webapi?

      No momento em que é realizada a subscrição no Valuekeep CMMS o subscriber recebe um email com as credenciais da subscrição, compostas por client_Id e um Cliente_Secret. Estas credencias devem ser guardadas, caso contrário não será possível utilizar a ...
    • WebAPI – Autenticação

      A autenticação na webapi é feita através do serviço "Primavera Identity". Para obter o token de autenticação deve seguir os seguintes passos: Fazer a chamada ao Primavera Identity(https://identity.primaverabss.com/connect/token), colocando o ...
    • Como customizar as Tags de uma Pipeline para o Url do pedido

      No Valuekeep temos pedidos "POST" devivados de chaves, exemplificando a seguir: O método a utilizar para a criação de um registo de follow-up numa Ordem de Trabalho é: POST ...
    • WebAPI – Alterar estado da ordem de trabalho

      Este método permite efetuar a mudança de estado de uma ordem de trabalho. O método a utilizar para a alteração de estado da ordem de trabalho é: Post {{url}/api/{{tenant}}/{{organization}}/maintenance/workorders/changeSchemaEntityState/{{companyKey}} ...
    • WebAPI - Registo e Manutenção de Peças e Serviços

      Este método permite gerir o registo e manutenção de peças e serviços(criar novos registos e alterar dados dos existentes). No âmbito do inventário (peças), além do registo da peça permite complementar a sua classificação em termos de inventário, ...