Skip to main content

review

Revisão (Humana)

Pára o fluxo para alguém rever os registos antes de continuar.

  • Kind: step
  • Key: review
  • Categoria: gate
  • Envelope: mapa (um objeto JSON em config)

Campos

ChaveTipoObrigatórioOmissãoDescriçãoReferência
reviewTypeenumerationnão"generic"O renderer que o cliente usa para rever. Ausente = generic (campos por chave), que é a omissão segura.-
autoApprovemapnão-Auto-aprovação por confiança. Ausente = nada é auto-aprovado (tudo espera por um humano).-
documentMappingmapnão-Só no formato document: casa o editor de fatura com as chaves do schema do utilizador. Ausente = auto-deteção total.-

autoApprove

ChaveTipoObrigatórioOmissãoDescriçãoReferência
pathstringsim-Caminho pontuado dentro do registo onde está a confiança (ex.: _match.<stepId>.confidence).-
thresholdnumbersim-Confiança mínima para passar sem revisão humana; tem de estar em (0,1]. Valor em falta ou inválido = tudo pendente.-

documentMapping

ChaveTipoObrigatórioOmissãoDescriçãoReferência
linesArrayPathstringnão""Chave da lista de linhas no registo extraído (ex.: linhas). Vazia = auto-deteção.-
headermapnão{}Campo canónico do cabeçalho (supplier.name, totals.total) → chave do registo extraído (fornecedor, total).-
linemapnão{}Chave canónica da linha (description, totalPrice) → chave dentro do item da lista do utilizador.-
headerAutoMatchmapnão{}Ligações automáticas do CABEÇALHO, por campo canónico. Ausente = o cliente deriva-as dos passos resolve a jusante.-
lineAutoMatchmapnão{}Ligações automáticas das LINHAS, por chave canónica da linha (na prática só description).-

documentMapping.headerAutoMatch{}

Cada entrada de documentMapping.headerAutoMatch é um objeto:

ChaveTipoObrigatórioOmissãoDescriçãoReferência
featureIduuidnão""A tabela onde se procura o texto extraído (a "tabela de pesquisa"). Vazia = a ligação não é oferecida.feature (uuid)
searchColumnstringnão""Coluna da tabela de pesquisa com o TEXTO a casar - o rótulo por que se procura, pelo NOME.coluna de featureId (nome)
valueColumnstringnão""Coluna da tabela de pesquisa com o VALOR que o campo passa a guardar, pelo NOME. Vazia = fica o próprio rótulo.coluna de featureId (nome)
creationMappingslist de mapnão[]Colunas a pré-preencher quando o revisor CRIA o registo em falta a partir deste campo. Vazia = a criação leva só o texto.-

documentMapping.headerAutoMatch{}.creationMappings[]

Cada elemento de documentMapping.headerAutoMatch{}.creationMappings é um objeto:

ChaveTipoObrigatórioOmissãoDescriçãoReferência
targetColumnstringnão""Coluna da tabela de pesquisa a pré-preencher (uuid ou nome - o runtime aceita os dois).coluna de featureId (uuid ou nome)
sourceFieldstringnão""Campo do registo de origem de onde vem o valor: caminho pontuado no cabeçalho, chave simples na linha.-

documentMapping.lineAutoMatch{}

Cada entrada de documentMapping.lineAutoMatch é um objeto:

ChaveTipoObrigatórioOmissãoDescriçãoReferência
featureIduuidnão""A tabela onde se procura o texto extraído (a "tabela de pesquisa"). Vazia = a ligação não é oferecida.feature (uuid)
searchColumnstringnão""Coluna da tabela de pesquisa com o TEXTO a casar - o rótulo por que se procura, pelo NOME.coluna de featureId (nome)
valueColumnstringnão""Coluna da tabela de pesquisa com o VALOR que o campo passa a guardar, pelo NOME. Vazia = fica o próprio rótulo.coluna de featureId (nome)
creationMappingslist de mapnão[]Colunas a pré-preencher quando o revisor CRIA o registo em falta a partir deste campo. Vazia = a criação leva só o texto.-

documentMapping.lineAutoMatch{}.creationMappings[]

Cada elemento de documentMapping.lineAutoMatch{}.creationMappings é um objeto:

ChaveTipoObrigatórioOmissãoDescriçãoReferência
targetColumnstringnão""Coluna da tabela de pesquisa a pré-preencher (uuid ou nome - o runtime aceita os dois).coluna de featureId (uuid ou nome)
sourceFieldstringnão""Campo do registo de origem de onde vem o valor: caminho pontuado no cabeçalho, chave simples na linha.-

Exemplo JSON

{
"reviewType": "generic"
}

Gerado de definitions.json versão 17f3e0bc59d9. Esta página nasce no build: não se edita à mão.