Pular para o conteúdo principal
English (US) Español (Latinoamérica)

Variáveis em Modelos de Documentos

Este documento detalha o uso devariáveisna plataforma Buk para a criação dinâmica de documentos, facilitando a automação e personalização de contratos, anexos, certificados e rescisões.

 

1. Requisitos e Estrutura

Para utilizar variáveis nos modelos de documentos, considere o seguinte:

  • Módulos Requeridos:É indispensável contar com os módulos deAssinatura DigitaleGestão Documental. Você pode solicitar a ativação da configuração "Habilitar modelos personalizáveis" à equipe de Suporte e Atendimento ao Cliente (SAC) assim que possuir esses módulos.

  • Formato das Variáveis:Todas as variáveis devem estar sempre entre chaves duplas{{e}}. Por exemplo:{{empleado.nombre}}.

2. O que é uma Variável?

Umavariávelé um contêiner que armazena um valor específico e representa informações relevantes em um documento. Essas variáveis contêm dados como datas, nomes, endereços ou identificadores, permitindo que as informações sejam atualizadas e personalizadas de forma simples.

3. Variáveis Disponíveis

A seguir, estão listadas as categorias de variáveis disponíveis para a gestão documental, com exemplos de uso:

3.1. Variáveis Gerais

Essas variáveis fornecem informações dinâmicas e gerais:

  • Dia de pagamento de salários: {{dia_pago_sueldos}}

  • Data de hoje (dinâmica): {{fecha_de_hoy}}

  • Data e hora atual: {{fecha_y_hora_actual}}

  • Data do primeiro dia do mês atual: {{fecha_primer_dia_mes}}

  • Início do mês aberto: {{inicio_mes_abierto}}

  • Fim do mês aberto: {{fin_mes_abierto}}

  • Data do primeiro dia do próximo mês: {{fecha_primer_dia_mes_siguiente}}

  • Data dois meses após hoje: {{fecha_dos_meses_despues_de_fecha_actual}}

  • Data três meses após hoje: {{fecha_tres_meses_despues_de_fecha_actual}}

  • Usuário que gera o documento: {{documento_generado_por}}(quem pressiona "gerar documento")

3.2. Variáveis para Assinaturas

Para incluir dados dos signatários no documento:

  • Primeiro Signatário: {{firma.primer_firmante.nombre}}

  • Segundo Signatário: {{firma.segundo_firmante.nombre}}

  • Nome completo dos signatários (que não são o colaborador) que precisam assinar o documento.

3.3. Variáveis para Empresa

Dados da empresa:

  • Nome da Empresa: {{empresa.nombre}}

  • CNPJ da Empresa: {{empresa.rut}}

  • Atividade Econômica: {{empresa.giro}}

  • Email da Empresa: {{empresa.email_empresa}}

  • Logo URL: {{empresa.logo}}(usar com o filtroimagen)

  • Endereço: {{empresa.direccion}}

  • Bairro: {{empresa.comuna}}

  • Cidade: {{empresa.ciudad}}

  • Nome do Representante: {{empresa.representante.nombre}}

  • CNPJ/CPF do Representante: {{empresa.representante.rut}}

  • Endereço do Representante: {{empresa.representante.direccion}}

  • Nacionalidade do Representante: {{empresa.representante.nacionalidad}}

  • Nome do Representante Secundário: {{empresa.representante_secundario.nombre}}

  • CNPJ/CPF do Representante Secundário: {{empresa.representante_secundario.rut}}

  • Endereço do Representante Secundário: {{empresa.representante_secundario.direccion}}

  • Nacionalidade do Representante Secundário: {{empresa.representante_secundario.nacionalidad}}

3.4. Variáveis para Empregado

Informações detalhadas do empregado:

  • Dados Pessoais: nombre,apellido,segundo_apellido,nombre_completo,sexo,rut,rut_limpio(sem pontos nem hífen),codigo_ficha,estado_civil,estado_civil_con_genero(Ex: Solteira),nacionalidad,profesion,fecha_nacimiento,edad,telefono_particular,telefono_oficina,universidad,titulo.

  • Dados Bancários: cuenta_corriente,banco,tipo_cuenta.

  • Endereço: numero_calle,calle,direccion,direccion_completa,region_empleado,comuna,ciudad.

  • Contatos: correo_electronico(institucional),correo_personal.

  • Previdência e Saúde: fondo_cotizacion(INSS/IPS),institucion_salud(Plano de Saúde/SUS).

  • Férias: saldo_vacaciones_legales,saldo_vacaciones_progresivas,vacaciones_legales_proporcionales,vacaciones_progresivas_proporcionales,vacaciones_legales_pendientes,vacaciones_progresivas_pendientes,fecha_reconocimiento_antiguedad.

  • Dados Trabalhistas: empleado.obra,fecha_ingreso_compania,fecha_ultimo_movimiento,fecha_termino_trabajo,tipo_contrato,periodicidad(Jornada de Trabalho),tipo_jornada,annos_servicio,fecha_termino_trabajo_anterior,fecha_vencimiento_contrato,fecha_vencimiento_contrato_2,area(Divisão),departamento(Área),sub_area,direccion_trabajo,comuna_trabajo,ciudad_trabajo,region_trabajo,region_zona_extrema_trabajo,comuna_zona_extrema_trabajo,nombre_del_cargo,descripcion_del_cargo,horas_semanales,sueldo(Salário Base),sueldo_liquido_teorico,forma_pago,centro_de_costo,dias_trabajo,comuna_trabajo,cargo_supervisor,localidad,cargo_anterior,sueldo_base_anterior.

 

3.5. Variáveis para Supervisor

Informações do supervisor do empregado:

  • Nome: {{supervisor.nombre}}

  • Sobrenome: {{supervisor.apellido}}

  • Nome Completo: {{supervisor.nombre_completo}}

  • CPF Supervisor: {{supervisor.rut}}

3.6. Atributos Personalizados (Coleções)

Essas variáveis sãocoleçõese requerem uma iteração (usando a estrutura{%for%}) para acessar seus elementos.

Estrutura geral para iterar:

{%for [elemento_singular] in [coleccion]%}
  Propiedad: {{[elemento_singular].[propiedad]}}
{%endfor%}

Coleções disponíveis:

  • Horas Extras: {{empleado.horas_extras}}

    • Propriedades:horas,aprobada,tipo,proporcion.

  • Bonificações: {{empleado.bonos}}

    • Propriedades:nombre,monto,codigo,monto_calculado.

    • Totais:{{empleado.total_bonos}}

  • Informativos: {{empleado.informativos}}

    • Propriedades:nombre,monto,codigo,monto_calculado.

    • Totais:{{empleado.total_informativos}}

  • Não Tributáveis: {{empleado.no_imponibles}}

    • Propriedades:nombre,monto.

    • Totais:{{empleado.total_no_imponibles}}

  • Descontos: {{empleado.descuentos}}

    • Propriedades:nombre,monto.

    • Totais:{{empleado.total_descuentos}}

  • Dependentes: {{empleado.cargas}}

    • Propriedades:nombre,rut,rut_limpio,sexo,relacion,fecha_nacimiento,expiration_date,tipo_carga.

    • Totais:{{empleado.total_cargas}}

  • Centros de Custo: {{empleado.centro_costos}}

    • Propriedades:codigo.

  • Subáreas Superiores: {{empleado.sub_areas_superiores}}

    • Propriedades:nombre,nivel.

  • Ausências: {{empleado.ausencias}}

    • Propriedades:nombre,codigo,dias_tomados,justificacion,estado,inicio_ausencia,termino_ausencia,inicio_aplicacion_ausencia,termino_aplicacion_ausencia.

    • Totais:{{empleado.total_ausencias}}

  • Licenças: {{empleado.licencias}}

    • Propriedades:nombre,codigo,dias_tomados,justificacion,estado,inicio_licencia,termino_licencia,inicio_aplicacion_licencia,termino_aplicacion_licencia.

    • Totais:{{empleado.total_licencias}}

  • Permissões: {{empleado.permisos}}

    • Propriedades:nombre,codigo,dias_tomados,justificacion,estado,inicio_permiso,termino_permiso,inicio_aplicacion_permiso,termino_aplicacion_permiso,goce_sueldo(Com Pagamento?).

    • Totais:{{empleado.total_permisos}}

  • Proventos: {{empleado.total_items_haberes}}(soma de bonificações e não tributáveis).

4. Estruturas de Controle

Os modelos permitem usar lógica condicional (if) e laços (for) para um controle mais avançado.

4.1. Estruturaif

Permite avaliar o valor de uma variável e mostrar conteúdo condicionalmente.

Exemplo:

{%if empleado.nombre == "Pedro"%}
  El empleado es Pedro.
{%endif%}

 

4.2. Estruturafor

É utilizada para iterar sobre coleções de elementos, como bonificações ou descontos.

Exemplo (Bonificações):

{%for bono in empleado.bonos%}
  Nombre: {{bono.nombre}} Monto: {{bono.monto}}
{%endfor%}

Exemplo (Permissões com condição):

{%for permiso in empleado.permisos%}
  {%if permiso.nombre == "Permiso"%}
    Inicio del permiso: {{permiso.inicio_permiso}}
  {%endif%}
{%endfor%}

 

5. Filtros

Os filtros transformam o valor das variáveis para apresentá-las em um formato diferente. São aplicados usando o símbolo|.

  • palabras: Converte números ou datas para sua versão por extenso.

    • Exemplo:{{sueldo | palabras}}

  • imagen: Exibe uma imagem a partir de sua URL.

    • Exemplo:{{empresa.logo | imagen: "200", "200"}}(largura, altura em pixels)

  • formato_fecha: Mostra uma data em um formato específico.

    • Exemplo:{{empleado.fecha_ingreso_compania | formato_fecha: "dd/mm/yyyy"}}(resultado:01/01/2023)

    • Formatos:yyyy(ano),mm(mês),dd(dia),hh(hora),MM(minutos),ss(segundos).

    • Separadores:'/','-',' '.

  • detalle_fecha: Obtém o dia, mês ou ano de uma data.

    • Exemplo:{{fecha_de_hoy | detalle_fecha: "A"}}(para ano)

    • Elementos:"A"(ano),"M"(mês),"D"(dia).

  • fecha_en_palabras: Mostra a data escrita por extenso.

    • Exemplo:{{fecha_de_hoy | fecha_en_palabras: "%A %d de %B de %Y"}}(resultado:Lunes 04 de septiembre de 2023)

    • Formatos:%A(Nome do dia),%d(Número do dia),%b(3 letras do mês),%B(Nome do mês),%Y(Ano 4 dígitos),%y(Ano 2 dígitos).

  • fecha_n_meses_al_futuro: Mostra a data "01/mm/yyyy" N meses no futuro.

    • Exemplo:{{fecha_de_hoy | fecha_n_meses_al_futuro: "3"}}

  • remove_zero: Remove o.0de um número.

    • Exemplo:{{empleado.horas_semanales | remove_zero}}

  • monto_con_formato: Mostra um valor com formato monetário (ex:$ ###.###).

    • Exemplo:{{empleado.total_descuentos_ultima_liquidacion | monto_con_formato}}(resultado:$ 500.000)

  • monto_con_decimales_a_palabras: Converte um número com decimais para palavras (decimais como fração x/100).

    • Exemplo:{{empleado.sueldo | monto_con_decimales_a_palabras}}

  • convertir_a_mayusculas: Transforma o texto em maiúsculas.

    • Exemplo:{{empleado.nombre_completo | convertir_a_mayusculas}}

6. Operadores

Você pode usar os seguintes operadores nas estruturas condicionais (if):

  • ==(Igual a)

  • !=(Diferente de)

  • greater_than(Maior que)

  • less_than(Menor que)

  • greater_or_equal_than(Maior ou igual a)

  • less_or_equal_than(Menor ou igual a)

  • or(Ou)

  • and(E)

Artigos Relacionados