Linha RM

Atalhos

Páginas filhas
  • Configuração dos novos portais

Versões comparadas

Versão antiga 29

changes.mady.by.user Samuel Rodrigues Carvalho Araujo

Gravado em

comparado com

Nova versão 30

changes.mady.by.user Samuel Rodrigues Carvalho Araujo

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Expandir
title1.0 - Pré-requisitos

 Os portais: Portal Gestão Educacional / Portal da Biblioteca / Novo Portal do Professor, fazem o uso de api's para buscar e armazenar informações, o controle destas APIs é feito pelo host. Para que os portais funcionem corretamente, é necessário expor as APIs para web, desta maneira, é necessário o uso do módulo URL Rewrite do IIS para que este módulo filtre as solicitações e encaminhe para o host as solicitações que sejam para a API.


Aviso
titleAtenção

A partir da versão 2402 é possível utilizar as api's do host diretamente, sem o uso do módulo do rewrite. Para isso deve expor o host para a web e informar o endereço do host nos arquivos de config dos portais.   Importante ficar atento a questões de segurança ao expor o host para a web. A forma como será utilizado fica a critério da insituição.


 É necessário instalar o URL Rewrite e o ARR (Application Request Routing) no IIS.


Expandir
titleARR (Application Request Routing)
Aviso

Caso tenha instalado e configurado o Application Request Routing (ARR) para o Novo Portal do Professor, não é necessário realizar esse processo.

Fazer o download do ARR no link  https://www.microsoft.com/en-us/download/details.aspx?id=47333 

Fazer a instalação no mesmo servidor do portal em questão (Portal Gestão Educacional / Portal da Biblioteca / Novo Portal do Professor) e ao final da instalação deve ser habilitado o proxy do ARR.




Expandir
titleURL Rewrite
Deck of Cards
effectDuration0.1
idtemp
effectTypefade
Card
labelInstalação
effectTypefade


1. Acessar o site https://www.iis.net/downloads/microsoft/url-rewrite para realizar o download do módulo do rewrite para o iis, efetuar o download conforme a versão do servidor.


2. Após realizar o download, executar o instalador e seguir os passos até finalizar a instalação


3. Após a Instalação, será criado um ícone: “URL Rewrite” no IIS


Card
labelConfiguração Rewrite
effectTypefade

 Versões anteriores à 12.1.2402 é necessário configurar duas regras para o rewrite:

  • A 1º regra é utilizada para direcionamento de api's onde não é necessário passar o alias selecionado(regra comum para todas as versões);
  • A 2º regra (apenas para versões anteriores à 12.1.2402) é utilizada para as api's onde é necessário passar o alias selecionado. Segue a configuração das versões:
Aviso

A configuração é realizada exclusivamente nos portais: Portal Gestão Educacional / Portal da Biblioteca / Novo Portal do Professor  em: Sites | Default Web Site | FrameHTML | Web | App |Edu | 'Selecione a pasta referente ao portal'.

Caso a configuração não seja realizada no caminho especificado anteriormente, o portal do Aluno poderá ser impactado.

 - Regra em comum para todas as versões: 

 1. Acessar o IIS -> Ir no aplicativo que está sendo configurado (Portal Gestão Educacional / Portal da Biblioteca / Novo Portal do Professor) -> URL Rewrite


2. Dar um duplo click no ícone URL Rewrite e em seguida clicar em: Adicionar uma Rule do tipo Inboud Rule.

Inserir as informações:

3. No campo "Name" informar um nome para a regra que está sendo criada


4. Na opção: Match URL, no campo: "Pattern" inserir as informação: api/(.*)


5. Na opção: "Actions", no campo: Rewrite URL informar o link: http://nome_da_maquina_do_host:porta/api/{R:1}

- Regra adicional necessário para versões anteriores a 12.1.2402: 

Acessar o IIS -> Acessar o Portal que está sendo configurado (FrameHTML | Web | App |Edu |  [Portal Gestão Educacional / Portal da Biblioteca / Novo Portal do Professor]) -> URL Rewrite


  2. Dar um duplo click no ícone URL Rewrite e em seguida clicar em: Adicionar uma Rule do tipo Inboud Rule.

Inserir as informações:

  3. No campo "Name" informar um nome para a regra que está sendo criada


  4. Na opção: Match URL, no campo: "Pattern" inserir as informação: aliasname\.(.*)/api/(.*)

5. Na opção: "Actions", no campo: Rewrite URL informar o link: http://{R:1}.nome_da_maquina_do_host:porta/api/{R:2}

6. Marcar a opção: "Stop processing of subsequent rules"


Aviso
titleAtenção

A porta utilizada deve ser a mesma que está configurada na chave "ApiPort" no arquivo de host (RM.Host.Service.exe.config, se utilizar o Host Service e RM.Host.exe.config, se utilizar o Host local). Ver a aba Configurações do config.

A ordem das regras deve ser respeitada.

Card
labelConfiguração do config
effectTypefade
  • Acessar o RM.Host.Service.exe.config (Se o cliente utilizar o Host Service) ou  RM.Host.exe.config (Se o cliente utilizar o Host local)  na Pasta: Totvs\RM.Net\Bin da versão e inserir as chaves:

      <add key="ApiPort" value="porta_definida_no_rewrite (IIS)" />
      <add key="DefaultDB" value="informe_aqui_o_nome_do_alias" />

  • Para versões anteriores à 12.1.2402 é necessário adicionar a chave:

      <add key="SubDomainMask" value="[ALIAS].nome_da_máquina_do_host" />


Aviso
titleAtenção

Para a opção "SubDomainMask", o nome da máquina deve ser inserido todo utilizando letras minúsculas. O texto [ALIAS] não deve ser alterado, deve ser inserido o texto desta forma, o que deve ser alterado é o "nomeDaMaquinaDoHost". Exemplo: a máquina do host possui o nome de ServerXYZ, desta forma, deve ser inserido o texto [ALIAS].serverxyz.

Nota
iconfalse

Em servidor publicado, na TAG: "SubDomainMask" utilizar o DNS.

Aviso
iconfalse

Se utilizar do rm.host, atentar para executa-lo como administrador.

Se utilizar o host.service, o usuário associado ao serviço tem que ter permissão para acessar a porta da API definida no URL Rewrite.



Card
labelConfiguração Rewrite TOTVS Educa Mobile (exibição das Salas no App)
effectTypefade

Essa configuração é necessária para que as salas sejam exibidas no menu: Mensagens | Sala de Atendimento.
Para mais detalhes do processo, acessar a documentação: Parametrização da Sala de Atendimento no App: Meu eduCONNECT. ( Menu: 07 da Documentação). 

Painel
titleConfiguração do URL Rewrite

1. Acessar o IIS -> Ir no aplicativo do EducaMobile -> URL Rewrite

2. Dar um duplo click no ícone URL Rewrite e em seguida clicar em: Adicionar uma Rule do tipo Inboud Rule

Inserir as informações:

3. No campo "Name" informar o endereço:  TOTVS_API_ReverseProxyInboundRule

4. Na opção: Match URL, no campo "Pattern" inserir a informação: (.*)

5. Na opção: "Conditions", clicar no botão: Add. e inserir a informação: {REQUEST_URI}  /api/(.*)

6. Na opção: "Actions", no campo: Rewrite URL informar o link: http://localhost:8052/{R:1}

Importante:

  • A URL a ser utilizada é a do servidor onde encontra-se instalado o Host, como exemplo, utilizamos o endereço http://IPdoServidorHost:8052/{R:1} 
    • Em alguns casos o servidor do Host é diferente do servidor Web, então neste caso, deve-se utilizar o endereço do servidor do Host. 
  • Verificar a porta configurada na tag ApiPort do arquivo de configuração do Host, como exemplo, utilizamos a porta 8052.
  • Em alguns cliente a parte da URL {R:1} é substituído por {C:0}

Verificar qual é a parte da URL {R:1} ou {C:0}

Utilizar o endereço http://EndereçodoServidorWeb/EducaMobile/api/framework/v1/menus/dd6626a5aa1e3c2c2ad79198824f67a4?$filter=tagMenu eq '808100759'&companyId=1


7. Em seguida, clicar no botão: Aplicar

Será apresentado a mensagem: As alterações foram salvas com êxito.

Painel
titleConfiguração do Config

Acessar o RM.Host.Service.exe.config (se o cliente utilizar o Host Service) ou RM.Host.exe.config (se o cliente utilizar o Host local) na pasta "Bin" da versão e inserir as chaves:

<add key="ApiPort" value="Porta definida no Host" />
<add key="DefaultDB" value="CorporeRM" />

Aviso
iconfalse

Para que a comunicação entre o Portal Gestão Educacional e o App: Meu eduCONNECT possa ocorrer normalmente, é necessário que a porta da API configuração do Rewrite do Portal Gestão Educacional e do TOTVS Educa Mobile estejam na mesma porta.





...