Linha Datasul

Árvore de páginas

Versões comparadas

Versão antiga 8

changes.mady.by.user Leonardo Fagundes Rocio

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Leonardo Fagundes Rocio

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

O Calendário Fiscal tem o objetivo de agendar as datas de entregas da obrigações fiscais pertinentes ao processo fiscal da empresa. Ele permitirá os usuários cadastrados nele, de receber as notificações de entrega das obrigações agendadas, onde será possível visualizar em um calendário todas as obrigações cadastradas no mês e, que devem ser entregues por esses usuários.


Conceitos:

Totvs custom tabs box
tabsCadastro de Usuários,Cadastro de Alertas, Configuração de Anexos, Cadastro de Compromissos, Calendário/Lista de Compromissos
idscad_usuario,cad_alerta,config_anexo,cad_compromissos,calendario
Totvs custom tabs box items
defaultyes
referenciacad_usuario

CONTEÚDO

  1. Visão geral
  2. Exemplo de utilização
  3. Tela html.fiscalCalendar - Menu Configurações - Usuários - Ações
  4. APIs Utilizadas

ÍNDICE

  • 01. VISÃO GERAL
  • 02. EXEMPLO DE UTILIZAÇÃO
  • 03. TELA html.fiscalCalendar - MENU CONFIGURAÇÕES - USUÁRIOS - AÇÕES
    • 04. APIS UTILIZADAS

    01. VISÃO GERAL

    Esse programa é responsável por efetuar o cadastro dos usuários, que irão utilizar o módulo do Calendário Fiscal, e somente os usuários cadastrados poderão ter acesso as funcionalidades do calendário. É possível apenas cadastrar os usuários que já existam no cadastro de usuários do ERP. 

    02.  EXEMPLO DE UTILIZAÇÃO

    O primeiro usuário cadastro cadastrado receberá automaticamente privilégios de administrador, mesmo que não tenha solicitado a própria inclusão. 

    Somente os usuários administradores e ativos poderão incluir, alterar ou excluir os usuários cadastrados. 

    É permitida a inclusão de mais de um usuário por vez, podendo conceder ou retirar privilégios de administrador aos usuários, assim como inativainativá-los, retirando sua permissão de acesso ao calendário. 

    Não é permitido remover o próprio usuário, apenas retirar o status de administrador, mas será necessário um outro administrador para concedeconcedê-lo novamente. 

    Deve sempre existir ao menos um usuário com status de administrador. Caso haja apenas um, não será possível remover ou retirar a permissão de administrador deste usuário até que exista outro administrador.

    Image Removed

    Image Removed

    03. TELA html.fiscalCalendar - MENU CONFIGURAÇÕES - USUÁRIOS - AÇÕES

    Outras Ações / Ações relacionadas

    Ação

    Descrição

    Adicionar usuárioAdicionar usuários, que estão no cadastro de usuários do ERP, ao cadastro de usuários do Calendário Fiscal.
    RemoverExclui usuários inseridos ao cadastro de usuários do Calendário Fiscal.
    Busca Avançada

    Abre a tela para o preenchimento de campos adicionais para o refinamento da busca.

    Os parâmetros listados na tela da busca avançada são:

    • Usuário: é  é possível filtrar pelo usuário cadastrado;
    • Ativo: é  é possível filtrar pelo Status com valor igual a "Sim" ou "Não";
    • Administrador: é possível filtrar pela permissão de Administrador com valor igual a "Sim" ou "Não";


    04.     APIS UTILIZADAS

    Totvs custom tabs box items
    defaultyesno
    referenciacad_alerta

    CONTEÚDO

    1. Visão geral
    2. Exemplo de utilização
    3. Tela html.fiscalCalendar - Menu Configurações - Alertas - Ações
    4. Tela html.fiscalCalendar - Menu Configurações - Alertas - Campos
    5. APIs Utilizadas

    ÍNDICE

  • 01. VISÃO GERAL
  • 02. EXEMPLO DE UTILIZAÇÃO
  • 03. TELA html.fiscalCalendar - MENU CONFIGURAÇÕES - ALERTAS - AÇÕES
  • 04. TELA html.fiscalCalendar - MENU CONFIGURAÇÕES - ALERTAS - CAMPOS
    • 05. API UTILIZADA

    01. VISÃO GERAL

    Esse é um

    cadastro 

    cadastro geral de

    alertas 

    alertas para que se possa configurar a forma de como os alertas irão se comportar, quando serão emitidos, com que frequência e de que forma os compromissos serão notificados para os usuários.

    02. EXEMPLO DE UTILIZAÇÃO

    Somente 

    Somente usuários administradores terão permissão para incluir ou editar

     as

     as configurações de alerta geral.

    É

    obrigatório selecionado

    obrigatório selecionado ao menos um Tipo de Alerta, caso contrário nenhuma notificação será enviada por e-mail.

    Image Removed

    03. TELA html.fiscalCalendar - MENU CONFIGURAÇÕES - ALERTAS - AÇÕES

    Outras Ações / Ações relacionadas

    Ação

    Descrição

    Adicionar AlertaEsse botão será apresentado somente na primeira utilização do cadastro de alertas, ou seja, ao inserir o primeiro registro ele será trocado pelo
    botão 
    botão Editar Alerta.
    Editar AlertaEfetua a edição de um alerta já incluído no cadastro.
    SalvarSalva o registro que se está Incluindo ou Editando no cadastro.
    CancelarCancela a operação que se está realizando.

    04.

     TELA 

    TELA html.fiscalCalendar - MENU CONFIGURAÇÕES - ALERTAS - CAMPOS

    Principais Campos e Parâmetros

    Campo

    Descrição

    Dias Antes do PrazoNesse campo é informado a quantidade de dias antes da data da entrega que o alerta começa a ser disparado.
    Horário do Inicio do AlertaHora na qual os disparos de alertas dentro do dia começa a ser disparado.
    Repetir a Cada X HorasIntervalo de horas que são disparados os alertas dentro daquela dia.
    Tipos de Alertas

    A seleção de uma das opções apresentadas abaixo determina como o usuário receberá este alerta

    .

    :

    • E-mail

    Se nenhuma opção for selecionada, nenhum alerta será enviado.

    Servidor RPWServiço de agendamento que será responsável pelo disparo e controle dos alertas.

    05. 

    API UTILIZADA

    APIS UTILIZADAS

    • notificSettingCalendFisc: http
    http
    Totvs custom tabs box items
    defaultyesno
    referenciaconfig_anexo

    CONTEÚDO

    1. Visão geral
    2. Exemplo de utilização
    3. Tela html.fiscalCalendar - Menu Configurações - Anexos
    4. APIs Utilizadas

    ÍNDICE

  • 01. VISÃO GERAL
  • 02. EXEMPLO DE UTILIZAÇÃO
    • 03. TELA html.fiscalCalendar - CONFIGURAÇÕES - ANEXOS

    01. VISÃO GERAL

    A configuração de anexos do calendário fiscal tem por objetivo centralizar a parametrização necessária para que os anexos das entregas dos compromissos sejam armazenados para posterior consulta pelos utilizadores do calendário fiscal.

    02.

     

    EXEMPLO DE UTILIZAÇÃO

    Image Removed

    O usuário deve inserir o diretório de rede no qual serão salvos os anexos dos compromissos.

    03.

     

    TELA html.fiscalCalendar - MENU CONFIGURAÇÕES - ANEXOS

    Principais Campos e Parâmetros

    Campo

    Descrição

    Diretório de redeInforme o diretório de rede onde os anexos serão armazenados. O diretório deve estar na mesma rede que o Sistema e é necessário que ele tenha permissão de leitura e escrita para que os arquivos sejam salvos corretamente.

    04. APIS UTILIZADAS

    Totvs custom tabs box items
    defaultno
    Totvs custom tabs box items
    defaultyes
    referenciacad_compromissocompromissos

    CONTEÚDO

    1. Visão geral
    2. Exemplo de utilização
    3. Tela html.fiscalCalendar - Compromissos - Listagem - Ações
    4. Tela html.fiscalCalendar - Compromissos - Listagem - Ações da grid
    5. Tela html.fiscalCalendar - Compromissos - Listagem - Parâmetros
    6. Tela html.fiscalCalendar - Compromissos - Listagem - Inclusão e edição de compromissos
    7. Tela html.fiscalCalendar - Compromissos - Listagem - Importar compromissos
    8. Tela html.fiscalCalendar - Compromissos - Listagem - Remover compromissos
    9. APIs Utilizadas

    ÍNDICE

  • 01. VISÃO GERAL
  • 02. EXEMPLO DE UTILIZAÇÃO
  • 03. TELA html.fiscalCalendar - COMPROMISSOS - LISTAGEM - AÇÕES
  • 04. TELA html.fiscalCalendar - COMPROMISSOS - LISTAGEM - AÇÕES DA GRID
  • 05. TELA html.fiscalCalendar - COMPROMISSOS - LISTAGEM - PARÂMETROS
  • 06. TELA html.fiscalCalendar - COMPROMISSOS - INCLUSÃO E EDIÇÃO DE COMPROMISSOS
  • 07. TELA html.fiscalCalendar - COMPROMISSOS - IMPORTAR COMPROMISSOS
    • 08. API UTILIZADAS

    01. VISÃO GERAL

    Essa tela

    ,

    tem como objetivo principal

    ,

     efetuar o cadastro dos compromissos de entrega das Obrigações

    Fiscais  

    Fiscais. 

    02. EXEMPLO DE UTILIZAÇÃO

    Os usuários

    administradores tem

    administradores têm acesso aos compromissos cadastrados para todos os usuários, mas os usuários comuns terão acesso somente aos compromissos que forem de sua responsabilidade.

     O

     

    O compromisso terá somente um responsável, caso seja necessário

    alertar

    que mais de uma pessoa visualize o compromisso, este deverá ser duplicado. 

    Listagem dos Compromissos

    Image Removed

    Novo/Editar compromisso

    Aba Geral/Alertas

    Image Removed

    Image Removed

    Importação de Compromissos

    Image Removed

    Apenas os usuários administradores têm permissão para excluir compromissos do Calendário Fiscal.

    03. TELA html.fiscalCalendar - COMPROMISSOS - LISTAGEM - AÇÕES

    Outras Ações / Ações relacionadas

    Ação

    Descrição

    Novo CompromissoAdiciona um novo compromisso ao calendário fiscal.
    ImportarEfetua a importação de compromissos pré-formatados conforme modelo anexo a tela de importação.
    Busca Avançada

    Abre uma modal para o preenchimento de campos adicionais para o refinamento da busca.

    Os parâmetros listados na tela da busca avançada são:

    • Estabelecimento: é possível selecionar o estabelecimento na qual o compromisso está cadastrado;
    • Responsável: é possível selecionar o usuário na qual o compromisso está cadastrado;
    • Periodicidade: é possível definir a periodicidade que
    a obrigação fiscal deve ser entregue
    • a obrigação fiscal deve ser entregue.
    Remover

    Efetua a exclusão dos compromissos selecionados na grid da listagem.

    04. TELA html.fiscalCalendar - COMPROMISSOS - LISTAGEM - AÇÕES DA GRID

    Outras Ações / Ações relacionadas

    Ação

    Descrição

    Selecionar CompromissoSeleciona um ou mais compromissos da listagem.
    Editar CompromissoEfetua a edição do registro escolhido, levando os dados para a tela de edição.
    Copiar CompromissoEfetua a cópia do registros com os mesmos dados, precisando somente informar um novo código para o cadastro.
    Visualizar CompromissoEfetua a visualização do registro escolhido, levando os dados para a tela de edição com
    os mesmos dados, precisando somente informar um novo código para o cadastro
    todos os campos desabilitados.

    05. TELA html.fiscalCalendar - COMPROMISSOS - LISTAGEM - PARÂMETROS

    Principais Campos e Parâmetros

    Campo

    Descrição

    BuscarEfetua a busca de cadastros por meio da descrição do compromisso informado no campo.

    06. TELA html.fiscalCalendar - COMPROMISSOS - INCLUSÃO E EDIÇÃO DE COMPROMISSOS

    A inclusão e edição de compromissos são divididas em duas partes, representadas por duas abas na tela, Geral e Alerta. Primeiramente, são informados os dados do compromisso que serão apresentados no calendário. Em seguida, caso seja necessário, é possível parametrizar alertas exclusivamente para o compromisso selecionado. Se nenhum dado for informado nos alertas, o Sistema assumirá a frequência de alertas padrão

    cadastrada. Caso alguma informação seja editada nos compromissos, as alterações realizadas serão refletidas somente nas entregas cuja data seja posterior à data de alteração do compromisso. Caso não haja nenhuma entrega futura, as alterações serão refletidas na última entrega disponível.

    cadastrada. 

    Principais Campos e Parâmetros - Aba Geral

    EstabelecimentosSeleciona os estabelecimentos relacionados ao compromisso,

    Campo

    Descrição

    Código do CompromissoIdentificador único do compromisso.
    DescriçãoDescrição do compromisso que será apresentada no calendário.
    EsferaDetermina a abrangência do compromisso. Pode ter os valores Federal, Estadual ou Municipal.
    EstadoCaso a esfera do compromisso seja Estadual ou Municipal, é necessário selecionar a UF a qual ele pertence.
    MunicípioPara os compromissos municipais, é necessário informar também o nome do município. O conteúdo do campo é automaticamente filtrado pela UF selecionada.
    Data de Início de VigênciaData de início de vigência do compromisso. Ela serve como data base para o cálculo das datas de entrega do compromisso de acordo com a periodicidade determinada. O indicado é que essa data seja preenchida com o primeiro dia do mês da primeira entrega do compromisso.
    Data Final de VigênciaData final da vigência do compromisso. Após essa data, não serão geradas novas entregas e o compromisso não será mais apresentado no calendário. O indicado é que essa data seja preenchida com o último dia do mês da última entrega do compromisso.
    PeriodicidadePeriodicidade do compromisso. Pode assumir os valores Quinzenal, Mensal, Trimestral, Semestral ou Anual.
    Dia da EntregaDia da primeira entrega do compromisso no período. Para as frequências semanal e quinzenal as próximas datas dentro do período são calculadas automaticamente. Por exemplo, para compromissos que devem ser entregues mensalmente no dia 10, o valor a ser informado é 10.
    Vencimento dia Não ÚtilCaso a data de entrega do compromisso caia no final de semana, determina se a entrega deve ser antecipada ou postergada.
    Anexar comprovanteDetermina se, ao marcar um compromisso como entregue no calendário, será necessário anexar um comprovante de entrega para completar a ação. Pode ter os valores Obrigatório ou Opcional.
    ResponsávelIndica o responsável pela entrega do compromisso. Para poder ser responsável pela entrega, o usuário deve estar relacionado como usuário do calendário fiscal nas configurações. Só
    é permitido um responsável por compromisso.
    é permitido um responsável por compromisso.
    EstabelecimentosSeleciona os estabelecimentos relacionados ao compromisso.
    DestinatáriosIndica os e-mails que devem receber as notificações de alerta do Calendário Fiscal. É habilitado apenas para compromissos que possuem um alerta exclusivo para este. Caso não seja informado, todos os administradores serão notificados por padrão.
    ObservaçõesEspaço para informações adicionais acerca do compromisso.

    Principais Campos e Parâmetros - Aba Alertas

    Campo

    Descrição

    Utilizar alertas padrão do sistemaEste campo vem marcado por padrão. Ao desmarcar, os campos de cadastro de alerta são habilitados e se torna possível cadastrar um alerta exclusivo para o compromisso.
    Emissão
    Dias Antes do
    alertaInforma quantos
    PrazoNesse campo é informado a quantidade de dias antes da
    entrega do compromissos as notificações de alerta começarão a serem emitidas, a partir de que hora do dia e qual intervalo de horas que devem se repetir
    data da entrega que o alerta começa a ser disparado.
    Horário do Inicio do AlertaHora na qual os disparos de alertas dentro do dia começa a ser disparado.
    Repetir a Cada X HorasIntervalo de horas que são disparados os alertas dentro daquela dia.
    Tipo de Alerta
    Informa por qual meio a notificação de alerta será enviada.

    A seleção de uma das opções apresentadas abaixo determina como o usuário receberá este alerta:

    • E-mail

    Se nenhuma opção for selecionada, nenhum alerta será enviado.

    Servidor de RPWAs notificações de alertas são enviadas a partir de execuções agendadas de acordo com os parâmetros no servidor RPW informado.

    07. TELA html.fiscalCalendar - COMPROMISSOS - IMPORTAR COMPROMISSOS

    Principais Campos e Parâmetros

    Campo

    Descrição

    Selecionar ArquivoPermite a seleção de arquivo com extensão *.csv para a importação de compromissos.
    Baixe nosso modelo .csv para importaçãoPermite o download do modelo .csv para ser utilizado
    como referência na criação do arquivo de importação de compromissos.
    como referência na criação do arquivo de importação de compromissos.
    CancelarCancela a operação e fecha a tela Importar Compromissos.
    ImportarInicia a importação do arquivo .csv selecionado.

    08. TELA html.fiscalCalendar - COMPROMISSOS - REMOVER COMPROMISSOS

    Esta é uma tela de confirmação da exclusão de compromissos, na qual são exibidos os registros selecionados para a exclusão.

    Principais Campos e Parâmetros

    Campo

    Descrição

    CancelarCancela a operação e fecha a tela
    Importar
    Remover Compromissos.
    Importar
    Remover
    Inicia a importação do arquivo .csv selecionado
    Efetua a exclusão dos compromissos selecionados.
    08

    09.

     

    API UTILIZADAS

    Descrição
    Totvs custom tabs box items
    defaultyesno
    referenciacalendario

    CONTEÚDO

    1. Visão geral
    2. Exemplo de utilização
    3. Tela html.fiscalCalendar - Calendário/Lista - Parâmetros e ações
    4. Tela html.fiscalCalendar - Detalhamento da Entrega - Compromisso selecionado
    5. APIs Utilizadas

    ÍNDICE

  • 01. VISÃO GERAL
  • 02. EXEMPLO DE UTILIZAÇÃO
  • 03. TELA html.fiscalCalendar - CALENDÁRIO/LISTA - PARÂMETROS E AÇÕES
  • 04. TELA html.fiscalCalendar - DETALHAMENTO DA ENTREGA - COMPROMISSO SELECIONADO 
    • 05. APIS UTILIZADAS

    01. VISÃO GERAL

    Após o cadastro dos compromissos no calendário, as entregas poderão ser visualizadas no calendário fiscal. Há duas possibilidades de agrupamento de entregas, por data de entrega na forma de calendário, ou por estabelecimento na forma de lista. Em ambos os casos, as entregas serão visualizadas mês a mês. Cada entrega possui uma situação que pode ser atualizada, e permite que sejam anexados diversos comprovantes ou arquivos complementares.

    02. EXEMPLO DE UTILIZAÇÃO

    Na visão Calendário, os compromissos são agrupados pela data de entrega

    image2020-11-3_13-38-5.pngImage Removed

    .

    Quando há mais de um compromisso por dia, é exibido o texto Ver mais no topo da célula correspondente. Ao clicar no texto, será aberto um quadro na lateral direita do calendário, com todos os compromissos do dia.

    image2020-11-3_13-33-30.pngImage Removed

    Na visão Lista o agrupamento é feito por estabelecimento. Cada estabelecimento possui a sua lista retrátil de compromissos.

    image2020-11-3_14-23-15.pngImage Removed

    Detalhamento

    Ao selecionar uma célula, é possível visualizar um detalhamento da entrega para alteração de situação e relacionamento de anexos.

    image2020-11-3_15-38-48.pngImage Removed

    As diferentes situações no status são apresentadas com diferentes cores:

    • Vermelho = pendente e atrasado;
    • Laranja = pendente e em dia;
    • Azul claro =  entregue;
    • Azul = em retificação; 
    • Verde = retificado.

    03. TELA html.fiscalCalendar - CALENDÁRIO/LISTA - PARÂMETROS E AÇÕES

    Principais Campos e Parâmetros

    Campo

    Descrição

    BuscarFiltra os compromissos pela descrição.
    Status do CompromissoFiltra os compromissos de acordo com a situação selecionada. Quando não há nenhuma opção selecionada, todas as opções são consideradas.
    EsferaFiltra os compromissos de acordo com a esfera selecionada. Quando não há nenhuma opção selecionada, todas as opções são consideradas.
    ResponsávelFiltra os compromissos de acordo com o responsável selecionado. Quando não há nenhuma opção selecionada, todas as opções são consideradas. Para o administrador, todos os responsáveis que possuem algum compromisso são apresentados, já para o usuário comum, apenas os seus compromissos são apresentados.
    EstabelecimentoFiltra os compromissos de acordo com o estabelecimento selecionado. Quando não há nenhuma opção selecionada, todas as opções são consideradas. Para o administrador, todos os estabelecimentos que possuem algum compromisso são apresentados, já para o usuário comum, apenas os estabelecimentos relacionados aos seus compromissos são apresentados.

    Outras Ações / Ações relacionadas

    Ação

    Descrição

    Novo CompromissoRedireciona para o cadastro de compromissos.
    CalendárioAlterna a visualização para o modo calendário.
    ListaAlterna a visualização para o modo lista.
    HojeNavega para o período atual.
    Anterior ( < )Navega para o período anterior ao apresentado.
    Próximo ( > )Navega para o período posterior ao apresentado.
    AplicarAplica os filtros selecionados.
    Ver maisEssa ação é exclusiva do modo calendário. É apresentada quando há mais de uma entrega para o dia em questão. Abre um painel lateral com a lista completa de entregas.
    Alterar StatusEssa ação é exclusiva do modo lista. Abre o detalhe do compromisso para alteração de status e relacionamento de anexos. No modo calendário, essa ação é executada
    clicando sobre o compromisso, tanto no próprio calendário quanto no painel lateral
    clicando sobre o compromisso, tanto no próprio calendário quanto no painel lateral.
    Detalhes do CompromissoNo modo de lista, esta ação é disponibilizada por meio de um link presente no código do compromisso apresentado na listagem. Redireciona o usuário para o compromisso no modo de visualização.


    04.     TELA html.fiscalCalendar - DETALHAMENTO DA ENTREGA - COMPROMISSO SELECIONADO 

    Principais Campos e Parâmetros

    Campo

    Descrição

    DescriçãoDescrição do compromisso detalhado
    StatusStatus atual do compromisso
    Data de EntregaData de entrega do compromisso.
    EstabelecimentoEstabelecimento correspondente do compromisso na estrutura código - nome.
    Novo StatusCampo editável para alteração de status do compromisso.
    Lista de anexosTodos os anexos relacionados à entrega do compromisso detalhada são listados abaixo do botão Selecionar arquivos.

    Outras Ações / Ações relacionadas

    Ação

    Descrição

    Ação

    Detalhar compromissoRedireciona o usuário para o compromisso no modo de visualização.
    Selecionar arquivosAbre a janela para selecionar um ou mais arquivos para serem anexados ao compromisso.
    Eliminar anexoSolicita a eliminação do anexo correspondente. Essa ação será efetivada somente se for clicado no
    botão 
    botão Salvar.
    SalvarSalva a alteração de status do compromisso e os anexos relacionados.
    CancelarFecha a tela de detalhamento sem efetivar nenhuma das alterações solicitadas.

    05.

     

    APIS UTILIZADAS

    Conceitos

    ...