ER_PCREQ-4599_Interação_dos_aplicativos_PIMSCS_com_o_Totvs_License_Server_2014

(Obrigatório)

Informações Gerais

   Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos). 

Objetivo

Realizar a interação dos aplicativos PIMS C/S como o TOTVS|License Server. O TOTVS|License Server é um recurso computacional da TOTVS que têm como objetivo realizar o controle das licenças de uso dos softwares e aplicações TOTVS. Através deste recurso é possível prover de forma eficiente e segura as licenças e liberações de utilização de módulos e/ou funcionalidades das aplicações TOTVS em conformidade com o contrato firmado entre o cliente e a TOTVS. Cada instancia do TOTVS|License Server identifica uma instalação física vinculada ao contrato de licenciamento do cliente. Para maximizar o uso do licenciamento TOTVS, recomenda-se a utilização de uma única instancia do TOTVS|License Server, independentemente do ambiente de operação (Produção, Homologação e Teste).  Caso opte-se por mais de uma instalação física do TOTVS|License Server, será necessário o registro da divisão das licenças do contrato entre as instalações físicas.

Definição da Regra de Negócio

1. Realizar o acoplamento e conversão de tipos entre a biblioteca de vínculo dinâmico license_client.dll e a linguagem SQL Windows utilizada pelos aplicativos PIMS C/S. Utilizar os métodos descritos abaixo para fazer a importação da DLL, obedecendo o nome dos métodos e seus parâmetros de entrada e saída, além do tipo de declaração utilizada na DLL.

• SLC_init

Método de inicialização da comunicação com o TOTVS|License Server. Este método deve ser executado para cada uma das threads de processamento da linha de software.

Parâmetros de entrada:

• ServerIp: Endereço IP do TOTVS|License Server.
• ServerPort: Porta de comunicação do TOTVS|License Server.
• ClientIP: Endereço IP da estação de trabalho da linha de produto TOTVS ou similar. Este parâmetro é utilizado para identificar o uso concorrente do licenciamento.

Retorno:

• Retorna um valor inteiro positivo com o Handle da conexão com o TOTVS|License Server. Este retorno será utilizado como parâmetros nos outros métodos da DLL. Caso o retorno seja negativo, um erro ocorreu durante a comunicação.

• SLC_setThreadID

Método utilizado para identificar a thread ou contexto onde será realizado o consumo de licença, esta informação é utilizada na regra de abono de licença.

Parâmetros de entrada:

• Handle da conexão com o TOTVS|License Server.
• Thread ID desejada.

Retorno:

• Retorna INVALID_SLC se o Handle da conexão com o TOTVS|License Server não for válido.Caso contrário, retorna 0.

• SLC_setClientPort

Método utilizado para identificar a porta da aplicação a qual fará conexão com o servidor de licenças, esta informação é utilizada na regra de abono de licença.

Parâmetros de entrada:

• Handle da conexão com o TOTVS|License Server.
• Porta da aplicação desejada.

Retorno:

• Retorna INVALID_SLC se o Handle da conexão com o TOTVS|License Server não for válido.Caso contrário, retorna 0.

• SLC_cleanup

Método de encerramento da comunicação com o TOTVS|License Server. Este método deve ser executado para cada uma das threads de processamento da linha de software. Realizar a chamada deste método em um destrutor de Classe para evitar que a conexão fique presa se houver uma queda da aplicação por não-conformidade.

Parâmetros de entrada:

• Handle da conexão com o TOTVS|License Server.

Retorno:

• Não se aplica.

• SLC_getId

Método de recuperação do número serial do TOTVS|License Server do ThreadId da conexão com o TOTVS|License Server. Quando não há um hardlock presente na instalação este método retorna a versão do TOTVS|License Server. Este método deve ser utilizado para verificar se trata-se da versão 2014 do TOTVS|License Server, neste caso o retorno será 2014.

Parâmetros de entrada:

• Handle da      conexão com o TOTVS|License Server.

Retorno:

• Retorna o número serial do hardlock ou a versão do TOTVS|License Server quando não há hardlock instalado, as versões possíveis são: 2002,2010,2011,2014.

• SLC_callinternal

Método para execução de funções ou comandos.

Parâmetros de entrada:

• Handle da      conexão com o TOTVS|License Server.
• Código de      identificação do tipo de mensagem que será enviada, conforme documentação.
• Mensagem no      formato Json, conforme documentação, que será transmitida.
• Mensagem de      retorno no formato Json, conforme documentação.

Retorno:

• Se >= 0, retorna o tamanho da mensagem de retorno, senão retorna código do erro.

• SLC_ renewpulse

Método para controlar manualmente o pulso de renovação para que a conexão fique ativa.

Parâmetros de entrada:

• Handle da      conexão com o TOTVS|License Server.

Retorno:

• Não se aplica.

1. Criar a classe “clsTotvsLS” para controlar o licenciamento TOTVS. Os métodos descritos abaixo demosntram as chamadas, retornos e tramatementos que deverm ser desenvolvidos.

• LSIsOnLine

Implementar um método para analisar se o TOTVS|License Server está configurado e aguardando uma mensagem.

Procedimento:

                     I.            Realizar a conexão com o TOTVS|License Server (SLC_init) conforme parâmetros de conexão configurados. Caso os parâmetros não estejam preenchidos, retorne -1.

                   II.            Caso o TOTVS|License Server retorne um erro, somar -1000 ao erro e retornar o valor.

                  III.            Armazenar o Handle da conexão em uma variável de escopo Privado para reutilização futura, caso não tenha sido feito anteriormente e retornar 1.

Parâmetros:

• Não há.

Retorno:

• Retorna 1 em caso de sucesso ou um valor negativo em caso de erro.

• LsIs2014

Implementar um método para analisar se a versão do TOTVS|License Server configurada é igual ou superior a 2014.

Procedimento:

                     I.            Verificar se o retorno do método LSIsOnLine é positivo, caso contrário retornar 0.

                   II.            Utilizar o método SLC_getId e verificar se o retorno é maior ou igual 2014 e menor que 9999. Em caso positivo retornar 1.

                  III.            Qualquer outra condição, retornar 0.

Parâmetros:

• Não há.

Retorno:

• Retorna 1 em caso de sucesso ou zero em caso de insucesso.

• LSgetLicense

Implementar um método para o consumo do licenciamento TOTVS. O consumo de licenciamento TOTVS está preparado para realizar a identificação do tipo de licença solicitada e a natureza do controle, bem como identificar se a solicitação de licenciamento refere-se ao licenciamento tradicional ou corporativo. A única preocupação do desenvolvedor é transmitir corretamente os dados solicitados na mensagem e realizar o tratamento correto do retorno da mensagem.

Procedimento:

                     I.            Verificar se o retorno do método LSIsOnLine é positivo, caso contrário retornar vazio.

                   II.            Verificar se a versão do TOTVS|License Server é igual ou superior a 2014, caso contrário retornar uma exceção.

                  III.            Montar o pacote Json

                 IV.            Concatenar ao pacote Json a seguinte expressão: Json = “TOTVSLICENSESERVER_GETLICENSE|”+Json

                  V.            Invocar o metodo SLC_callinternal passando no parâmetro code o valor 10003 e o novo valor do Json no parâmetro par1.

                 VI.            Em caso de sucesso será retornado um Json com os procedimentos que devem ser desenvolvidos no parâmetro par2.

Parâmetros:

• String Json montada conforme documentação.

Retorno:

• String Json conforme documentação.

1. O Json de solicitação de licenciamento TOTVS deve ter a estrutura mencionada abaixo:

1. O Json retornado pelo método possui uma das seguintes estruturas possíveis.

a)       Estrutura de retorno em caso de aviso de necessidade de renovação manual do LS. Esta mensagem será retornada quando ocorrer algum problema na atualização do TOTVS|License Server que necessite uma intervenção manual do Administrador do sistema. É recomendado que seja utilizado a mensagem padrão fornecida pelo TOTVS|License Server. Esta mensagem deverá ser transmitida para todos os usuários do sistema (opção default ) ou somente ao usuários administradores ( opção configurada ), a cada solicitação de licenciamento. A mensagem contém o prazo de expiração da autorização de uso.

b)       Estrutura de retorno em caso de necessidade de atualização (sincronização) dos dados do usuário. Esta mensagem é gerada mensalmente para sincronização com os dados do usuário que aparece no monitor de licenciamento. Mais abaixo é descrito um método que deverá ser invocado para atualização destes dados.

c)       Estrutura de retorno em caso de necessidade de atualização (sincronização) dos dados da empresa. Esta mensagem é gerada mensalmente para sincronização com dos dados da empresa que aparece no monitor de licenciamento. Mais abaixo é descrito um método que deverá ser invocado para atualização dos dados.

d)       Estrutura de retorno em caso de necessidade de atualização dos dados de suporte técnico. Esta mensagem é gerada mensalmente para sincronização com dos dados que aparece no monitor de licenciamento. Mais abaixo é descrito um método que deverá ser invocado para atualização dos dados.

e)       Estrutura de retorno em caso de sucesso ou erro na operação. Note que no Objeto pendent, os dados descritos acima e “a” até “d” são retornados.

a)        

• LSCanUseCA

Implementar um método para verificar se determinado componente acessório do produto pode ser habilitado na linha de produto – Licenciamento de natureza Habilitação.

Procedimento:

                     I.            Verificar se o retorno do método LSIsOnLine é positivo, caso contrário retornar vazio.

                   II.            Verificar se a versão do TOTVS|License Server é igual ou superior a 2014, caso contrário retornar uma exceção.

                  III.            Montar o pacote JSon

                 IV.            Concatenar ao pacote Json a seguinte expressão: Json = “TOTVSLICENSESERVER_DEFAULT|”+Json

                  V.            Invocar o metodo SLC_callinternal passando no parâmetro code o valor 10003 e o novo valor do Json no parâmetro par1.

                 VI.            Analisar o Json retornado para identificar o correto retorno do método.

Parâmetros:

• Id do Slot do componente acessório TOTVS.

Retorno:

• Informe 1 em caso de sucesso e 0 em caso de falha.

1. Json de envio:

1. Json de retorno:

• LSgetOnDemand

Implementar um método para verificar a necessidade de bloqueio no licenciamento de natureza OnDemand. Estes método irá retornar o limite contrato do licenciamento.

Procedimento:

                     I.            Verificar se o retorno do método LSIsOnLine é positivo, caso contrário retornar vazio.

                   II.            Verificar se a versão do TOTVS|License Server é igual ou superior a 2014, caso contrário retornar uma exceção.

                  III.            Montar o pacote JSon

                 IV.            Concatenar ao pacote Json a seguinte expressão: Json = “TOTVSLICENSESERVER_GETONDEMAND|”+Json

                  V.            Invocar o metodo SLC_callinternal passando no parâmetro code o valor 10003 e o novo valor do Json no parâmetro par1.

                 VI.            Analisar o Json retornada para identificar o correto retorno do método.

Parâmetros:

• Id do Slot do licenciamento OnDemand TOTVS.

Retorno:

• Um valor inteiro positivo com o limite do licenciamento OnDemand ou 0 caso o licenciamento não seja OnDemand.

1. Json de envio:

1. Json de retorno:

• LSgetInfo

Implementar um método para verificar algumas informações do servidor, tais como Série e Segmento.

Procedimento:

                     I.            Verificar se o retorno do método LSIsOnLine é positivo, caso contrário retornar vazio.

                   II.            Verificar se a versão do TOTVS|License Server é igual ou superior a 2014, caso contrário retornar uma exceção.

                  III.            Montar o pacote JSon conforme o parâmetro informado

                 IV.            Concatenar ao pacote Json a seguinte expressão: Json = “TOTVSLICENSESERVER_GETINFO|”+Json

                  V.            Invocar o metodo SLC_callinternal passando no parâmetro code o valor 10003 e o novo valor do Json no parâmetro par1.

                 VI.            Analisar o Json retornada para identificar o correto retorno do método.

Parâmetros:

• String com o tipo de informação que deseja-se recuperar do TOTVS|License Server

Retorno:

• String com a informação solicitada.

1. Json de envio:

1. Json de retorno:

• LSsetInfo

Implementar um método para enviar informações adicionais ao servidor.

Procedimento:

                     I.            Verificar se o retorno d método LSIsOnLine é positivo, caso contrário retornar vazio.

                   II.            Verificar se a versão do TOTVS|License Server é igual ou superior a 2014, caso contrário retornar uma exceção.

                  III.            Montar o pacote JSon conforme o parâmetro informado

                 IV.            Concatenar ao pacote Json a seguinte expressão: Json = “TOTVSLICENSESERVER_DEFAULT|”+Json

                  V.            Invocar o metodo SLC_callinternal passando no parâmetro code o valor 10003 e o novo valor do Json no parâmetro par1.

Parâmetros:

• String com o tipo de informação que deseja-se recuperar do TOTVS|License Server.

Retorno:

• String com a informação solicitada.

1. Json de envio:

a)       O Json abaixo deve ser enviado quando houver uma solicitação de complemento de informação LS001.

b)       O Json abaixo deve ser enviado quando houver uma solicitação de complemento de informação LS002.

c)       O Json abaixo deve ser enviado quando houver uma solicitação de complemento de informação LS003.

1. Json de retorno:

Sempre retorna vazio.

1. Realizar o consumo de licença TOTVS.

• Criar o parâmetro Seção “GERAIS” Entrada “FG_LS_ATIVADO” para ativar o processo de consumo de licenças no TOTVS|License Server. Os valores válidos são “SIM” ou “NÃO” para habilitar ou desbilitar respectivamente.
• Criar o parâmetro Seção “GERAIS” Entrada “DE_LS_SERVER_IP” para que seja informado o enderço IP do servidor onde esta instalado o TOTVS|License Server.
• Criar o parâmetro Seção “GERAIS” Entrada “DE_LS_SERVER_PORT” para que seja informada a porta de comunição com o servidor onde esta instalado o TOTVS|License Server.
• Implementar no método “fInzSecurity” da classe “cSecurity” a verificação do parâmetro “GERAIS/FG_LS_ATIVADO”, se for “SIM” realizar o consumo de licença TOTVS, caso contrário continuar o fluxo normal da aplicação.
• O consumo de licença TOTVS dererá ser de acordo com o IP da máquina cliente, o Usuário logado na aplicação e o SlotId do aplicativo em questão.