Como obter suporte para as APIs
O presente documento visa facilitar o trabalho de comunicação entre o cliente e o nosso suporte.
Se deseja ter uma solução mais rápida, e atendimento prioritário tenha em mente os principais pontos:
- Verifique se a pasta Maker.Commons está no lugar correto;
- Coloque a versão mais atual da API e da l2s-core.jar;
- Ative o DebugMode;
- Gere o HAR e Log do erro (se for camada cliente);
- Tenha um ambiente pronto para reproduzir o erro, não damos suporte no ambiente do cliente ou produção;
- Não faça perguntas sobre itens não cobertos pelo suporte.
- Se o problema é URGENTE ou NO CLIENTE, este não é o canal. O suporte é ao desenvolvedor apenas, e tem SLA de 05 (cinco) dias. Suporte para ambiente de produção não é coberto, e pode opcionalmente ser contratado à parte.
Antes de pedir suporte
- Verifique se a função em questão foi feita pela L2MAKER;
- Verifique se você está usando a versão mais recente, se necessário atualize para a versão mais atual disponível da API;
- Remova qualquer alteração e/ou personalização que não esteja incluída no pacote oficial;
- Saiba a versão do Webrun lendo o arquivo changelog.txt no contexto do Webrun;
- Saiba a versão do Java do Tomcat;
- Saiba a versão do Maker;
- Ative (colocando o valor “1”) o modo debug (DebugMode) nas configurações do Webrun para que o botão “+ Detalhes” seja exibido:
- Pesquise na documentação pela mensagem de erro, certifique-se que não já exista documentação a respeito;
- Determine os passos para reprodução do erro.
Erros na camada cliente (HAR e Logs)
Muitas vezes para diagnósticar o erro na camada cliente será necessário enviar os logs do navegador, isso é feito exportando o HAR e o LOG com os passos abaixo.
Salvador o HAR
- Na aba do navegador onde está rodando a API clique o botão direito e escolha “Inspecionar” (por ser também “Inpsect” ou “Inspect Element”). Se a janela for um popup você deve inspecionar a Janela do popup);
- Em seguida, clique na aba “Rede” (“Network”);
- Na aba rede você deve limpar o histórico usando o segundo botão no topo esquerdo da aba, ele se chama “Clear” ou “Limpar” (ao lado do botão vermelho);
- Em seguida execute o fluxo que provoca o erro (duas ou três vezes se possível);
- Vá na lista de chamadas da rede (“Netowrk”), clique o com o botão direito e selecione a opção de exportar todo o conteúdo como HAR (“Save all HAR with content”) e salve o arquivo HAR;
Salvador o arquivo de LOG
- Agora clique na aba “Console“;
- Com o botão direito escolha a opção “Save as…” / “Salvar como…” e salve o arquivo de LOG.
Envie os dois arquivos HAR e LOG salvos.
Erros em fluxo Web
Se o fluxo Web estiver dando erro interno (500), desabilite a página de erros do Webrun para que os detalhes do erro aparece na tela;
- Acessa a pasta “WEB-INF” dentro do contexto do Webrun, e abra o arquivo “web.xml”. (EX: “/MINHACONTA/tomcat/webapps/webrun/WEB-INF/web.xml”);
- Localize o bloco de código abaixo (por volta da linha 446):
<error-page>
<error-code>500</error-code>
<location>/errors/500.jsp</location>
</error-page> - Remova o bloco e salve o arquivo web.xml;
- Reinicie o Tomcat/Webrun.
Horário e Formato
- O suporte funciona de 09:00 – 12:00 e 14:00 – 17:00. Suporte fora desse horário será tratado no dia útil seguinte;
- O suporte deve ser solicitado exclusivamente via texto. O envio áudio, fotos, vídeos e outras informações só devem ser enviadas de forma complementar.
Prazos e Prioridades
- Os prazos só começam a contar a partir da checagem dos itens acima;
- A prioridade de atendimento da demanda atual e das próximas vai ser reduzida de acordo com a qualidade das informações fornecidas;
- Demandas sem instruções para reprodução ficam com prazos congelados;
- Demandas URGENTES ou NO CLIENTE não são atendidas como suporte ao desenvolvedor, e deve opcionalmente ser contratada à parte.
Respostas
- Seja objetivo nas respostas;
- Evite referencias (“A última”, “Aquela lá”, “A da última vez”, …) – Ainda que seja a mesma pessoa a te atender, há outros clientes e outras demandas sendo atendida, fica impossível lembrar detalhes de todos os atendimentos, SEJA REPETITIVO, é a melhor maneira pra agilizar seu atendimento.