Estrutura e regras básicas dos Arquivos de Remessa
Para ser corretamente aceito no Módulo de Pessoal do Sagres o arquivo de Remessa deve obedecer a algumas regras básicas.
Quanto ao formato e conteúdo do arquivo de Remessa :
- O arquivo de remessa deverá ser compactado no formato .ZIP.
- O arquivo .ZIP conterá, obrigatoriamente e exclusivamente, 10 arquivos de formato XML, com os dados a serem enviados, nomeados como:
- Cargo.XML
- ClasseNivelFaixa.XML
- Lotacao.XML
- Servidor.XML
- Vinculo.XML
- FolhaPagamento.XML
- CodigoVantagemDesconto.XML
- VantagemDesconto.XML
- Dependente.XML
- HistoricoFuncional.XML
- A lista com os campos constantes de cada arquivo XML, assim como uma descrição de cada arquivo e de cada campo, pode ser encontrada no documento oficial de layout, disponível no site do TCE, na área relativa ao Módulo de Pessoal do Sagres.
Quanto à Estrutura dos arquivos XML
Cada arquivo no formato XML deve possuir os seguintes elementos (tags):
- Cabeçalho: elemento que identifica um arquivo XML. Deve ser como abaixo:
<?xml version="1.0" encoding="ISO-8859-1"?>
Obs.: O encoding usado para gerar os arquivos XML tem que ser obrigatoriamente ISO-8859-1. - Elemento raiz: identifica qual entidade está sendo informada. Exemplo: para o arquivo Lotacao.xml, o elemento raiz é <Lotacao>.
- Elementos de identificação <VersaoLayout> e <CodigoUJ>: são os elementos que identificam respectivamente a versão do layout e a Unidade Jurisdicionada correspondentes àquele arquivo.
- Elemento de detalhe: é o elemento que traz as linhas de detalhe, ou seja, os registros de dados propriamente ditos.
- Exemplo: para o arquivo Lotacao.xml, haverá zero ou mais elementos <ItemLotacao>
- Campo: Cada campo do layout será representado por um elemento, interno ao elemento de detalhe.
- Exemplo de arquivo Lotacao.xml com dois registros de detalhe:
<?xml version="1.0" encoding="ISO-8859-1"?>
<Lotacao>
<VersaoLayout>0001</VersaoLayout>
<CodigoUJ>999001</CodigoUJ>
<ItemLotacao>
<LotacaoCodigo>PRES</LotacaoCodigo>
<Nome>Presidência</Nome>
</ItemLotacao>
</Lotacao>
- Observações:
- Campos não obrigatórios: quando não houver conteúdo a ser informado para um determinado campo, o correspondente elemento (tag) XML deverá ser omitido.
- Estão disponíveis no site do TCE, na área relativa ao Módulo de Pessoal do Sagres, os arquivos de extensão XSD (XML Schema) que podem ser utilizados para validar os arquivos XML gerados quanto à estrutura e tipos de dados.
- Há um arquivo XSD para cada um dos dez arquivos XML da remessa.
- Há também um arquivo generico.xsd com definições gerais de tipos de dados utilizados nos arquivos XML.
Quanto a validação dos arquivos XML
A atual versão do Módulo de Pessoal do Sistema Sagres, desenvolvido em Java 1.6, utiliza a classe XStream para mapeamento dos arquivos XML para objetos, e as classes javax.xml.validation.SchemaFactory e javax.xml.validation.Validator para a validação propriamente dita, em conjunto com os arquivos XSD disponibilizados na área relativa ao Módulo de Pessoal do Sagres.
Opcionalmente, e se o Jurisdicionado dispuser de ambiente em Linux, pode-se utilizar o comando xmllint para a validação dos XMLs.
Segue um exemplo de comando utilizado na validação em Linux :
xmllint --noout --schema [pasta-dos-XSD]/[arquivo].xsd [arquivo].xml
Quanto a nomenclatura do arquivo de Remessa:
- Para Remessa Mensal ou Retificadora o nome do arquivo deve conter, na ordem abaixo :
- Código da Unidade Jurisdicionada no TCE-PE - Número com 6 dígitos.
- Mês de competência - Número com 2 dígitos.
- Ano de competência - Número com 4 dígitos.
- Identificador do módulo no Sistema Sagres, no caso do módulo de Pessoal as letras “PE”.
- Versão do Layout dos arquivos XML - Número com 4 dígitos disponível no site do TCE, na área relativa ao Módulo de Pessoal do Sagres.
- Exemplo : 999004012016PE0001.zip - Remessa Mensal da Unidade Jurisdicionada TCE-PE, referente a janeiro/2016.
- Código da Unidade Jurisdicionada no TCE-PE - Número com 6 dígitos.
- Identificador de Remessa de Update - palavra “UPDATE”.
- Sequencial de controle interno ao Jurisdicionado - Número com 2 dígitos.
- Identificador do módulo no Sistema Sagres, no caso do módulo de Pessoal as letras “PE”.
- Versão do layout dos arquivos XML - Número com 4 dígitos disponível no site do TCE, na área relativa ao Módulo de Pessoal do Sagres.
- Exemplo : 999004UPDATE35PE0001.zip - Remessa de Update da Unidade Jurisdicionada TCE-PE.