Histórico da Página
...
Dados do Projeto
Cliente | Projeto Nº | Projeto Descrição |
|---|---|---|
SERVIÇO NACIONAL DE APRENDIZAGEM INDUSTRIAL- SENAI e SERVIÇO SOCIAL DA INDÚSTRIA – SESI | FS007273 | Integrações Benner, CRM e OFFICE |
Síntese
O objetivo deste documento é descrever todas as implementações desenvolvidas como solução para os requisitos descritos no documento de especificação FS007273, onde o cliente solicita a integração com os sistemas Benner, CRM e OFFICE com TOTVS.
Instalando a Customização
Recomenda-se primeiramente disponibilizar a customização em um ambiente de homologação e somente após a validação de todos os itens libera-la para produção.
Ambiente necessário
Sistema Base: TOTVS Educacional.
Banco de Dados: SQLServer
Versão do ERP: 11.83
Execução de scripts
Para o perfeito funcionamento da customização, é necessário executar os scripts de baco de dados listados abaixo:
- Totvs_Custom_Register_Action: Script responsável por registrar todas a Actions customizadas na base de dados.
- Totvs_Custom_Consolidated_All: Script responsável por criar/atualizar todas as tabelas customizadas na base de dados.
Executando o Instalador de arquivos WinForms
O instalador é gerado com o nome "TOTVS Customização (Win) – CNI DR Paraná - 11.80.x.xxx" e esse copiará todos os arquivos referentes a customização para a máquina servidora da aplicação. O instalador de arquivos deverá ser executado em todas as máquinas que utilizarão a Customização.
Para realizar a instalação, basta seguir os passos abaixo:
Figura 1 - Instalador da customização
Figura 2 - Instalador da customização
Figura 3 - Instalador da customização
Figura 4 - Instalador da customização
Após a instalação o usuário poderá consistir os arquivos correspondentes a customização em seus respectivos diretórios.
Nome do arquivo | Diretório | ||||||||
|---|---|---|---|---|---|---|---|---|---|
RM.Cst.CNI_DR_Parana.CRM.Plugin.dll | C:\TOTVS\CorporeRM\RM.Net\Custom{color}| | C:\TOTVS\CorporeRM\RM.Net\Custom{color}| | C:\TOTVS\CorporeRM\RM.Net\Custom{color}| | C:\TOTVS\CorporeRM\RM.Net\Custom{color}| | C:\TOTVS\CorporeRM\RM.Net\Custom{color}| | C:\TOTVS\CorporeRM\RM.Net\Custom{color}| | C:\TOTVS\CorporeRM\RM.Net\Custom{color}| | C:\TOTVS\CorporeRM\RM.Net\Custom{color}| | C:\TOTVS\CorporeRM\RM.Net\Custom{color}| |
|
|
|
|
|
|
| Diretório | |||||
|---|---|---|---|---|---|---|
Web.config | C:\inetpub\wwwroot\WsCNI{color}| | C:\inetpub\wwwroot\ WsCNI{color}| | C:\inetpub\wwwroot\ WsCNI{color}| | C:\inetpub\wwwroot\ WsCNI{color}| | C:\inetpub\wwwroot\ WsCNI\bin{color}| | C:\inetpub\wwwroot\ WsCNI\bin{color}|
|
- LibRMNET: Indique o diretório onde foi instalado o CorporeRM, por padrão o diretório é "C:\TOTVS\CorporeRM\RM.Net".
...
- LocalizationLanguage: Utilizar o mesmo valor indicado no arquivo RM.exe.config
Configurando o IIS
O processo de instalação do WebService descrito logo acima, cria um diretório virtual no IIS (Gerenciador de Serviços de Informações da Internet) e copia todos os arquivos customizados para o local indicado. Porém este diretório, deverá ser convertido para um "Aplicativo" conforme figura abaixo:
Figura 12 - Convertendo o Diretório virtual
Após realizar a conversão, é recomendado reiniciar o serviço do IIS.
Importante!
Conforme descrito na especificação, ressaltamos que plugins e dlls desenvolvidos para a versão acima podem apresentar algum tipo de incompatibilidade nas próximas versões oficiais, precisando assim serem recompilados(as). Portanto, qualquer mudança de versão deve ser previamente comunicada à Totvs. A forma dessa comunicação é a seguinte:
- Abertura de uma ocorrência junto ao suporte (suporte.totvs.com) com no mínimo 15 dias de antecedência da data marcada para conversão, solicitando ao departamento de customização a conversão do plugin.
- Após recebimento do mesmo executar a validação de suas funcionalidades em um ambiente de testes da nova versão.
Permissão de acesso as telas
No primeiro momento, os usuários não terão acesso ao menu onde foi disponibilizado a customização, dessa maneira, será necessário conceder tal permissão ao perfil do usuário.Verificando perfil do Usuário
Para verificar qual perfil está vinculado ao usuário, siga os passos abaixo:
- Acessar o "RM.exe" em "C:\totvs\CorporeRM\RM.Net"
- Menu: TOTVS Serviços Globais | Segurança | Usuário;
- No campo (Sistema) selecione o produto TOTVS Folha de Pagamento;
- Busque pelo usuário desejado e clique em editar;
- Navegue até a aba Segurança;
- Verifique qual é o perfil do usuário (Como mostra na imagem exemplo abaixo o perfil é DBA);
Figura 13 - Permissão 1
Figura 14 - Permissão 2
Liberando acesso ao menu
Após descobrir o Perfil atrelado ao usuário, será necessário acessar o cadastro de Perfis e conceder permissão de acesso ao menu customização.
- Menu: TOTVS Serviços Globais | Segurança | Perfis;
- No campo (Sistema) selecione o produto TOTVS Folha de Pagamento;
- Busque pelo perfil desejado e clique em editar (como no exemplo acima o perfil será DBA);
- Navegue até a aba Acesso a Menus;
- Procure pelas customizações e selecione as desejadas;
- Clique em Permitir Acesso e depois em Ok.
Figura 15 - Permissão 3
Parâmetros da Integração CRM - WebService
Pré - requisitos
Os itens 3 e 4 descritos acima, devem ser executados com sucesso.
Descrições do Processo
Foi desenvolvido um cadastro customizado, onde será possível informar os parâmetros referentes ao processo de integração com o CRM.
Este cadastro ficará disponível através do menu "Customização | Inregração CRM | WebService CRM", conforme imagem abaixo:
Figura 16 - Menu customização
Ao acionar esta opção, será apresentada uma tela de cadastro, padrão do CorporeRM onde será exibido os seguintes campos:
- Endereço Ws CRM: Neste campo deverá ser informado o endereço do WebService que será utilizado para a atualização do Produto no CRM.
- Chave: Deverá ser informado o valor da Chave utilizada na autenticação do WebService.
Figura 17 - Cadastro do Responsável
Detalhamento dos campos
ZPARAMCRMWEBSERVICE |
|---|
Campo | Descrição | Observações |
|---|---|---|
CODCOLIGADA | Código da Coligada | Preenchimento obrigatório |
ENDERECOWS | Endereço do WebService CRM | Preenchimento obrigatório |
CHAVEWS | Chave criptografada utilizada na autenticação do WebService CRM | Preenchimento obrigatório |
Parâmetros da Integração CRM – Situação de Matricula
Pré - requisitos
Os itens 3 e 4 descritos acima, devem ser executados com sucesso.
Descrições do Processo
Foi desenvolvido um cadastro customizado, onde será possível informar os parâmetros referentes ao processo de integração com o CRM.
Este cadastro ficará disponível através do menu "Customização | Inregração CRM | Situação de Matrícula", conforme imagem abaixo:
Figura 18 - Menu customização
Ao acionar esta opção, será apresentada uma visão de dados, padrão do CorporeRM que apresentará de acordo com o filtro selecionado as situações de matrícula que serão consideradas como matriculado na apuração de vagas.
Para informar uma nova situação, o usuário deverá acionar o botão "Novo", onde será apresentada uma tela exibindo o campo Cod. Status, que apresenta todas as situações previamente cadastradas na tabela SSTATUS.
Figura 19 – Cadastro da situação de matrícula
Detalhamento dos campos
ZPARAMCRMSTATUSMATRICULA |
|---|
Campo | Descrição | Observações |
|---|---|---|
CODCOLIGADA | Código da Coligada | Preenchimento obrigatório |
CODSTATUS | Código do status | Preenchimento obrigatório |
Consulta turmas com Matrícula em Aberto
Pré - requisitos
Os itens 3, 4 e 5 descritos acima, devem ser executados com sucesso.
Descrições do Processo
Foi disponibilizado pela customização um WebService que será responsável por retornar as turmas com Matrícula em Aberto no TOTVS Educacional.
Uma vez o WebService instalado e devidamente configurado, conforme descrito no início deste documento, o sistema CRM, deverá configurar suas conexões que devem apontar para o diretório em que foi configurado o WebService.
Abaixo segue uma demonstração básica desta configuração utilizando o programa openSource denominado "SoapUI" e que poderá ser utilizado para realizar testes de conexão com o TOTVS.
Para isso, o serviço do RM.Host no servidor de aplicação deverá estar ativo e o arquivo Web.config devidamente configurado.
Para mais detalhes do SoapUI, acesse: http://www.soapui.org/
Para baixar o programa acesse: http://sourceforge.net/projects/soapui/files/
Acesse o menu "File | New SOAP Project", para informar a conexão com o WebServices.
Figura 20 - Novo projeto SOAP
Defina um nome para o projeto e informe o caminho do WSDL do WebService.
Figura 21 - Diretório do WebService com WSDL
Será apresentado na árvore do projeto todos os WebMetodos disponíveis no WebService e para cada método, será necessário informar o usuário e senha de conexão do Corpore, e o tipo de senha deverá ser "PasswordText", conforme figura abaixo.
Figura 22 - Configuração do Usuário e Senha
O sistema CRM ao realizar a consulta no WebService deverá informar o item de Venda conforme imagem abaixo:
Figura 23 – Chamada do método ConsultaVagas
Na consulta, a customização, encontrará a Matriz Aplicada vinculada ao item de venda enviado.
Através da Matriz Aplicada será verificado na Matriz curricular se o controle de alunos do curso está parametrizado para ser feito por "Turma", conforme regra definida pelo SESI/SENAI. Caso não esteja, será gerado XML de erro e o processo finalizado.
Caso contrário, para cada turma vinculada a Matriz Aplicada será apurado:
- O número máximo de alunos permitido para a turma (STURMA.MAXALUNOS)
...
Apurado o número de vagas das turmas, será gerado arquivo XML a ser retornado pelo WebService. É importante ressaltar que para o mesmo item de venda poderão ser apuradas mais de uma turma no período, por este motivo, o arquivo XML possuirá uma estrutura de repetição na turma.
Figura 24 – Retorno do WebService com erro
Figura 25 – Retorno do WebService com Sucesso
Dados da ocorrência para o item de venda
Pré - requisitos
Os itens 3, 4 e 5 descritos acima, devem ser executados com sucesso.
Para o perfeito funcionamento desta rotina, deverá ser criado na tabela complementar de Curso, os campos RETORNO e DATAATUALIZACAO, ESCOLARIDADEMINIMA, IDADEMINIMA, IDADEMAX, JUSTIFICATIVA, OBJETIVOS, OBJGERAL, OBJESP, COMPGERAL conforme imagens abaixo:
Figura 26 – Campo complementar Retorno
Figura 27 – Campo complementar DATAATUALIZACAO
Figura 28 – Campo complementar ESCOLARIDADEMINIMA
Figura 29 – Campo complementar IDADEMINIMA
Figura 30 – Campo complementar IDADEMAX
Figura 31 – Campo complementar JUSTIFICATIVA
Figura 32 – Campo complementar OBJETIVOS
Figura 33 – Campo complementar OBJGERAL
Figura 34 – Campo complementar OBJESP
Figura 35 – Campo complementar COMPGERAL
Descrições do Processo
No TOTVS Educacional assim que for criada e/ou atualizada a Matriz Aplicada ou o Anexo customizado de Dados do Contrato (implementado através da Especificação de Customização FS007270), será consumido método a ser disponibilizado no WebService do CRM enviando os dados complementares vinculados ao item de venda.
O processo customizado será disparado através do botão salvar de qualquer um dos dois cadastrados mencionados acima.
O endereço webservice a ser consumido, assim como a chave para autenticação, deverão estar previamente parametrizados através do item 5 deste documento.
Os dados complementares vinculados ao item de venda a serem enviados para o CRM serão extraídos da Matriz Aplicada a qual o item de venda está vinculado.
O método a ser consumido será o AtualizarProduto, sendo enviadas as informações abaixo:
WEBSERVICE CRM: PRODUTOSOAP |
Método: AtualizarProduto |
Parâmetro | Descrição | Tipo | Requerido | Origem da Informação no TOTVS |
produtoId | Número identificador do produto no AX | String | Not Null | Anexos de Dados Contratuais, campo Item de Venda |
nomeDoProduto | Descrição do Item no AX | String | Not Null | SCURSO.NOME |
casa | informar 2 para SESI, 3 para SENAI | Int | Not Null | GCOLIGADA.CODCOLIGADA (coligada 2 – Sesi, |
listaDePreco | Nome da Unidade | String | Not Null | GFILIAL.NOME |
linhaDeAcao | Descrição da Linha de Ação do Programa (extraído do centro de responsabilidade do Item, enviado pelo AX) | String | Not Null | Através do terceiro nível do SHABILITACAOFILIAL.CODCCUSTO, busca GCCUSTO.NOME |
familiaDoProduto | Descrição do Sub-Programa(extraído do centro de responsabilidade do Item, enviado pelo AX) | String | Not Null | Através do quarto nível do SHABILITACAOFILIAL.CODCCUSTO, busca GCCUSTO.NOME |
classeDoProduto | Descrição da Modalidade(extraído do centro de responsabilidade do Item, enviado pelo AX) | String | Not Null | Através do quinto nível do SHABILITACAOFILIAL.CODCCUSTO, busca GCCUSTO.NOME |
linhaDoProduto | Descrição da Área de Atuação(extraído do centro de responsabilidade do Item, enviado pelo AX) | String | Not Nul | Através do sexto nível do SHABILITACAOFILIAL.CODCCUSTO, busca GCCUSTO.NOME |
tipo | fixo "Educação" | String | Not Null | fixo "Educação" |
descrição | Texto como referência adicional para identificar o Produto/Item/Ocorrência. | String | Not Null | SCURSO.NOME |
obrigatoriedades | campo com texto informando Escolaridade Mínima, Idade Mínima e Máxima para realizar o curso, | String | Not Null | Escolaridade Mínima = SCURSOCOMPL.ESCOLARIDADEMINIMA; Idade Mínima = SCURSOCOMPL.IDADEMIN |
grupoDeUnidadeDeMedidas | fixo "Unidade Padrão" | String | Not Null | fixo "Unidade Padrão" |
unidadeDeMedidaPadrao | fixo "Unidade Principal" | String | Not Null | fixo "Unidade Principal" |
ofereceDecimais | fixo 0 | String | Not Null | fixo 0 |
dataInicio | Data de inicio do curso | Date | Not null | SGRADE.DTINIICIO |
dataFim | Data de fim do curso | Date | Not null | SGRADE.DTFIM |
justificativa | Justificativa do curso | Texto | Null | SCURSOCOMPL.JUSTIFICATIVA |
objetivo | Objetivo do curso | Texto | Null | Se SESI: |
objetivoEspecifico | Objetivo especifico do curso | Texto | Null | Se SENAI: |
descricaoCurso | Descrição do Curso | Texto | Null | SHABILITACAOFILIAL.DESCRICAOCURSO |
competenciaGeral | Competencia Geral do Curso | Texto | Null | Competência Geral (SCURSOCOMPL..COMPGERAL) |
cargaHoraria | Carga horária do curso | Numerico | Not null | Carga Horária (SGRADE.CARGAHORARIA) |
O processo customizado irá enviar a atualização de apenas um produto (item de venda) por vez.
É importante ressaltar que para um item de venda poderá existir N matrizes aplicadas no mesmo curso.
O método AtualizarProduto retorna o status da atualização e uma mensagem de erro caso exista, este retorno assim como a data e hora da atualização, será armazenado em campo complementar do curso (SCURSOCOMPL.DATAATUALIZACAO, SCURSOCOMPL.RETORNO). É importante ressaltar que somente o registro da última atualização estará armazenado.
Professores e Técnicos de Ensino
Pré - requisitos
Os itens 3, 4 e 5 descritos acima, devem ser executados com sucesso.
Descrições do Processo
Foi disponibilizado pela customização um WebService que será responsável por sincronizar os dados das "pessoas" cadastradas no sistema Benner.
Uma vez o WebService instalado e devidamente configurado, conforme descrito no início deste documento, o sistema CRM, deverá configurar suas conexões que devem apontar para o diretório em que foi configurado o WebService.
Abaixo segue uma demonstração básica desta configuração utilizando o programa openSource denominado "SoapUI" e que poderá ser utilizado para realizar testes de conexão com o TOTVS.
Para isso, o serviço do RM.Host no servidor de aplicação deverá estar ativo e o arquivo Web.config devidamente configurado.
Para mais detalhes do SoapUI, acesse: http://www.soapui.org/
Para baixar o programa acesse: http://sourceforge.net/projects/soapui/files/
Acesse o menu "File | New SOAP Project", para informar a conexão com o WebServices.
Figura 36 - Novo projeto SOAP
Defina um nome para o projeto e informe o caminho do WSDL do WebService.
Figura 37 - Diretório do WebService com WSDL
Será apresentado na árvore do projeto todos os WebMetodos disponíveis no WebService e para cada método, será necessário informar o usuário e senha de conexão do Corpore, e o tipo de senha deverá ser "PasswordText", conforme figura abaixo.
Figura 38 - Configuração do Usuário e Senha
O sistema Benner ao chamar o método InserePessoa, deverá informar um Xml contendo todas as informações nescessárias para inclusão de uma pessoa no TOTVS.
Para mais detalhes dos campos a serem enviados, consulte o documento de especificação "FS007273 – Integrações Benner,CRM e OFFICE" no requisito 21 e página 22.
Abaixo segue um exemplo da chamada ao WebSerivce:
Figura 39 – Chamada do método InserePessoa
Consumido o método, a customização verificará se os parâmetros passados são válidos. Se os parâmetros não forem válidos, será gerado XML de erro e o processo finalizado.
Se os parâmetros forem válidos, a customização verificará se o CPF se a pessoa já está cadastrada na tabela padrão do TOTVS.
Se existir, o processo customizado irá atualizar o registro da pessoa. Caso contrário, ou seja, a pessoa não exista, o processo customizado irá inserir um novo registro na tabela PPESSOA.
Tanto para inclusão quanto atualização, será utilizada funcionalidade padrão do TOTVS sendo validadas todas as regras de negócio do ERP Padrão.
Figura 40 – Retorno do WebService com Sucesso
E-mail, senha inicial do professor/aluno
Pré - requisitos
Os itens 3, 4 e 5 descritos acima, devem ser executados com sucesso.
Para o perfeito funcionamento desta rotina, deverá ser criado nas tabelas complementares de Aluno e Professor, os campos EMAIL e SENHA, conforme imagem abaixo:
Figura 41 – Campo complementar Email
Figura 42 – Campo complementar Senha
Descrições do Processo
Foi disponibilizado pela customização um WebService que será responsável por sincronizar os dados do endereço de e-mail e senha cadastrados no sistema OFFICE.
Uma vez o WebService instalado e devidamente configurado, conforme descrito no início deste documento, o sistema OFICE, deverá configurar suas conexões que devem apontar para o diretório em que foi configurado o WebService.
Abaixo segue uma demonstração básica desta configuração utilizando o programa openSource denominado "SoapUI" e que poderá ser utilizado para realizar testes de conexão com o TOTVS.
Para isso, o serviço do RM.Host no servidor de aplicação deverá estar ativo e o arquivo Web.config devidamente configurado.
Para mais detalhes do SoapUI, acesse: http://www.soapui.org/
Para baixar o programa acesse: http://sourceforge.net/projects/soapui/files/
Acesse o menu "File | New SOAP Project", para informar a conexão com o WebServices.
Figura 43 - Novo projeto SOAP
Defina um nome para o projeto e informe o caminho do WSDL do WebService.
Figura 44 - Diretório do WebService com WSDL
Será apresentado na árvore do projeto todos os WebMetodos disponíveis no WebService e para cada método, será necessário informar o usuário e senha de conexão do Corpore, e o tipo de senha deverá ser "PasswordText", conforme figura abaixo.
Figura 45 - Configuração do Usuário e Senha
O sistema OFFICE ao chamar o método AtualizaEmail, deverá informar um Xml contendo todas as informações nescessárias para inclusão/Atualização dos campos e-mail e senha de uma pessoa no TOTVS.
Para mais detalhes dos campos a serem enviados, consulte o documento de especificação "FS007273 – Integrações Benner,CRM e OFFICE" no requisito 22 e página 28.
Abaixo segue um exemplo da chamada ao WebSerivce:
Figura 46 – Chamada do método AtualizaEmail
Consumido o método, será verificado se os parâmetros passados são válidos. Se os parâmetros não forem válidos, será gerado XML de erro e o processo finalizado.
Se parâmetros válidos, entre os parâmetros o método receberá um arquivo no formato XML, com layout conforme definido. O processo customizado irá verificar se Tag "RA" está preenchida. Se sim, através da coligada e do RA, o aluno será localizado no cadastro padrão do TOTVS Educacional e os campos complementares e-mail (SALUNOCOMPL.EMAIL) e senha inicial (SALUNOCOMPL.SENHA) atualizados de acordo com informação do registro no arquivo.
Caso contrário, ou seja, Tag "RA" não preenchida, através da coligada e do CPF, o professor será localizado no cadastro padrão do TOTVS Educacional e os campos complementares e-mail (SPROFESSORCOMPL.EMAIL) e senha inicial (SPROFESSORCOMPL.SENHA) atualizados de acordo com informação do registro no arquivo.
Não encontrando o registro no TOTVS, será gerado erro no arquivo de retorno.
Figura 47 – Retorno do WebService com Erro
Figura 48 – Retorno do WebService com Sucesso
Import HTML Content
Visão Geral
Conteúdo das Ferramentas