Gerenciar funções personalizadas

Gerenciar funções personalizadas

As funções personalizadas permitem que os usuários desenvolvam e executem funções definidas pelo usuário usando o Deluge. Você pode executar trechos simples de programa para automatizar processos ou integrar-se a aplicativos de terceiros ou Zoho.   

Usos comerciais para funções personalizadas

  1. Use as funções personalizadas para mover cartões automaticamente para os estágios anteriores ou posteriores, quando transições específicas ou atualizações de cartões forem realizadas.
  2. Você também pode postar comentários, mensagens ou atualizações em outros aplicativos usados em sua organização, como Zoho Desk, Zoho Cliq ou MS Teams, usando funções personalizadas. 
Os usuários podem configurar novas funções personalizadas ou usar um conjunto de funções predefinidas disponíveis na  Function Gallery (Galeria de funções).

Autenticação de API para chamar funções personalizadas

As funções personalizadas podem ser chamadas no Qntrl usando blueprints e regras de negócios ou de outros aplicativos de terceiros usando chamadas de API. Para acionar as funções usando API, o Qntrl oferece suporte a dois métodos de autenticação diferentes:
  1. OAuth 2.0
  2. Chave de API


O protocolo OAuth 2.0 é um modo seguro de autenticação que permite que os usuários acessem as APIS REST para executar operações como obter, criar, atualizar e excluir em sua organização. 

Saiba como  autorizar usando OAuth 2.0 no Qntrl.

A chave de API fornece autenticação única, mas não é tão segura quanto a autenticação OAuth 2.0. Embora o protocolo OAuth 2.0 exija a regeneração de tokens de acesso a cada hora, a chave de API fornece uma chave única para autenticação. 

Use o seguinte formato de URL de solicitação para autenticar usando a chave de API: 

  1. https://core.qntrl.com/blueprint/ <organization-name>/customfunction/executeFunction/<custom-function-ID> 
Melhores práticas
  1. Não compartilhe a chave de API com usuários não autorizados ou externos, pois qualquer usuário com acesso à chave de API pode executar todas as operações. 
  2. Recomendamos que você gere novamente a chave de API periodicamente para garantir a segurança. 

Autenticação Oauth 2.0
Autenticação por chave de API
O protocolo OAuth 2.0 usa o  cabeçalho para autenticação.
A chave de API é autenticada na  URL de solicitação   . 
Todas as funções personalizadas no Qntrl podem ser autenticadas usando o protocolo OAuth 2.0.
Somente as funções  autônomas podem ser autenticadas usando a chave de API.
Na autenticação OAuth 2.0, o token de acesso  expira a cada hora . Os tokens de atualização são usados para gerar novos tokens de acesso. 
A chave de API deve ser gerada apenas uma vez. Ela  não expira .

Cenários de negócios  

  • Atualize o site da sua empresa dinamicamente com o número de vagas abertas quando um candidato for selecionado no processo de recrutamento.

  • Calcule o tempo total gasto por um usuário em cada etapa e envie um resumo detalhado por e-mail ao cliente para cobrança.

  • Integre o Qntrl a um aplicativo de calendário e envie convites de entrevista para os candidatos pré-selecionados.

  • Integre o Qntrl ao  Jira para adicionar um cartão ao Qntrl para cada projeto criado no Jira. 


Criar uma função personalizada baseada em cartão

  1. Navegue até   e selecione Custom Functions (Funções personalizadas) em Advanced (Avançado) no menu.

  2. Clique em  New Custom Function (Nova função personalizada).

  3. Preencha os dados:

    • Module Type (Tipo de módulo) :   selecione  Cards (Cartões)  se a função exigir argumentos de cartão. 

    • Function Name  (Nome da função) : nomeie sua função.

    • Return Type  (Tipo de retorno) :   o tipo de retorno para funções personalizadas baseadas em cartão sempre será nulo . 

    • Description (Descrição)  : descreva como a função funciona.

    • Arguments (Argumentos)  : digite os argumentos usados no trecho de código. Você pode usar o valor personalizado ou escolher um campo de formulário na lista suspensa. Os campos de formulário capturam valores dinâmicos de campos de cartão correspondentes à função personalizada.   

    • Connections (Conexões)  : configure as integrações internas ou de terceiros aqui. Saiba mais sobre as conexões.

    • Codifique sua função personalizada. 

  4. Clique em  Save (Salvar) ou  Save & Execute (Salvar e executar).    

  1. As funções personalizadas baseadas em cartão só podem ser chamadas usando o protocolo OAuth 2.0.
  2. Somente as funções personalizadas baseadas em cartão podem ser chamadas a partir de blueprints e regras de negócios. 
  3. O Module type (Tipo de módulo), uma vez selecionado, não pode ser editado.  
  4. Os argumentos para campos suspensos podem ser passados usando o ID de campo obtido via API.



Criar uma função personalizada independente 

  1. Navegue até    e  selecione  Custom Functions (Funções personalizadas)  em  Advanced (Avançado)   no menu.   

  2. Clique em  New Custom Function (Nova função personalizada).

  3. Preencha os dados:

    • Module Type (Tipo de módulo)  : selecione  Standalone (Independente) se a função exigir apenas argumentos independentes. 

    • Function Name (Nome da função)  : nomeie sua função. 

    • Return Type (Tipo de retorno)  : selecione um tipo de retorno para a função personalizada. 

    • Description (Descrição)  : descreva como a função funciona.

    • Arguments (Argumentos)  : digite os argumentos usados no trecho de código. 

    • Connections (Conexões)  : configure as integrações internas ou de terceiros aqui.  Saiba mais  sobre conexões.

    • Codifique sua função personalizada. 

  4. Clique em  Save (Salvar)  ou  Save & Execute (Salvar e executar).    

  1. As funções personalizadas autônomas podem ser chamadas usando o protocolo OAuth 2.0 ou a chave de API. 
  2. O Module Type (Tipo de módulo), uma vez selecionado, não pode ser editado.  



Chamar funções autônomas usando a chave de API  

Para chamar uma função autônoma usando a chave de API, ela precisa ser ativada primeiro. Certifique-se de que a chave de API seja gerada na Organization Setup (Configuração da organização) . 

  1. Passe o mouse sobre a função personalizada e clique em .
  2. Selecione  REST   API (REST API)no menu suspenso.
  3. Alterne o botão ao lado da chave de API para ativá-la.

Agendar funções personalizadas

As funções personalizadas podem ser acionadas periodicamente ou em intervalos de tempo definidos usando Schedules (Agendas) no Qntrl. 

As funções personalizadas que estão sendo usadas em Schedules (Agendas) não podem ser excluídas. 

Associar função personalizada a blueprints 


As funções personalizadas podem ser configuradas para serem acionadas após uma transição ocorrer em um blueprint. Saiba mais sobre blueprints.

  1. Navegue até     e selecione  Orchestration (Orquestração) no menu.

  2. Selecione uma orquestração existente ou crie uma nova. Saiba mais sobre orquestração. 
    1. Você entrará na Etapa 1: Criar Formulário.
  3. Navegue até a  Etapa 2: Projetar Blueprint . 

  4. Clique em uma transição e navegue até a seção  After (Após) no painel direito.

  5. Agora, em   Instant Actions (Ações instantâneas)  ou  Schedule Actions (Ações agendadas)  , clique no ícone    ao lado de  Associate Custom Functions (Associar funções personalizadas) . 

  6. Selecione uma função na  Function Gallery (Galeria de funções) ou  Configured Functions (Funções configuradas).

    • Ao associar uma função da galeria, clique em  Save as New (Salvar como novo). 

    • Ao associar uma função configurada, clique em  Save (Salvar)  ou  Save & Execute (Salvar e executar) .  

  7. Depois que as funções estiverem configuradas,  Salve   o blueprint.  




Um máximo de três funções personalizadas pode ser associado a cada transição de blueprint.  

Associar função personalizada a regras de negócios


As regras de negócios são configuradas para serem acionadas quando um cartão é criado ou atualizado ou quando um campo é atualizado. Saiba mais  sobre as regras de negócio aqui. As regras de negócios podem, por sua vez, acionar as funções personalizadas associadas a elas. 

  1. Navegue até     e selecione  Business Rules (Regras de negócio) em  Automation (Automação) no menu. 

  2. Crie uma nova regra de negócios ou abra uma regra existente.  Saiba mais sobre as  regras de negócio.
  3. Preencha os detalhes da regra e passe para   Criteria & Actions (Critérios e ações).
  4. Agora  ,   clique no    icone ao lado de   Instant Actions (Ações instantâneas)  ou  Schedule Actions (Ações agendadas)  e selecione  Custom Functions (Funções personalizadas)    na lista suspensa.

  5. Selecione uma função na  Function Gallery (Galeria de funções) ou  Configured Functions (Funções configuradas). 

    • Ao associar uma função da galeria, clique em  Save as New (Salvar como novo). 

    • Ao associar uma função configurada, clique em  Save (Salvar)  ou  Save & Execute (Salvar e executar) .  

  6. Depois de configurar as funções, clique em  Save (Salvar) .  




No máximo três funções personalizadas podem ser associadas a cada regra de negócios.

Priorizar a função personalizada 


Uma vez que uma função personalizada é acionada no  Qntrl , pode levar um ou dois minutos para ser executada. No entanto, você pode priorizar determinadas funções personalizadas e executá-las instantaneamente.  
  1. Navegue até a função personalizada associada no Blueprint/Regra de negócios e passe o mouse sobre ela.
  2. Clique em mais opções e marque Prioritize this function’s execution (Priorizar a execução desta função) .
 

Observação: 
  1. As funções personalizadas configuradas em Schedule Actions (Ações agendadas) não podem ser priorizadas.
  2. Somente uma função personalizada por bloco de ação instantânea pode ser priorizada. 

Excluir funções personalizadas


Você pode excluir uma função personalizada se ela não for mais necessária. Uma vez excluída, ele será removida das transições de blueprint associadas e das regras de negócios.  

  1. Navegue até    e  selecione  Custom Functions (Funções personalizadas)  em    Advanced (Avançado)   no menu . 

  2. Passe o mouse sobre o nome da função que deseja excluir. 

  3. Clique em  e selecione  Delete (Excluir) .

  4. Confirme sua ação.  




    • Related Articles

    • Funções

      Visão geral das funções A designação de usuários é classificada como funções. Por exemplo, um usuário pode ser um designer, codificador ou escritor em sua escala profissional. Eles podem ser um gerente, líder ou mentor de uma escala gerencial. Mais ...

    • Visualizações personalizadas do cartão (Card)

      Os cartões são agrupados e exibidos em diferentes visualizações. Os usuários podem usar as exibições padrão do Qntrl ou também criar suas próprias exibições personalizadas. Exibições padrão Há cinco exibições padrão compatíveis com o Qntrl. Para usar ...

    • Gerenciar regras de negócios

      O que é uma regra de negócio? Uma regra de negócio ajuda você a acionar um evento ou uma cadeia de eventos automatizados, quando uma ação definida ocorre em um cartão. Por exemplo, quando o campo de responsável de um cartão é atualizado, talvez você ...

    • Gerenciar scripts de servidor

      Os scripts de servidor ajudam você a codificar a lógica de negócios específica da empresa para gerenciar o banco de dados, executar processos demorados rapidamente e automatizar atividades em seus fluxos de trabalho de negócios. Esses scripts em ...

    • Gerenciar scripts do cliente

      Os scripts do cliente são usados para incorporar validações adicionais aos dados de negócios enquanto são registrados no Qntrl. Em scripts de cliente, você pode codificar usando JavaScript e executar o código no navegador do usuário final enquanto ...