Padrão de Documentação¶

Esta página tem como objetivo concentrar os padrões definidos para a documentação.

A documentação foi criada visando passar orientações aos usuários das aplicações da família SAD Gestor de forma direta e prática. Os padrões exibidos abaixo foram definidos pela equipe de documentação e devem ser seguidos, porém, podem sofrer alterações quando:

For necessário ajuste para obter melhor concordância;
Por decorrência de correções orto-gramaticais;
A equipe de documentação avaliar que se faz necessário.

Algumas orientações a serem consideradas:

Quando houver documentação para uma funcionalidade citada, deve ser disponibilizado o link da mesma. Exibir exemplo Exibir exemplo
Lote: Informar o Lote a ser utilizado.
Deve-se respeitar a hierarquia estrutural das funcionalidades. Exibir exemploExibir exemplo
- Lote: Informar o Lote a ser utilizado.
  - Adicionar Item:
    - Lote:
    - Validade:
  - Alterar Item:
  - Remover Item:
Manter as imagens em suas proporções originais;
Somente imagens em uso na documentação deverão ser anexadas na página;

Estrutura Padrão Estrutura Padrão

Colocar o "{{>toc}}" caso houver necessidade.

Nome do Formulário¶

Introdução

Detalhamento dos botões do rodapé¶

Imprimir: Permite ao usuário visualizar o lançamento de acordo com os filtros informados.
Excluir: Permite ao usuário excluir o lançamento permanentemente.
Salvar: Permite ao usuário salvar as informações do lançamento.
Sair: Fecha o formulário.

Filtros¶

Filtro: Informar o filtro que deseja consultar.
Consultar : Realiza a consulta de acordo com os filtros informados.

Campos¶

Lançamento: Esse campo possibilita a consulta de lançamentos, caso o usuário queira incluir um novo lançamento informe o número zero.

Nome do Campo: Informar...
ComboBox: Selecionar... , podendo ser "", "" ou "".

Nota: Caso queira inativar o cadastro, marcar o flag Inativo.

h3.

Adicionar Item

**: Informar

Alterar Item : Permite ao usuário alterar o item selecionado.
Remover Item : Permite ao usuário remover o item selecionado.

Nota: A inserção e/ou remoção só será concluída se for salva no botão do rodapé do formulário.

Parâmetros¶

Abaixo os Parâmetros do formulário:

000000 - Parâmetro.

Eventos¶

Abaixo os [[Framework:GerenciadorAcesso#Aba-Eventos|Eventos]] do formulário:

Evento.

Videoaula ¶

Formulario

Página Relacionada¶

Página

Filtros para adicionar títulos
- Opção 01Opção 01
  Títulos¶
  
  Esta grade permite ao usuário visualizar informações de acordo com os dados informados nos campos, além disso, é possível realizar alterações no próprio formulário utilizando os botões abaixo na grade ou alterando valor no campo Vlr Baixa.
  
  Adicionar Item
  Através do botão adicionar é possível realizar uma busca mais detalhada de título.
  - Todas as empresas: Caso queira consultar todas as empresas, marque o flag. Caso o flag "Todas as Empresas" esteja desmarcado, selecione a empresa que deseja consultar.
  - Tipo Data: Informar o período de "Emissão" ou "Vencimento", de acordo com a opção desejada.
  - Data (a): Informar o período que deseja consultar.
  - Valor da Parcela (a): Informar o intervalo de valores que deseja consultar.
  - Cliente: Informar o Movimentador do tipo cliente que deseja consultar.
  - Tipo de Cobrança: Informar Tipo da Cobrança que deseja consultar.
  - Tipo de Cliente: Informar o Tipo de Movimentador de acordo com a sua classificação.
  - Convênio: Informar o convênio, caso possua.
  - Juro %: Informar o percentual de juros a ser aplicado sobre o título.
  - Carência: Informar o período no qual o cliente pode quitar os seus débitos após o vencimento estando isento de juros.
  - Selecione o tipo de informação que deseja consultar, podendo ser "Nº do Lançamento", "Documento", "Nota Fiscal" ou "Nosso Número" e no campo abaixo insira a informação que deseja consultar.
  - Consultar : Realiza a consulta de acordo com os filtros informados.
  - Títulos: Após informar os campos de filtros para a realização da consulta, nesta grade irá exibir as informações do título.
  Nota: Para marcar/desmarcar todos os itens, clique com o botão direito do mouse e selecione a opção desejada.
  - Opções
    - Mais Informações: Permite ao usuário visualizar informações referentes ao título selecionado.
    - Meu Alinhamento de Grade : Permite ao usuário configurar a exibição das informações na grade.
    - Eventos: Permite ao usuário visualizar os eventos referentes ao título selecionado.
  - Enviar : Permite ao usuário enviar o título ao formulário anterior para a realização da baixa.
  - Sair: Retorna à tela anterior.
  Remover Item : Permite ao usuário remover item selecionado.
  - Opções :
    - Observação: Caso haja informações adicionais referente ao lançamento, utiliza a opção.
    - Recalculando Juros Permite ao usuário recalcular juros e o prazo de carência.
    - Valor Pré Determinado: Essa opção tem a função de realizar as baixas de acordo com um valor pré-determinado pelo cliente.
    - Slip Lançamento: Esse extrato demonstra os detalhes do lançamento do título.
    - Documentos Fiscais: Essa opção realiza a consulta do documento fiscal de origem.
  Adicionar¶
  
  Através do botão adicionar é permitido ao usuário realizar a baixa de títulos por agrupamento.
  - Tipo: Informar o tipo de Operação de Títulos a ser utilizada.
  - Valor: Esse campo refere-se aos lançamentos que serão agrupados, o mesmo é preenchido automaticamente.
  - Cliente: Informar o cliente o qual será transferido o título.
  - Forma de Pagamento: Informar a Forma de Pagamento a ser utilizada.
  - Condição de Pagamento: Informar a Condição de Pagamento a ser utilizada.
  - Tipo de Cobrança: Informar o Tipo de Cobrança a ser utilizada.
  - Moeda auxiliar: Informar a Moeda Corrente.
  - Contrato: Caso haja um tipo de Contrato, utilizar este campo.
  - Enviar: Permite ao usuário salvar as informações inseridas.
  - Sair: Retorna à tela anterior.
  Nota: As informações da baixa somente será válida, utilizando o botão salvar no rodapé.
- Opção 02Opção 02
  BAIXA DE TÍTULOS - CONTAS A RECEBER (AGRUPAMENTO)¶
  
  Campos¶
  - Lançamento: Esse campo possibilita a consulta de títulos lançados. Caso o usuário queira incluir um novo título deverá informar o número zero.
  - Operação: Informar a [[CD_FI_TITULO_OPERACOES|Operações de Titulos].
  - Baixa: Informar a data referente a baixa.
  Títulos¶
  
  Ao informar os campos, é possível o usuário visualizar nesta grade as informações do título.
  
  Nota: Para marcar/desmarcar todos os itens, clique com o botão direito do mouse e selecione a opção desejada.
  
  Adicionar Item ¶
  
  Através do botão adicionar é possível realizar uma pesquisa de título, para que isso ocorra é preciso informar os filtros.
  - Todas as empresas: Caso queira consultar todas as empresas, marque o flag. Caso o flag "Todas as Empresas" esteja desmarcado, selecione a empresa que deseja consultar.
  - Tipo Data: Informar o período de "Emissão" ou "Vencimento", de acordo com a opção desejada.
  - Data (a): Informar o período que deseja consultar.
  - Valor da Parcela (a): Informar o intervalo de valores que deseja consultar.
  - Cliente: Informar o Movimentador do tipo cliente que deseja consultar.
  - Tipo de Cobrança: Informar Tipo da Cobrança que deseja consultar.
  - Tipo de Cliente: Informar o Tipo de Movimentador de acordo com a sua classificação.
  - Convênio: Informar o convênio, caso possua.
  - Juro %: Informar o percentual de juros a ser aplicado sobre o título.
  - Carência: Informar o período no qual o cliente pode quitar os seus débitos após o vencimento estando isento de juros.
  - Selecione o tipo de informação que deseja consultar, podendo ser "Nº do Lançamento", "Documento", "Nota Fiscal" ou "Nosso Número" e no campo abaixo insira a informação que deseja consultar.
  - Consultar : Realiza a consulta de acordo com os filtros informados.
  - Títulos: Após informar os campo de filtros para a realização da consulta, esta grade permite visualizar o título que foram buscados de acordo com os dados da pesquisa.
  Nota: Para marcar/desmarcar todos os itens, clique com o botão direito do mouse e selecione a opção desejada.
  - Opções
    - Mais Informações: Permite ao usuário visualizar informações referentes ao título selecionado.
    - Meu Alinhamento de Grade : Permite ao usuário configurar a exibição das informações na grade.
    - Eventos: Permite ao usuário visualizar os eventos referentes ao título selecionado.
  - Enviar : Permite ao usuário enviar o título ao formulário anterior para a realização da baixa.
  - Sair: Retorna à tela anterior.
  Remover Item : Permite ao usuário remover item selecionado.
  Opções :
  - Observação: Caso haja informações adicionais referente ao lançamento, utiliza a opção.
  - Recalculando Juros Permite ao usuário recalcular juros e o prazo de carência.
  - Valor Pré Determinado: Essa opção tem a função de realizar as baixas de acordo com um valor pré-determinado pelo cliente.
  - Slip Lançamento: Esse extrato demonstra os detalhes do lançamento do título.
  - Documentos Fiscais: Essa opção realiza a consulta do documento fiscal de origem.
  Adicionar¶
  
  Através do botão adicionar é permitido ao usuário realizar a baixa de títulos por agrupamento.
  - Tipo: Informar o tipo de Operação de Títulos a ser utilizada.
  - Valor: Esse campo refere-se aos lançamentos que serão agrupados, o mesmo é preenchido automaticamente.
  - Cliente: Informar o cliente o qual será transferido o título.
  - Forma de Pagamento: Informar a Forma de Pagamento a ser utilizada.
  - Condição de Pagamento: Informar a Condição de Pagamento a ser utilizada.
  - Tipo de Cobrança: Informar o Tipo de Cobrança a ser utilizada.
  - Moeda auxiliar: Informar a Moeda Corrente.
  - Contrato: Caso haja um tipo de Contrato, utilizar este campo.
  - Enviar: Permite ao usuário salvar as informações inseridas.
  - Sair: Retorna à tela anterior.
  Tipo da Baixa¶
  
  Esta grade permite ao usuário visualizar o título baixado por agrupamento, caso queira alterar as informações referente a baixa, utilizar os botões abaixo na grade.
  
  Alterar Item : Permite ao usuário alterar informações da baixa por titulo.¶
  
  Remover Item : Permite ao usuário remover item selecionado¶
  
  Nota: As informações da baixa somente será válida, utilizando o botão salvar no rodapé.
- Opção 03Opção 03
  BAIXA DE TÍTULOS - CONTAS A RECEBER (TÍTULOS E PARCELAS)¶
  
  Filtros¶
  - Operação: Informar a [[CD_FI_TITULO_OPERACOES|Operações de Titulos].
  - Baixa: Informar a data referente a baixa.
  Títulos¶
  
  Esta grade permite ao usuário visualizar informações de acordo com os dados informados nos campos, além disso, é possível realizar alterações no próprio formulário utilizando os botões abaixo na grade ou alterando valor no campo Vlr Baixa.
  
  Adicionar Item ¶
  
  Permite ao usuário busca título com pesquisa mais detalhada.
  - Todas as empresas: Caso queira consultar todas as empresas, marque o flag. Caso o flag "Todas as Empresas" esteja desmarcado, selecione a empresa que deseja consultar.
  - Tipo Data: Informar o período de "Emissão" ou "Vencimento", de acordo com a opção desejada.
  - Data (a): Informar o período que deseja consultar.
  - Valor da Parcela (a): Informar o intervalo de valores que deseja consultar.
  - Cliente: Informar o Movimentador do tipo cliente que deseja consultar.
  - Tipo de Cobrança: Informar Tipo da Cobrança que deseja consultar.
  - Tipo de Cliente: Informar o Tipo de Movimentador de acordo com a sua classificação.
  - Convênio: Informar o convênio, caso possua.
  - Juro %: Informar o percentual de juros a ser aplicado sobre o título.
  - Carência: Informar o período no qual o cliente pode quitar os seus débitos após o vencimento estando isento de juros.
  - Selecione o tipo de informação que deseja consultar, podendo ser "Nº do Lançamento", "Documento", "Nota Fiscal" ou "Nosso Número" e no campo abaixo insira a informação que deseja consultar.
  - Consultar : Realiza a consulta de acordo com os filtros informados.
  - Títulos: Após informar os campo de filtros para a realização da consulta, esta grade permite visualizar o título que foram buscados de acordo com os dados da pesquisa.
  Nota: Para marcar/desmarcar todos os itens, clique com o botão direito do mouse e selecione a opção desejada.
  - Opções
    - Mais Informações: Permite ao usuário visualizar informações referentes ao título selecionado.
    - Meu Alinhamento de Grade : Permite ao usuário configurar a exibição das informações na grade.
    - Eventos: Permite ao usuário visualizar os eventos referentes ao título selecionado.
  - Enviar : Permite ao usuário enviar o título ao formulário anterior para a realização da baixa.
  - Sair: Retorna à tela anterior.
  Remover Item : Permite ao usuário remover item selecionado.

Arquivos (0)

Projeto

Geral

Perfil

Derevo | Documentação

Wiki

Padrão de Documentação¶

Nome do Formulário¶

Detalhamento dos botões do rodapé¶

Filtros¶

Campos¶

Parâmetros¶

Eventos¶

Videoaula ¶

Página Relacionada¶

Títulos¶

Adicionar¶

BAIXA DE TÍTULOS - CONTAS A RECEBER (AGRUPAMENTO)¶

Campos¶

Títulos¶

Adicionar Item ¶

Adicionar¶

Tipo da Baixa¶

Alterar Item : Permite ao usuário alterar informações da baixa por titulo.¶

Remover Item : Permite ao usuário remover item selecionado¶

BAIXA DE TÍTULOS - CONTAS A RECEBER (TÍTULOS E PARCELAS)¶

Filtros¶

Títulos¶

Adicionar Item ¶