Inserir Dados XT em Lote (ECM)

Sumário

1. Conceito

O plugin é um componente de software adicional que estende ou personaliza as funcionalidades de uma plataforma ou ferramenta. No plugin ECM-XT será possível inserir dados em lote, com base no formulário ECM em uma configuração XT.

2. Pré-Requisitos

• Integrações: Possui integração com os serviços da XT
• Cenário de Uso: Durante uma determinada etapa de um processo BPM, o usuário consegue configurar o plugin para inserir dados em uma configuração na XT.

3. Configurações

3.1 Configuração Inicial

Na tela de plugins, procure por Inserir dados XT em Lote (ECM – XT) para utilizar este plugin, será necessário criar uma configuração na tela de configurações do plugin. Através dela, será possível criar configurações do tipo Fonte de Dados ou Serviço de Integração.

• Para utilizar o plugin, é importante saber que alguns campos são necessários para preenchimento:
  • Server;
  • Module (Módulo);
  • Port (Porta);
  • Service (Serviço).
• Os demais campos são opcionais:
  • Separator (Separador);
  • User (Usuário);
  • Password (Senha);
  • Encryption (Criptografia);
  • List (Campo Lista de Objetos)

  Alguns pontos importantes:

  • Caso os campos User e Password não sejam informados, o plugin irá enviar ao XT o usuário logado na plataforma;
  • O campo Encryption tem como valor padrão 0 caso o usuário não especificar;
  • Como o plugin envia dados em lote, o nome da lista de objetos precisa ser especificada no campo List.

  4. Autenticação e Permissões

  Como mencionado, para realizar a autenticação na XT, os campos User, Password e Encrypton são opções viáveis. Caso esses campos não sejam enviados, o plugin realizará o login automaticamente na XT com o usuário da plataforma que realizou a chamada do plugin. No campo Encrypton caso não informado, será enviado com o valor 0.

  5. Fluxo de Dados

  • Ao realizar a requisição do plugin, ele será responsável por tratar a lista de objetos que contém os dados que serão enviados em lote para a XT;
  • Após o tratamento da lista de objetos, o payload da requisição será convertido para XML e enviado;
  • Com o retorno do serviço, o plugin converte para JSON e retornará o payload para a plataforma.

  6. Erros e Logs

  Para verificar o comportamento do plugin, acesse a tela Senior Flow > Conector > Selecionar Plugin > Detalhes, em seguida a guia Histórico de Execução. Nela será possível verificar o histórico de retorno do plugin em específico.

  

  

  No caso do plugin em lote da XT, é importante destacar que a cada chamada que a XT retornar com um erro, será enviado uma notificação na plataforma informando sobre o problema retornado.

  

  7. Como Testar

  7.1 Testando pela Plataforma

  Para testar o plugin, observe que, como ele precisa enviar uma lista de objetos, não é possível realizar o teste pela aba Testar plugin conforme imagem:

  

  Com isso, para pequenos testes dentro da plataforma, é recomendado criar um processo com um fluxo pequeno, que faça somente a chamada ao plugin.No exemplo abaixo, um processo ECM foi criado com o seguinte formulário:

  

  Antes de criar um fluxo que possua integração com o plugin, será necessário criar uma configuração dos campos:

  

  • Nos campos da lista de objetos “cargos”, são subparâmetros da lista;
  • O tipo deixado para eles é lista, mesmo que sejam enviados como string;

  Esta será a forma que deverá ser configurado um plugin para suportar o envio de lista de objetos usando formulários ECM.
  Com isso, será necessário configurar um fluxo que possua serviço de integração:

  

  Com o serviço de integração configurado, basta executar a etapa do processo em que foi configurado e verificar os logs, caso o usuário necessite verificar algum retorno indesejado.

  7.2 Testando pelo Postman

  Um exemplo simples, será pela chamada do plugin pela primitiva invoke:

  

  Para esse tipo de teste será necessário passar o header Authorization, com o token do usuário logado na plataforma. No payload da requisição, informar o id da configuração do plugin e o id do plugin. Os campos enviados ao plugin devem ser passados no objeto inputData. É de extrema importância que o usuário preencha os campos obrigatórios.

  
  Exemplo body enviado na primitiva invoke

  8. Desempenho e Limitações

  • Tempo de Resposta: Como o plugin trata de enviar dados em lote, caso o número de dados for muito grande, há uma possibilidade da requisição acabar retornando com timeout.
  • Limitações: Atualmente há uma limitação na integração do plugin com o ECM, basicamente uma limitação onde é possível enviar somente lista de objetos, ou seja, não será possível enviar listas de listas, listas de string, números, booleanos, datas ou qualquer outro tipo. Somente listas de objetos são permitidos, e ainda, será necessário atentar-se ao detalhe de como ela deverá ser configurada no plugin.