Manual do módulo de eSocial - Ives
INTRODUÇÃO.
Este manual tem por objetivo ensinar o usuário a trabalhar com os sistemas Ives – Integrador e Validador para o Esocial. Qualquer sugestão de melhoria será bem-vinda.
Este sistema foi desenvolvido para funcionar em ambiente Web e Smartfone usando tecnologia de última geração.
Para acessar, basta informar o link em um navegador homologado e informar o usuário e senha. O Link de acesso será fornecido para o cliente mediante contrato de uso.
Navegadores homologados: Google Chrome, Mozilla Firefox e Edge/IE da Microsoft.
GLOSSÁRIO.
Esocial – Sistema de Escrituração Digital das Obrigações Fiscais, Previdenciárias e Trabalhistas (eSocial) do governo federal.
VERSÕES.
| Versão | Data Liberação | Descrição das alterações. |
|---|---|---|
| 22.11.1 | 24/11/2022 | Correção para excluir a parte do Reinf |
| 20 05.1 | 12/05/2020 | Conversão desse manual para versão web on line |
| 18 05.1 | 31/05/2018 | Acrescentada as opções de resumos. Sessão 12. |
| 18 04.1 | 17/04/2018 | Acrescentada as opções de relatórios. Sessão 11. |
| 18 01.1 | 05/01/2018 | Primeira versão. |
DIAGRAMA DE FUNCIONAMENTO.
1 - Esquema de funcionamento do Ives.
Na figura acima mostra o esquema de funcionamento dos sistemas Ives. Para melhor entendimento dividimos o esquema em quatro sessões a seguir: Data Entry (entrada de dados), ETL (extração de dados), eSocial e Mensageria.
Quando os dados são digitados (Data Entry) diretamente nas telas estes dados são armazenados diretamente nas tabelas de dados do sistema e é feita as validações em tempo real.
Quando os dados são inseridos por integração através de arquivos .txt ou .xml, estes dados são extraídos (ETL) desses arquivos para as tabelas de interface e feitas as validações de estruturas e regras de negócios. Se nesse processo for detectado algum evento com estrutura ou regra de negócio inconsistente, é gerado um relatório de erros mostrando as inconsistências. Os eventos que tiverem consistentes são gravados nas tabelas de movimentação do sistema.
Uma vez que estes dados estão nessas tabelas, são executados processos que fazem as validações usando as regras descritas neste manual. Se nesse processo for detectado algum evento com inconsistências é gerado um relatório de erros mostrando as inconsistências. Os eventos que tiverem consistentes são gravados em arquivos no formato xml ficando prontos para serem enviados para o governo
A mensageria faz o controle de envio dos arquivos xml para o governo e retornos destes para o Ives.
ACESSO AO SISTEMA.
Login – Acesso ao sistema.
2 - Tela de entrada no sistema.
Informe o usuário. Para o primeiro acesso usar a senha genérica 123. Esta senha deve ser trocada no primeiro acesso. Caso esqueça a senha clique em “Esqueceu sua senha?” Será enviada uma senha provisória para o e-mail do usuário cadastrado. Sempre que receber uma senha provisória substitua a por outra no primeiro acesso. As opções do sistema podem ser acessadas pelo “Menu lateral” ou pelo “Menu de ícones”
Menu Lateral.
3 - Tipos de menus. 
1 – “Menu lateral” – Para acessar, clique na lateral esquerda da tela.
Mostra as opções principais. Á medida que for clicando sobre elas vai mostrando as opções de nível inferior até o ultimo nivel.
1.1 – Tipo de menus – detalhes
4_1 - Sessões 
4_2 – Sub-sessões 
4_3 – Opções 
2 – “IVES” – é o nome do usuário ativo conectado ao sistema. Clicando sobre ela, mostras as opções 3, 4 e 7.
3 – “Alterar senha” - opção para alterar a senha. Clicando sobre essa opção será mostrado o formulário “alteração de senha”, informe os campos “Senha Atual”, “Nova Senha” e “Confirmação da Nova Senha” e clique no botão “Confirmar”.
4 – Help-Desk – Clicando nessa opção chama o sistema de Help-Desk para abertura de chamados. Para ter acesso ao sistema de Help-Desk o usuário do Ives, também tem que ser usuário dele.
5 – Mostra a opção “Painel de Controle” no menu lateral e no menu de ícones
6 – Mostra a opção “Relatórios” no menu lateral e no menu de ícones
7 – Log-Out – Clicando nessa opção o usuário se desconecta do sistema.
MENU GLOBAL.
5 - Menu global por ícones.
A figura 9 mostras os ícones dos principais módulos do sistema. Á medida que for clicando sobre eles vai mostrando as opções de nível inferior até o ultimo nível.
Clicando no ícone indicado pela seta 1 (globo), mostra a tela do “Menu Global”.
6- Menu de configuração e sistemas adquiridos.
O Menu Global é composto pelo ícone que tem as opções de administração do sistema e os ícones dos módulos ou sistemas adquiridos pelo cliente.
Administração.
Clique no ícone “Administração” da tela acima para acessar as opções de administração.
Empresas.
7 - Menu “Administração” - Empresas
Para cadastrar empresas clique no ícone “Empresas” para acessar a tela de relação (lista) de empresas já cadastradas. Clique no ícone “Voltar” para voltar para o menu anterior.
8 - Lista de empresas usuárias e acesso a manutenção.
Por padrão, o usuário acessa o sistema com a empresa que adquiriu o sistema, com os dados principais cadastrados, como mostrado na figura acima.
Para alterar clique no ícone “Lápis” para mostra a tela abaixo, com os dados da empresa principal.
9 - Empresa usuária – alteração.
Faça as alterações desejadas. Caso tenha dúvida quanto ao preenchimento dos campos clique sobre o texto em azul para mostrar a janela de ajuda com a explicação referente ao campo. Clique em “Salvar” para salvar os dados informados, ou em “Deletar” para excluir uma empresa cadastrada ou em “Cancelar” para voltar para a opção anterior.
Para cadastrar outras empresas clique no botão “Criar”.
Usuários.
10 - Menu “Administração” - Usuário
Para cadastrar usuários clique no ícone “Usuários” para acessar a tela de relação (lista) de usuários já cadastrados.
Cadastro de usuários.
11 - Lista de usuários.
A figura acima mostra o relatório de usuários cadastrados. Para cadastrar outros usuários, clique em “Criar” e para alterar clique no ícone “Lápis”, ou clique no botão “Voltar” para voltar para a tela anterior.
12 - Manutenção no cadastro de usuário.
A figura acima mostra a aba “Manutenção Cadastro de Usuário”, permite cadastrar ou alterar os dados cadastrais do usuário. A tela é dividida em duas regiões (A e B). Na região “A” deve ser informado os dados principais do usuário e na região “B” deve ser informada as empresas que o usuário terá direito de acesso.
Para informa a empresa que o usuário terá direito de acesso, clique no botão “Adicionar Linha” (2) que será adicionada uma linha com os campos em branco para serem preenchidos. Clique em “3” e selecione uma empresa da lista, Clique em “4” e selecione da lista se a empresa é a principal ou não. O campo “Perfil” em “5”, deve ser selecionado (informado) somente se o perfil do usuário para essa empresa for diferente do perfil informado na região “A”. Clique em “Salvar” (9) para salvar as informações. Caso seja necessário adicionar mais empresas para o usuário clique no botão “Adicionar várias empresas” (6) que será mostrada a tela abaixo.
13 - Adicionando empresas para usuários 
Faça as ações indicadas para adicionar empresas para o usuário.
Caso precise excluir empresas de um usuário, siga os passos abaixo.
14 - Exclusão de empresas do usuário 
Clique em 1, depois em 2, depois em 3. Faça o mesmo para todas as linhas que deseja excluir. Depois clique em 4 (Salvar). Para excluir os dados da regia “A” e “B”, clique no botão “Deletar” (6). Clique em “Cancelar” (5) para voltar para a tela anterior.
Perfil.
15 - Menu “Administração” - Perfil 
Clique aqui para acessar o cadastro de perfil
O sistema trabalha com perfis de acesso para controlar o aceso dos usuários às opções do menu.
Quando o usuário acessa o sistema pela primeira vez, o acesso é feito no perfil “Administrador”. Este perfil dá acesso completo a todos submodulos e opções do sistema.
Por questão de segurança é importante que este usuário crie outros perfis com acessos restritos às opções do menu que os usuários vão acessar.
Dica: crie um perfil desabilitando as opções de “Usuário” e “Parâmetros” para os usuários não administradores.
Cadastro de Perfil.
16 - Lista de perfis. 
A figura acima mostra o relatório com os perfis cadastrados. Clique em “Criar” para acessar a tela de manutenção no perfil.
17 - Manutenção no perfil. 
1- Opções do menu:
Clique no ícone para expandir somente uma parte do menu.
Clique no ícone para contrair somente uma parte expandida do menu.
Quando a opção tiver marcada é porque o usuário tem acesso à opção.
Quando a opção tiver desmarcada é porque o usuário não tem acesso à opção.
Marque as opções que deseja liberar para o perfil.
2 – Clique no botão “Salvar” (2) para salvar as informações digitadas.
3 – Caso precise excluir um perfil, clique no botão “Deletar” e confirme clicando em OK.
4 – Botão para configurar as permissões de consultas. Clicando nesse botão será mostrada a próxima tela.
18 - Configuração de permissões 
O Botão “Permissão de Consulta”, permite configurar o menu para liberar opções do menu apenas para consulta. Para permitir que um usuário acesse uma opção apenas como consulta, marque a opção com . A opção liberada nessa tela tem prioridade sobre as opções liberadas na tela de cadastro de perfil. Isto é: se no cadastro de perfil foi liberada a opção “Cadastro de usuário” e nesta tela também foi liberada esta opção, então o usuário terá somente direito de consulta.
LUPA.
Clicando em (lupa), abre uma caixa de texto.
19 - Acesso a opções pela lupa 
A lupa é uma facilidade implementada no Ives para o usuário encontrar qualquer programa (pagina) digitando o nome ou parte dele.
Digite um nome ou parte dele para encontrar a opção desejada e clique sobre ela para acessar a opção. A figura acima monstra o resultado de uma pesquisa onde foi informado “S-10”. O ícone de acesso foi colocado nessa posição para facilitar o acesso, pois poderá ser acessado de vários pontos do sistema.
FILTRO PADRÃO.
Para acessar a tela de configuração do filtro padrão do Ives, clique no ícone (filtro). Veja a tela abaixo. O ícone de acesso foi colocado nessa posição para facilitar o acesso, pois será acessado de vários pontos do sistema. As alterações feitas nessa tela só sortirão efeitos para o usuário que está conectado no momento. Portanto cada usuário poderá configurar seu filtro padrão de acordo com sua necessidade.
20 - Tela do filtro padrão. 
O filtro padrão é usado para filtrar as informações mostradas na tela acima para fins de consultas ou relatórios. As informações dessa tela não alteram os parâmetros do sistema.
1 – Serão disponibilizadas as empresas que o usuário tem direito de acesso. As empresas que tiverem na caixa da direita, serão as empresas que o sistema considerará em todas as suas operações. 2 – É o período que o sistema vai considerar em todas as suas operações; 3 – É a situação que o sistema vai considerar em todas as suas operações. Exemplificando: Na figura acima, podemos dizer que o sistema só aceitará importar arquivos para a empresa “Compliance Soluções Ltda”, com data de 08/02/2017 e só disponibilizará para manutenção ou mostrará no painel de controle os eventos que tiverem na situação “Liberado” ou “Pendente”.
4 – Identificação do ambiente que se pretende fazer consultas ou ver relatórios. 5 - Sempre que fizer alguma alteração nos campos da tela, clicar no botão “Aplicar Filtro” para salvar as alterações.
Observação: O conceito de situação para o Ives, será detalhado mais adiante.
21 - Ícones das opções do iVeS 
EVENTOS DO ESOCIAL.
Os ícones da tela abaixo mostram os “Eventos do eSocial” – Acessa os eventos iniciais e de tabelas, eventos periódicos e eventos não periódicos. Veja a tela abaixo.
22 - Ícones dos eventos do eSocial 
Eventos iniciais e de tabelas.
Clique no ícone “eventos iniciais e de tabelas” para acessar a tela abaixo.
23 - Opções dos eventos iniciais e de tabelas. 
Essa tela mostra todos os ícones para acessar os eventos iniciais e de tabelas.
Detalhes de uma tela de relatório.
Abaixo uma explicação detalhada de uma tela de relatório do sistema. Todas as telas seguem o mesmo padrão. Vamos pegar como exemplo a tela do evento S-1000.
24 - Entendimento de uma tela de relatório. 
A figura acima mostra as opções de manuseio de uma tela de relatório. Abaixo estão detalhadas cada uma dessas opções na sequência da numeração.
1 – Identificação da tela – Quando a identificação é muito grande fica abreviada por 3 pontos, mas colocando o cursor sobre a identificação mostra a identificação completa;
2 – Sequência do menu até chegar na opção desejada separadas por barras invertidas, sempre mostrada na cor azul. O último é a identificação da tela resumida, no exemplo acimo o “S-1000”. Clicando nas palavras em azul, retorna para o modulo ou submodulo correspondente. O ícone representa o menu inicial;
3 – Campo para pesquisa – utilizado para localizar uma determinada informação que esteja na região de relatório (item 11);
4 - Executa a pesquisa – clicando em “Ir”, executa a pesquisa com a informação digitada no item 3;
5 - Quantidade de linhas que são mostradas na região de relatório item 11;
6 - Permite escolher a quantidade de linhas que serão mostradas na região de relatório item 11;
7 - Mostra as ferramentas de manuseio do relatório. Será detalhada mais adiante;
8 – Região de cabeçalho – mostra os campos do relatório;
9 - Botão “Criar” para acessar o formulário de entrada de dados;
10 – “Lápis” – acessa o formulário de entrada de dados com os dados que estão na tela para alteração ou exclusão;
11- Região que mostra as informações em forma de relatório;
12 - Informa a quantidade de linhas mostradas na tela e a quantidade total de do relatório.
13 – Menu Lateral – mostra as opções do sistema na lateral esquerda da tela.
Manutenção de uma tela de dados.
As telas do sistema para manutenção dos eventos são padronizadas, por isso vamos usar como exemplo a tela do evento S-1000, as demais seguem o mesmo critério.
25 - Identificação do evento. 
A figura acima mostra a identificação do evento, esses dados são comuns para todos os eventos, e são preenchidos automaticamente pelo sistema, tem caráter informativo. Esses dados são atualizados de acordo com a posição que o evento está em tempos de transmissão e retorno ao ambiente do esocial do governo.
O Ives foi estruturado para receber as informações por digitação ou através de uma interface de integração por meio de arquivos no formato .txt ou xml. Para manutenção e visualização dessas informações existe uma tela para cada evento que permite realizar essas operações.
Quando acessa uma opção é mostrada uma tela com os campos em branco para incluir informações ou com as informações existentes para alterá-las, isto é um padrão para todo o sistema. Clicando no ícone “Incluir” mostra a tela com os campos em branco para preencher. Clicando no ícone “Lápis” numa tela de relatórios abre a tela com os campos preenchidos para alterar alguma informação. Sempre que alterar alguma informação clique no botão “Salvar”.
Tela de manutenção de dados.
As telas de manutenção de dados do sistema seguem o mesmo padrão. Abaixo vamos detalhar a operação dessa tela.
26 - Tela de manutenção. 
Detalhamento de acordo com os números indicados.
1 – Clicando sobre o nome do campo (label), mostra uma janela de ajuda com informações referente ao preenchimento do campo.
2 – Os campos com um “pic” são campos com opções de múltiplas escolhas. Para selecionar uma delas, clique sobre o “pic” ou sobre o campo e clique sobre a opção desejada ou digite a primeira letra da opção.
3 – Botão “Log”. Clicando nesse botão, mostra uma tela de logs com as mensagens de ocorridas em tempos de integração, envio e retorno do governo
4 – Botão “Criar”. Clicando nesse botão, cria o registro no banco de dados e salva as informações da tela.
Em algumas telas aparecem campos como os mostrados abaixo, esse são ditos campos de filtros
27 - Configuração de envio.
A figura acima mostras campos que permite ao usuário filtrar tipos de informações. O sistema vai acatar os campos que estão na caixa do lado direito. No exemplo acima o sistema vai acatar para fins de processamento os eventos S-100 e S1030 pelo fato de estarem na caixa do lago direito. Para escolher apenas um campo, clique sobre uma opção na caixa do lado esquerdo e em seguida clique na seta simples para o campo passar para a caixa do lado direito. Para passar alguns campos, pressione
Para sair de uma tela de manutenção clique no ícone (X) no canto superior direito.
28 - Ícone “Sair”
Tela para alteração ou exclusão.
29 - Manutenção do estabelecimento. 
Essa tela é mostrada quando clicado no ícone “Lápis” da tela de relatório.
1 – Botão “Log”. Clicando nesse botão, mostra uma tela de logs com as mensagens de ocorridas em tempos de integração, envio e retorno do governo;
2 – Botão “Excluir”, usado para excluir as informações que estão na tela;
3 – Botão “Salvar”, usado para salvar as informações que estão na tela. Sempre que alterar alguma informação na tela, deve se clicar nesse botão, caso contrário a alteração não terá efeito.
Eventos Periódicos.
30 - Tela para acessara as opções dos eventos periódicos. 
A figura acima mostra as opções de relatórios e manutenções dos eventos periódicos. Para acessas essas opções basta clicar sobre os ícones.
Eventos não Periódicos.
31 - Tela para acessar os eventos não periódicos. 
A figura acima mostra as opções de relatórios e manutenções dos eventos não periódicos. Para acessar essas opções basta clicar sobre os ícones.
PAINEL DE CONTROLE.
A tela abaixo mostra as opções do “Painel de Controle” – Acessa Parâmetros, Lotes de integração, Log’s mensageria e painel de eventos.
46 - Painel de controle. 
Parâmetros.
47 - Painel de controle - Parâmetros 
Clique sobre os ícones representados pelos números para acessar a tela correspondente.
Aba “Parâmetros”.
48 - Tela de parametrização.
Tela para fazer a parametrização do sistema, como detalhada a seguir de acordo com a numeração.
1 – Identificação do ambiente (eSocial): Possui as opções a seguir: 1 – Produção – o usuário deve configurar esta opção quando o empregador estiver transmitindo dados reais que terão validade jurídica. 2 – Produção restrita – Dados reais – o usuário deve configurar esta opção quando o empregador estiver transmitindo dados reais sem validade jurídica na fase de teste. 3 – Produção restrita – Dados fictícios – o usuário deve configurar esta opção quando o empregador estiver transmitindo dados fictícios sem validade jurídica apenas com a finalidade de testes.
2 – Processo de emissão do evento (eSocial): Possui as opções: 1 – Aplicativo do empregador - o usuário deve configurar esta opção quando o empregador estiver usando um aplicativo cuja responsabilidade de manter é do empregador e 2 – Aplicativo governamental – esse caso não se aplica quando o aplicativo que estiver em uso for o Ives.
3 - Mantém o Id do sistema origem?: Se esse campo tiver com o valor “Sim”, quando o evento é integrado por webservise, por arquivo .txt ou por arquivo .xml ou pelo programa integrador, será mantido o ID (identificador do evento) do sistema origem. Caso o campo tiver com o valor “Não”, o Ives gera um novo ID para o evento. O objetivo desse parâmetro é para manter o mesmo valor do identificador do evento em todo processo de envio para o Ives e para o governo e retornos para Ives e para o sistema origem. quando o cliente precisa manter o mesmo ID durante todo processo.
4 – Data inicial da implantação do eSocial: Deve informar a data em que o empregador iniciou a transmissão dos eventos para o ambiente do governo. Uma vez informada e transmitido algum evento, esta data não deve ser alterada, pois existe muitas consistências que são feitas com essa data.
5 – Desabilita processo de integração e mensageria? :Deve ser configurado por padrão como “Não”, configurar como “Sim”, mediante solicitação do fornecedor do Ives. Isto vai ser solicitado em caso de ocorrências de erros específicos que demanda depuração mais criteriosa.
6 – Número máximo de tentativa de envio: Deve ser informado o número máximo de tentativas que a mensageria vai enviar um evento sem sucesso para o ambiente do governo. Quando esse número é excedido, a mensageria coloca o evento (no painel de controle) como divergente e envia uma mensagem informando que foi excedido o número de tentativas de envios.
Aba “e-Mail’s’.
49 - Parametrização de e-mail’s’ 
Não está em funcionamento ainda.
Será implementado o processo de envio de notificação referente aos vencimentos dos certificados.
1 – Informar o e-mail da pessoa que vai receber as mensagens de notificação do sistema referente a vencimentos dos certificados. Para informar mais de um e-mail, separe os por ponto e vírgula (;). Exemplo: paulo@ig.com.br;maria@gmail.com
2 – Idem 1, com cópia.
3 – Idem 1, com cópia oculta.
Aba – “Eventos”.
50 -Parametrização de eventos. 
1 – Eventos com envio automáticos: Destina se a configurar o envio dos eventos automaticamente ou não para a mensageria. Pode haver algumas situações em que o usuário queira fazer uma verificação visual nos dados inseridos (importados) antes de enviar para a mensageria, nesse caso basta passar esses eventos para o lado direito da caixa. Os eventos que forem colocados nessas situações devem ser liberados depois no “painel de controle”, pois são mostrados como “pendentes”.
2 – Eventos incluídos no processo de validação do Ives: Com o objetivo de diminuir ao máximo erros de validações ao enviar os eventos para o ambiente do governo, foi implementado no Ives processos para fazer essas validações. Estes processos são opcionais e configurado pelo usuário. Os eventos que tiverem na caixa do lado direito serão validados antes do envio, os que permanecerem na caixa do lado esquerdo não serão validados pelo Ives.
Aba – “Certificados”
Esta aba é utilizada para anexar e alterar certificados digitais tipo A1.
51 - Parametrização de certificados. 
A tela acima mostra a relação de empresas cadastradas que podem anexar ou alterar o certificado.
1 – Mostras o CNPJ raiz da empresa matriz;
2 – Monstra o nome da empresa matriz e das filiais (separadas por virgula) que usarão o certificado;
3 – Mostra o botão “anexar/alterar”;
4 – Mostra a data de validade do certificado, após a inclusão.
Clicando no botão “Anexar” ou “Alterar”, vai para a tela seguinte. Siga o procedimento abaixo para anexar certificado.
52 - Parâmetros – Aba “Eventos” – Anexar/Alterar. 
1 - Informe a senha do certificado;
2 - Informe a data de fim devalidade do certificado;
3 - Área pontilhada, local de transição do certificado até ser transferido para o Servidor;
4 - Nome do arquivo do certificado;
5 - Para anexar o certificado clique sobre a área pontilhada (3) para abrir a janela de pastas no seu computador, (a) localize a pasta onde o certificado está guardado, (b) localize o arquivo do certificado, (c) clique sobre o nome do arque e arraste até a área pontilhada (3) e solte ou clique sobre ao nome do arquivo, marque o e clique no botão abrir (6) que o arquivo vai para a área pontilhada (3) ficando como mostrado na figura abaixo.
53 - Parâmetros – Aba “Eventos” – Anexar. 
Coloque o cursor sobre o nome do arquivo, como mostrado em 1 na tela acima. Se aparecer a mensagem em vermelho “Não é permitido o envio de arquivos deste tipo” como em 2, clique em “Remover”, pois o arquivo não é um certificado tipo A1, caso contrário, clique no botão “anexar” em 3 para o arquivo ser anexado.
Para alterar um certificado, clique no botão “Alterar” e siga o mesmo procedimento.
Para efetivar as alterações deve-se clicar no botão no canto superior direito.
Todas alterações feitas nestes paramentos são registradas e mostradas em um relatório ao clicar no botão no canto superior direito. Veja abaixo o relatório de logs.
54 - Relatório de logs. 
Processos de integração
O Ives faz a integração com outros sistemas com arquivos .txt ou .xml, através de Webservice ou por aplicação ou através de um serviço instalado no servidor do cliente que enviar os arquivos para o Ives. Vamos mostrar abaixo como são feitas através de uma aplicação.
55 - Painel de controle - Lotes de Integração 
Clicando no ícone representado pelo número 2 “Lotes de integração” na tela acima mostra as opções do processo de integração.
Relação de lotes de integração.
56 - Processos de integração - Lotes de importação 
A tela acima mostra as abas que dão acesso aos processos de integração que serão detalhadas a seguir:
Aba “Lotes de integração”
1 – Relatório dos lotes importados;
2 – Informar a quantidade de dia anterior à data atual que deseja ver os lotes importados mostrados na tela.
3 – Clicando no ícone “Lápis” da tela acima, mostra a tela abaixo.
57 - log de lote de integração. 
A aba “Log” da figura acima mostra as informações resumidas referentes aos lotes importados. É Importante acessar essa tela após fazer uma importação para checar o “status” da operação e verificar as informações em “Resumo dos Registros”. Caso tenha ocorrido erros de estruturas ou de validações do Ives, será mostrada a quantidade e quantos registros ficaram divergentes. Os registros que ficaram divergentes devem ser corrigidos na origem e importados novamente.
58 - Eventos importados. 
A aba “Linhas de integração” da figura acima, mostra as informações do evento integrado na forma original. O objetivo de mostrar essas linhas na forma original é para facilitar a depuração de eventuais erros. Caso tenha ocorrido algum erro, aparecerá “SIM” na coluna “Erro”. Dica: Para mostrar apenas as linhas que tiveram erros. Clique sobre a palavra “Erro” no cabeçalho e digite “sim” em filtrar e pressione
4– Clicando sobre “Executar consistência”, da figura (Processos de integração - Lotes de importação) mostra a janela abaixo com a execução do processo de consistência e validações em ordem cronológica inversa.
59 - Execução do processo de consistência. 
Caso queira exportar essas informações para uma planilha Excel para posterior análise, basta clicar em “Exportar Log para Excel”.
Importação de XML.
60 - Processos de integração - Importação de arquivo .xml 
A figura acima mostra como importar um arquivo .xml ou um arquivo compactado que contenha arquivos .xml.
Para importar um arquivo siga os passos abaixo:
1 – Clique na aba “Importação de XML” para mostrar a figura acima;
2 – Clique com o cursor sobre a área pontilhada para mostrar a janela do Windows com as pastas onde estará os arquivos a ser importados;
3 – Localize a pasta onde estão os arquivos que deseja importar;
4 – Clique sobre o nome do arquivo para marcar;
5 – Clique em abrir (na janela do Windows) ou arraste o nome do arquivo para a área pontilhada, será mostrada a figura abaixo, clique em “remover” para desistir da operação, se for o caso ou passe para o passo seguinte;
61 – Remover xml 
6 – Clique em “Importar”. Será mostrada a figura abaixo. Clique em “cancelar” para desistir ou em “ok” para importar o arquivo selecionado para o Ives.
62 – Importar xml 
Importação de TXT.
63 - Processos de integração - Importação de arquivo .txt
A figura acima mostra como importar um arquivo .txt ou um arquivo compactado que contenha arquivos .txt.
Para importar um arquivo siga os passos abaixo:
1 – Clique na aba “Importação de TXT” para mostrar a figura acima;
2 – Clique com o cursor sobre a área pontilhada para mostrar a janela do Windows com as pastas onde estará os arquivos a ser importados;
3 – Localize a pasta onde estão os arquivos que deseja importar;
4 – Clique sobre o nome do arquivo para marcar;
5 – Clique em abrir (na janela do Windows) ou arraste o nome do arquivo para a área pontilhada, será mostrada a figura abaixo, clique em “remover” para desistir da operação, se for o caso ou passe para o passo seguinte;
64 – remover txt 
6 – Clique em “Importar”. Será mostrada a figura abaixo. Clique em “cancelar” para desistir ou em “ok” para importar o arquivo selecionado para o Ives.
65 – importar txt 
Log’s Mensageria/Integração por API.
66 - Painel de controle – Logs Mensageria 
A figura acima mostra a tela com as opções do painel de controle para acessar a opção “Logs Mensageria/Integração por API”(3).
67 - Processos de envio 
A figura acima é uma tela de log para monitorar a execução de “serviços” que são executados automaticamente (Jobs) e validação de objetos (campos, tabelas, pacotes, funções, etc) do banco de dados, com o objetivo de auxiliar na resolução de problemas que possa acontecer durante a execução desses objetos. Esses problemas deverão ser reportados ao suporte.
Painel de Eventos
68 - Painel de controle – Painel de eventos. 
A figura acima mostra a tela com as opções do painel de controle para acessar a opção “Painel de eventos” (5).
Detalhamento do painel de eventos
69 - Painel de eventos. 
A figura acima mostra o painel de controle do Ives. Através desse painel o usuário recebe as informações do que acontece com o evento em toda sua trajetória desde o momento da recepção do arquivo do ERP até o retorno do recibo de entrega do evento para o ERP do empregador. O número sobre o botão representa a quantidade de eventos que está nessa situação. Utilizado para visualizar as mensagens de erros e possíveis correções.
Abaixo o detalhamento das opções numeradas.
1 – Período – Data inicial e final da integração. Utilizado para mostrar na tela os eventos que foram integrados nesse período. Deve ser alterado pelo “Filtro padrão”.
2 – Timer - utilizado para dimensionar o tempo que essa tela será atualizada e consequentemente a atualização dos estados de envios dos eventos. Essa atualização faz-se necessária pelo fato de terem vários processos trabalhando automaticamente na manutenção dos eventos, tais como recepção, validação, envio e retorno.
3 – Tipo de registro – Mostra em qual tipo de ambiente o painel de controle está atuando no momento. Para alterar o tipo de ambiente basta clicar na opção desejada.
4 – Botão “Consistir Geral” – Força o envio de um evento que por algum motivo de transmissão tenha ficado divergente. Por exemplo: a mensageria tenta enviar um evento várias vezes seguidas até estourar o limite de tentativas, este evento será colocado como divergente, para tirá-lo dessa situação é necessário clicar em “Consistir Geral”. Esse limite é configurado na tela de parâmetros.
5 – Mostra os eventos que estão sendo monitorados ou que passaram por alguma situação.
6 – Situação - Do momento em que os eventos são incluídos no sistema até o seu aceite pelo ambiente do governo com o retorno do recibo, eles passam por algumas situações que podem ser: Cancelado, esperando uma ação, pendente, divergente, liberado, na fila de envio, aguardando governo, rejeitado ou aprovado. Essas situações serão detalhadas a seguir.
6.7 – Cancelado – um evento só pode ser colocado na situação de cancelado quando tiver na situação de pendente. Para cancelar um evento, veja abaixo o item 10.4.2 “Procedimento para cancelar um evento”.
6.8 – Ação/Liberar - Botão “liberar” – Utilizado para liberar eventos que estão pendentes.
6.9 – Pendente – Um evento fica nessa situação quando ele já passou com sucesso pelas etapas de validações e foi configurado na tela de parâmetros no campo “Registros com Envio Automático” para não ser enviado automaticamente. Nesse caso tem que ser liberado clicando no botão “Liberar” (item 6.8). Se o evento foi configurado na tela de parâmetros no campo “Registros com Envio Automático” para envio automático ele não passa por essa situação, vai direto para a situação de liberado (6.11).
6.10 – Divergente – Um evento fica na situação de divergente quando ocorre alguma anormalidade em alguma etapa de consistência. Para mudar essa situação o usuário tem que interagir, verificando o relatório de mensagens de erros, fazer uma ação (se for um erro corrigir) para que ele vá para a situação de “pendente” ou “liberado”.
6.11 – Liberado – Um evento fica na situação de liberado quando ele está pronto para ser enviado, está numa etapa de espera.
6.12 – Fila de envio – Um evento fica na situação de envio quando por algum motivo o lote enviado anteriormente ainda não retornou uma resposta do ambiente do governo, por exemplo: o evento foi enviado para o governo e ainda não voltou a mensagem de aceite (devolução do protocolo).
6.13 – Aguardando governo – Um evento fica nessa situação quando foi feito o envio e ainda não recebeu uma mensagem de aceite (devolução do protocolo). Observar que o fato do evento ter sido aceite pelo ambiente do governo, não significa que ele foi aprovado. Significa que foi aceito para fazer as devidas consistências.
6.14 – Rejeitado - Um evento fica na situação de rejeitado quando ocorre alguma anormalidade retornada pelo governo. Para mudar essa situação o usuário tem que interagir, verificando o relatório de mensagens, fazer uma ação (se for um erro corrigir) para que ele vá para a situação de “pendente” ou “liberado”. Ver abaixo item 5.4.3, procedimento para corrigir um evento rejeitado.
6.15 – Aprovado – Um evento fica na situação de aprovado quando foi retornado pelo governo o recibo de aceito do evento.
6.16 – Botões direcionadores - São botões que direciona para as telas de mensagens. O número sobre o botão representa a quantidade de eventos que está nessa situação. Utilizado para visualizar as mensagens de erros e possíveis correções.
Procedimento para cancelar um evento.
70 - Cancelamento de eventos. 
71 - Relatório de eventos. 
Escolha a linha que deseja cancelar e faça o citado acima.
72 - Tela de manutenção do evento S-1020. 
73 - Tela de manutenção do evento S-1020 - Cancelamento. 
74 - Tela de manutenção do evento S-1020 – botão de retorno. 
Procedimento para verificar a situação de evento rejeitado.
75 - Painel de eventos – Botão quantidade de rejeitados 
76 - Acesso a tela de logs 
Clique no botão “Log” para acessar a tela de logs.
77 - Aba “Log” de erros de retorno.
78 - Aba de retorno de erros 
79 - Tela com destaque na opção de retorno. 
80 - Tela com destaque na opção de correções. 
Quando o erro é referente ao preenchimento de algum campo do leiaute do evento, ele pode ser corrigido através da tela de manutenção do evento que é acessada clicando no ícone indicado acima. São os casos dos códigos 927, 8 e 1 da tela anterior a esta. Se o evento foi importado de um sistema legado através do processo de importação, é aconselhado que se faça a correção no sistema legado e depois importe novamente. Mas se o erro for de outra natureza deve se usar outro procedimento. É o caso do código 130 da tela anterior a esta.
81 - Tela mostrando a opção de edição. 
82 - Tela mostrando a opção de exclusão. 
83 - Tela com destaque para a opção de retorno. 
Geração de Eventos de Exclusão S-3000.
84 - Tela para gerar exclusão de eventos aprovados 
A finalidade do evento S-3000 é excluir eventos aprovados no ambiente do governo.
Siga os passos a seguir de acordo com os números da tela acima para gerar os eventos de Exclusões:
1 – Escolha da lista o evento que deseja excluir;
2 – Informe uma data inicial;
3 – Informe uma data final;
Serão mostrados os eventos com data de aprovação entre a data inicial e final informadas;
4 – Escolha o tipo de ambiente do governo que o evento foi enviado;
5 – Clique sobre o botão “Filtrar”, para mostrar os eventos nas condições acima informadas;
6 – Clique no local indicado pelo número 6 se quiser gerar a exclusão para todos os eventos mostrados na tela;
7 – Clique no local indicado pelo número 7 se quiser gerar a exclusão apenas para aquele evento mostrado naquela linha da tela;
8 – Clique no botão “Gerar S-3000” para gerar os eventos de exclusão.
9 – Vá ao painel de eventos e libere esses eventos para enviar para o ambiente selecionado. Aguarde a aprovação.
Altera status (condição) de eventos cancelados para pendentes.
85 – Altera status 
86 - Tela para alterar evento cancelado para pendente. 
A finalidade dessa tela é possibilitar alterar um evento cancelado para pendente.
Siga os passos a seguir de acordo com os números da tela acima para gerar os eventos de Exclusões:
1 – Escolha da lista o evento que deseja excluir;
2 – Informe uma data inicial;
3 – Informe uma data final;
Serão mostrados os eventos com data de cancelamento entre a data inicial e final informadas;
4 – Escolha o tipo de ambiente do governo que o evento foi enviado;
5 – Clique sobre o botão “Filtrar”, para mostrar os eventos nas condições acima informadas;
6 – Clique no local indicado pelo número 6 para executar a operação.
Veja no painel de eventos que eles estão na condição de pendentes.
RELATÓRIOS.
“Relatórios” – Acessa as opções Arquivados, Dowload XML e Erros dos eventos. Veja a tela abaixo.
87 - Tela de acesso aos relatórios. 
Arquivados.
A medida que vai se trabalhando com o sistema, vão sendo acumulado tipos de eventos nas situações “Rejeitados” e “Aprovados” que ficam mostrados no painel de eventos, pelos botões direcionadores explicado no item 6.16 da sessão 5.4.1 do painel de eventos. O sistema possibilita que se transfira os eventos que estão nessas situações para um local para facilitar as consultas. Esse processo de transferência para esse local chamamos de “Arquivar” representado por botões com esse nome nas telas de manutenção de evento onde é possível executar esse processo. Quando o processo é executado em uma dessas telas ele transfere apenas aquele evento. Ou pode ser executado para arquivar vários eventos de uma só vez através do botão “Arquivar Vários”. Os dois procedimentos serão detalhados a seguir.
Arquivar por telas de manutenção de eventos.
88 -Tela do painel de controle. 
Vamos detalhar o procedimento para arquivar um dos três eventos S-1020 mostrado na rela acima.
1 – Clicando no botão indicado na tela acima, será mostrada a tela seguinte.
89 - Tela que mostra o relatório do evento a ser arquivado. 
2 – Clique no ícone indicado na tela acima.
90 - Tela que mostra as opções de finalização do arquivamento do evento. 
2 – Clique no botão indicado e depois em “OK” para arquivar o evento.
91 - Painel de eventos – evento arquivado.
Veja que a quantidade de eventos agora está 2, pois 1 foi arquivado.
Arquivar vários eventos de uma vez.
Relatório de eventos arquivados.
92 - Eventos arquivados. 
Explicando a tela acima.
1 – Os campos dessa região devem ser informados para filtrar os dados que serão mostrados no relatório.
2 – Botão “Filtrar” após ter informado os dados nos campos da região 1, clicar nesse botão para mostrar as linhas do relatório.
3 – Relatório mostrado de acordo com os dados informado na região 1. Note que está mostrando o evento que foi arquivado no procedimento anterior.
4 – Clicando no botão “Arquivar Vários”, acessa a tela para arquivar vários eventos de uma vez.
Arquivar vários.
Clicando no botão “Arquivar Vários” da tela anterior, será mostrada a tela abaixo.
93 - Tela para arquivar vários certificados.
Para arquivar eventos, siga os passos abaixo.
1 – Informe os dados nos campos em “1”. Note que o campo “Código do evento” pode ser informado mais de um, basta clicar sobre o campo e escolher da lista;
2 – Clicar no botão “Filtrar”;
3 – Mostra as linhas do relatório de acordo com os dados informados em “1”, após clicar em “Filtrar”;
4 – Clicando no botão indicado, em “4” marca todas as linhas do relatório, indicado em “5”;
5 – Caso queira arquivar somente algumas linhas, selecione clicando em “5”. Só serão arquivadas as linhas marcadas. Portanto é obrigatório marcar pelo menos uma linha;
6 – Clique no botão “Arquivar” e confirme clicando em “OK”.
94 - Painel de eventos – mostrando que os eventos foram arquivados. 
Veja na tela acima que o evento S-1020 na situação “Rejeitado” e o evento S-1030 na
situação “Aprovado” não estão mais.
Erros de Admissão.
95 - Admissão 
Com o objetivo de auxiliar os usuários na identificação dos erros dos eventos S-2200 e S-2300 de admissão foi implementado no iVeS as opções abaixo.
Clique sobre o ícone indicado para acessar a tela de erros dos eventos de admissão.
96 - Tela para visualização de erros de admissão. 
1 – Informe o período (Data Inicial e Final) que deseja visualizar;
2 – Clique no ícone “Filtrar” para executar a consulta;
3 – Agrupamento para visualizar o relatório – nesse caso está agrupado por: Matricula, Cpf, Trabalhador e Ide do Ives.
4 – Mostra a descrição da mensagem de erros.
5 – Clicando em “5” marca todos os eventos mostrados na tela.
6 – Clicando em “6” marca apenas aquele evento.
7 – Botão “Arquivar” – clicando nesse botão o evento marcado em “6” ou os eventos marcados em “5” são transferidos para uma área de eventos arquivados onde o usuário não terá acesso. É como se fosse eliminado do sistema. Geralmente usa-se essa opção quando faz se a correção na origem (sistema ERP) e faz a integração novamente.
8 – Botão “Tornar Pendente” – Muda a situação do evento marcado em “6” ou dos eventos marcados em “5” para pendente. Geralmente usa-se essa opção para fazer a correção dos erros do evento no próprio iVeS e enviar novamente.
Erros por colaborador.
Fazer
Download XML.
97 - Tela mostra como são feitos os downloads de eventos.
Para fazer o download dos eventos, siga os passos abaixo.
1 – Informe os dados nos campos em “1”. Note que o campo “Código do evento” pode ser informado mais de um tipo de evento, basta clicar sobre o campo e escolher da lista;
2 – Clicar no botão “Filtrar”;
3 – Mostra as linhas do relatório de acordo com os dados informados em “1”, após clicar em “Filtrar”;
4 – Botão “Download dos selecionados”;
5 – Clicando no botão indicado, em “4” marca todas as linhas do relatório, indicado em “6”;
6 – Caso queira fazer o download somente de alguns XML, selecione clicando em “5”. Só serão feitos downloads das linhas marcadas. Portanto é obrigatório marcar pelo menos uma linha;
Erro dos eventos.
98, 99, 100 - Parâmetros e relatórios de erros
Para ver o relatório de erros, siga os passos abaixo.
1 – Informe os dados nos campos em indicado em “1”. Note que o campo “Código do evento” pode ser informado mais de um tipo de evento, basta clicar sobre o campo e escolher da lista;
2 – Botão “Filtrar” – Clique nesse botão para mostrar o relatório de acordo com os dados informados em “1”;
3 – Mostra as quebras do relatório. Na primeira parte do relatório a indicação “Código S-1005, ID do evento: 264”, significa que foi enviado um evento do tipo S-1005 e foi retornado erros nos códigos: 401, 553, 927 e 130.
4 – Clicando no ícone “Lápis” mostra a tela abaixo.
101 - Tela de manutenção de evento – Botão log. 
Está é a tela de manutenção desse evento.
Clicando no botão “Log”, indicado pela seta, será mostrada a tela abaixo.
102 - Tela de detalhes de erros. 
Está é a tela que mostra os detalhes dos erros. Esta tela foi explicada anteriormente.
Procedimento para gerar o relatório em planilha Excel.
103 - Erros dos eventos – botão “Ações”. 
1 – Clique no botão “Ações” para mostrar as opções.
104 - Erros dos eventos – opções para gerar planilha. 
2 – Clique em “Fazer Download” na janela de opções.
3 – Clique no ícone “CSV”, para gerar a planilha.
105 - Planilha gerada.
Planilha gerada com os dados do relatório de erros.
RESUMOS.
Estão implementados no Ives alguns relatórios resumos para ajudar o usuário nas consistências das informações recebidas do ERP.
Para acessar as opções dos relatórios de resumos, clique no ícone “Resumo indicado na tela abaixo.
106 - Tela de acesso ao ícone resumos. 
12.1 – Resumos dos eventos de pagamentos.
107 - Tela de acesso aos resumos 
Para acessar os relatórios dos resumos dos eventos de pagamentos, clique no ícone “Resumo de Pagamentos” indicado na tela acima.
108 - Tela de acesso aos resumos dos pagamentos dos eventos S-1200 e S-2299 
1 – Aba para parametrizar o relatório de resumo de pagamentos dos eventos S-1200 e S-2299. Os parâmetros (ou também chamados de filtros) que tem um asterisco (*) são obrigatórios. Sempre que alterar um parâmetro, deve clicar no botão “Consulta” (4) ou em “Ir” (4) para executar a consulta novamente.
Se alterar apenas os parâmetros “Agrupamentos”, clique em “Ir” para refazer a consulta.
Notar que esta aba tem duas sub abas, que são aba “Rubrica” (2) que mostra as informações referentes às rubricas informadas nos eventos e, a aba “Plano de Saúde” (3) que mostra as informações referentes a planos de saúde.
O parâmetro “Inscrição” refere-se a CNPJ das empresas usuárias.
109 - Tela de parâmetros para gerar relatório 
110 - Relatório gerados pelos parâmetros informados acima. 
111 - Tela para que mostra a sub aba “Plano de Saúde”. 
Note que nesta sub aba o parâmetro “Agrupamento” restringe-se a “Colaborador” e “Inscrição”.
112 - Tela de acesso aos resumos dos pagamentos dos eventos S-1210 
Aba “Pagamentos – Evento S-1210” (5). Para essa aba ale as mesmas considerações feitas para a aba “Pagamentos S-1200 e S-2299”.
Informe os parâmetros e cline no botão “Consultar” ou “Ir”.
12.2 – Resumos dos eventos de retorno S-5001 e S-5002.
113 - Tela de acesso aos resumos 
Para acessar os relatórios dos resumos dos eventos de retornos, clique no ícone “Resumo dos Eventos S-5001 e S-5002” indicado na tela acima.
114 - Tela de acesso aos resumos dos eventos de retornos – Aba S-5001-Contribuição Social. 
1 – Parâmetros principais, as informações desses parâmetros são usadas para as abas “S-5001 – Contribuição Social” e “S-5002 – IRRF”.
2 - Botão “Consultar” - Informe os parâmetros em (1) e clique nesse botão para executar a consulta e gerar os relatórios.
3 – Parâmetros da aba “S-5001’ – Contribuição Social”, informar esses parâmetros e clicar em “Ir” (5).
4 – São as sub abas da aba “S-5001 – Contribuição Social”. Clique sobre elas para ver as informações geradas.
5 – “Ir” – Sempre que alterar uma informação dos parâmetros indicado por (3), Clique nesse botão para refazer a consulta de acordo com as novas informações;
115 - Tela de acesso aos resumos dos eventos de retornos – Aba S-5002-IRRF 
1 – Parâmetros principais, as informações desses parâmetros são usadas para as abas “S-5001 – Contribuição Social” e “S-5002 – IRRF”.
2 - Botão “Consultar” - Informe os parâmetros em (1) e clique nesse botão para executar a consulta e gerar os relatórios.
3 – Parâmetros da aba “S-5002 – IRRF”, informar esses parâmetros e clicar em “Ir” (4).
4 – “Ir” – Sempre que alterar uma informação dos parâmetros indicado por (3), Clique nesse botão para refazer a consulta de acordo com as novas informações;
5 – Mostra o relatório.