Manual para utilização da funcionalidade de importar arquivo XML para prestação de contas

Transcrição

1 Manual para utilização da funcionalidade de importar arquivo XML para prestação de contas

2 Conteúdo 1. Introdução 2. Exemplo de documento XML válido para prestação de contas 3. DTD utilizada para validação do documento XML 4. Esclarecimentos quanto ao documento XML para prestação de contas 5. Esclarecimentos quanto a DTD para validação do documento XML

3 1. Introdução Para que a prestação de contas possa ser feita via XML, algumas regras devem ser seguidas. Desta forma, foi definido um formato de documento XML que deve ser respeitado para a realização da prestação. Este manual demonstra um exemplo de documento XML válido. Contém também a DTD utilizada para validar o documento XML e ainda possui esclarecimentos referentes ao XML e a DTD aqui presentes.

4 2. Exemplo de documento XML válido para prestação de contas <?xml version='1.0' encoding="iso "?> <!DOCTYPE prestacao-contas SYSTEM " <prestacao-contas> <minas-gerais> <prestacaomg> <autorizacao-exploracao numero=" z"> <tipo-autorizacao>apef</tipo-autorizacao> </autorizacao-exploracao> <processo numero=" /00" /> <municipio nome="" /> <produto nome="carvão" /> <gca numero="0"> <serie>y</serie> </gca> <emitente nome="siderurgica Teste"> <documento tipo="cnpj"> / </documento> </emitente> <nota-fiscal> <produtor numero="12345"> <data>15/06/2005</data> </produtor> <entrada numero="54321"> <data>15/06/2005</data> </entrada> </nota-fiscal> <essencia tipo="plantada" /> <volume> <transportado>100</transportado> <recebido>100</recebido> </volume> <motorista nome="motorista Teste"> <documento tipo="cpf"> </documento> </motorista> <placa-caminhao numero="yyy-0000" /> </prestacaomg> </minas-gerais> <outros-estados> <prestacaooe> <documento-transporte numero="000"> <tipo>doc</tipo> <orgao-expeditor>org</orgao-expeditor> </documento-transporte> <estado valor="sp" /> <emitente nome="siderurgica Paulista"> <documento tipo="cnpj"> / </documento> </emitente> <nota-fiscal> <produtor numero="12345"> <data>07/03/2005</data> </produtor> <entrada numero="54321"> <data>07/03/2005</data> </entrada> </nota-fiscal> <volume> <transportado>100</transportado> <recebido>100</recebido> </volume> <motorista nome="motorista Teste"> <documento tipo="cpf"> </documento> </motorista> <placa-caminhao numero="yyy-0000" /> </prestacaooe> </outros-estados> </prestacao-contas>

5 3. DTD utilizada para validação do documento XML <!ELEMENT prestacao-contas (minas-gerais,outros-estados)> <!ELEMENT minas-gerais (prestacaomg*)> <!ELEMENT prestacaomg (autorizacao-exploracao,processo,municipio,produto,gca,emitente,notafiscal,essencia,volume,motorista,placa-caminhao)> <!ELEMENT autorizacao-exploracao (tipo-autorizacao)> <!ATTLIST autorizacao-exploracao <!ELEMENT tipo-autorizacao (#PCDATA)> <!ELEMENT processo EMPTY> <!ATTLIST processo <!ELEMENT municipio EMPTY> <!ATTLIST municipio nome CDATA #REQUIRED> <!ELEMENT produto EMPTY> <!ATTLIST produto nome CDATA #REQUIRED> <!ELEMENT gca (serie)> <!ATTLIST gca <!ELEMENT serie (#PCDATA)> <!ELEMENT emitente (documento)> <!ATTLIST emitente nome CDATA #REQUIRED> <!ELEMENT documento (#PCDATA)> <!ATTLIST documento tipo CDATA #REQUIRED> <!ELEMENT nota-fiscal (produtor,entrada)> <!ELEMENT produtor (data)> <!ATTLIST produtor <!ELEMENT data (#PCDATA)> <!ELEMENT entrada (data)> <!ATTLIST entrada <!ELEMENT essencia EMPTY> <!ATTLIST essencia tipo CDATA #REQUIRED> <!ELEMENT volume (transportado,recebido)> <!ELEMENT transportado (#PCDATA)> <!ELEMENT recebido (#PCDATA)> <!ELEMENT motorista (documento)> <!ATTLIST motorista nome CDATA #REQUIRED> <!ELEMENT placa-caminhao EMPTY> <!ATTLIST placa-caminhao <!ELEMENT outros-estados (prestacaooe*)> <!ELEMENT prestacaooe (documento-transporte,estado,emitente,nota-fiscal,volume,motorista, placa-caminhao)> <!ELEMENT documento-transporte (tipo,orgao-expedidor)> <!ATTLIST documento-transporte <!ELEMENT tipo (#PCDATA)> <!ELEMENT orgao-expedidor (#PCDATA)> <!ELEMENT estado (#PCDATA)> <!ATTLIST estado valor CDATA #REQUIRED>

6 4. Esclarecimentos quanto ao documento XML para prestação de contas No início do arquivo, na segunda e terceira linhas, encontra-se o texto: <!DOCTYPE prestacao-contas SYSTEM " Este trecho é obrigatório e necessário para que ocorra a validação do documento, além de permitir que os dados contidos no mesmo sejam lidos e gravados corretamente. Logo abaixo, encontra-se o elemento <prestacao-contas>. Este elemento deve ter obrigatoriamente dois outros elementos, primeiro, o elemento <minas-gerais> e logo após o elemento <outros-estados>. Elemento <minas-gerais> O elemento <minas-gerais>, pode ter ou não, o elemento <prestacaomg>. A ausência deste elemento (<prestacaomg>), indica que neste documento não há prestação de contas de Minas Gerais. A presença de um ou mais elementos <prestacaomg>, indica que há prestação de contas de Minas Gerais no documento. Os elementos presentes em <prestacaomg>, são explicados abaixo e são todos obrigatórios. O primeiro elemento presente em <prestacaomg> é o elemento abaixo: <autorizacao-exploracao numero=" z"> <tipo-autorizacao>apef</tipo-autorizacao> </autorizacao-exploracao> Este é um exemplo válido. Note que autorização de exploração, possui um atributo número, que corresponde ao número da autorização. Além disso, possui também um elemento <tipo-autorizacao>, correspondente ao tipo da autorização. Os tipos válidos são APEF (como no exemplo acima), DCC, IBAMA e PROMOTORIA. O formato do número da autorização depende do tipo da mesma. No exemplo acima, o número tem o formato do tipo APEF, seis números, um traço e uma letra. O próximo elemento é: <processo numero=" /00" />. Este elemento possui apenas o atributo número, correspondente ao número do processo. Caso o tipo da autorização não seja APEF, o atributo número deve ser deixado em branco, ficando assim: <processo numero="" />. Se o tipo da autorização for APEF, deve ser informado o número da autorização (abordado no parágrafo anterior) ou o número do processo. Em seguida, temos o elemento: <municipio nome="" />. Este elemento possui apenas o atributo nome, correspondente ao nome do município. O nome só deve ser informado quando o tipo da autorização for IBAMA. Se o tipo da autorização for APEF, DCC ou IBAMA basta deixar como acima, ou seja, em branco. Agora, o elemento: <produto nome="carvão" />. Este elemento possui um atributo chamado nome e refere-se ao nome do produto. É obrigatório informar o nome do produto. Caso contrário ocorrerá erro. Os produtos que podem ser informados são: CARVÃO, MADEIRA e LENHA. O próximo elemento é: <gca numero="0"> <serie>y</serie> </gca> Neste elemento, o atributo número corresponde ao número da GCA e o elemento <serie> à série da GCA. No exemplo acima, a GCA tem o número 0 e a série Y. Logo abaixo, encontra-se o elemento: <emitente nome="siderúrgica Teste"> <documento tipo="cnpj"> / </documento> </emitente> Este elemento possui o atributo nome, correspondente ao nome do emitente. Possui também o elemento referente ao documento, que deve ter o número do documento, este deve estar de acordo com o atributo tipo, que pode ser CNPJ ou CPF. No exemplo acima, o emitente é Siderúrgica Teste e o documento é um CNPJ de número / Prosseguindo, logo abaixo, se encontra o elemento <nota-fiscal>. Este elemento possui outros dois elementos, como abaixo: <produtor numero="12345"> <data>07/03/2005</data>

7 </produtor> <entrada numero="54321"> <data>07/03/2005</data> </entrada> No elemento referente ao produtor, encontra-se o atributo numero, que corresponde ao número da nota-fiscal do produtor. Este elemento possui outro, o elemento data, referente à data da nota-fiscal do produtor. O outro elemento, referente à entrada também possui um atributo numero, que corresponde ao número da nota-fiscal de entrada. E também possui um elemento data, referente à data da nota-fiscal de entrada. No exemplo anterior, o número da nota-fiscal do produtor é e a data da nota-fiscal do produtor é 15/06/2005, enquanto o número da nota-fiscal de entrada é e a data da nota-fiscal de entrada é 15/06/2005. O próximo elemento de <prestacaomg>, é o elemento <essencia tipo="plantada" />. Este elemento corresponde à essência e possui o atributo tipo que pode ser: plantada, manejo ou nativa. No exemplo acima, a essência é plantada. <volume> é o próximo elemento. Ele possui dois outros elementos: <transportado>100</transportado> e <recebido>100</recebido> O elemento <transportado> refere-se ao volume transportado, que neste caso é 100. O outro elemento <recebido> refere-se ao volume de entrada que no documento XML é representado por este elemento (<recebido>). O penúltimo elemento do <prestacaomg> é: <motorista nome="motorista Teste"> <documento tipo="cpf"> </documento> </motorista> Neste exemplo, o elemento referente à motorista possui um atributo nome, que corresponde ao nome do motorista. Este elemento possui um elemento que corresponde ao documento do motorista, assim como o elemento emitente, comentado anteriormente. E o último elemento de <prestacaomg> é: <placa-caminhao numero="yyy-0000" /> Este elemento possui um atributo numero referente ao número da placa do caminhão, que neste caso é YYY Elemento <outros-estados> Este elemento, pode ter ou não, o elemento <prestacaooe>. A ausência deste elemento (<prestacaooe>), indica que neste documento não há prestação de contas de outros estados. A presença de um ou mais elementos <prestacaooe>, indica que há prestação de contas de outros estados no documento. O primeiro elemento presente em <prestacaooe> é: <documento-transporte numero="000"> <tipo>doc</tipo> <orgao-expeditor>org</orgao-expeditor> </documento-transporte> Este elemento possui um atributo numero referente ao número do documento de transporte. Ele ainda possui dois outros elementos, o elemento <tipo> referente ao tipo do documento de transporte e o elemento <orgao-expeditor> referente ao órgão expeditor do documento de transporte. O próximo elemento é: <estado valor="sp" />. Este elemento refere-se ao estado e possui um atributo valor. Neste exemplo, o estado informado é SP. Os demais elementos presentes em <prestacaooe> referem-se à: emitente, notafiscal, volume, motorista e placa-caminhão, nesta ordem. Todos estes elementos também estão presentes em <prestacaomg> e foram explicados anteriormente.

8 5. Esclarecimentos quanto a DTD para validação do documento XML Na DTD, primeiramente, é declarado o elemento prestação-contas. Este elemento deve conter um elemento minas-gerais e também um elemento outros-estados. Elemento minas-gerais Este elemento deve possuir vários ou nenhum elemento prestacaomg. Assim, uma vez presente, o elemento prestacaomg deve possuir os elementos: autorizacao-exploracao, processo, gca, emitente, nota-fiscal, essencia, volume, motorista e placa-caminhao, nesta ordem. Abaixo, cada elemento de prestacaomg é comentado. o autorizacao-exploracao: possui outro elemento, o tipo-autorizacao. E ainda o atributo numero. o processo: possui o atributo número e não possui elementos. o municipio: possui o atributo nome e não possui elementos. o produto: também possui o atributo nome e não possui elementos. o gca: possui o elemento serie e o atributo numero. o emitente: possui o atributo nome e o elemento documento que por sua vez, possui o atributo tipo. o nota-fiscal: possui os elementos produtor e entrada, não possui atributos. O elemento produtor possui o atributo numero e o elemento data, que não possui. O elemento entrada é semelhante, possui o atributo numero e o elemento data sem atributos. o essencia: possui apenas o atributo tipo. o volume: possui dois elementos, transportado e recebido. Ambos não possuem atributos. o motorista: possui o atributo nome e o elemento documento que possui o atributo tipo (O elemento documento, também está presente no elemento emitente). o placa-caminhao: possui apenas o atributo numero. Elemento outros-estados De maneira semelhante ao elemento minas-gerais, o elemento outros-estados deve possuir vários ou nenhum elemento prestacaooe. O elemento prestacaooe, estando presente, deve conter os elementos: documentotransporte, estado, emitente, nota-fiscal, volume, motorista e placa-caminhao, nesta ordem. Abaixo, cada elemento de prestacaooe é comentado: o documento-transporte: possui o atributo numero e dois elementos, o elemento tipo e o elemento orgao-expeditor. Ambos sem atributos. o estado: possui o atributo estado e não possui elementos. Os demais elementos, emitente, nota-fiscal, volume, motorista e placa-caminhao, estão presentes na prestacaomg e já foram comentados.