Integrando o Orquestra com o Zapier

O Orquestra BPMS possui uma API de integração com o Zapier, que será descrita ao longo desta página. Este trabalho de integração ainda está em desenvolvimento e novas funcionalidades serão em breve adicionadas ao seu escopo.

O que é o Zapier?

Zapier é um produto online que permite a integração entre as mais diversas plataformas online, como Google (Drive, Gmail, Sheets, Calendar), Instagram, Facebook, LinkedIn, Youtube, EverNote, entre outras, totalizando centenas de integrações possíveis hoje.

O Zapier se baseia num sistema de "Triggers" (gatilhos), condições que, quando ativadas, dão sequência a uma ou mais "Actions" (Ações) que automaticamente, usando dados da "trigger" e das "actions" anteriores a ela, executam uma tarefa específica.

Um exemplo:

Pode ser configurado uma trigger para que a cada novo arquivo em uma pasta de uma conta do Google Drive, seja criada uma nova instância de um processo no Orquestra com o mesmo anexado. De maneira simples e com configuração intuitiva, o Zapier permite que diversas aplicações "conversem" entre si.

Como funciona?

Logo abaixo é possível ver um passo a passo exemplificando como realizar a configuração citada acima. Para executar essa demonstração, é necessário:

  • Ter uma conta no Zapier
  • Ter uma conta no Google e Google Drive.
  • Ter uma pasta no Google Drive e um arquivo recente dentro desta pasta.
  • Ter acesso a uma instância do Orquestra BPMS disponível na internet.
  • O token de autenticação permanente do seu usuário no Orquestra.
  • Criar um processo no Orquestra BPMS no qual seu usuário possa abrir instância.

Após isso, ao clicar em "MAKE A ZAP", um editor do Zapier é aberto. Um "ZAP" é um fluxo automático, composto de um gatilho e uma sequência de uma ou mais ações.

Agora é preciso definir o gatilho no seletor de aplicações e, no caso, será utilizado o Google Drive. Cada aplicação terá seu conjunto específico de gatilhos, no caso do Google Drive, existem gatilhos para quando um novo arquivo é criado numa certa pasta, quando um arquivo é criado em qualquer pasta, quando uma nova pasta é criada, e quando um arquivo é atualizado. Para essa demonstração, será utilizado o "New File in Folder" (Novo arquivo em pasta específica).

Configurando a integração do Zapier com o Google Drive

Para prosseguir para o próximo passo, é necessário conectar ao Zapier sua conta do Google, basta clicar em "Connect an Account" e permitir ao Zapier que acesse os arquivos do Google Drive.

Para monitorar uma pasta específica, é necessário selecionar a pasta que será monitorada. Como exemplo, foi criada uma pasta chamada "Documentos" na raiz do Drive, e o Zapier reconheceu a mesma; assim, ela será utilizada para a demonstração. Dentro desta pasta foi colocado um documento Word simples com um conteúdo de texto.

No Zapier, pode ser feito o teste para buscar os dados do arquivo o qual acabou de realizar o upload. É possível, até mesmo, explorar os seus dados para saber o que poderá ser utilizado na próxima ação (que será abrir um processo no Orquestra).

Configurando a integração do Zapier com o Orquestra

O próximo passo será abrir um processo no Orquestra anexando a ele o arquivo do Google Drive. Para isso selecione a aplicação que executará a ação (nesse caso, o Orquestra).

É importante ressaltar que a aplicação do Orquestra dentro do Zapier ainda está em desenvolvimento, e novas funcionalidades devem ser adicionadas ao longo do tempo.

Cada aplicação tem suas ações e gatilhos específicos. No caso do Orquestra será utilizada a ação "Create Instance", que cria uma nova instância de um processo específico, e nessa ação configuraremos os dados que serão enviados para a instância.

Para usar a aplicação do Orquesta, é necessário conectar sua conta do Zapier com sua conta em seu ambiente Orquestra (que deve estar exposto para a internet). Usando a URL de domínio e o token de acesso permanente do seu usuário (que está na configuração de usuário do Orquestra), é possível conectar essa conta ao Zapier e todas as ações tomadas a partir dele serão representadas por este usuário.

Os tokens de autenticação estão no cadastro de usuário. Em caso de dúvidas, contate o administrador do sistema.

Configurando os dados da instância do Orquestra

Configurada a conexão da conta do Orquestra com o Zapier, agora é preciso configurar os dados da instância. Cada ação possui um formulário de informações específicas que devem ser supridas. Neste exemplo, será preenchido o processo onde deseja-se iniciar uma instância no Orquestra, anexando à ele o arquivo que estiver armazenado no Google Drive. Assim, será escolhido o processo "Flow - Tratar arquivo do Dropbox, Google Drive ou OneDrive".

O campo "Simulation" determina se o processo é uma simulação (campo de verdadeiro ou falso). O campo "Form Fields" é um campo multivalorado, do lado esquerdo coloca-se o identificador do campo do formulário do Orquestra e do lado direito o valor (usando dados provenientes do documento), como no exemplo abaixo em que será preenchido o campo "nomeDoArquivo" com a informação do nome do arquivo que o conector do Zapier irá fornecer.

O campo "File Content" é um campo do tipo arquivo vindo do próprio Zapier. Esse campo recebe informações de dados de um arquivo, que podem ser uma URL ou os próprios dados binários de um arquivo. Para receber um arquivo de entrada é necessário um dado de saída do tipo arquivo (como do Google Drive ou Dropbox). Neste exemplo será utilizado o campo de "File" do Google Drive.

Aqui está um exemplo de formulário de criação de instância completamente preenchido. Com esses dados será executado o teste. É possível conferir os dados antes de enviar o teste para o servidor. Como se trata de um teste, será marcado o indicador de simulação como "verdadeiro" (valor "yes"). Também é preciso preencher o campo "origem" com um texto fixo que identifique que que a instância de processo foi iniciada pela integração do Zapier.

Testando a integração entre o Google Drive e o Orquestra

Ao continuar, é possível verificar todos os dados que serão enviados para o Orquestra, o processo que será instanciado e todos os campos preenchidos.

Após o processamento dos dados, pode-se ver a mensagem de sucesso do Zapier e conferir o processo criado no Orquestra com o arquivo anexado do Google Drive. A tela abaixo indica que o Zapier conseguiu contatar o Google Drive e o Orquestra BPMS com sucesso.

Acessando o sistema do Orquestra, vê-se que o arquivo colocado no Google Drive agora aparece como anexo no processo.

Podem ser adicionadas mais ações em um determinado "ZAP", que terão disponíveis os dados retornados da instância e também os dados do arquivo. Cada ação terá disponível os dados das ações anteriores de forma cumulativa.

Neste exemplo, o "ZAP" será encerrado com a criação de uma instância no Orquestra. É possível nomear o "ZAP" e ativá-lo facilmente.

Agora, o Zapier monitorará a pasta a cada 5 minutos. Cada novo arquivo na pasta "Documentos" do Google Drive automaticamente gera uma nova instância do processo "Tratar Arquivo do Dropbox, Google Drive ou OneDrive" com o arquivo anexado e dados do mesmo preenchidos no formulário.

Mais possibilidades de integração

O que é importante ressaltar é que a integração com o Google Drive é apenas uma das muitas possibilidades de integração entre o Zapier e o Orquestra. Várias outras aplicações podem ser integradas de maneiras diferentes. Exemplos:

  • Criar uma instância no Orquestra com dados de uma oportunidade no RD Station.

Configuração da instância do processo

Resultado no Orquestra


  • Envio de e-mail para o Zapier para adicionar uma mensagem a uma instância de processo, onde o assunto é o número da instância, e o corpo do e-mail é a mensagem.

E-mail enviado para o Zapier:

Configuração do Zapier para receber os e-mails:

Mensagem inserida no processo do Orquestra:


  • Resposta de um formulário no Google Forms adiciona uma mensagem a uma instância de processo, com as respostas dadas no formulário.

Configuração do Zapier para adicionar mensagens a partir das respostas do Google Forms:

Exemplo do formulário preenchido:

Mensagem adicionada no Orquestra com os dados da resposta do formulário:


Integrações com MS Flow e IFTTT

Hoje o Orquestra está sendo integrado com o Zapier com sua própria aplicação, mas existem outras plataformas como o MS Flow e o IFTTT (If This Then That) que também funcionam da mesma maneira. A aplicação do Orquestra ainda não está presente nessas plataformas, embora possa ser acessada a partir de requisições web customizadas (REST), flexibilizando a integração entre os sistemas. Os métodos do Orquestra são acessíveis por interface web a partir de outras plataformas, mesmo que não exista aplicação específica do Orquestra nas mesmas.