Client NeoGrid 5 2

Fazer download em pdf ou txt
Fazer download em pdf ou txt
Você está na página 1de 18

Manual do Usuário

Client NeoGrid 5.2

Versão
Versão 1.00
2.37
www.neogrid.com | Página 2

Copyright NeoGrid - Todos os direitos reservados

Todas as informações contidas neste documento são de propriedade exclusiva da NeoGrid e seu uso é regulado pela Lei
9.610/98 - Lei dos Direitos Autorais e pelo Contrato de Prestação de Serviços firmado entre a NeoGrid e seus Clientes. É
proibido: copiar, reproduzir, traduzir, adaptar, modificar, alienar, vender, locar, sublocar, ceder, ou transferir esta
documentação, no todo ou em parte, sem prévia e expressa autorização da NeoGrid.
www.neogrid.com | Página 3

Sumário
1 Visão Geral ................................................................................................................................... 4
2 Requisitos ...................................................................................................................................... 4
3 Download do NeoGrid Client .................................................................................................... 5
4 Ativação do Código de Acesso................................................................................................ 6
5 Primeira Execução do NeoGrid Client ...................................................................................... 8
6 Funcionamento ......................................................................................................................... 10
7 Instalação Windows Service .................................................................................................... 11
8 Utilizando o NeoGrid Client ...................................................................................................... 12
9 Envio de Arquivos ...................................................................................................................... 14
10 Recebimento de Arquivos ..................................................................................................... 15
11 Perguntas Frequentes............................................................................................................. 16
12 Central de Atendimento ....................................................................................................... 17
www.neogrid.com | Página 4

1 Visão Geral

Bem-vindo ao manual da versão 5.2 do NeoGrid Client. Este é o software padrão da NeoGrid para os processos de
envio e recebimento de documentos usando protocolo de conexão segura.

O Processo de envio de documentos é executado buscando os arquivos do diretório de saída para enviá-los aos
servidores da NeoGrid.

O Processo de recebimento armazena no diretório de entrada seus arquivos disponibilizados pelos servidores da
NeoGrid.

Nas próximas seções serão apresentadas mais informações como requisitos básicos para o funcionamento do NeoGrid
Client, download, execução, possíveis configuração e problemas frequentes.

2 Requisitos

Para a instalação do NeoGrid Client são necessários os seguintes pré-requisitos:

• Processador Intel Pentium 1.90GHz;


• 2 GB de memória RAM;
• Conexão com a Internet;
• 300 MB disponíveis em disco para a aplicação;
• Sistema Operacional Windows ou Linux compatível com Java 8 Update 92.

Seguem abaixo algumas definições de endereço e porta para os usuários com acesso à internet via banda-larga que
utilizam firewall:

• Endereço: webedi.neogrid.com
• Conexão tem saída no protocolo HTTPS: porta 443 (Certificado com criptografia 256 bits)
www.neogrid.com | Página 5

3 Download do NeoGrid Client

O download do NGClient deve ser feito pelos links conforme o sistema operacional e versão.

- Windows 64 bits

- Windows 32 bits

- Linux 64 bits

- Linux 32 bits

- Sem JRE
www.neogrid.com | Página 6

4 Ativação do Código de Acesso

Após seu cadastro na NeoGrid você receberá um e-mail (imagem 1) para ativação do seu código de acesso e cadastro
da senha, esses dados serão usados na inicialização do NGClient. Para ativação basta clicar no link sublinhado.

Imagem 1: E-mail de ativação de usuário.


www.neogrid.com | Página 7

Você será direcionado para uma página onde fará o cadastro de sua senha de acesso e pergunta secreta (imagem 2).

Imagem 2: Cadastro da senha e pergunta secreta.


www.neogrid.com | Página 8

5 Primeira Execução do NeoGrid Client

Windows:
Descompactar o arquivo “.zip” (imagem 3) recebido no download em um diretório (ex.: C:\).

Imagem 3: Descompactar NeoGrid Client.

Para iniciar, execute como administrador da máquina o arquivo “NeoGridClient\ngclient.bat” pela primeira vez será
necessário informar o código de acesso e a senha (imagem 4).

Imagem 4: NeoGrid Client iniciando pela primeira vez.


www.neogrid.com | Página 9

Após escolha a linguagem e ambiente, é necessária a inserção dos dados de login há serem validados. A senha
informada será automaticamente criptografada e o NeoGrid Client estará em execução.

• Linguagens disponíveis: Português (padrão), Inglês e Espanhol


o Digite ‘2’ para selecionar Inglês
o Digite ‘3’ para Espanhol
o Digite ‘Enter’ ou qualquer outra tecla para Português

• Ambientes disponíveis: Produção (padrão) e Teste


o Digite ‘2’ para selecionar o ambiente de Teste (webedi-teste.neogrid.com)
o Digite ‘Enter’ ou qualquer outra tecla para Produção (webedi.neogrid.com)

OBS.: buscando uma maior segurança o código de acesso é um conjunto único de 20 caracteres e ao digitar a senha o
usuário não verá os caracteres informados.

Após a primeira execução com sucesso do NeoGrid Client, os tipos de documentos enviados e recebidos deverão ser
configurados pela equipe de Entrega ou Suporte da NeoGrid. Para falar com Suporte NeoGrid utilize os canais de contato
disponíveis aqui.

ATENÇÃO: a NeoGrid não se responsabiliza pela perda de senhas ou pelo uso indevido de senhas digitadas pelo
usuário. A criptografia utilizada pelo software é apenas uma funcionalidade que busca auxiliar na segurança do NeoGrid
Client.
www.neogrid.com | Página 10

6 Funcionamento

O NeoGrid Client é considerado um software não invasivo. Isto significa que todas as requisições são feitas do servidor
do Cliente para o servidor da NeoGrid. Tanto para envio quanto para recepção, todas as chamadas são sempre de saída.
O NeoGrid Client não é servidor, portanto não abre nenhuma porta de comunicação no servidor do Cliente.

Toda comunicação entre os servidores da NeoGrid e o NeoGrid Client é feita utilizado HTTPS, código de acesso único
e senha criptografada.

Imagem 5: Infraestrutura de chamadas do NeoGrid Client.


www.neogrid.com | Página 11

7 Instalação Windows Service

É possível realizar a execução automática do NeoGrid Client através do Gerenciador de Serviços Windows. Para isso,
siga as etapas abaixo:

1. Acessar a máquina/servidor como administrador.


2. Executar o arquivo NeoGridClient\installService.bat e após a mensagem de sucesso aparecer pressione
qualquer tecla para a tela de prompt fechar, esse arquivo irá fazer a instalação do serviço.
3. Executar o arquivo NeoGridClient\startService.bat e após a mensagem de sucesso aparecer pressione
qualquer tecla para a tela de prompt fechar, esse arquivo irá iniciar o serviço e deixa-lo executando em
segundo plano.

OBS.: Caso exista a necessidade de executar mais de um NeoGrid Client na mesma máquina/servidor, devem ser
alterados os valores de “service_name” e “display_name” dentro do arquivo NeoGridClient\ setServiceName.bat,
diferenciando assim o nome do serviço em execução e mitigando qualquer divergência de duplicidade.

Ex.: NeoGrid Client 1: “SET service_name=ngclient_edi” / “SET display_name=NeoGrid Client EDI”


NeoGrid Client 2: “SET service_name=ngclient_visibilidade” / “SET display_name=NeoGrid Client Visibilidade”

Para remover o NeoGrid Client, é necessário fazer a desinstalação do serviço:

1. Acessar a máquina/servidor como administrador.


2. Execute o arquivo NeoGridClient\stopService.bat e após a mensagem de sucesso aparecer pressione
qualquer tecla para a tela de prompt fechar, esse arquivo irá interromper a execução do serviço.
3. Execute o arquivo NeoGridClient\uninstallService.bat e após a mensagem de sucesso aparecer pressione
qualquer tecla para a tela de prompt fechar, esse arquivo irá desinstalar o serviço.
4. Excluir a pasta do programa.
www.neogrid.com | Página 12

8 Utilizando o NeoGrid Client

Para executar o NeoGrid Client, basta executar o arquivo “ngclient.bat” que está posicionado dentro da pasta raiz
do Client (pasta NeoGridClient). Dependendo da configuração do sistema, o nome do arquivo pode ser exibido somente
como “ngclient”, sem a extensão.

O NeoGrid Client necessita ter permissões administrativas na máquina/servidor que está sendo executado, para que
seja possível realizar a leitura, escrita e criação de arquivos no diretório raiz da instalação do NeoGrid Client.

Em alguns casos, quando não há permissão local de administrador, precisamos executar passos complementares para
executar o NeoGrid Client. Os passos a seguir se aplicam para as versões do Windows: Windows XP, Windows 7, Windows
8 ou Windows 10. Caso seu sistema não seja um dos sistemas listados, ou são necessárias mais informações sobre a
execução do administrador, por favor verifique a referência Microsoft no site:

https://msdn.microsoft.com/pt-br/library/hh831491(v=ws.11).aspx#BKMK_cmd

1 - Clicar no Menu Iniciar -> digitar “cmd” -> clicar com o botão direito do mouse no Prompt e “Executar”
2 – Já no “Prompt” acesse a raiz NeoGrid Client digitando -> cd ‘caminho do download realizado\NeoGridClient\’
3 - Na raiz do diretório do NeoGrid Client é possível executar as funcionalidades desejadas. Ex.: installService.bat e
startService.bat (quando serviço) e ngclient.bat (execução normal)
www.neogrid.com | Página 13

O procedimento padrão prevê a execução de um processo composto de quatro fases macro, na seguinte ordem:

1. Autenticação
2. Envio de documentos para a NeoGrid;
3. Recebimento de documentos;
4. Geração do relatório da execução (desabilitado por padrão);

É possível escolher quais processos serão executados em cada NeoGrid Client conforme sua necessidade. Por padrão
o software é executado no modo automático, executando a checagem dos documentos para enviar e receber no intervalo
de 30 minutos.

O software não apagará os arquivos nos diretórios, irá apenas movê-los para o diretório correspondente ao seu
estado. Fica sob responsabilidade do usuário limpar estes diretórios periodicamente e evitar problemas de disco cheio.

Abaixo estão as configurações dos diretórios principais, dentro dos quais serão armazenados todos os documentos
recebidos e enviados para a NeoGrid. Caso as opções abaixo não atendam suas necessidades, entre em contato com a
NeoGrid.
Diretórios Padrões:
• Diretório onde serão armazenados os arquivos recebidos:
default = NeoGridClient\documents\in
• Diretório onde deverão ser depositados os arquivos para envio aos servidores do NeoGrid:
default = NeoGridClient\documents\out
• Diretório onde ficam arquivos em transmissão, em recepção e, em casos excepcionais, em erro:
default = NeoGridClient\documents\tmp
• Diretório onde ficam arquivos que tiveram erro de transmissão ou que foram rejeitados por algum critério
pré-acordado, por exemplo, reenvio de documento:
default = NeoGridClient\documents\error
• Diretório onde ficam arquivos corretamente enviados para a NeoGrid:
default = NeoGridClient\documents\sent

Configurações Específicas:
• Codificação usada na compactação dos arquivos trafegados entre o Client e o Server NeoGrid:
default = ISO-8859-1
• Quebra de linhas padrão Windows (CRLF) ou Unix (LF):
default = CRLF
• Tipo de escrita do conteúdo no processo de recebimento, escrita em texto (text) ou escrita em binário (bin)

default = binário (bin)


www.neogrid.com | Página 14

9 Envio de Arquivos

Para enviar documentos para a NeoGrid basta depositar os arquivos no diretório de Saída. Por padrão o diretório de
saída é NeoGridClient\documents\out. Caso houver um arquivo na pasta de saída ele será enviado para os Servidores da
NeoGrid de acordo com o tempo de intervalo de execução determinado e estará disponível por padrão no diretório
NeoGridClient\documents\sent.

O processo segue os seguintes passos:


1. Busca todos os arquivos no diretório de Saída;
2. Para cada arquivo encontrado:
a. Verifica a possibilidade de leitura e escrita sobre o arquivo;
b. Se o diretório/nome do arquivo contém os caracteres correspondentes a algum tipo de documento:
i. Identifica o tipo de documento;
ii. Move o arquivo para o diretório temporário;
iii. Transfere arquivo para a NeoGrid;
iv. Move o arquivo para o diretório de enviados.

Se ocorrer algum problema durante a transferência este arquivo continuará no diretório temporário (por padrão
NeoGridClient\documents\rec_out). Caso o servidor NeoGrid o rejeite ele será movido para o diretório de erro (por
padrão NeoGridClient\documents\error).

Problemas na transferência de um arquivo não interrompem o processo de envio como um todo. O programa tentará
enviar os demais arquivos disponíveis no diretório. O procedimento de transmissão do NeoGrid Client garante que: ou o
conteúdo do arquivo é enviado completamente ou nenhuma parte do arquivo é enviada, descartando a possibilidade de
documentos parcialmente enviados.
É importante observar que se existir um lote de documentos dentro do mesmo arquivo, por exemplo, um mesmo
arquivo conter mais de uma nota ou pedido, o lote é avaliado isoladamente pelo sistema NeoGrid e caso algum deles
apresente problemas todo o lote será recusado. Arquivos enviados com sucesso para a NeoGrid sofrerão ainda um processo
de validação sobre o seu conteúdo e só então serão enviados para o destinatário.

O Neogrid Client também possui a funcionalidade de monitorar uma estrutura de repositório externa pré definida pelo o
usuário, monitorando os seus eventos de criação de arquivos com o objetivo de realizar uma cópia para o diretório de
saída “NeoGridClient\documents\out”. Para o uso desta funcionalidade torna-se obrigatório modo de execução em
serviço de iteração contínua (daemon), recomenda-se que o tempo de iteração seja no mínimo de 30 minutos.
www.neogrid.com | Página 15

10 Recebimento de Arquivos

Os arquivos disponibilizados pelos servidores da NeoGrid serão recebidos pelo NeoGrid Client e armazenados no
diretório de entrada, por padrão esse diretório é NeoGridClient\documents\in. Os arquivos continuarão armazenados na
NeoGrid para efeito de backup por um tempo determinado em contrato.

O processo é composto dos seguintes passos:


1. Verifica os tipos de documentos a receber;
2. Realiza uma busca nos Servidores NeoGrid dos arquivos disponíveis;
3. Realizar o download dos arquivos no diretório temporário;
4. Mover os arquivos para o diretório de entrada;
5. Notificar a NeoGrid da entrega efetivada.

A confirmação de recebimento dos arquivos é executada somente após os arquivos serem armazenados no diretório
de entrada, caso o nome do arquivo recebido já exista no diretório, por padrão é concatenado um número único que
identifica o momento exato do recebimento do arquivo (timestamp) ao nome/nomenclatura do arquivo. É possível alterar
o nome do arquivo durante seu recebimento, configurando a máscara de entrada. Caso a definição padrão de nomes não
supra as necessidades e ocorra qualquer erro entre em contato com a NeoGrid. Para falar com Suporte NeoGrid utilize
os canais de contato disponíveis aqui.
www.neogrid.com | Página 16

11 Perguntas Frequentes

O que é a mensagem “Serial inválido”?


Mensagem de serial inválido indica que sua distribuição do NeoGrid Client não foi ativada nos servidores da NeoGrid.

Como é possível resolver problemas com caracteres especiais na interface do NeoGrid Client executando no
Windows?
Para apresentação das mensagens com os devidos caracteres especiais é necessário o CMD esteja sendo executado
com a fonte Lucida Console. Caso a fonte não esteja correta siga as seguintes instruções para ajustar:

1 – Clicar no botão iniciar -> digitar “executar” -> digitar CMD e pressionar ENTER.

2 – Com CMD aberto clicar na barra de títulos e em Propriedades.


www.neogrid.com | Página 17

3 – Selecionar a aba Fonte, no campo Fonte selecionar Lucida Console e clicar em OK.

Como é possível resolver problemas com caracteres especiais na interface do NeoGrid Client executando no
Linux via PuTTY?

É necessário alterar o “remote character set” para UTF-8, seguindo: change settings... -> Window -> Translation ->
Remote character set = UTF-8.

12 Central de Atendimento
Entre em contato conosco através dos canais disponíveis no site:
https://www.neogrid.com/br/contato
www.neogrid.com | Página 18

https://www.neogrid.com/br/contato

Você também pode gostar