Entidade MODELOS_DOCUMENTOS

ARQANE.MODELOS_DOCUMENTOS

Descrição

Modelos de documentos para utilização e geração dos documentos pelo sistema. Os modelos são semelhantes a "templates" que podem ser automaticamente preenchidos a partir de um contexto ou parâmetros informados pelo usuário.

Atributos

AtributoDomínioRegrasDescrição
IDID(18)Rqd PK Id:
Chave de identificação interna
MODELOUPPER(80)Rqd UK Nome do modelo:
Nome utilizado para identificar o modelo específico.
DESCRICAOTEXT_LONGDescrição:
Texto livre para descrever o modelo.
ARQUIVO_MODELOATTACHED_FILE(250)Rqd Arquivo modelo:
Arquivo anexado contendo o modelo (template) propriamente dito.
CONTEXTOOPTION(28)Rqd Contexto:
Contexto no qual o modelo pode ser utilizado. O contexto define quais informações estão disponíveis para a sua geração. Por exemplo: Um modelo criado para gerar um documento a partir do contexto de um pedido não irá funcionar se for gerado a partir do contexto de um projeto pois não encontrará informações.

Valores permitidos:
  • ANOTACAO_TECNICA_CERTIFICADO - Anotação técnica - Certificado
  • ANOTACAO_TECNICA_OFICIO - Anotação técnica - Ofício
  • ATIVIDADES - Atividades
  • CONTRATOS - Contratos
  • CURSOS INSTITUICAO - Cursos da instituição
  • DOCUMENTOS - Documentos fiscais
  • EMPRESARIAL_CERITICADO - Certificado empresarial
  • PEDIDOS - Pedidos
  • PROFISSIONAL_CARTEIRA - Carteira do profissional
  • PROFISSIONAL_CEDULA - Cedula para profissional
  • PROFISSIONAL_OFICIO - Ofício para profissional
TIPO_ANEXO_IDID(18)FK Tipo:
Quando informado, indica que o arquivo gerado por este modelo irá gerar um anexo deste tipo.

Referência para TIPOS_ANEXOS
CORPOSOURCE_CODECorpo:
Corpo utilizado no modelo de documento que utiliza um arquivo "jasper" ao invés de arquivo "docx".

Quando utilizado pela interface de Vistorias, pode ser utilizado macros de substituição. As macros disponíveis são:

  • ${vistoria}: - refere-se a entidade de Vistorias, permitindo utilizar quaisquer métodos inclusos na entidade.
  • ${assinatura}: - refere-se a entidade de Relacionamentos, permitindo utilizar quaisquer métodos inclusos na entidade.
  • ${setor}: - refere-se a entidade de Áreas funcionais, permitindo utilizar quaisquer métodos inclusos na entidade.
  • ${cpf}: - permite utilizar o CPF da pessoa informada como "fiscalizado".
  • ${oficio_sigla}: - permite utilizar a sigla de área do setor.
  • ${modelo}: - refere-se a entidade de Modelos de documentos, permitindo utilizar quaisquer métodos inclusos na entidade.

Caso haja a necessidade de incluir no relatório informações para o usuário adicionar no documento que será gerado, deve-se:
  • Incluir um novo parâmetro na guia "Parâmetros".
  • No corpo do modelo, utilizar a macro de substituição com o nome do parâmetro criado. Por exemplo, se for incluído um parâmetro com nome "DATAGERACAO", pode ser utilizado esta informação no corpo como ${datageracao}

O corpo do modelo aceita HTML. Caso incluir a tag

(maiúsculo), o parágrafo ficará com "recuo de parágrafo".

Regras

Gerar documento(velocity)

Retorna um instância de arquivos anexos, porém a mesma não é persistida "ainda" no banco de dados

Montar parâmetros

Retorna um formulário com todos os parâmetros utilizados por este modelo.