====== Layout do arquivo de customização versão 1.0 ====== O arquivo de customização é um arquivo XML estruturado para armazenar opções do sistema que são específicas para cada município. Esse arquivo armazena configurações que afetam o funcionamento do sistema e que devem ser ajustadas para cada município, porém não devem ser modificadas pelos usuários após sua definição. ===== Convenções ===== ==== Tags XML ==== As tags XML devem ser escritas todas em maiúsculas, sem caracteres especiais, acentuação ou pontuação de qualquer tipo. ==== Nome do arquivo ==== O arquivo deve ser chamado "Custom.config" e deve ser armazenado e distribuído na pasta do sistema (mesmo local dos arquivos binários). ==== Regras de formatação ==== === Textos === Nenhuma formatação especial é requerida. Caracteres especiais e de acentuação/pontuação podem ser usados livremente. === Datas === Datas devem estar no formado YYYY-MM-DD. === Horas === Horas devem estar no formato HH:MM:SS. === Valores numéricos === Valores numéricos devem ser inseridos com seus separadores, quando necessário. A vírgula (,) deve ser usada como separador decimal, enquanto o ponto (.) deve ser usado como separador de milhar. === Valores booleanos === Valores booleanos devem ser informados como //TRUE// ou //FALSE//, sempre em maiúsculas. ===== Composição do arquivo ===== Cada elemento do arquivo, bem como sua função e a origem das informações que os compõem, estão detalhados nas sessões seguintes. ==== CONFIGURACOES ==== Este elemento é o elemento raiz do documento. Seus elementos filhos devem ser os elementos que armazenam as configurações do sistema específicas do município que o está utilizando. === Elementos filho === |< 100% 10% 6% 84%>| ^Elementos filho ^Ocorrências ^Descrição ^ |DOCSIMPRESSOS |1 |Configurações de documentos impressos em geral. | |DIARIOELETRONICO |1 |Configurações específicas do diário eletrônico. | === Atributos === |< 100% 10% 30% 60%>| ^Atributos ^Descrição ^Informações adicionais ^ |VERSAO |Versão do layout do arquivo. |Valor do atributo (fixo): 1.0 | === Exemplo === ... ... ==== DOCSIMPRESSOS ==== Este elemento contém as configurações relativas aos documentos impressos pelo sistema. === Elementos filho === |< 100% 10% 6% 84%>| ^Elementos filho ^Ocorrências ^Descrição ^ |GERAL |1 |Configurações aplicadas a todos os documentos impressos. | |HISTORICO |1 |Configurações aplicadas à impressão dos históricos do aluno. | |FICHAMATRICULA |1 |Configurações aplicadas à impressão da ficha de matrícula do aluno. | |FICHAINDIVIDUAL |1 |Configurações aplicadas à impressão da ficha individual do aluno. | |ATARESULTADO |1 |Configurações aplicadas à impressão das atas de resultado final das turmas. | === Atributos === Este elemento não possui atributos. === Exemplo === ... ... ... ... ... ... ... === GERAL === Este elemento contém as configurações gerais aplicadas aos documentos impressos do sistema. == Elementos filho == |< 100% 10% 6% 84%>| ^Elementos filho ^Ocorrências ^Descrição ^ |TIMBRE |1 |Define o formato do timbre que deve ser utilizado na impressão. | == Atributos == |< 100% 10% 30% 60%>| ^Atributos ^Descrição ^Informações adicionais ^ |FORMATO |Define o formato do timbre. |Valores permitidos:\\ - CENTRALIZADO: logomarca da entidade mantenedora à esquerda, dados da entidade e da escola ao centro e logomarca da escola à direita.\\ - ENTIDADECENTRALIZADO: Apenas a logomarca da entidade mantenedora, seu nome e os dados da escola, todos centralizados.\\ - LADOALADO: Timbre dividido ao meio, com os dados da entidade mantenedora (e logomarca) no lado esquerdo e com os dados da escola (e logomarca) no lado direito, ambos alinhados à esquerda. | == Exemplo == ... ... === HISTORICO === Este elemento contém as configurações aplicadas ao módulo de históricos do sistema. == Elementos filho == |< 100% 10% 6% 84%>| ^Elementos filho ^Ocorrências ^Descrição ^ |INSERIRRESULTADOFINALDISCIPLINAS |1 |Define se o sistema deve inserir ou não o resultado final da série do histórico para todas as disciplinas. | |INSERIRTRACOSCAMPOSSEMNOTA |1 |Define se o sistema deve inserir ou não um traço nos campos sem nota na impressão dos históricos. | == Atributos == |< 100% 10% 30% 60%>| ^Atributos ^Descrição ^Informações adicionais ^ |HABILITADO |Determina se o recurso está ou não habilitado. |Valores permitidos: TRUE ou FALSE | == Exemplo == ... ... ... ... === FICHAMATRICULA === Este elemento contém as configurações das sessões da ficha de matrícula. == Elementos filho == |< 100% 14% 6% 80%>| ^Elementos filho ^Ocorrências ^Descrição ^ |SESSOES |1 |Lista das sessões existentes na ficha de matrícula. | |-- IDENTIFICACAOESCOLA |1 |Dados de identificação da escola. | |-- IDENTIFICACAOALUNO |1 |Dados de identificação do aluno. | |-- FILIACAORESPONSAVEL |1 |Filiação e dados do responsável. | |-- COMPOSICAOFAMILIAR |1 |Composição familiar do aluno. | |-- ENDERECO |1 |Endereço do aluno. | |-- DOCUMENTOIDENTIFICACAO |1 |Documentos de identificação do aluno. | |-- CURSOSERIETURMA |1 |Curso, série e turma na qual o aluno está matriculado. | |-- DOCUMENTOSAPRESENTADOS |1 |Documentos apresentados no ato da matrícula. | |-- ESCOLASFREQUENTADAS |1 |Escolas frequentadas pelo aluno anteriormente. | |-- VACINASTOMADAS |1 |Vacinas tomadas pelo aluno. | |-- SAUDESANCOES |1 |Dados de saúde do aluno. | |-- INFORMACOESCOMPLEMENTARES |1 |Informações complementares sobre o aluno e anamnese. | |-- RENOVACAOMATRICULA |1 |Dados da renovação de matrícula. | |-- OBSERVACOES |1 |Observações do cadastro de alunos. | == Atributos == |< 100% 10% 30% 60%>| ^Atributos ^Descrição ^Informações adicionais ^ |HABILITADO |Determina se a sessão será ou não impressa. |Valores permitidos: TRUE ou FALSE | |QUEBRAPAGINA |Determina se haverá uma quebra de página após a sessão. |Valores permitidos: TRUE ou FALSE | == Exemplo == ... ... ... ... === FICHAINDIVIDUAL === Este elemento contém as configurações aplicadas à impressão da ficha individual do aluno. == Elementos filho == |< 100% 14% 6% 80%>| ^Elementos filho ^Ocorrências ^Descrição ^ |CONVERTEREMHORAS |1 |Define se o sistema deve converter a carga horária das disciplinas e as faltas em horas. | |EXIBIRDADOSESCOLA |1 |Define se o sistema deve imprimir os dados da escola no cabeçalho do documento ou apenas imprimir o nome dos campos, sem valores. | == Atributos == |< 100% 10% 30% 60%>| ^Atributos ^Descrição ^Informações adicionais ^ |HABILITADO |Determina se o recurso está ou não habilitado. |Valores permitidos: TRUE ou FALSE | == Exemplo == ... ... ... ... === ATARESULTADO === Este elemento contém as configurações aplicadas à impressão das atas de resultado final. == Elementos filho == |< 100% 10% 6% 84%>| ^Elementos filho ^Ocorrências ^Descrição ^ |CABECALHO |1 |Define como o cabeçalho do documento deve ser impresso | == Atributos == |< 100% 10% 30% 60%>| ^Atributos ^Descrição ^Informações adicionais ^ |FORMATO |Define o formato do cabeçalho das atas. |Valores permitidos:\\ - SIMPLIFICADO: imprime apenas o texto contínuo com o dia da finalização do ano, série, turma e curso.\\ - DETALHADO: Imprime, além do texto contínuo, dados detalhados da escola, curso, série e turma aos quais a ata pertence. | == Exemplo == ... ... ... ==== DIARIOELETRONICO ==== Este elemento contém as configurações relativas à geração dos arquivos de diário eletrônico. === Elementos filho === |< 100% 10% 6% 84%>| ^Elementos filho ^Ocorrências ^Descrição ^ |GERAL |1 |Configurações gerais do arquivo. | |TIPOSPERIODOLETIVO|1 |Configurações específicas para cada tipo de período letivo. | |FICHADESCRITIVA |1 |Configurações específicas da ficha descritiva. | |IMPRESSAO |1 |Configurações de impressão do diário. | === Atributos === Este elemento não possui atributos. === Exemplo === ... ... ... ... ... === GERAL === Este elemento contém as configurações gerais do modelo de diário eletrônico. == Elementos filho == |< 100% 10% 6% 84%>| ^Elementos filho ^Ocorrências ^Descrição ^ |MODELO |1 |Define o modelo de diário e a orientação das páginas quando impressas. | |ARREDONDAMENTO |1 |Define quando as regras de arredondamento serão aplicadas. | |PROTECAOSENHA |1 |Define se o acesso aos arquivos de diário gerados a partir desse modelo estará ou não protegido por senha. | == Atributos == |< 100% 20% 30% 50%>| ^Atributos ^Descrição ^Informações adicionais ^ |ID (MODELO) |Identificação única do modelo de diário. |O ID do modelo deve ser suportado pelo Diário eletrônico. | |NOME (MODELO) |Nome do modelo de diário. |Utilizar o nome do município que utiliza esse modelo. | |ORIENTACAO (MODELO) |Define a orientação das páginas do diário quando estas forem impressas. |Valores permitidos: RETRATO ou PAISAGEM. | |APLICAR (ARREDONDAMENTO) |Define quando aplicar as regras de arredondamento (no Diário eletrônico). |Valores permitidos:\\ - NUNCA: não realiza qualquer tipo de arredondamento.\\ - ANOLETIVO: arredonda apenas a nota final do aluno no ano letivo.\\ - PERIODOLETIVO: arredonda apenas a nota final de cada período letivo.\\ - AVALIACAO: arredonda a nota de cada avaliação registrada. | |HABILITADO (PROTECAOSENHA) |Define se a proteção por senha deve estar ativa para os arquivos de diário gerados. |Valores permitidos: TRUE ou FALSE. | == Exemplo == ... ... ... ... === TIPOSPERIODOLETIVO === Este elemento contém as configurações de avaliações e resultados para cada tipo de período letivo. == Elementos filho == |< 100% 10% 6% 84%>| ^Elementos filho ^Ocorrências ^Descrição ^ |NORMAL |1 |Define as configurações dos períodos letivos regulares. | |-- AVALIACAO |1 |Define as configurações das avaliações. | |-- RESULTADO |1 |Define as configurações dos resultados do período letivo. | |-- RESULTADOFINAL |1 |Define as configurações do resultado final do período letivo. | |RECUPERACAO |1 |Define as configurações dos períodos letivos de recuperação. | |-- AVALIACAO |1 |Define as configurações das avaliações. | |-- RESULTADO |1 |Define as configurações dos resultados do período letivo. | |-- RESULTADOFINAL |1 |Define as configurações do resultado final do período letivo. | |RECUPERACAOESPECIAL |1 |Define as configurações dos períodos letivos de recuperação especial (NOA). | |-- AVALIACAO |1 |Define as configurações das avaliações. | |-- RESULTADO |1 |Define as configurações dos resultados do período letivo. | |-- RESULTADOFINAL |1 |Define as configurações do resultado final do período letivo. | == Atributos == |< 100% 20% 30% 50%>| ^Atributos ^Descrição ^Informações adicionais ^ |QUANTIDADE (AVALIACAO) |Define a quantidade de avaliações do período letivo. |Embora não exista limites para a quantidade de avaliações, é necessário verificar se a quantidade definida pode ser impressa, de acordo com o modelo de impressão definido. | |POSSUIRECUPERACAO (AVALIACAO) |Define se a avaliação tem ou não uma recuperação. |Valores permitidos: TRUE ou FALSE. | |DESCRICAOAVALIACAO (AVALIACAO) |Armazena o título da coluna da avaliação, no sistema (Diário eletrônico) e na impressão. |Tamanho máximo: 12 caracteres. | |DESCRICAORECUPERACAO (AVALIACAO) |Armazena o título da coluna da recuperação, no sistema (Diário eletrônico) e na impressão.|Tamanho máximo: 12 caracteres. Só é exibido se a avaliação possuir recuperação. | |FORMACALCULONOTAFINAL (AVALIACAO/RESULTADO) |Define como a nota final de uma avaliação deve ser calculada. |Usado apenas para avaliações que possuem recuperação. Valores permitidos:\\ - MAIOR: a nota final da avaliação é a maior entre a nota da avaliação e a nota da recuperação.\\ - SOMA: a nota final da avaliação é a soma da nota da avaliação com a nota da recuperação.\\ - MEDIA: a nota final da avaliação é a média da nota da avaliação com a nota da recuperação.\\ - ULTIMA: a nota final da avaliação é a nota da recuperação.\\ Em todos os casos, a nota da recuperação só é considerada quando não for vazia. | |DESCRICAORESULTADO (RESULTADO/RESULTADOFINAL) |Armazena o título da coluna do resultado, no sistema (Diário eletrônico) e na impressão. |Tamanho máximo: 12 caracteres. | |FORMACALCULONOTA (RESULTADO/RESULTADOFINAL) |Define como o resultado deve ser calculado. |Usado apenas para avaliações do tipo RESULTADO. Valores permitidos:\\ - SOMA\\ - MEDIA. | == Exemplo == ... ... ... ... === FICHADESCRITIVA === Este elemento contém as configurações da ficha descritiva. == Elementos filho == Este elemento não contém elementos filho. == Atributos == |< 100% 20% 30% 50%>| ^Atributos ^Descrição ^Informações adicionais ^ |HABILITADO |Define se a ficha descritiva estará ou não habilitada. |Valores permitidos: TRUE ou FALSE. Quando habilitada, a ficha descritiva substitui a folha de notas nas séries de módulo I, tanto no sistema (Diário eletrônico) quanto na impressão. | |TIPO |Define o tipo de ficha descritiva. |Valores permitidos:\\ - AVALIATIVA: um conceito pode ser registrado para cada item da disciplina, em cada período letivo.\\ - DESCRITIVA: pode ser adicionada, para cada disciplina, uma descrição do desempenho do aluno no período letivo. | == Exemplo == ... ... ... ... === IMPRESSAO === Este elemento contém as configurações de impressão das folhas do diário. == Elementos filho == |< 100% 10% 6% 84%>| ^Elementos filho ^Ocorrências ^Descrição ^ |CAPA |1 |Define as configurações de impressão da capa do diário. | |NORMAS |1 |Define as configurações de impressão da folha de normas do diário. | |FREQUENCIA |1 |Define as configurações de impressão da folha de frequência do diário. | |AVALIACOESPERIODICAS |1 |Define as configurações de impressão da folha de avaliações periódicas do diário. | |DADOSBIOMETRICOS |1 |Define as configurações de impressão da folha de dados biométricos do diário. | |CONTEUDO |1 |Define as configurações de impressão da folha de conteúdos do diário. | |RECUPERACAO |1 |Define as configurações de impressão da folha de recuperação do diário. | |RECUPERACAOESPECIAL |1 |Define as configurações de impressão da folha de recuperação especial do diário. | |RESULTADOANUAL |1 |Define as configurações de impressão da folha de resultado anual do diário. | |RESULTADOANUALFREQUENCIA |1 |Define as configurações de impressão da folha do resultado anual de frequência do diário. | |DEMONSTRATIVOAVALIACOES |1 |Define as configurações de impressão do demonstrativo de avaliações do diário. | |OBSERVACOES |1 |Define as configurações de impressão da folha de observações do diário. | == Atributos == |< 100% 20% 30% 50%>| ^Atributos ^Descrição ^Informações adicionais ^ |HABILITADO |Define se a impressão da folha estará ou não habilitada. |Valores permitidos: TRUE ou FALSE. | |TIPOPERIODO |Define a qual tipo de período a folha está vinculada. |Valores permitidos:\\ - ANUAL: folhas impressas uma vez ao ano.\\ - NORMAL: folhas impressas em cada período letivo regular.\\ - RECUPERACAO: folhas impressas em cada período de recuperação.\\ - RECUPERACAOESPECIAL: folhas impressas nos os períodos de recuperação especial. | == Exemplo == ... ===== Schema =====