Tarefa em JavaScript

Aviso: o Application Integration já está disponível para seu projeto do Google Cloud. Agora é possível usar a Apigee Integration e o Application Integration no mesmo projeto do Google Cloud. Saiba mais

A tarefa JavaScript permite criar snippets de código JavaScript personalizados para sua integração.

Com o Editor de JavaScript, você pode codificar lógica de mapeamento de dados complexa para sua integração, realizar atribuições de variáveis e adicionar ou modificar variáveis de integração.

O Editor de JavaScript é compatível com os seguintes recursos:

• Um minimapa que exibe uma visão geral de alto nível do código do script e ajuda na navegação rápida.
• Destaque de sintaxe/código, recuo e numeração de linhas para facilitar a legibilidade do código e o reconhecimento da estrutura.
• Destaque de erros para encontrar e rastrear erros no código.
• Dobragem para expandir e recolher as regiões do código do script.
• Opção clique para copiar o código na área de transferência.

Configurar a tarefa JavaScript

Para adicionar uma tarefa JavaScript à integração, siga estas etapas:

1. Na IU da Apigee, selecione sua organização da Apigee.
2. Clique em Desenvolver > Integrações.
3. Selecione uma integração existente ou clique em Criar integração.

   Caso você esteja criando uma nova integração, siga estas etapas:

   1. Digite um nome e uma descrição na caixa de diálogo Criar integração.
   2. Selecione uma Região para a integração na lista de regiões compatíveis.
   3. Clique em Criar.

   Isso abre a integração na página do designer de integração.

4. Na barra de navegação do designer de integração, clique em +Adicionar uma tarefa/gatilho> Tarefas para conferir a lista de tarefas disponíveis.
5. Clique e posicione o elemento JavaScript no editor de integração.
6. Clique no elemento JavaScript no designer para visualizar o painel de configuração de tarefas JavaScript.
7. Clique em Abrir editor de script para ver e editar o Editor JavaScript.
8. Escreva seu código JavaScript na função executesScript(event) que é criada automaticamente no Editor JavaScript. Quando o editor for fechado, as alterações serão salvas automaticamente.
   Aviso: não exclua a função executesScript(event). Essa função é chamada quando a tarefa JavaScript é executada.

   Para ver informações sobre como acessar variáveis de integração e as funções compatíveis, consulte Como usar o editor JavaScript.

   Para informações sobre como visualizar os registros de execução gerados, consulte Registros de execução.

A imagem a seguir mostra um layout de exemplo do JavaScript Editor:

Como usar o Editor JavaScript

Para ver e editar o Editor JavaScript, acesse o painel de configuração de tarefas JavaScript e clique em Abrir editor javascript. Por padrão, o Editor JavaScript contém uma função chamada executesScript(event).

Em que:

• executesScript() é a função chamada quando a integração da Apigee executa a tarefa JavaScript durante a execução de uma integração.
• event é o objeto na memória da integração da Apigee.

  Para mais informações sobre os métodos compatíveis com o objeto event, consulte Acessar variáveis de integração.

Aviso: não exclua a função executesScript(event). Essa função é chamada quando a tarefa JavaScript é executada.

O mecanismo de execução JavaScript usado pela integração da Apigee é baseado no Rhino 1.7.14, que não é compatível com todas as sintaxes ES6. Somente o preenchimento automático da sintaxe ES5 é compatível. Para ver toda a sintaxe ES6 compatível, consulte Suporte ao Rhino ES2015.

Acessar variáveis de integração

As variáveis definidas na sua integração podem ser acessadas no Editor do JavaScript usando o objeto evento na memória da integração da Apigee.

Os métodos a seguir são compatíveis com o acesso a variáveis de integração no seu Editor do JavaScript:

Nome da função	Descrição	Uso
getEventExecutionInfoId	Retorna o ID de execução da execução da integração. Tipo de retorno: String	Sintaxe: event.getEventExecutionInfoId() Exemplo: function executeScript(event) { event.getEventExecutionInfoId(); }
getGoogleCloudProjectId	Retorna o ID do projeto do Google Cloud. Tipo de retorno: String	Sintaxe: event.getGoogleCloudProjectId() Exemplo: function executeScript(event) { event.getGcpProjectId(); }
getIntegrationName	Retorna o nome atual da integração. Tipo de retorno: String	Sintaxe: event.getIntegrationName Exemplo: function executeScript(event) { event.getIntegrationName(); }
getParameter	Retorna o valor da variável de integração fornecida. Tipo de retorno: tipo de dado da variável de integração	Sintaxe: event.getParameter("variable_name") Parâmetro de entrada: nome da variável de integração. Se variable_name for uma variável gerada automaticamente, coloque a variável entre caracteres de acento grave (``). Por exemplo, `responseBody`. Exemplo: function executeScript(event) { event.getParameter("var1"); }
getRegion	Retorna o nome da região de integração. Tipo de retorno: String	Sintaxe: event.getRegion() Exemplo: function executeScript(event) { event.getRegion(); }
log	Grava o valor especificado nos registros de execução. Para informações sobre como visualizar os registros de execução gerados, consulte Registros de execução.	Sintaxe: event.log(value) Parâmetro de entrada:qualquer variável ou função usada no script. Exemplo 1: function executeScript(event) { event.log(event.getParameter("var1")); } Exemplo 2: function executeScript(event) { event.log("Lorem ipsum"); }
setParameter	Define ou atualiza o valor de uma variável de integração.	Sintaxe: event.setParameter("variable_name", "variable_value") Parâmetro de entrada: essa função usa os seguintes argumentos: Primeiro argumento: nome da variável. Se variable_name for uma variável gerada automaticamente, coloque a variável entre caracteres de acento grave (``). Por exemplo, `responseBody`. Segundo argumento: Valor. Exemplo: function executeScript(event) { event.setParameter("`responseBody`", "NewStringValue"); }

Definir parâmetros da tarefa

Se a integração tiver vários parâmetros de tamanho grande que não são usados pela tarefa JavaScript, defina o campo TaskParameter da tarefa JavaScript para melhorar o desempenho.

Se quiser definir o campo TaskParameter para a tarefa JavaScript, selecione uma das seguintes opções:

Console

1. Acesse a página Application Integration.

   Acessar o Application Integration

2. Selecione uma integração. O editor de integração será aberto.
3. Clique em Action > Download Integration > Integration Version. O download da versão de integração é feito como um arquivo JSON.
4. Abra o arquivo da versão de integração em um editor e faça o seguinte:
   1. Localize o campo taskConfigs com a tarefa como JavaScriptTask. No campo parameters, localize o parâmetro chamado script.

      "taskConfigs": [{
        "task": "JavaScriptTask",
        "taskId": 1,
        "parameters": {
          "script": {
            "key": "script",
            "value": {
              "stringValue": "function that is called during the JavaScriptTask execution"
            }
        }"
      }]
      

   2. No campo parameters, adicione parâmetros que são usados no campo JavaScriptTask com o seguinte modelo:

      "ParamName": {
        "key": "ParamName",
        "value": {
          "stringValue": "$ParamName$"
        }
      }
      

5. Salve as mudanças feitas no arquivo da versão de integração.
6. Faça upload do arquivo da versão de integração.

API

1. Para fazer o download da versão de integração, chame o método projects.locations.integrations.versions.download com filFormat definido como JSON.
2. Abra o arquivo da versão de integração em um editor e faça o seguinte:
   1. Localize o campo taskConfigs com a tarefa como JavaScriptTask. No campo parameters, localize o parâmetro chamado script.

      "taskConfigs": [{
        "task": "JavaScriptTask",
        "taskId": 1,
        "parameters": {
          "script": {
            "key": "script",
            "value": {
              "stringValue": "function that is called during the JavaScriptTask execution"
            }
        }"
      }]
      

   2. No campo parameters, adicione parâmetros que são usados no campo JavaScriptTask com o seguinte modelo:

      "ParamName": {
        "key": "ParamName",
        "value": {
          "stringValue": "$ParamName$"
        }
      }
      

3. Para fazer upload da versão de integração, chame o método projects.locations.integrations.versions.upload com o arquivo atualizado da versão de integração.

Estratégia de solução de erros

A estratégia de solução de erros para uma tarefa especifica a ação a ser realizada se a tarefa falhar devido a um erro temporário. Para mais informações sobre como usar uma estratégia de tratamento de erros e conhecer os diferentes tipos de estratégias de tratamento de erros, consulte Estratégias de tratamento de erros.