Validação de Conteúdo e Registro de Exceções

Após a conversão dos arquivos XML para PDF e DOCX (veja o tutorial sobre geração de arquivos), o MarkAPI realiza uma validação técnica do arquivo XML original para verificar se ele atende aos padrões e regras estabelecidos. Esta validação analisa aspectos como a conformidade dos valores inseridos, a presença de elementos obrigatórios, a estrutura correta do XML e outros critérios técnicos necessários para uma conversão adequada. É como uma "inspeção de qualidade" que identifica problemas no arquivo de origem que podem comprometer o resultado final. Os problemas identificados são registrados e ficam disponíveis para consulta no formato de arquivos:

1. Arquivo de Exceções (.exceptions.json): Registra erros técnicos e falhas críticas encontradas durante o processamento, incluindo o tipo de erro, contexto onde ocorreu e detalhes técnicos para diagnóstico.
2. Arquivo de Validação (.validation.csv): Contém um relatório detalhado de todas as verificações realizadas no XML, apresentando o status de cada elemento, contexto da análise, orientações para correções e detalhamento dos problemas identificados.

Estes arquivos são fundamentais para orientar correções no arquivo XML original, permitindo que você ajuste os problemas identificados antes de uma nova conversão. Dessa forma, você obtém documentos finais de melhor qualidade e evita retrabalho.

Após o acesso ao sistema MarkAPI e execução do processo de conversão, anteriormente indicados, os arquivos de exceções e validações estarão disponíveis para download, conforme ilustra a seguinte imagem:

O arquivo .exceptions.json registra erros críticos e falhas técnicas encontradas durante o processamento:

{
 "response": "exception",
 "group": "article-meta", 
 "error": "Element 'pub-date' is missing required attribute 'date-type'",
 "type": "<class 'ValidationError'>"
}

• response: Tipo de resposta (sempre "exception" neste arquivo)
• group: Grupo ou seção do XML onde o erro ocorreu
• error: Descrição detalhada do erro encontrado
• type: Tipo técnico do erro para diagnóstico

O arquivo .validation.csv contém um relatório detalhado de todas as verificações realizadas:

xml,response,context,advice,detail
"//article-meta/pub-date",invalid,"Data de publicação","Adicione o atributo 'date-type' com valor 'pub' ou 'epub'","Elemento <pub-date> deve conter atributo obrigatório date-type"
"//article-meta/title-group/article-title",valid,"Título do artigo","","Título presente e formatado corretamente"
"//contrib[@contrib-type='author']/name",warning,"Informações do autor","Verifique se todos os autores possuem ORCID","Autor sem identificador ORCID pode afetar indexação"
"//abstract[@xml:lang='en']",invalid,"Resumo em inglês","Adicione resumo em inglês ou corrija atributo xml:lang","Resumo obrigatório em inglês não encontrado"
"//fig/graphic/@xlink:href",exception,"Figura referenciada","Verifique se arquivo de imagem existe no diretório","Arquivo 'figura1.jpg' não encontrado"

• xml: Caminho XPath do elemento analisado
• response: Status da validação (valid, invalid, warning, exception)
• context: Contexto ou descrição do elemento
• advice: Orientação específica para correção
• detail: Detalhamento técnico do problema ou confirmação

1. Priorize exceções e elementos inválidos - estes impedem uma conversão adequada
2. Analise os avisos (warnings) - podem afetar qualidade ou indexação
3. Use a coluna "advice" - oferece orientações específicas para cada problema
4. Consulte o caminho XPath - localiza exatamente onde está o problema no XML

Estes relatórios permitem identificar e corrigir problemas de forma sistemática, garantindo documentos finais de alta qualidade.