Parâmetros e Variáveis da execução de um relatório

A ferramenta de relatórios disponibiliza diversos parâmetros e variáveis, por padrão, em todos os relatórios, onde é possível obter informações úteis ou configurar algum comportamento desejado.

Parâmetros

Chave	Tipo	Descrição
RELATORIO_TITULO	String	Título do relatório
RELATORIO_PARAMETROS	String	Parâmetros passados para o relatório, ignorando valores nulos, formatado descrição: valor delimitados por ;
RELATORIO_PROTOCOLO_EXECUCAO	String	Protocolo da execução.
RELATORIO_FORMATO_EXPORTACAO	String	Formato da exportação, pode ser um dos seguintes valores: PDF, DOCX, ODT, ODS, XLS, CSV, HTML, TXT ou XML.
RELATORIO_VERSAO_NUM	String	Número da versão do relatório
RELATORIO_VERSAO_DATA	String	Data da versão do relatório, no formato dd/MM/yyyy HH:mm:ss
ENTIDADE_NOME	String	Nome da entidade que onde o relatório está sendo executado
ENTIDADE_BRASAO	Image	Brasão configurado para a entidade
BTH_ENTIDADE	Map	Mapa com as seguintes chaves contendo dados da entidade: brasao, nome, sigla, cnpj, bairro, endereco, cep, numero, completo, telefone, fax, email, site, fusoHorario, horarioAtendimento, rpps, cnae.id, cnae.descricao, esfera.valor, esfera.descricao, natureza.id, natureza.descricao, municipio.nome, municipio.estado.nome, municipio.estado.uf
BTH_ENTIDADE_ESTADO	String	Nome do estado da entidade, no formato Estado {do / de / da} {nome}
USUARIO_ID	String	Id do usuário que está executando o relatório
USUARIO_NOME	String	Nome do usuário que está executando o relatório
USUARIO_EMAIL	String	Email do usuário que está executando o relatório
DESENVOLVEDOR_NOME	String	Nome da entidade responsável pelo desenvolvimento do relatório
SISTEMA_NOME	String	Nome do sistema

Variáveis

Chave	Tipo	Descrição
BTH_NOME_ARQUIVO	String	Permite customizar o nome do arquivo gerado, não deve incluir a extensão
BTH_PARTICIONAMENTO_EXPRESSAO	String	Armazena o valor que será utilizado para classificar a qual grupo a página atual pertence. Essa variável é lida sempre que uma nova página é adicionada ao relatório.
BTH_PARTICIONAMENTO_DESCRICAO	String	Descrição que será adicionada no arquivo json , criado dentro do zip, que vai conter as informações das partições
BTH_PARTICIONAMENTO_NOME_ARQUIVO	String	Nome que será utilizado na exportação da partição, não deve conter a extensão.
BTH_PARTICIONAMENTO_PROPRIEDADES_[NOME_PROP]	String	Propriedades adicionais que serão adicionadas à lista de propriedades no arquivo json . Nesse caso a chave da propriedade vai ser NOME_PROP .
BTH_PARTICIONAMENTO_PROTOCOLO	String	UUID da partição atual, essa variável é somente leitura, e é configurada automaticamente pela ferramenta em tempo de execução.
BTH_METADADO_[NOME_PROP]	String	Valores adicionais que serão adicionados como tags quando a exportação for para PDF e incluídos como marcadores na execução.