Como incluir macros de substituição em modelos de contratos de serviços?

CONTRATO.FAQ-73846

As interfaces Contratos de serviços e Contratos de serviços - DEPRECIADO possuem a operação de geração de um documento para o contrato de serviço através de um modelo pré definido na interface Cadastro de modelos de documentos. Estes documentos podem utilizar algumas informações sobre o contrato, como por exemplo o número do contrato e a data da geração.

A tela de cadastro de modelos de documentos dispõe da possibilidade de informar um tipo de anexo. Recomenda-se ou cadastrar um tipo de anexo para modelos de contratos ou utilizar o tipo "DOCUMENTO", embora esta informação possui impacto posteriormente na geração do documento do contrato. Para cadastrar tipos de anexos, deve-se:

Acessar Tipos de anexos;
Clicar em [b:Novo];
Informar no campo "tipo de anexo" a nomenclatura do tipo de anexo que está cadastrando (esta nomenclatura será utilizada como identificação);
Informar no campo "título" um nome "formal" para o tipo de anexo;
Campos "Descrição" e "Ícone" são opcionais e não afetam na geração do documento de contrato, então fica a critério do usuário esta informação.

O documento a ser utilizado como modelo na geração de contrato pode utilizar algumas informações sobre o mesmo, como por exemplo o número do contrato e a data da geração. Para utilizar estas informações é necessário utilizar um documento Word (extensão DOCX) e incluir macros de substituição no documento modelo. Cada macro deve conter no início o símbolo de dólar ($) e opcionalmente estar entre chaves (p.ex.: :$numero: ou :${numero}:). As macros disponíveis são:

$numero: - número do contrato de serviço
$frota: - número da frota ou pedido que originou o contrato de serviço
$pedido: - pedido que originou o contrato de serviço
$cidade_estabelecimento - cidade do estabelecimento informado para o contrato de serviço
$data_geração: data (no formato "dia de mês de ano") em que foi gerado o contrato de serviço
$contratante_nome_completo: - nome completo do contratante
$contrato_entrega_endereco: - endereço de entrega informado para o contrato
$contrato_entrega_cidade: - cidade do endereço de entrega. Apresenta a cidade/país
$contrato_data_cadastro: - data em que o contrato foi cadastrado, no formato dd/MM/yyyy
$contrato_data_aprovacao: - data de aprovação do contrato, no formato dd/MM/yyyy
$contrato_valor: - valor do contrato
$contrato_frequencia: - frequência informada no contrato de serviço
$contrato_tipo_contrato: - tipo do contrato
$contrato_tipo_servico: - tipo de serviço do contrato
$contrato_tecnico: - nome completo do técnico informado no contrato
$contrato_vendedor: - código do vendedor informado no contrato
$contrato: - permite utilizar qualquer atributo (ou campo) do contrato, como por exemplo: ${contrato.findContratante().getNomeCompleto().toText()}

Atenção

Arquivos do Word modificam internamente a estrutura do documento quando formatado a fonte de algumas palavras. Portanto, não deve ser inclua uma macro de substituição e logo após formatada a fonte do texto (p.ex.: negrito, itálico, sublinhado, etc). É recomendado já deixar definida toda a formatação necessária antes de incluir a macro de substituição.

Para criar um modelo a ser utilizado como documento para o contrato, deve-se:

Acessar a interface Cadastro de modelos de documentos;
Clicar em [b:Novo];
Informar um nome do modelo;
O campo "descrição" é opcional, mas é recomendado utilizá-lo para descrever o modelo;
No campo "arquivo modelo" selecionar o documento modelo;
No campo "contexto", selecionar "Contratos";
Campo "tipo de anexo", selecionar um tipo de anexo adequado para o modelo que está incluindo;
Clicar em [b:Salvar].

Após a inclusão de um modelo de documento, é necessário informar nos tipos de contratos utilizados o modelo de documento padrão. Cada contrato de serviço que gerará um documento deve possuir o modelo padrão no seu tipo de contrato. Para isto, deve-se:

Acessar Tipos de contratos;
Selecionar o tipo de contrato que gerará documentos;
Clicar em [b:Alterar];
No campo "modelo de contrato padrão", selecione o modelo de documento apropriado para o tipo de contrato selecionado;
Clicar em [b:Salvar].

Com o modelo de documento padrão informado no tipo de contrato, ao clicar no botão [b:Gerar contrato] nas interfaces Contratos de serviços e Contratos de serviços - DEPRECIADO, será gerado um documento e salvo na guia "Anexos".