Árvore de páginas

Versões comparadas

Chave

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

...

Deck of Cards
effectDuration0.5
idcabecalho
effectTypeslide
Card
defaulttrue
effectDuration0.5
idapplinker
labelAppLinker
titleApplinker
effectTypeslide
Deck of Cards
effectDuration0.5
idvertentes
Card
idintroducao
labelIntrodução
titleIntrodução
Column
width80%

Propósito 

O AppLinker é uma ferramenta desenvolvida com o objetivo de permitir a criação de Alias para bases locais PROTHEUS

Aviso

Está é uma ferramenta para benefício das equipes de suporte ou desenvolvimento. Esta solução NÃO é para geração deAlias para ambientes externos, apenas para fins internos.  

Determinados aplicativos necessitam realizar integração com o intermediador (gateway), também conhecido como Mingle, para conexão com os servers. 

Isso se faz necessário para que a URL do servidor não fique exposta ou disponível para todos. Trazendo assim estabilidade e segurança para o ambiente. 

Os aplicativos móveis a seguir necessitam de Alias

  • Legal Process
  • Legal Task
  • Meu Posto de Trabalho
  • Meu Protheus
  • Minha Prestação de Contas
  • Meus Ativos Fixos 
  • Meus Contratos
  • Minha Gestão de Postos 
Card
effectDuration0.5
idfuncionalidades-interfaces
labelFuncionalidades e Interfaces
titleFuncionalidades e Interfaces
Deck of Cards
effectDuration0.5
idaplicacao
Card
effectDuration0.5
idacesso
labelAcesso
titleAcesso

Primeiro Login

Para acessar o AppLinker, é necessário ter um usuário liberado. 

Informe os dados de "Usuário" e "Senha" e clique em "Acessar sistema".

Painel
titleTenha de Login - AppLinker

Card
effectDuration0.5
idnovo-usuario
labelNovo Usuário
titleNovo Usuário

Solicitando Nova Credencial

Para criar um novo usuário clique em "Novo Registro" em seguida informe os dados necessários de "E-mail" e "Senha". 

Aviso

Para o cadastro é necessário que o usuário seja um TOTVER. Outras organizações não são permitidas. 

Painel
titleCadastro - AppLinker

Card
effectDuration0.5
idrecuperar-senha
labelRecuperar Senha
titleRecuperar Senha

Resgatar Palavra Chave

Para recuperar as credenciais de acesso, informe o seu "E-mail", confirme no seu e-mail a troca de senha e altere sua senha. 

Painel
titleRecuperação de Senha - AppLinker

Card
effectDuration0.5
idconexao-server
labelConexão com o Server
titleConexão com o Server

Rest Protheus

Preencher as informações de configuração do REST de seu Protheus local.

Porta - Porta que o REST está configurado

URL - path onde o REST irá subir

Painel
titleRest Protheus - AppLinker

Dica

Os campos acima devem ser preenchidos de acordo com o seu appserver.ini, exemplo:

Painel

Card
effectDuration0.5
idescolher-aplicativo
labelEscolher aplicativo
titleEscolher aplicativo

Aplicativo

Após clicar em conectar, se a conexão for bem sucedida você será redirecionado a seguinte página. Nesta pagina será necessário escolher o APP que serão realizados os testes.
De acordo com o APP selecionado, exibirá campos personalizados, como por exemplo, empresa e filial, que são campos obrigatórios.

Painel
titleAplicativo - AppLinker

Nota

Para o aplicativo "Meu Protheus NÃO É COMPATÍVEL" com a funcionalidade de notificações. Para tal, deve ser criado um ALIAS através do Mingle, ou pelo Assistente de Configuração Mobile.

Card
effectDuration0.5
idalias-gerado
labelAlias Gerado
titlealias-gerado

Start

Após as etapas, na tela do aplicativo, você utiliza o usuário e a senha do Protheus configurado no REST
e o ALIAS gerado no Applinker.

Painel
titleAlias - AppLinker


Painel
titleAplicativo

Card
effectDuration0.5
idconfiguracao-instrucoes-tecnicas
labelConfiguração e Instruções Técnicas
titleConfiguração e Instruções Técnicas
Deck of Cards
startHiddenfalse
effectDuration0.5
iddesenvolvimento-producao
Card
idprojeto
labelProjeto
titleProjeto
Deck of Cards
effectDuration0.5
iddocumentos-tecnicos
Card
idcaso-uso
labelCaso de Uso
titleCaso de Uso

Funcionalidades do Usuário

A seguir você irá visualizar os requisitos de usuário. 

Painel
titleCaso de Uso

Card
idfluxo-usuario
labelFluxo do Usuário
titleFluxo do Usuário

Diagrama de Uso

A seguir você irá visualizar um passo a passo de como funciona a aplicação e todas as entidades presentes. 

Painel
titleDiagrama de Uso



Card
effectDuration0.5
idmodelo-conceitual-logico
labelModelo Conceitual e Lógico
titleModelo Conceitual e Lógico

Diagramas

A modelagem de dados do AppLinker é bem "simples".

É composta apenas por uma tabela de "Usuários", que guarda o "e-mail", "senha", "permissão" e "data do registro". 

Painel
titleModelo Conceitual

Painel
titleModelo Lógico

Card
effectDuration0.5
idprodução
labelProdução
titleProdução
Deck of Cards
effectDuration0.5
idambiente-producao
Card
effectDuration0.5
idbanco-dados
labelBanco de Dados
titleBanco de Dados
Deck of Cards
effectDuration0.5
iddatabase
Card
effectDuration0.5
idcriando-ambiente-sql
labelCriando o Ambiente SQL
titleCriando o Ambiente SQL

Persistência de Dados

Query para a criação da tabela de usuários: 

Bloco de código
languagesql
themeConfluence
firstline1
titleCriando Tabela de Usuários
CREATE TABLE public.tb_users
(
    id integer NOT NULL DEFAULT nextval('tb_users_seq'::regclass),
    email character varying(50) COLLATE pg_catalog."default" NOT NULL,
    password character varying(50) COLLATE pg_catalog."default",
    enable boolean,
    register text COLLATE pg_catalog."default" DEFAULT now()
)
Card
effectDuration0.5
idacesso
labelAcesso
titleAcesso

Conexão em Produção  

Para acessar a página de administração do banco de dados acesse o PGADMIN.

Acesse usando o usuário administrador do banco. 

Para encontrar a tabela vá em Servers → Applinker → Databases → AppLinker → Schemas → Public → Tables → tb_users 

Painel
titleAcessando as tabelas


Card
effectDuration0.5
idusuarios
labelUsuários
titleUsuários

Permissões de Usuários

Após aberta a tabela você poderá clicar com o botão direito do mouse, clicar sobre Query Tool,  e em seguida será aberta uma tela para que possa ser criado querys SQL na tabela.  

Painel


Aviso

Caso o serviço de verificação de e-mails esteja instável ou fora do ar, será necessário alterar a permissão por uma query.

O campo "enable" é que diz se o usuário têm ou não permissão para entrar no Applinker

Para alterar a permissão do usuário execute: 

UPDATE tb_users SET enable = true WHERE email = 'email_do_usuario@totvs.com.br';

Card
effectDuration0.5
idadministracao-usuarios
labelAdministração de Usuários
titleAdministração de Usuários

Serviço de E-mails

O AppLinker possui um mecanismo para criação de novos usuários e recuperação de senha.

O processo para criação de novos usuários se resume em: 

  1. Usuário cadastra suas informações pelo cadastro do AppLinker.
  2. O AppLinker envia ume-mail de confirmação para criação do usuário. 
  3. O usuário recebe o e-mail e confirma o cadastro.

O processo para recuperação de senha: 

  1. Usuário informa o e-mail para recuperação de senha pelo AppLinker
  2. O AppLinker envia um e-mail com o link para recuperação de senha. 
  3. Usuário informa a nova senha e envia as alterações.

O server do AppLinker é responsável por todo esse provisionamento do serviço de e-mails. 

As informações do cadastro do serviço de e-mails com autenticação de dois fatores está no Google Cloud

Aviso

Por motivos de segurança não será posto nenhum gif do processo para acessar as informações presentes no Google Cloud.

Para acessar as informações selecione o time "Google Play Android Developer". 

Na seção "IDs do Cliente OAuth 2.0" clique sobre "App Linker Emails".

Neste painel você terá acesso as informações presentes no server do AppLinker, no arquivo smtp.js.

Card
idprovisionamento-aplicação
labelProvisionamento da Aplicação
titleProvisionamento da Aplicação
Deck of Cards
effectDuration0.5
idAcessos
Card
effectDuration0.5
idpainel-acesso
labelPainel de Acesso
titlePainel de Acesso

Gestão com Rancher

Rancher é uma plataforma para gestão de aplicações Docker.

Por meio do Rancher disponibilizamos e gerenciamos as aplicações Backend e Frontend do AppLinker

Para acessar os containers Docker: 

  1. Acesse o painel de administração do Rancher.
  2. Informe as credenciais de acesso. (As credenciais são seu usuário e senha de rede). 
  3. Após logado você será direcionado para página de "Clusters". Acesse o projeto clicando no cluster "engpro-eks" e em seguida "mobile".

Painel

Card
effectDuration0.5
iddeploy-restart-aplicacoes
labelDeploy e Restart das Aplicações
titleDeploy e Restart das Aplicações

Administrando Containers

Em alguns momentos, as aplicações ficam fora do ar ou apresentam instabilidade. 

Neste caso será necessário reiniciar as aplicações. 

Para reiniciar as aplicações selecione applinker-client e o AppLinker-server  e em seguida clique em "Redeploy". 

Painel
Card
effectDuration0.5
iddesenvolvimento
labelDesenvolvimento
titleDesenvolvimento
Deck of Cards
startHiddenfalse
effectDuration0.5
idconfiguracao-tecnica
Card
effectDuration0.5
idinstalacao
labelInstalação
titleInstalação

Clone dos Projetos 

O AppLinker possui dois repositórios.

Um contém o projeto Frontend e o outro o Backend

Aviso

É necessário solicitar uma licença para ter acesso ao Azure.

Caso o usuário no Azure seja um StackHolder ou nem tenha login, o mesmo deve preencher o formulário de solicitação pelo link: 
https://fluig.totvs.com/portal/p/10097/pageworkflowview?processID=solicitacaoLicencasAzureDevops

Segue os links para os repositórios:

Expandir
titleFrontend

https://totvstfs.visualstudio.com/ServicesMobile/_git/AppLinker%20-%20Client

Expandir
titleBackend

https://totvstfs.visualstudio.com/ServicesMobile/_git/AppLinker%20-%20Server

Card
effectDuration0.5
idambiente-desenvolvimento
labelAmbiente de Desenvolvimento
titleAmbiente de Desenvolvimento

Configurar Máquina

Para subir o client e o server do AppLinker em uma máquina para fins de desenvolvimento, é necessário instalar algumas dependencias.

Segue uma lista de tecnologias que devem estar presentes. 

Para subir o client

Para subir o server:

Instale o Banco de Dados Postgree para testes locais.

As branchs para iniciar o desenvolvimento de qualquer feature devem ser feitas a partir da "develop" (tanto client como server)

Card
effectDuration0.5
idaponte-local
labelAponte para Local
titleAponte para Local
Deck of Cards
effectDuration0.5
idarquivos
Card
effectDuration0.5
idfrontend
labelFrontend
titleFrontend

Alterando arquivos

Aviso

Todas as requisições são feitas para ambiente de produção. Altere os arquivos que apontam para o ambiente de produção para que eles sejam direcionadas para localhost. 

Note a seguir que o client faz todas as suas requisições usando um provider HttpService.

Neste HttpService usamos uma constante que possui a URL para onde estamos apontar, se localhost ou produção. 

Painel
titleHttpService

Altere o valor do objeto de:  

Bloco de código
languagejs
themeMidnight
titleValor para Produção
export const environment = {
production: true,
api: 'https://applinkerserver.applinker.engpro.totvs.com.br'
};

para: 

Bloco de código
languagejs
themeMidnight
titleValor para Produção
export const environment = {
production: false,
api: 'http://localhost:3000'
};

em: 

AppLinkerClient/app/src/environments/environment.ts

Painel
titleEnvironment



Painel
titleEnvironment


Card
effectDuration0.5
idbackend
labelBackend
titleBackend


Aviso

As tabelas do banco NÃO são criadas de forma automática.

Será necessário realizar uma cópia da base de dados de produção e importar ela para a local. 

Card
effectDuration0.5
idbanco-dados
labelBanco de Dados
titleBanco de Dados
Deck of Cards
effectDuration0.5
idbd
Card
effectDuration0.5
idcrie-server
labelCrie um Server
titleCrie um Server

Criando o DataBase

Para criar um Banco de Dados clique com o botão direito em "Databases" e depois em "Create". 

De o nome de "applinker" e clique em "Save". 

Painel
titleCriação do Server

Card
defaulttrue
effectDuration0.5
idsuporte
labelSuporte
titleSuporte
effectTypeslide
Column

Perguntas frequentes (FAQs)


Expandir
titleAcesso a ferramenta

https://AppLinker.engpro.totvs.com.br/login

Expandir
titleSolicitação do Alias pelo portal do Mingle

https://mingle.totvs.com.br/landpage/

Expandir
titleDocumentação dos Aplicativos Móveis

https://tdn.totvs.com/x/Wm9KE

Expandir
titleConfigurar REST

https://tdn.totvs.com/x/fEn6Hg

Expandir
titleAplicativos na Web

https://tdn.totvs.com/x/RXXjIg

Expandir
titleCriar Alias pelo Assistente de Configuração Mobile

https://acm.engpro.totvs.com.br/index.html

...