Pular para o conteúdo principal

Workflow

Workflow é a representação das etapas de integração realizadas no documento. Conforme ilustração abaixo, o workflow é divido em duas etapas: Portal e ERP. As Etapas do Portal, são geradas automaticamente no DocsM3 antes do documento estar disponível para integração no ERP. No geral essas etapas são: Recepção, Validação, Aprovação e Integração.

Após concluídas as etapas do portal, o documento é integrado ao ERP através do consumo da API Mensagens. Nesse momento o DocsM3 espera que sejam enviadas as etapas de processamento desse documento no ERP, essas etapas podem variar de acordo com o tipo de documento e cenário de negócio atribuido ao documento específico. Caso o usuário necessite acompanhar essas etapas de processamento do documento via portal DocsM3, é necessário a chamada da API de atualização do Workflow informando as etapas bem como o status de cada uma dentro do ERP.

Screenshot

Guia do Usuário

Para mais informações, veja a sessão Detalhes do documento no manual do usuário.

Fluxo de Integração​

Atenção

O fluxo de integração pode variar de acordo com o nível de processos requeridos pelo Sistema Corporativo. A representação abaixo considera um cenário básico de integração ponta-a-ponta.

Overview

  • Cliente envia atualização do workflow → API recebe status
  • Backend processa e valida o workflow → API responde sucesso ou falha

Exemplo via cURL​

curl -X 'PATCH' \
  '/api/v1/Documents/Workflow' \
  -H 'accept: application/json;odata.metadata=minimal;odata.streaming=true' \
  -H 'Content-Type: application/json;odata.metadata=minimal;odata.streaming=true' \
  -H 'Authorization: Basic <Your-Token>' \
  -d '[
        {
          "id": "string",
          "workflow": [
            {
              "id": 0,
              "order": 0,
              "name": "string",
              "description": "string",
              "comments": "string",
              "indicator": 0,
              "group": 0,
              "action": "string",
              "metadata": [
                {
                  "field": "string",
                  "value": "string"
                }
              ]
            }
          ]
        }
      ]'

Mais detalhes em PATCH /api/v1/Documents/Workflow.

Próximos passos?​