Histórico da Página

Informações Gerais

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

Objetivo

 O diagnóstico dos recursos utilizados pela experiência de uso 2, tem por objetivo analisar as configurações e componentes que impactam no funcionamento adequado dos Workflows do Fluig, apresentando o resultado da análise e meios para correção das inconsistências encontradas. Portanto, um dos itens essenciais para o correto funcionamento dos serviços dos Workflows do ERP Datasul no Fluig é a disponibilidade do dataset WSExecBO, que deve estar devidamente publicado no Fluig bem como o dataserviceDatasulServerDS para que seja possível executar os programas Progress, à partir dos workflows do Fluig.

Definição da Regra de Negócio

Visão Geral

A ferramenta de diagnóstico das experiências de uso engloba quatro experiências, no entanto esta especificação irá tratar exclusivamente o diagnóstico da experiência 2 (workflows). As demais experiências estarão descritas em especificações distintas facilitando a compreensão profunda de como é realizado o diagnóstico em cada experiência de uso.

O diagnóstico de serviços de workflow deverá analisar e disponibilizar meios para correção de inconformidades nas configurações relevantes para o funcionamento do sistema no que tange à experiência de workflow. A localização deste recurso se dará no Fluig-configurator em uma nova aba específica denominada "Diagnóstico". A funcionalidade de diagnóstico de serviços de workflows estará visível logo abaixo do título "#UX2" - Workflow.

As validações descritas nesta especificação se restringem ao dataset WSExecBO e o dataservice DatasulServerDS, suas configurações, disponibilidade, e devida publicação no Fluig.

Interface:         

A interface da funcionalidade irá atender o diagnóstico das experiências de uso do Fluig 1(Single Sign-on), 2(Workflows), 3(Itens de Menu), 5(Consultas Rápidas). A ferramenta de diagnóstico é dividida em containers separados para facilitar a utilização da ferramenta, e cada item terá um checkbox para que seja possível realizar um diagnóstico personalizado. A seleção do checkbox ao lado do título de cada experiência dispara a seleção de todos os itens relacionados à experiência.

O botão "Diagnosticar Tudo" realizará automaticamente a seleção de todas as experiências de uso e seus respectivos itens, em seguida iniciará o procedimento de diagnóstico.

O botão "Diagnosticar Selecionados" iniciará o procedimento de diagnóstico que irá verificar apenas os itens previamente selecionados pelo usuário.

Protótipo de interface: (Apresentando apenas o container da experiência 2 destacando em amarelo a funcionalidade que verificará se o WSEXECBO está publicado no Fluig. A funcionalidade que verificará se o DatsulServerDS está publicado no Fluig está destacada em vermelho).

1. Consulta se o  WSExecBO está publicado no Fluig
      

   O WSExecBO dentro do Fluig é um Dataservice que é um serviço de dados que fornece acesso às informações, independente da origem dos dados. O WSExecBO no Datasul é um webservice que permite a execução de procedures (regras de negócio) em programas Progress (BO – Business Object) no Datasul através de aplicações web, incluindo Fluig. As chamadas poderão ser feitas a qualquer procedure de maneira não persistente, cujos programas estão disponíveis no AppServer Progress do Datasul configurado. Detalhes: WSExecBO [Datasul]   -    WSExecBO [Fluig]

   Para que o Fluig execute um programa do Datasul, é necessário que no Fluig exista um Dataservice (Desenvolvimento de Formulários#Dataservice) denominado WSExecBO cuja propriedade dataServiceURL aponte para um servidor onde está o Datasul. Exemplo:( http://[servidor onde está o Datasul]:[porta]/wsexecbo/WebServiceExecBO?wsdl ).

    

   • Verificação das configurações de acesso

     A existência dos dados de configuração é essencial para o funcionamento da execução de programas do Datasul por meio do Fluig, portanto a  verificação das configurações de acesso é realizada no momento em que o usuário clicar no botão "Diagnosticar". O sistema irá acessar o arquivo de propriedades "<dir-instalação>/ServidorAplicacao\jboss-4.2.3.GA\server\<instance>\conf\datasul\datasul_framework.properties" para verificar as seguintes informações:

     ecm.integrated=[true/false]
     ecm.isFluig=[true/false]
     ecm.url=http://[servidor do Fluig]:[Porta]/webdesk
     ecm.integration.user.login=[email do usuário de integração]
     ecm.integration.user.password=[senha do usuário de integração]
     ecm.totvs.company.id=[código da empresa de integração]

      

    

   • Verificação da disponibilidade
     
     A verificação da disponibilidade do serviço será realizada por meio de três verificações:

     1. O sistema buscará no arquivo de propriedades "<dir-instalação>/ServidorAplicacao\jboss-4.2.3.GA\server\<instance>\conf\datasul\datasul_framework.properties" as configurações de acesso já validadas.

     2. O sistema executará uma requisição: http://[servidor_fluig]:[porta]/webdesk/ECMDataServiceService   e o método "getAllServices" para listar todos os serviços disponíveis.

     3. O sistema buscará o serviço "WSEXECBO" e informará a URL existente na propriedade "dataServiceURL". O sistema deve encontrar nos serviços do Fluig o WSEXECBO conforme exemplo abaixo para que a validação apresente um resultado positivo.

                 <item>
                    <binding/>
                    <companyId>10</companyId>
                    <dataServiceDescription>WSEXECBO</dataServiceDescription>
                    <dataServiceName>WSEXECBO</dataServiceName>
                    <dataServiceType>1</dataServiceType>
                    <dataServiceURL> http://[servidor do datasul]:[porta]/wsexecbo/WebServiceExecBO?wsdl</dataServiceURL>
                    <wsEngine>1</wsEngine>
                 </item>
      

    
    

   • Protótipo de tela (Ação Diagnosticar resultou em "Ativo"):

     O retorno positivo é indicado na tela sob a forma de uma mensagem "Status: Ativo" em verde. Significando o sucesso na busca pelo "WSEXECBO" dentro do Fluig utilizando as configurações definidas no arquivo de propriedades do produto Datasul "<dir-instalação>/ServidorAplicacao\jboss-4.2.3.GA\server\<instance>\conf\datasul\datasul_framework.properties".

      

     
     

     
     

   • Protótipo de tela (Ação Diagnosticar resultou em "Configuração: Não foi possível acessar os serviços do Fluig com as configurações atuais."):

     O retorno negativo é indicado na tela sob a forma de uma mensagem "Configuração: Não foi possível acessar os serviços do Fluig com as configurações atuais." em vermelho demonstrando a inexistência ou inconsistência nas configurações de conexão definidas no arquivo de propriedades do produto Datasul "<dir-instalação>/ServidorAplicacao\jboss-4.2.3.GA\server\<instance>\conf\datasul\datasul_framework.properties".

     
     

   • Protótipo de tela (Ação Diagnosticar resultou em "Status: WSEXECBO não está publicado no Fluig"):

     O retorno negativo é indicado na tela sob a forma de uma mensagem "Status: WSEXECBO não está publicado no Fluig" em vermelho demonstrando que apesar de existirem configurações consistentes, o WSEXECBO não está publicado no Fluig. Uma mensagem de "Erro Gerado" exibida no relatório apresentará maiores detalhes sobre qual propriedade analisada pode estar inconsistente.

      

     
     
     
    

   Procedimentos para verificação de disponibilidade do WSExecBO no Fluig

   
   

   1. O usuário irá clicar no botão "Diagnosticar".

      Existirá a possibilidade de alterar [protocolo] :// [Servidor] : [Porta],  empresa, login e senha para testar a funcionalidade em casos onde é desejável verificar a disponibilidade do WSEXECBO em outro servidor.

       
      

   2. Verificação das configurações utilizadas pelo WSExecBO:

      O sistema buscará no arquivo de propriedades "<dir-instalação>/ServidorAplicacao\jboss-4.2.3.GA\server\<instance>\conf\datasul\datasul_framework.properties" os dados de configuração necessários para o funcionamento do WSExecBO:

      ecm.integrated=[true/false]
      ecm.isFluig=[true/false]
      ecm.url=http://[servidor do Fluig]:[Porta]/webdesk
      ecm.integration.user.login=[email do usuário de integração]
      ecm.integration.user.password=[senha do usuário de integração]
      ecm.totvs.company.id=[código da empresa de integração]

      
      
      

   3. Verificação de disponibilidade do serviço WSExecBO no Fluig:

      
      O sistema executará uma procedure de testes utilizando o método userLogin passando o usuário super do datasul_framework.properties.
      
      Requisição interna: ex: http://ribanceira:8080/webdesk/ECMDataServiceService 
      <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.dataservice.ecm.technology.totvs.com/">
         <soapenv:Header/>
         <soapenv:Body>
            <ws:getAllServices>
               <companyId>10</companyId>
               <username>integrador@totvs<username>integrador@totvs.com.br<br</username>
               <password>Totvs@123</password>
            </ws:getAllServices>
         </soapenv:Body>
      </soapenv:Envelope>
      
      
      Retorno:
      <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
         <soap:Body>
            <ns1:getAllServicesResponse xmlns:ns1="http://ws.dataservice.ecm.technology.totvs.com/">
               <dataservice>
                  <item>
                     <binding/>
                     <companyId>10</companyId>
                     <dataServiceDescription>WSECMSERVICELOGIX</dataServiceDescription>
                     <dataServiceName>WSECMSERVICELOGIX</dataServiceName>
                     <dataServiceType>1</dataServiceType>
                     <dataServiceURL>http://marape.jv01.local:5330/WSECMSERVICELOGIX.apw?wsdl</dataServiceURL>
                     <wsEngine>2</wsEngine>
                  </item>
                  <item>
                     <binding/>
                     <companyId>10</companyId>
                     <dataServiceDescription>WSEXECBO</dataServiceDescription>
                     <dataServiceName>WSEXECBO</dataServiceName>
                     <dataServiceType>1</dataServiceType>
                     <dataServiceURL>http://cordas:8080/wsexecbo/WebServiceExecBO?wsdl</dataServiceURL>
                     <wsEngine>1</wsEngine>
                  </item>
               </dataservice>
            </ns1:getAllServicesResponse>
         </soap:Body>
      </soap:Envelope>
       
      
      A existência do Serviço <dataServiceName>WSEXECBO</dataServiceName> e o endereço para onde o serviço está apontando são propriedades analisadas pelo sistema para resultar em um status positivo ou negativo sobre o WSEXECBO publicado no Fluig.
       
      
      

2.  Consulta se o  DatasulServerDS está publicado no Fluig
   

    

   O DatasulServerDS do Fluig é um Dataset que por meio de um serviço de dados suporta do WSEXECBO cujo objetivo é fornecer acesso às informações, independente da origem dos dados.

   Para que o Fluig execute um programa do Datasul, é necessário que no Fluig exista um Dataservice publicado no seguinte endereço: http://[servidor][porta]/webdesk/ECMDatasetService?wsdl

• 
  
  • Procedimentos para verificação de publicação e disponibilidade do Dataset DatasulServerDS no Fluig
    
    

    1. O usuário irá clicar no botão "Diagnosticar".

       Existirá a possibilidade de alterar [protocolo] :// [Servidor] : [Porta],  empresa, login e senha para testar a funcionalidade em casos onde é desejável verificar a disponibilidade do DatasulServerDS em outro servidor.

        
       

    2. Verificação das configurações utilizadas pelo DatasulServerDS:

       O sistema buscará no arquivo de propriedades "<dir-instalação>/ServidorAplicacao\jboss-4.2.3.GA\server\<instance>\conf\datasul\datasul_framework.properties" os dados de configuração necessários para o funcionamento do DatasulServerDS:

       ecm.integrated=[true/false]
       ecm.isFluig=[true/false]
       ecm.url=http://[servidor do Fluig]:[Porta]/webdesk
       ecm.integration.user.login=[email do usuário de integração]
       ecm.integration.user.password=[senha do usuário de integração]
       ecm.totvs.company.id=[código da empresa de integração]

       
       
       

    3. Verificação de disponibilidade do serviço DatasulServerDS:
       O sistema executará uma procedure de testes utilizando o método getAvailableDatasets passando o usuário integrador do datasul_framework.properties.
       
       Requisição interna: ex:  http://ribanceira:8080/webdesk/ECMDatasetService?wsdl
       <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.dataservice.ecm.technology.totvs.com/">
          <soapenv:Header/>
          <soapenv:Body>
             <ws:getAvailableDatasets>
                <companyId>10</companyId>
                <username>[email protected]</username>
                <password>Totvs@123</password>
             </ws:getAvailableDatasets>
          </soapenv:Body>
       </soapenv:Envelope>
       
       
       Retorno:
       <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
          <soap:Body>
             <ns1:getAvailableDatasetsResponse xmlns:ns1="http://ws.dataservice.ecm.technology.totvs.com/">
                <datasets>
                   <item xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">AccessLog</item>
                   <item xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">contentLogDataset</item>
                   <item xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">customFields</item>
                   <item xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">DatasulServerDS</item>
                   <item xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">destinationArea</item>
                   <item xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">disciplineClassDataset</item>
                   <item xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">disciplineItemDataset</item>
                </datasets>
             </ns1:getAvailableDatasetsResponse>
          </soap:Body>
       </soap:Envelope>
        
       
       A existência do iten <item xsi:type="xs:string" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">DatasulServerDS</item>  é a propriedade analisada pelo sistema para resultar em um status positivo ou negativo sobre o DatasulServerDS publicado no Fluig.
       
       

       
       
       

  • Protótipo de tela (Ação Diagnosticar resultou em "Ativo"):
    
    O retorno positivo é indicado na tela sob a forma de uma mensagem "Status: Ativo" em verde. Significando o sucesso na busca pelo "DatasulServerDS" dentro do Fluig utilizando as configurações definidas no arquivo de propriedades do produto Datasul "<dir-instalação>/ServidorAplicacao\jboss-4.2.3.GA\server\<instance>\conf\datasul\datasul_framework.properties".
    
    
    
    

  • Protótipo de tela (Ação Diagnosticar resultou em "Serviço: DatasulServerDS não encontrado no Fluig. Falha de acesso."):

    O retorno negativo é indicado na tela sob a forma de uma mensagem "Serviço: DatasulServerDS não encontrado no Fluig. Falha de acesso." em vermelho demonstrando a inexistência ou inconsistência nas configurações de conexão gerando "Falha de acesso". Estas configurações estão definidas no arquivo de propriedades do produto Datasul "<dir-instalação>/ServidorAplicacao\jboss-4.2.3.GA\server\<instance>\conf\datasul\datasul_framework.properties".

     

    
    
    

  • Protótipo de tela (Ação Diagnosticar resultou em "Status: DatsulServerDS não está publicado no Fluig"):

    O retorno negativo é indicado na tela sob a forma de uma mensagem "Status: DatasulServerDS não está publicado no Fluig" em vermelho demonstrando que apesar de existirem configurações consistentes, o DatasulServerDS não está publicado no Fluig. Uma mensagem de "Erro Gerado" exibida no relatório apresentará maiores detalhes sobre qual propriedade analisada pode estar inconsistente.
    

Relatório:

A ferramenta de diagnóstico deve produzir um relatório com os resultados das verificações de cada item selecionado. Este relatório ficará disponível para download enquanto o Fluig-configurator estiver aberto.

O relatório será emitido em formato de texto contendo as mesmas informações existentes em tela.

     - Layout do Relatório

    O layout do relatório deve seguir a mesma ordem estrutural do resultado apresentado em tela. Também deve conter data e horário em que o mesmo foi emitido pelo sistema, desconsiderando a data e horário de  download.