S-Works - Camada Integração

S-Works - Camada Integração

1. Escopo dos serviços 


Neste manual estão contidas todas as informações necessárias referentes às integrações do S-Works.

2. Webhook 


O Webhook permite a visualização gerencial dos resultados e informações geradas através de dashboards, indicadores de performance (KPI) e consultas padrão online. 
São disponibilizados todos os registros e logs de execução das tarefas, de forma a permitir controle e rastreabilidade de toda operação. 
Realiza a simulação e cálculo do CAPACITY, que traduz o número de recursos necessários para a operação.


3. Integrações (API’s)


As API´s são a forma de integração do S-Works com outros sistemas, seja da Simply, terceiros ou do próprio cliente. Elas são parte fundamental, pois a partir delas, o S-Works desempenha as funcionalidades configuradas nos workflows.
Elas são criadas pela Simply e importadas no S-Works através do menu Administração >> APIs, para registrar as funcionalidades que os workflows do sistema irão desempenhar. 


                     

No menu Administração>APIs , o sistema exibe a coleção de APIs configuradas atualmente no sistema, que são:
  1. SWorks.Core.ServerAPI.dll
  2. SWorks.Utils.API.dll
De posse das APIs fornecidas no pacote de instalação, verifique se cada API a ser adicionada já existe no sistema. Caso a API não exista, será necessário adicioná-la. Para adicionar uma API, siga o passo a passo abaixo:

3.1 Adicionar API 


1. Clique no menu Administração> APIs; 
2. Clique em Adicionar API; 







3. Selecione a DLL desejada e clique em salvar:



Após salvar, o sistema exibirá uma lista de APIs existentes no S-Works acrescentando a API incluída anteriormente.





É possível visualizar os métodos e dados disponíveis em cada API,  clicando no sinal de "+" ao lado da API: 




 O sistema exibe os métodos disponíveis para a API. 

- 





Clique em  detalhar  para visualizar os campos/detalhes do método.




Os métodos são funcionalidades que realizam procedimentos internos (Funções do S-Works) ou externos (Funções de outros sistemas) por exemplo REC, Mining, etc.
Ao clicar em detalhar é possível visualizar as tarefas que utilizam o método selecionado. No exemplo, o método é AdicionarPendenciaDocumental. 







É possível visualizar os detalhes do método selecionado, conforme a imagem abaixo:




Observações:

1. Parâmetros de configuração: são as informações da chamada do método; 

2. Parâmetros internos: são os campos que ficam disponíveis após a execução do método, podendo ser utilizados nas expressões nas atividades do fluxo.


Clique em atualizar, para atualizar a API: 




Quando uma API é atualizada a seguinte mensagem é exibida: 





Clique em workflows para visualizar os workflows que utilizam a API selecionada:  













Clique em excluir para excluir a API selecionada: 




3.2 Funções dos métodos e suas API’s


  1. API: SWorks.Atomics.API.dll 
  1. API: SWorks.Core.Server.API.dll
  1. API: SWorks.Mining.API.dll
  1. API: SWorks.Rec.API.dll 
  1. API: SWorks.SCC.API.dll
  1. API: SWorks.Utils.API.dll


3.2.1 API: SWorks.Atomics.API.dll 


Método: ConsultarSolicitacaoProcessamento - Método que realiza integração com o Atomics para consultar a extração do OCR dos documentos de um processo já solicitado por outro sistema. A tarefa aguardará o retorno do Atomics e associará o OCR retornado ao documento anexado no processo.





Método: ConverterDocumentosIN100 -  Método que aciona o Atomics para converter os documentos informados para o padrão IN 100.




Método: DocumentosIN100 - Método que obtém os documentos da IN 100 após a tipificação do Atomics. 


   


Método: Extracao - Este método realiza integração com o Atomics para solicitar a extração do OCR dos documentos do processo. A tarefa aguardará o retorno do Atomics e associará o OCR retornado ao documento anexado no processo. 



Método: QuantificarUtilizacaoEndereco - Este método realiza integração com o Atomics para consultar a quantidade de utilização de determinado endereço. O método grava nos dados internos quantas vezes determinado endereço foi utilizado, e em quais propostas ele foi utilizado.



Método: RecuperarSolicitacaoVAR - Método que realiza a consulta da solicitação no VAR.



Método: Tipificacao - Método que realiza integração com o Atomics para solicitar a tipificação dos documentos do processo. A tarefa aguardará o retorno do Atomics e associará os formulários definidos no workflow com os documentos do processo. Atenção: É necessário que os formulários tenham nomes idênticos (case-sensitive) aos mapeados no Atomics.


Método: TipificacaoExtracao - Método que realiza integração com o Atomics para solicitar a tipificação e extração do OCR dos documentos do processo. A tarefa aguardará o retorno do Atomics e associará os formulários definidos no workflow com os documentos do processo. Atenção: É necessário que os formulários tenham nomes idênticos (case-sensitive) aos mapeados no Atomics.







3.2.2 API: SWorks.Core.Server.API.dll


Método: AdicionarPendenciaDocumental - Método que adiciona uma pendência documental a um formulário configurado no workflow. O formulário precisa conter uma tabela de motivos parametrizada. O motivo precisa ser um dos itens contidos na tabela utilizada.




Método: AguardarParaProsseguir - Método que cria um delay (mesmo que prorrogação) no processamento do workflow, fazendo com que sua execução prossiga após o tempo parametrizado.



Método: AlteraCampo - Método para alterar um dado de entrada do processo.































Método: AlteraCampoComDoc - Método que gera uma tarefa manual para realizar alteração dos dados de entrada parametrizados. Os documentos tipificados com o formulário parametrizado serão mostrados na tela para execução manual da tarefa.






Método: AlteraCampoObjetoRelacionamento - Método para alterar um dado de objeto do relacionamento do processo.




Método: AlterarPrioridadeProcesso - Método que processa uma expressão lógica e reflete o resultado na prioridade do processo que está sendo executado. Se a expressão for verdadeira, a prioridade da tarefa será alterada para a que foi informada na expressão, caso contrário, a prioridade continuará a mesma.



Método: AnexarDocumentoLink - Método que faz download de um documento usando o link informado e tentará anexar no processo atual. Caso o formulário seja informado, o documento será tipificado com o valor informado.


Método: AprovarDocumentacao - Método que atribui a todos os documentos que estão com status de análise "pendente", o status de "aprovado". Opcionalmente, é possível filtrar os formulários aos quais isso se aplicará, do contrário, todos os documentos pendentes serão afetados.




Método: CampoDocumento - Método que recupera um campo do documento ou um valor específico através de uma expressão regular.





Método: CampoDocumentoData - Método que recupera uma data do documento através de uma palavra-chave.






Método: CamposExtraidos - Método que verifica se os campos informados no parâmetro foram extraídos para o tipo de documento informado.


Método: CancelarProcesso - Método que cancela o processo atual, colocando todas as tarefas pendentes como não executadas e finaliza todas as atividades manuais pendentes. Opcionalmente, um motivo de cancelamento pode ser informado para que seja atribuído ao processo.






Método: ComparaCampo - Método que realiza a comparação entre campos extraídos e dados de entrada/texto literal. Esse método funciona tanto para documentos cujo OCR estendido ou simplificado (templates).
Tipos de comparações possíveis:
Contains : Verifica se determinado dado de entrada/texto literal está contido no texto extraído do documento.
Regex: Usa mecanismo de expressão regular para critérios de comparação no dado de entrada em relação ao texto extraído do documento.
Levenshtein: Usa o algoritmo de comparação de textos (Levenshtein String Distance) que usa uma taxa de semelhança como critério de aceitação.





Método: ComparaCampoCPF - Método que realiza a comparação entre campos extraídos e dados de entrada/cpf. Esse método funciona para documentos com OCR estendido. 
Tipo de comparação executada:

Contains : Verifica se determinado dado de entrada/cpf está contido no texto extraído do documento.
Levenshtein : Usa o algoritmo de comparação de textos (Levenshtein String Distance) que usa uma taxa de semelhança como critério de aceitação.



Método: ComparaCampoData - Método que realiza a comparação entre campos extraídos e dados de entrada/data. Esse método funciona para documentos com OCR estendido.
Tipo de comparação executada:
Contains: Verifica se determinado dado de entrada/data está contido no texto extraído do documento
Levenshtein: Usa o algoritmo de comparação de textos (Levenshtein String Distance) que usa uma taxa de semelhança como critério de aceitação.




Método: ComparaCampoMatricula - Método que realiza a comparação entre campos extraídos e dados de entrada/matricula. Esse método funciona para documentos com OCR estendido.
Tipo de comparação executada:
Contains: Verifica se determinado dado de entrada/matricula está contido no texto extraído do documento.
Levenshtein: Usa o algoritmo de comparação de textos (Levenshtein String Distance) que usa uma taxa de semelhança como critério de aceitação.




Método: ComparaCampoNumerico - Método que realiza a comparação entre campos extraídos e dados de entrada/número. Esse método funciona para documentos com OCR estendido.
Tipo de comparação executada:
Contains: Verifica se determinado dado de entrada/numero está contido no texto extraído do documento.
Levenshtein: Usa o algoritmo de comparação de textos (Levenshtein String Distance) que usa uma taxa de semelhança como critério de aceitação.



Método: ComparaCampoTextual - Método que realiza a comparação entre campos extraídos e dados de entrada/texto literal. Esse método funciona para documentos com OCR estendido.
Tipo de comparação executada:
Contains: Verifica se determinado dado de entrada/texto literal está contido no texto extraído do documento.
Levenshtein: Usa o algoritmo de comparação de textos (Levenshtein String Distance) que usa uma taxa de semelhança como critério de aceitação.




Método: ComparaCampoValor - Método que realiza a comparação entre campos extraídos e dados de entrada/valor. Esse método funciona para documentos com OCR estendido.
Tipo de comparação executada:
Contains: Verifica se determinado dado de entrada/valor está contido no texto extraído do documento.
Levenshtein: Usa o algoritmo de comparação de textos (Levenshtein String Distance) que usa uma taxa de semelhança como critério de aceitação.



Método: ComparaDocumento - Método que gera um validação manual com as imagens de dois documentos anteriormente tipificados.



Método: ComparaDocumentos - Método que gera uma validação manual para todos os documentos presentes no processo. A validação manual gerada apresentará uma tela onde os documentos podem ser comparados dois a dois, a fim de realizar uma verificação de todos os documentos de forma simultânea.



Método: ComparaImagem - Método que realiza a comparação entre dois campos extraídos de determinados documentos. Essa comparação só é realizada quando ambos os documentos foram tipificados de forma automática pelo método estendido de tipificação (templates).


Método: Condicao - Método que processa uma expressão lógica é reflete o resultado no status da tarefa que executou o processamento. Se a expressão for verdadeira, o status da tarefa será alterado para "aprovada", caso contrário, o status será alterado para "reprovada".



Método: CriarAtualizarObjetoComDoc - Método que gera uma atividade manual para criação/alteração de objetos usados no relacionamento configurado, exibindo os documentos de formulário na mesma tela. Se não houverem documentos para o tipo informado a tarefa ficará reprovada.


Método: CriarObjetoComExpressao - Método de execução automática que verifica se existe um objeto com os dados informados, e se não existir, cria um objeto novo no relacionamento configurado.



Método: DecisaoAutomatica - Método que realiza uma decisão automática, redirecionado o workflow, tomada a partir do resultado de uma expressão lógica. Se não for possível processar a expressão, a decisão automática será redirecionada para os usuários do grupo responsável pelo workflow, tornando-a uma decisão manual.



Método: DecisaoAutomaticaExpressao - Método que serve como roteador para múltiplas saídas no workflow. Ao combinar o uso de parâmetro de expressão, onde o resultado será a ordem da tarefa de destino, com a configuração de ordem de tarefa, o workflow poderá ser redirecionado para múltiplas saídas.



Método: DecisaoAutomaticaExpressaoMulti - Método que possibilita o caminho do fluxo conforme as condições definidas na configuração desta tarefa. Se todas as condições tiverem o resultado 'false', o fluxo assumirá a Saída Padrão definida no primeiro parâmetro.



Método: DecisaoChecklist - Método de decisão que tenta validar de forma automática as tarefas informadas como check-list. Se todas as tarefas do check-list estiverem aprovadas no momento da execução desta tarefa, a decisão será tomada automaticamente. Caso pelo menos uma das tarefas informadas no check-list estiver com status de reprovada, a tarefa irá gerar uma decisão manual na caixa de entrada dos usuários configurados, mostrando todas as tarefas do check-list e seus respectivos status,aguardando que uma decisão seja tomada.




Método: DecisaoManual - Método que gera uma aprovação em caixa de entrada para o usuário ou grupo de usuários configurados na tarefa. É possível informar vários grupos de usuários, separando-os por, espaço, vírgula ou ponto-e-vírgula. Se um usuário estiver associado a mais de um grupo, este não será duplicado na lista de responsáveis. A decisão tomada pelos executores irá indicar o redirecionamento do workflow. A decisão manual pode ser configurada para ser executada por apenas um, ou vários usuários (multi-aprovação). Quando configurada para aprovação de um usuário, o botão reivindicar aparecerá na caixa de entrada de todos os usuários responsáveis. O primeiro usuário que reivindicar a tarefa se tornará o responsável pela aprovação, e a aprovação será excluída da caixa de entrada dos demais responsáveis. Quando configurada para multi-aprovações, será necessário informar uma taxa de aprovação mínima (0-100) para que a tarefa seja considerada aprovada. Dessa forma, vários usuários deverão dar seu parecer na caixa de entrada, aprovando ou reprovando, até que a taxa mínima de aprovação seja atingida. O método pode ser configurado para permitir suspensão do fluxo, fazendo com que o botão "Suspender" apareça na caixa de entrada dos usuários responsáveis. Após suspenso, o processo pode receber estímulos pelo sistema legado para dar continuidade ao workflow.




Método: DecisaoTabelaRegras - Método que utilizará uma tabela de regras para tomada de decisão de forma automática, redirecionando o workflow. Caso não seja possível processar a tabela de regras, uma decisão manual será gerada para os usuários do grupo responsável pelo workflow.




Método: DispararWebHook - Método que envia uma chamada aos WebHooks associados ao workflow do processo atual.


Método: EnviarEmailRelatorioTarefas - Método que envia um e-mail para os usuários/grupos com um relatório de status das tarefas informadas.



Método: ExisteMotivoPendenciaDoc - Método que verifica a existência de uma pendência documental pelo nome do motivo.




Método: FinalizarAtividade - Método responsável pela finalização de uma atividade (sub-fluxo) de um workflow. Seu uso é obrigatório para que o workflow prossiga para as tarefas de nível superior.



Método: FinalizarOutroProcesso - Método responsável pela finalização de um workflow. Após sua execução, todo o processo será concluído no sistema. Seu uso é obrigatório para determinar o fim de um workflow.


Método: FinalizarProcesso - Método responsável pela finalização de um workflow. Após sua execução, todo o processo será concluído no sistema. Seu uso é obrigatório para determinar o fim de um workflow.


Método: ImagemPreenchida - Método que verifica se determinado campo extraído de um documento tipificado pelo OCR estendido (templates) foi preenchido. Útil para verificar o preenchimento de campos de assinatura e outros campos obrigatórios.



Método: ObrigaDocumento - Método que valida se um ou mais documentos estão anexados ao processo. Caso não esteja, é possível gerar uma validação manual para fazer uma busca pelos documentos do processo. Método normalmente usado após a tipificação de documentos.


Método: ObterResultadoExpressao - Método que compila uma determinada expressão informada e expõe seu resultado nos dados internos para ser utilizado posteriormente no fluxo.


Método: RecuperaParametroDocumento - Método que compara com um valor esperado, o valor retornado por um parâmetro de qualquer documento tipificado pelo Atomics de acordo com o formulário informado. Se pelo menos um deles satisfizer a condição, a tarefa será aprovada. No campo de valor esperado, quando informado na forma 0...100 (utilizando reticências entre dois números), o método verificará se o valor do metadado no documento está compreendido entre os valores. Caso o valor esperado seja separado por vírgulas, o método irá comparar se o valor do metadado é um dos valores informados.




Método: RecuperarDadosPendenciaDocumental - Método que recupera os dados de uma determinada pendência documental que foi gerada à partir da tarefa informada, no mesmo nível de análise do atual. Pendências geradas em outro nível de análise não podem ser recuperadas por este método (Nível de análise: QtdeRetornosLegado).



Método: RelacionarDocumentosObjetos - Método que Relaciona Documentos a Objetos.



Método: RemoverPendenciaDocumental - Método para excluir pendência documental.


Método: RenderizarDocumentoTemplate - Método que renderiza o template em formato PDF e anexa no processo tipificado com o formulário selecionado.


Método: ReproducaoAudio - Método que gera uma validação manual onde é possível realizar a reprodução de arquivos de áudio anexados ao processo. Se o tipo de formulário for informado, a validação manual conterá apenas o tipo informado. Se a configuração for deixada em branco, todos os arquivos de áudio serão mostrados na validação.



Método: ReproducaoVideo - Método que gera uma validação manual onde é possível realizar a reprodução de arquivos de vídeo anexados ao processo. Se o tipo de formulário for informado, a validação manual conterá apenas o tipo informado. Se a configuração for deixada em branco, todos os arquivos de vídeo serão mostrados na validação.


Método: SomarPesosRespostasRegraFomulario - Método que calcula a soma dos pesos de todas as validações de regras de formulários executadas para o processo. O resultado desta soma é gravado nos dados internos desta tarefa.


Método: SubmeterProcessosFilhosRelacionamento - Método que cria/atualiza e submete processos para o workflow parametrizado. A tarefa fica com status "Aguardando" até que os processos disparados sejam finalizados.

Método: SuspenderProcesso - Método que suspende imediatamente a execução do processo, alterando o status do processo e da tarefa configurada para "suspenso". O processo aguardará a recepção de um estímulo, tipado de positivo ou negativo, indicando qual redirecionamento do workflow será realizado.




Método: Temporizador - Método que cria um delay no processamento do workflow, fazendo com que sua execução prossiga após o tempo parametrizado.



Método: TipificacaoExtracao - Método que realiza a tipificação e extração de dados dos documentos anexados ao processo.
A tipificação poderá ser realizada utilizando dois mecanismos:
- Simplificado: O sistema extrairá todo o texto contido no documento (OCR) e o armazenará internamente na base de dados para futuras verificações.
- Estendido: Mecanismo avançado de OCR que tipifica os documentos anexados do processo utilizando templates previamente configurados. Esse mecanismo varrerá por campos específicos do documento corretamente tipificado, realizando a extração de dados somente para os campos especificados.
Caso um documento não seja tipificado automaticamente, uma validação manual de tipificação será gerada para ação humana.


Método: UsuarioPertenceGrupo - Método que verifica se um determinado usuário faz parte de um determinado grupo. A tarefa é aprovada caso a condição seja verdadeira, e reprova caso seja falsa.


Método: ValidarRegraFormulario - Método que cria uma validação manual para a regra de formulário especificada na configuração.



Método: VerificaFormulariosNoDocumento - Método que verifica se todos os formulários desejados estão contidos em pelo menos um documento do processo.  O nome dos formulários devem ser separados por vírgula.


Método: VerificarAssinaturaDocumento - Método que verifica se o documento passou na verificação de assinatura do sistema, ou, verifica se existem campos reconhecidos na tipificação por template que correspondem a uma assinatura reconhecida.


Método: VerificarTipificacaoAutomatica - Método que verifica se o documento foi tipificado pelo Atomics com sucesso.


3.2.3 API: SWorks.Mining.API.dll 


Método: AlterarValorParcelaSiape - Método pré-implementado de integração ao Siape.



Método: AprovarReservaMargemCartaoGovRJ - Método que realiza integração com o Governo do Rio de Janeiro, através do Mining, para realizar a aprovação da reserva de margem para cartão de crédito.


Método: AprovarReservaMargemGovRJ - Método que realiza integração com o Governo do Rio de Janeiro, através do Mining, para realizar a aprovação da reserva de margem.


Método: AtualizarContratoSiape - Método pré-implementado de integração ao Siape.



Método: AverbacaoComAlteracaoGovSC - Método que realiza integração com o Governo de Santa Catarina, através do Mining, para realizar a averbação com alteração.


  Método: AverbarMargemEmprestimoGovBA - Método que realiza integração com o Governo da Bahia, através do Mining, para realizar a inclusão de uma averbação.




 

Método: AverbarMargemEmprestimoGovGO - Método que realiza integração com o Governo de Goiás, através do Mining, para realizar a inclusão de uma averbação.



Método: AverbarMargemEmprestimoGovMT - Método que realiza integração com o Governo do Mato Grosso, realizando a averbação de uma margem previamente reservada.




Método: AverbarMargemEmprestimoGovPB - Método que realiza integração com o Governo da Paraíba, através do Mining, para realizar a averbação de margem.



Método: AverbarMargemEmprestimoGovPE - Método que realiza integração com o Governo de Pernambuco, realizando a averbação de uma margem previamente reservada.



Método: AverbarMargemEmprestimoGovPR - Método que realiza integração com o Governo do Paraná, através do Mining, para realizar a averbação de margem.


Método: AverbarMargemEmprestimoGovSC - Método que realiza integração com o Governo de Santa Catarina, através do Mining, para realizar a averbação de margem.



Método: AverbarMargemEmprestimoPrefFO - Método que realiza integração com a Prefeitura de Fortaleza, através do Mining, para realizar a reserva de margem.




Método: AverbarMargemEmprestimoPrefSP - Método que realiza integração com o Governo de São Paulo, através do Mining, para realizar a averbação de margem.





Método: AverbarMargemPrefSA - Método que realiza integração com a Prefeitura de Fortaleza, através do Mining, para realizar a reserva de margem.





Método: AverbarMargemRefinanciamentoGovPR - Método que realiza integração com o Governo do Paraná, através do Mining, para realizar a averbação de margem de refinanciamento.




Método: CancelarContratoSiape - Método que realiza integração com o Siape, através do Mining para cancelamento de contrato.



Método: ConsultaCNPJReceita - Método que realiza integração com a Receita Federal, através do Mining, para realizar a consulta do CNPJ.






Método: ConsultaConsignacoesGovRJ - Método que realiza a integração com o Governo do Rio de Janeiro para consultar as consignações através do CPF.





Método: ConsultaMargemPrefSA - Método que realiza integração com a Prefeitura de Fortaleza, através do Mining, retornando o nome e a situação cadastral do CPF informado.





Método: ConsultarBovespa - Método que realiza consulta no site da Bovespa e realiza download.



Método: ConsultarCaixaEconomicaFederal - Método que realiza a integração com a Caixa Econômica Federal através do Mining.




Método: ConsultarContatoINSS - Método que realiza integração com o INSS para consultar o endereço do beneficiário.




Método: ConsultarContratosFuncionarioSiape - Método que realiza integração com o Siape através do Mining para consulta de contratos por Funcionário.





Método: ConsultarDataInicioBeneficio - Método que realiza integração com o INSS, através do Mining, para relizar a consulta da data de início do benefício.



Método: ConsultaReservaMargemPrefSA - Método que realiza integração com a Prefeitura de Fortaleza, através do Mining, para relizar a reserva de margem.





Método: ConsultarInfoBusca - Método que realiza integração com o InfoBusca, através do Mining, retornando os três primeiros endereços retornados.




Método: ConsultarJucesp - Método que realiza consulta na Junta Comercial de São Paulo.





Método: ConsultarJucespCertidaoSimplificada - Método que realiza consulta na Junta Comercial de São Paulo.





Método: ConsultarMargemCartaoGovMG - Método que realiza integração com o Governo de Minas Gerais, através do Mining, para realizar a consulta de margem para cartão.



Método: ConsultarMargemCPFSiape - Método pré-implementado de integração ao Siape.





Método: ConsultarMargemEmprestimoCartaoGovPE - Método que realiza integração com o Governo do Pernambuco, através do Mining, para realizar a consulta de margem.



Método: ConsultarMargemEmprestimoGovBA - Método que realiza integração com o Governo da Bahia, através do Mining, para realizar a inclusão de uma consulta.




Método: ConsultarMargemEmprestimoGovBAWS - Método que realiza integração com o Governo da Bahia, através do Mining, para realizar a consulta de margem disponível.




Método: ConsultarMargemEmprestimoGovGO - Método que realiza integração com o Governo de Goiás, através do Mining, para realizar a consulta de margem disponível. A margem encontrada pode ser utilizada em expressões através do dado interno "Margem".


Método: ConsultarMargemEmprestimoGovMG - Método que realiza integração com o Governo de Minas, através do Mining, para realizar a consulta de margem disponível. A margem encontrada pode ser utilizada em expressões através do dado interno "Margem".




Método: ConsultarMargemEmprestimoGovMS - Método que realiza integração com o Governo do Mato Grosso do Sul, através do Mining, para realizar a consulta de margem disponível. A margem encontrada pode ser utilizada em expressões através do dado interno "Margem".



Método: ConsultarMargemEmprestimoGovMT - Método que realiza integração com o Mining, para consultar a margem disponível no governo do Mato Grosso.



Método: ConsultarMargemEmprestimoGovPB - Método que realiza integração com o Governo da Paraíba, através do Mining, para realizar a consulta de margem disponível. A margem encontrada pode ser utilizada em expressões através do dado interno "Margem".




Método: ConsultarMargemEmprestimoGovPR - Método que realiza integração com o Governo do Paraná, através do Mining, para realizar a consulta de margem disponível. A margem encontrada pode ser utilizada em expressões através do dado interno "Margem".



Método: ConsultarMargemEmprestimoGovRJ - Método que realiza integração com o Governo do Rio de Janeiro, através do Mining, para realizar a consulta de margem disponível. A margem encontrada pode ser utilizada em expressões através do dado interno "Margem".



 Método: ConsultarMargemEmprestimoGovSC - Método que realiza integração com o Governo de Santa Catarina, através do Mining, para realizar a consulta de margem disponível. A margem encontrada pode ser utilizada em expressões através do dado interno "Margem".



Método: ConsultarMargemEmprestimoPrefBH - Método que realiza integração com a Prefeitura de BH, através do Mining, para realizar a consulta de margem disponível. A margem encontrada pode ser utilizada em expressões através do dado interno "Margem".



Método: ConsultarMargemEmprestimoPrefFO - Método que realiza integração com a Prefeitura de Fortaleza, através do Mining, retornando o nome e a situação cadastral do CPF informado.



Método: ConsultarMargemSiape - Método pré-implementado de integração ao Siape.




Método: ConsultarPerfilSiape - Método pré-implementado de integração ao Siape.






Método: ConsultarPosseCartaoGovMG - Método que realiza integração com o Governo de Minas Gerais, através do Mining, para relizar a consulta de posse de cartão.


Método: ConsultarReceita - Método que realiza integração com a Receita Federal, através do Mining, retornando o nome e a situação cadastral do CPF informado.



Método: ConsultarReservaEmprestimoGovMT - Método que realiza integração com o Governo do Mato Grosso, através do Mining, para realizar a consulta de reserva de margem.




Método: ConsultarReservaMargemEmprestimoGovBA - Método que realiza integração com o Governo da Bahia, através do Mining, para incluir uma reserva de margem.




Método: ConsultarReservaMargemEmprestimoGovGO - Método que realiza integração com o Governo de Goias, através do Mining, para incluir uma reserva de margem.




Método: ConsultarReservaMargemEmprestimoGovPB - Método que realiza integração com o Governo da Paraíba, através do Mining, para realizar a consulta de reserva de margem.



Método: ConsultarReservaMargemEmprestimoGovPE - Método que realiza integração com o Governo do Pernambuco, através do Mining, para realizar a consulta de reserva de margem. O valor financiado encontrado pode ser utilizado em expressões através do dado interno "ValorFinanciado".






Método: ConsultarReservaMargemEmprestimoGovPR - Método que realiza integração com o Governo do Paraná, através do Mining, para realizar a consulta de reserva de margem. O valor financiado encontrado pode ser utilizado em expressões através do dado interno "ValorFinanciado".






Método: ConsultarReservaMargemEmprestimoGovSC - Método que realiza integração com o Governo de Santa Catarina, através do Mining, para consultar se há ou não uma reserva realizada.






Método: ConsultarReservaMargemEmprestimoPrefSP - Método que realiza integração com o Governo de São Paulo, através do Mining, para incluir uma solicitação no Mining.







Método: ConsultarReservaRefinanciamentoGovPR- Método que realiza integração com o Governo do Paraná, através do Mining, para realizar a consulta de refinanciamento.






Método: ConsultarSerasa - Método que realiza integração com o Serasa, através do Mining, retornando o status do documento, alerta de óbito, e se existem inconsistências cadastrais para o CPF informado.


Método: ConsultarSerasaWS - Método que realiza integração com o Serasa, através do Mining, retornando o status do documento, alerta de óbito, e se existem inconsistências cadastrais para o CPF informado.


Método: ConsultarSusep - Método Método que realiza consulta no site Susep.




Método: ConsultarTSE - Método que realiza a integração com o TSE, através do Mining, para realizar a consulta de dados.



Método: EncerrarContratoSiape - Método que realiza integração com o Siape, através do Mining para encerramento de contrato.



Método: ExcluirAverbacaoMargemEmprestimoGovBA - Método que realiza integração com o Governo da Bahia, através do Mining, para realizar a exclusão de uma averbação de margem de empréstimo.



Método: ExcluirReservaMargemEmprestimoGovMG - Método que realiza integração com o Governo de Minas Gerais, através do Mining, a fim de realizar a exclusão de uma averbação anterior informada, e também realizar a averbação desejada após a exclusão.



Método: ExclusaoMaisAverbacaoMargemGovMG - Método que realiza integração com o Governo de Minas Gerais, através do Mining, a fim de realizar a exclusão de uma averbação anterior informada, e também realizar a averbação desejada após a exclusão.





Método: ExclusaoMaisInclusaoAverbacaoMargemGovPB - Método que realiza integração com o Governo da Paraíba, através do Mining, a fim de realizar a exclusão de uma averbação anterior informada, e também realizar a averbação desejada após a exclusão.




Método: ExclusaoMaisInclusaoMargemEmprestimoGovMT - Método que realiza integração com o Governo do Mato Grosso, através do Mining, a fim de realizar a exclusão de uma averbação anterior informada, e também realizar a averbação desejada após a exclusão.




Método: ExclusaoMargemCartaoGovMG - Método que realiza integração com o Governo de Minas, através do Mining, para realizar a exclusão de uma reserva de cartão.



Método: ExclusaoReservaMargemEmprestimoGovPB - Método que realiza integração com o Governo da Paraíba, através do Mining, para relizar a exclusão de reserva de margem.




Método: IncluirContratoSiape - Método que realiza integração com o Siape, através do Mining para inclusão de contrato.




Método: IntencaoCompraGovMT - Método que realiza a integração com o Governo do Mato Grosso para consultar a intenção de compra.




Método: ReinclusaoReservaMargemCartaoComCancelamentoGovMG - Método que realiza integração com o Governo de Minas Gerais, através do Mining, para relizar a reinclusão da reserva de margem com cancelamento de despesas para cartão.


Método: ReinclusaoReservaMargemCartaoComConsultaGovMG - Método que realiza integração com o Governo de Minas Gerais, através do Mining, para relizar a reinclusão da reserva de margem para cartão trazendo os dados da situação do servidor.


Método: ReinclusaoReservaMargemCartaoGovMG - Método que realiza integração com o Governo de Minas Gerais, através do Mining, para relizar a reinclusão da reserva de margem para cartão.


Método: RenovarContratoSiape - Método pré-implementado de integração ao Siape.




Método: ReservaMargemCartaoComConsultaGovMG - Método que realiza integração com o Governo de Minas Gerais, através do Mining, para relizar a reserva de margem retornando os dados de consulta para cartão.


Método: ReservaMargemCartaoGovPE - Método que realiza integração com o Governo de Pernambuco, através do Mining, para relizar a reserva de margem para cartão.


Método: ReservaMargemEmprestimoGovBA - Método que realiza integração com o Governo da Bahia, através do Mining, para realizar a inclusão de uma consulta.



Método: ReservaMargemPrefSA - Método que realiza integração com a Prefeitura de Fortaleza, através do Mining, para relizar a reserva de margem.





Método: ReservarMargemCartaoGovMG - Método que realiza integração com o Governo de Minas Gerais, através do Mining, para relizar a reserva de margem para cartão.



Método: ReservarMargemCartaoGovRJ - Método que realiza integração com o Governo do Rio de Janeiro, através do Mining, para realizar a reserva de margem para cartão de crédito.



Método: ReservarMargemComAverbacaoGovPB - Método que realiza integração com o Governo da Paraíba, através do Mining, para relizar a reserva de margem com averbação.



Método: ReservarMargemComAverbacaoGovPE - Método que realiza integração com o Governo de Pernambuco, através do Mining, para relizar a reserva de margem com averbação.



Método: ReservarMargemEmprestimoGovBA - Método que realiza integração com o Governo da Bahia, através do Mining, para relizar a reserva de margem.




Método: ReservarMargemEmprestimoGovMG - Método que realiza integração com o Governo de Minas, através do Mining, para realizar a reserva de margem.




Método: ReservarMargemEmprestimoGovMT - Método que realiza integração com o Governo do Mato Grosso, realizando a reserva de margem.




Método: ReservarMargemEmprestimoGovPB - Método que realiza integração com o Governo da Paraíba, através do Mining, para relizar a reserva de margem com opções de recorrência e reserva parcial.


Método: ReservarMargemEmprestimoGovPR - Método que realiza integração com o Governo do Paraná, através do Mining, para realizar a reserva de margem.




Método: ReservarMargemEmprestimoGovRJ - Método que realiza integração com o Governo do Rio de Janeiro, através do Mining, para realizar a reserva de margem.





Método: ReservarMargemEmprestimoGovSC - Método que realiza integração com o Governo de Santa Catarina, através do Mining, para relizar a reserva de margem.



3.2.4 API: SWorks.Rec.API.dll 


Método: ConsultarTribunal:  Método que realiza integração com os tribunais estaduais, utilizando o Rec, para verificar existência de processos judiciais que envolvam os alertas informados nas configurações da tarefa. Os processos encontrados podem ser acessados nos detalhes de execução da tarefa, na aba de resultados.
Os tipos de alertas disponíveis são:
- Banco Autor (alerta 1): Verifica processos cujo banco é autor.
- Banco Réu (alerta 2): Verifica processos cujo banco é réu.
- Bancos Diferentes (alerta 3): Verifica processos que envolvem vários bancos diferentes.
- UF Diferente CPF (alerta 4): Verifica processos cuja UF é diferente da UF original do CPF.
- Comarca de Risco (alerta 5): Verifica processos registrados por determinadas comarcas que foram marcadas como comarcas de risco.
É possível filtrar os processos a serem analisados pelas situações informadas na configuração da tarefa.



3.2.5 API: SWorks.SCC.API.dll


Método: AlteracaoDaAverbacaoComPrevia - Método de integração com a CIP, usando o SCC, para gerar a mensagem ASCC025, destinado ao participante consignatário financeiro e não financeiro enviar o registro dos contratos consignados no SCC cujas parcelas serão alterados para um novo.



Método: CadastroDeTaxaDeEmprestimos - Método de integração com a CIP, usando o SCC, para gerar a mensagem ASCC014, cadastro de taxa de empréstimos.


Método: CancelamentoDaReservaDeAverbacao - Método de integração com a CIP, usando o SCC, para gerar a mensagem ASCC016, para realizar o cancelamento de reserva de averbação financeira, usando o número de averbação gerado anteriormente pelo SCC. 



Método: ConsultaAverbacao - Método de integração com a CIP, usando o SCC, para gerar a mensagem ASCC013, para realizar a consulta de margem disponível. O valor da margem, o tipo de vínculo do servidor e a situação da margem são retornados nos dados internos para posteriores validações via expressões.


Método: ConsultaDeMargem - Método de integração com a CIP, usando o SCC, para gerar a mensagem ASCC013, para realizar a consulta de margem disponível. O valor da margem, o tipo de vínculo do servidor e a situação da margem são retornados nos dados internos para posteriores validações via expressões.



Método: ConsultaDeMargemRefin - Método de integração com a CIP, usando o SCC, para gerar a mensagem ASCC015, para realizar a consulta de margem disponível para refinanciamento.



Método: ConsultaMargemDetalhada - Destinado ao participante Consignatário consultar de forma detalhada a margem disponível  dos Servidores.


Método: ConsultaMargemDetalhadaRefinanciamento - Destinado ao participante Consignatário consultar de forma detalhada a margem disponível para Refinanciamento.



Método: DesaverbacaoConsignatarioFinanceiro - Método de integração com a CIP, usando o SCC, para gerar a mensagem ASCC007, para realizar a desaverbação de consignatário financeiro, utilizando o número de averbação gerado anteriormente pelo SCC.


Método: FinalizacaoDeReservaDeAverbacao - Método de integração com a CIP, usando o SCC, para gerar a mensagem ASCC006, para realizar a finalização de reserva de averbação financeira, utilizando o número de averbação gerado anteriormente pelo SCC.



Método: FinalizacaoDeReservaDeAverbacaoRefin - Método de integração com a CIP, usando o SCC, para gerar a mensagem ASCC009, para realizar a finalização de reserva de averbação financeira de refinanciamento, utilizando o número de averbação gerado anteriormente pelo SCC.





Método: PreviaDaAverbacao - Método de integração com a CIP, usando o SCC, para gerar a mensagem ASCC024, destinado ao participante Consignatário financeiro e não financeiro enviar os registros que confirmar o valor da parcela para uma averbação de SCC.


Método: ReservaDeAverbacaoFinanceira - Método de integração com a CIP, usando o SCC, para gerar a mensagem ASCC005, para realizar a reserva de averbação financeira, gerando um número de averbação pelo SCC, a ser utilizado na finalização da reserva.



Método: ReservaDeAverbacaoRefin - Método de integração com a CIP, usando o SCC, para gerar a mensagem ASCC008, para realizar a reserva de averbação financeira de refinanciamento, gerando um número de averbação pelo SCC, a ser utilizado na finalização da reserva.



Método: ReservaDeMargemCartaoDeCredito - Destinado ao participante Consignatário consultar de forma detalhada a margem disponível dos Servidores.



3.2.6 API: SWorks.Utils.API.dll


Método: ComparacaoExpressoesRegex - Método para comparação de expressões que são compiladas em dois textos, usando o Regex.



Método: ComparacaoExpressoesRegexDocumento - Método para comparação de expressões que são compiladas em dois textos, usando o Regex. Caso a comparação não seja totalmente similar, gera uma validação manual (do tipo compara campo) que exibe para comparação o documento informado com o "Texto A".


Método: ComparacaoExpressoesSimilaridade - Método para comparação de expressões que são compiladas em dois textos, usando o algoritmo de semelhança de texto (Levenshtein String Distance), utilizando uma taxa de aceitação.


Método: ComparacaoExpressoesSimilaridadeDocumento - Método para comparação de expressões que são compiladas em dois textos, usando o algoritmo de semelhança de texto (Levenshtein String Distance), utilizando uma taxa de aceitação. Caso a taxa de aceitação não seja alcançada, gera uma validação manual (do tipo compara campo) que exibe para comparação o documento informado com o "Texto A".


Método: ComparacaoTextual - Método para comparação textual usando o algoritmo de semelhança de texto (Levenshtein String Distance), utilizando uma taxa de aceitação.


Método: EnviarEmail - Método para envio de e-mails que aceita como destinatários a informação preenchida no Dado de Entrada do Novo Processo ou por um Parametro de Expressão pré-definido. É possível concatenar os e-mails com os separadores padrão do sistema. Para os campos Assunto e Corpo que irão conter parâmetros, obrigatoriamente devera seguir a sintaxe de Zona Isolada -@(parametro) - sem concatenação de valores. (ex: Este email foi enviado para o @(email) referente a proposta @(obj.NumeroProposta).



Método: SimilaridadeTextual - Método alternativo de comparação textual que verifica a quantidade de palavras contidas dentro um texto. A taxa de aceitação é obtida com relação a quantidade de palavras contidas no texto total.



Método: VerificarValidadeDocumento - Método que processa o texto extraído sobre um documento, em busca de dados relativos à data de emissão do documento. Se essa data é encontrada, o método verifica se tal data está dentro do prazo especificado no parâmetro, caso não encontre, dá a opção de enviar a tarefa para validação manual da informação, aprovando ou reprovando.


3.3 Criando Expressões

Para a construção de expressões, alguns conceitos são necessários, como Operadores, Tipos de Campos e Funções.

Operadores






Tipos de Campo


No S-Works os tipos de campo possíveis são os descritos abaixo:
  1. Alfanumérico:  Suporta campos de texto. 
  1. Boolean: Suporta campos que possuem apenas dois valores possíveis por exemplo “Sim” ou “Não”.
  1. DateTime: Suporta campos de data e hora.
  1. Número: Suporta campos numéricos inteiros. Exemplo: 1, 20, 500.
  1. Monetário: Suporta campos decimais. Exemplo: 500,50.


Obs.: Se você quiser que um numérico seja tratado como decimal, use o sufixo m ou M. 

Exemplo: obj.ValorParcela == 500,5M (equivale a 500,50).

  1. Imagem: Suporta imagens.
  2. ComboBox: Suporta campos do tipo caixa de combinação que contém uma lista de opções pré-definida. Exemplo abaixo:






Funções

Equals

Objetivo: Determina se o conteúdo de um campo e um texto especifico têm o mesmo  valor.    

Exemplo :    obj.Dados[60].Situacao.Equals("INEXISTENTE")

Esta expressão determina se o conteúdo do campo obj.Dados.Situacao é 
igual a INEXISTENTE.

Obs: Toda a comparação com texto deve estar entre aspas dupla. ""

ToLower

Objetivo: Converte um campo texto para caracteres em caixa alta.

Exemplo:    obj.Dados[60].Cidade.ToLower("BELO HORIZONTE") .  
Resultado:    "belo horizonte"

ToUpper

Objetivo: Converte um campo texto para caracteres em caixa alta.

Exemplo:    obj.Dados[60].Cidade.ToUpper("belo horizonte") 
Resultado:    "BELO HORIZONTE"

Trim

Objetivo: Remove de um campo texto a cadeia de em branco.

Exemplo:    Supondo que o campo obj.Dados.Situacao estivesse com o conteúdo (" INEXISTENTE ")
    obj.Dados[60].Situacao.Trim()
Resultado:    "INEXISTENTE"

IsNullOrEmpty

Objetivo: Indica se um campo caractere é um nulo ou vazio.

Exemplo:    obj.Dados[60].Situacao.IsNullOrEmpty()


IsNullOrWhiteSpace

Objetivo: Indica se um campo caractere é um nulo ou espaço em branco.

Exemplo:    obj.Dados[60].Situacao.IsNullOrEmpty()

DateTime.Now


Objetivo: Obter a data e hora atual.

Exemplo:    DateTime.Now
Resultado:    23/10/2014 17:00

Day

Objetivo: Obter o dia de um campo data

 Exemplo:     obj.DataNascimento.Day

Month

Objetivo: Obter o mês de um campo data

Exemplo:    obj.DataNascimento.Month

Year

Objetivo: Obter o ano de um campo data

Exemplo:    obj.DataNascimento.Year

TotalDays

Objetivo: Calcula o número de dias entre duas datas.

Exemplo:    (30/10/2014 - 25/10/2014).TotalDays
Resultado:    5


3.3.1 Criando Expressões no S-Works


As expressões são validações que são criadas para validar alguma condição necessária.
A condição é realizada por uma atividade ou por um gateway.
A API que permite a construção de expressões é a SWorks.Core.ServerAPI.dll
Quando a expressão a ser construída é em uma Tarefa, o método a ser utilizado é a Condição.
Quando a expressão a ser construída é em um gateway o método a ser utilizado é a DecisaoAutomatica.
Ao digitar na expressão obj. será mostrada uma caixa de seleção com os campos de entrada e retornos de tarefas, conforme tela de exemplo abaixo.





Exemplo de construção de expressão na Tarefa:

Exemplo de construção de expressão na Tarefa:

Como forma de padronização, o “Sim” da condição é atribuído a cor verde e o “Não” da condição é atribuído a cor vermelha.

Confira também o artigo Expressões C# no S-Works e o também o artigo sobre Expressões Regulares no S-Works.

4. WebApi


Através de uma funcionalidade denominada WebAPI, permite a parametrização de integrações diversas com sistemas externos, baseando-se em API’s.

4.1 Descrição da funcionalidade


A funcionalidade consiste na criação de um mecanismo de parametrização de serviços no S-Works, trazendo a possibilidade de criar integrações específicas para sistemas externos sem a necessidade de implementar um novo componente (API) para o sistema, ou seja, sem escrita de código. Esse recurso foi batizado de Web API.

O recurso permite que o usuário informe uma especificação de serviço REST no S-Works (Swagger), que fará a tradução da especificação, transformando as operações expostas em APIs invocáveis através de tarefas.

O S-Works transforma parâmetros da requisição REST em dados de configuração das tarefas, mesmo que sejam parâmetros de Query, Body ou URL.

4.2 Autenticação


O sistema permite que seja configurado o mecanismo de autenticação a ser utilizado para o consumo das WebAPIs configuradas.
Atualmente o sistema é compatível com os seguintes tipos de autenticação:

Basic Authentication
OAuth 2.0: suportando tipos de "grant" Client Credentials (Client ID e Client Secret) e Password Credentials (Usuário e Senha).

Caso a autenticação não esteja seja compatível com as listas, é possível desenvolver um módulo simples para agregar o tipo de autenticação necessária.
Temos no nosso roadmap o desenvolvimento de uma funcionalidade para tornar configurável a requisição de autenticação, eliminando desenvolvimento nos casos de exceção.

4.3 Configuração


A configuração de um serviço de WebAPI é feita através de tela no sistema, onde o usuário informa o descritivo do serviço que deseja consumir, a URL onde o serviço se encontra e o mecanismo de autenticação a ser utilizado.



Uma vez a WebAPI devidamente configurada, ela ficará disponível para ser invocada através de tarefas dentro do workflow. A tarefa no workflow exibe na forma de dados de configuração todos os insumos necessários para consumir as operações do serviço.

A leitura do retorno feita pelo sistema pode ser feita de forma estruturada, recomendável quando o retorno não possui arrays, ou de forma dinâmica, indicado para leitura de conteúdo que possui arrays e/ou estrutura dinâmica de retorno.

É importante salientar que, mesmo que o serviço atual contenha alguma limitação que impeça o uso da funcionalidade, é possível construir uma camada de fachada para resolver o problema, e estruturar os dados de configuração e dados de retorno, visando facilitar tanto a configuração do workflow quanto o uso dos dados de retorno dentro do workflow.

Limitação: O sistema não suporta arrays aninhados como entradas nas requisições.



    • Related Articles

    • Manual Autenticação API S-Works

      Manual Autenticação API S-Works Integrações com sistemas de terceiros podem requisitar autenticação.  O objetivo deste artigo é mostrar a configuração de um modo de autenticação e apresentar as opções de autenticação disponíveis. Para uma ...

    • Camada Administração Configurações iniciais

        SWORKS Camada Administração - Configurações Iniciais Sumário 1. Escopo dos serviços 2.   Fazendo a identificação (login) no sistema................................................................2 3.   Visualizando a tela inicial do ...

    • Melhoria perfil de acesso S-Works

      Melhoria implantada a partir da versão 2.5 do S-Works Introdução Com a melhoria implantada na versão 2.3 Criação de Perfil Personalizado, temos na versão 2.5 uma melhoria realizada no Perfil Personalizado. Foram realizadas mudanças na estrutura da ...

    • Integração Datavalid

      Visando a utilização da API da Datavalid na forma de WebAPI dentro do S-Works, seria necessário criar um método que realizasse a autenticação/autorização customizada. Para isso, seria implementada uma classe na "SWorks.Serpro.API", para receber os ...

    • S-Works - Manual de Instalação da Versão 2.0 - v2 2 1

      Versionamento Versão Data Comentários 1.0 23/09/2020 Versão inicial do documento. Atualização do manual para conter etapas de instalação 2.0 20/01/2021 manual do sistema e seus módulos, assim como configuração dos mesmos. 2.1 21/01/2021 Revisão, ...