...
Expandir |
---|
|
Como requisito para o funcionamento dos portais é necessário instalar o URL Rewrite e ARR (Application Request Routing) no IIS.
Expandir |
---|
title | ARR (Application Request Routing) |
---|
| A instalação deve ser realizada no servidor do portal desejado. Link para download do ARR: https://www.microsoft.com/en-us/download/details.aspx?id=47333
Aviso |
---|
title | Apenas uma vez para cada IIS |
---|
| A instalação deve ser realizada apenas uma vez para cada IIS. |
Aviso |
---|
| Após finalizar a instalação ARR (Application Request Routing), deverá ser habilitado a propriedade "Enable proxy" |
|
Expandir |
---|
| A instalação deve ser realizada no servidor do portal desejado.
Aviso |
---|
| A partir da versão 12.1.2402
É possível utilizar as api's do host diretamente, sem o uso do módulo do URL 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 instituição. |
Deck of Cards |
---|
effectDuration | 0.1 |
---|
id | temp |
---|
effectType | fade |
---|
| Card |
---|
label | Configuração Rewrite |
---|
effectType | fade |
---|
| Deve ser necessário configurar duas regras para o URL Rewrite: - A 1º regra (regra comum para todas as versões) é utilizada para direcionamento de API onde não é necessário passar o alias selecionado;
- A 2º regra (apenas para versões anteriores à 12.1.2402) é utilizada para as API onde é necessário passar o alias selecionado.
Aviso |
---|
title | Exclusivamente para os novos portais |
---|
| A configuração deve ser realizada exclusivamente nos portais: Portal Gestão Educacional / Portal da Biblioteca / Novo Portal do Professor em: Sites | Default Web Site | FrameHTML | Web | App |Edu | 'Pasta referente ao portal'. Caso a configuração não seja realizada no caminho especificado anteriormente, o portal do Aluno poderá ser impactado. |
Aviso |
---|
title | A ordem das regras deve ser respeitada. |
---|
| A ordem das regras deve ser respeitada. |
Informações |
---|
title | Regra 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.
3. No campo "Name" informar um nome para a regra que está sendo criada Image RemovedImage Added
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}
|
Informações |
---|
title | Regra adicional necessário para versões anteriores a 12.1.2402 |
---|
| Para as versões anteriores à 12.1.2402 é necessário configurar uma nova regra.
Aviso |
---|
| A porta utilizada deve ser a mesma que está configurada na chave "ApiPort" no arquivo de host RM.Host.Service.exe.config. |
1. Acessar o IIS -> Ir no aplicativo que está sendo configurado (Portal Gestão Educacional / Portal da Biblioteca / Novo Portal do Professor) -> URL Rewrite Image RemovedImage Added
2. Dar um duplo click no ícone URL Rewrite e em seguida clicar em: Adicionar uma Rule do tipo Inboud Rule.
3. No campo "Name" informar um nome para a regra que está sendo criada Image RemovedImage Added
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"
|
| card
|
|
|
Expandir |
---|
label | Configuração Rewrite TOTVS Educa Mobile (exibição das Salas no App) |
---|
effectType | fade |
---|
|
Essa configuração é necessária para que as salas sejam exibidas no menu: Mensagens | Sala de Atendimento. Para mais detalhes Parametrização da Sala de Atendimento no App: Meu eduCONNECT
Aviso |
---|
|
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. |
1. Acessar o IIS -> Ir no aplicativo que está sendo configurado EducaMobile -> URL Rewrite
Image Removed
2. Dar um duplo click no ícone URL Rewrite e em seguida clicar em: Adicionar uma Rule do tipo Inboud Rule
Image Removed
Image Removed
3. No campo "Name" informar o endereço: TOTVS_API_ReverseProxyInboundRule
Image Removed
4. Na opção: Match URL, no campo "Pattern" inserir a informação: (.*)
Image Removed
5. Na opção: "Conditions", clicar no botão: Add. e inserir a informação: {REQUEST_URI} /api/(.*)
Image Removed
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}
Image Removed
Image Removed
Utilizar o endereço http://EndereçodoServidorWeb/EducaMobile/api/framework/v1/menus/dd6626a5aa1e3c2c2ad79198824f67a4?$filter=tagMenu eq '808100759'&companyId=1
Image Removed
Image Removed
7. Em seguida, clicar no botão: Aplicar
Image Removed
Expandir |
---|
title | 2- Configurar aquivo de config do Host do RM |
---|
|
Após configurar o servidor conforme o item de pré-requisito, é necessário configurar o arquivo de configuração do Host do RM. Para isso, acesse o arquivo RM.Host.Service.exe.config que está disponível no caminho padrão do instalador do RM.exe.
Inserir as chaves as chaves abaixo:
<add key="ApiPort" value="porta_definida_no_rewrite (IIS)" />
<add key="DefaultDB" value="informe_aqui_o_nome_do_alias" />
Aviso |
---|
title | Versão anteriores à 12.1.2402 |
---|
|
title | 2- Configurar aquivo de config do Host do RM |
---|
|
Após configurar o servidor conforme o item: 1- Pré-requisitos, é necessário configurar o arquivo de configuração do Host do RM. Para isso, acesse o arquivo RM.Host.Service.exe.config que está disponível no caminho padrão do instalador do RM.exe. Inserir as chaves as chaves abaixo: <add key="ApiPort" value="porta_definida_no_rewrite (IIS)" /> <add key="DefaultDB" value="informe_aqui_o_nome_do_alias" />
Aviso |
---|
title | Versão anteriores à 12.1.2402 |
---|
| Inserir a chave abaixo: <add key="SubDomainMask" value="[ALIAS].nome_da_máquina_do_host" /> 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. |
Aviso |
---|
icon | false |
---|
title | Usuário associado ao serviço |
---|
| O usuário associado ao serviço tem que ter permissão para acessar a porta da API definida no URL Rewrite. Image Added
|
|
Expandir |
---|
title | 3- Configurar arquivo de config do Portal |
---|
|
Após configurar o servidor conforme o item: 1- Pré-requisitos, é necessário configurar o arquivo de configuração no portal. Para isso, acesse o arquivo config.json que está disponível no caminho padrão do instalador do Portal. “C:\totvs\CorporeRM\FrameHTML\Web\App\Edu\"Pasta referente ao portal" \config\”. - Exemplo do portal do professor:FrameHTML| Web | Edu | Portal | PortalDoProfessor
- Exemplo do portal do gestão educacional: FrameHTML| Web | Edu | Portal | PortalGestaoEducacional
- Exemplo do portal da biblioteca: FrameHTML| Web | Edu | Portal | portalbiblioteca
No arquivo, as seguintes configurações são possíveis: Informações |
---|
title | Parâmetro "apiServer" |
---|
| Essa configuração é utilizada para realizar o redirecionamento para a API que será feito pelo URL Rewrite do IIS. Deve ser configurado com o endereço público do portal conforme o exemplo a seguir:. - Exemplo do portal do professor: http://*EndereçoDaInstituição*/FrameHTML/web/app/edu/PortalDoProfessor
- Exemplo do portal do gestão educacional: http://*EndereçoDaInstituição*/FrameHTML/web/app/edu/PortalGestaoEducacional
- Exemplo do portal da biblioteca: http://*EndereçoDaInstituição*/FrameHTML/web/app/edu/portalbiblioteca
*EndereçoDaInstituição* refere-se ao DNS da Instituição de ensino. Aviso |
---|
A partir da versão 12.1.2402 Este parâmetro poderá ficar vazio, pois a instalação do portal irá preenche-lo com o mesmo endereço configurado para acessar o portal automaticamente. Além disso, será possível configurar este parâmetro com um endereço diferente do utilizado para acessar o portal. Para isto, o host deve estar configurado para acesso externo, ou seja, o host deve estar exposto para internet. Desta maneira o valor a ser preenchido neste parâmetro, deve ser o endereço no qual o host está sendo exposto.
- Exemplo do portal da biblioteca
|
|
|
Versão anteriores à 12.1.2402
Inserir a chave abaixo:
<add key="SubDomainMask" value="[ALIAS].nome_da_máquina_do_host" />
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.
Aviso |
---|
icon | false |
---|
title | Usuário associado ao serviço |
---|
|
O usuário associado ao serviço tem que ter permissão para acessar a porta da API definida no URL Rewrite. Image Removed
|
Expandir |
---|
title | 3- Configurar arquivo de config do Portal |
---|
|
Após configurar o servidor conforme o item de pré-requisito, é necessário configurar o arquivo de configuração no portal. Para isso, acesse o arquivo config.json que está disponível no caminho padrão do instalador do Portal. “C:\totvs\CorporeRM\FrameHTML\Web\App\Edu\"Pasta referente ao portal" \config\”. No arquivo, as seguintes configurações são possíveis: Informações |
---|
title | Parâmetro "apiServer" |
---|
| Essa configuração é utilizada para realizar o redirecionamento para a API que será feito pelo URL Rewrite do IIS. Deve ser configurado com o endereço público do portal. Exemplo: http://instituicao.br/FrameHTML/web/app/edu/portalXXXX. Aviso |
---|
A partir da versão 12.1.2402 Este parâmetro poderá ficar vazio, pois a instalação do portal irá preenche-lo com o mesmo endereço configurado para acessar o portal automaticamente. Além disso, será possível configurar este parâmetro com um endereço diferente do utilizado para acessar o portal. Para isto, o host deve estar configurado para acesso externo, ou seja, o host deve estar exposto para internet. Desta maneira o valor a ser preenchido neste parâmetro, deve ser o endereço no qual o host está sendo exposto. Exemplohttps- :O portal está sendo acessado pelo seguinte endereço
portalTotvs.com.br- *EndereçoDaInstituição*/FrameHTML/web/app/edu/
portalXXXXX - portalbiblioteca e o host está exposto no seguinte endereço https://
portaltotvs.com.br*EndereçoDaInstituição* refere-se ao DNS da Instituição de ensinoportaltotvs.com.br:9051. |
|
Informações |
---|
title | Parâmetro "basePath" |
---|
| Deve ser configurado com o caminho relativo do portal.Exemplo: Caminho do novo portal do professor Image Removed Image Removed Image Removed do portal. - Exemplo do portal do professor:FrameHTML| Web | Edu | Portal | PortalDoProfessor
- Exemplo do portal do gestão educacional: FrameHTML| Web | Edu | Portal | PortalGestaoEducacional
- Exemplo do portal da biblioteca: FrameHTML| Web | Edu | Portal | portalbiblioteca
Image Added
|
Informações |
---|
title | Parâmetro "defaultAlias" |
---|
| Esta configuração não define qual o alias que será utilizado para acessar o portal, apenas seleciona automaticamente o alias na caixa de seleção na tela de login quando possui mais de um alias cadastrado. Deve ser configurado com o alias padrão utilizado para fazer o acesso à base de dados. Este alias, deve estar cadastrado no arquivo alias.dat. |
Informações |
---|
title | Parâmetro "urlCorpore" (apenas no portal do professor) |
---|
| Deve ser configurado o endereço público do portal Corpore.NET, para que as funcionalidades ainda não migradas do portal do professor, sejam redirecionadas para o Corpore.NET. Quando o ambiente possuir mais de um servidor WEB contendo uma instalação do Portal do Professor e Corpore.NET, seja possível cada servidor redirecionar para o Corpore.NET do seu próprio servidor. Ou, em casos que o endereço do Corpore.NET parametrizado no RM esteja sendo utilizado para outras finalidades, apontando para um ambiente específico.
Aviso |
---|
title | Apenas para o portal do professor |
---|
| Configuração apenas para o portal do professor, não sendo utilizada nos demais portais. |
Aviso |
---|
title | Configuração mandatória é no arquivo config.json |
---|
| A configuração mandatória é no arquivo config.json, portando, quando preenchida o portal não irá utilizar o caminho parametrizado no RM. |
|
Informações |
---|
title | Parâmetro "imgBannersLogin" |
---|
| Deve ser configurado os banners que são exibidos na tela de login do portal. Para alterar as imagens, basta adicionar ou remover imagens desejadas no diretório do portal e no arquivo config.json.Diretório das imagens no portal: "C:\totvs\CorporeRM\FrameHTML\Web\App\Edu\PortalXXXX. - Exemplo do portal do professor:C:\totvs\CorporeRM\FrameHTML\Web\App\Edu\portaldoprofessor\assets\img\banners-login
- Exemplo do portal do gestão educacional: C:\RM\Atual\Release\FrameHTML\web\app\Edu\portalgestaoeducacional\assets\img\banners-login
". - O portal da Biblioteca não possui esse formato de banner. A imagem da tela principal deve ser inserida conforme instruções https://tdn.totvs.com/x/n9PGLg
Informações |
---|
O nome da imagem da lista no arquivo config.json deve ser o mesmo nome da imagem no diretório do portal. |
Dica |
---|
| Para que o banner tenha uma boa apresentação sugerimos que a imagem tenha a dimensão de 720 (largura) x 1024 (altura). | Image Removed |
Informações |
---|
title | Parâmetro "multitenant" |
---|
| Deve ser configurado o portal para o Multi-Tenancy. Para mais informação Configurando o RM Multi Tenancy (Multi Alias)
Aviso |
---|
A partir da versão 12.1.2402 As chaves multitenant e subdomainMask devem ser removidas do arquivo config.json, com exceção de ambiente que esteja configurado como multitenant. |
|
|
...
Expandir |
---|
title | 5- Configurar tempo de timeout do portal |
---|
|
O portal permite que a instituição realize a configuração do timout Time out da forma que desejar.
Dica |
---|
Algumas funcionalidades tenha um comportamente comportamento adequado sugerimos que o tempo seja de 240 segundo (4 minutos). |
Informações |
---|
| Após realizar as configurações é necessário reiniciar o IIS |
1. Acessar o IIS -> Ir na pasta "Default Web Site"
2. Selecione a opção "Configurações Avançadas" Image Removed 3. Preencha com tempo desejado em "Tempo Limite de Conexão (segundos)" Image Removed 4. Acessar o IIS -> Ir no pasta do servidor -> Application Request Routing Cache Image Removed 5. Clicar em: Server Proxy Settings Image Removed "Configurações Avançadas" Image Added
36. Preencha com tempo desejado em "Time-out (secondsTempo Limite de Conexão (segundos)" Image RemovedImage Added 7. Em seguida, clicar no botão: Aplicar Image Removed |
Expandir |
---|
title | 5- Customizar portal Gestão Educacional |
---|
|
4. Acessar o IIS -> Ir no pasta do servidor -> Application Request Routing Cache Image Added
5. Clicar em: Server Proxy Settings Image Added
6. Preencha com tempo desejado em "Time-out (seconds)" Image Added
7. Em seguida, clicar no botão: Aplicar Image Added Expandir |
---|
|
title | Customização do Nome do Portal |
---|
|
A Instituição de ensino poderá customizar o nome desse aplicativo que será exibido no login e no cabeçalho da estrutura.
A alteração deve ser realizada no arquivo: C:\RM\Atual\Release\FrameHTML\web\app\Edu\PortalGestaoEducacional\config\Config.json
Image Removed
O nome alterado ficará disponível na tela de apresentação (login) e no cabeçalho da estrutura.
Image Removed