Atualização do conector Clarizen no Jitterbit Design Studio

A atividade de atualização do Clarizen disponível dentro do conector Clarizen permite atualizar dados existentes em uma instância conectada do Clarizen usando o Jitterbit.

Esta página descreve como atualizar dados existentes do Clarizen usando um exemplo de atualização de uma tarefa existente no Clarizen a partir de dados de origem fornecidos em um arquivo XML através do Jitterbit.

Este exemplo é utilizado apenas para fins de demonstração e não cobre todas as opções disponíveis no produto; consulte Design Studio para uma documentação mais abrangente.

As seções a seguir estão divididas em iniciar a atividade de atualização, definir os componentes da operação e implantar e executar a operação.

Criando uma operação de atualização do Clarizen

1. Dentro do seu projeto no Jitterbit Studio, existem várias maneiras de iniciar uma nova atividade de atualização do Clarizen. Cada uma das opções a seguir iniciará o Assistente de Atualização do Clarizen para guiá-lo pelo processo.

   • Vá para Arquivo > Novo > Conectores > Nova Atualização do Clarizen.
   • Na árvore à esquerda, sob Conectores, clique com o botão direito na categoria Clarizen, e selecione Nova Atualização do Clarizen.
   • Na árvore à esquerda, sob Conectores, clique duas vezes na categoria Clarizen, depois clique com o botão direito em Atividades de Atualização do Clarizen e selecione Nova Atualização do Clarizen.
   • Na barra de ferramentas superior, clique no ícone do conector (peça de quebra-cabeça laranja) . No popup, selecione Clarizen, depois selecione Atualização do Clarizen.

2. A tela de Endpoint do Assistente de Atualização do Clarizen deve abrir na visualização principal do Studio. Esta tela solicita que você selecione o endpoint no qual gostaria de atualizar os dados existentes. Você já deve ter configurado seu endpoint em endpoint do conector Clarizen. Use o menu suspenso para selecionar o endpoint apropriado. Clique em Próximo quando terminar.

3. A tela de Objeto do Assistente de Atualização do Clarizen solicita que você selecione o objeto no qual gostaria de atualizar os dados existentes. Neste exemplo, queremos atualizar uma tarefa existente no Clarizen, então selecionamos o objeto "Tarefa" e, em seguida, clicamos em Concluir para continuar.

   Nota

   Se você tiver muitos objetos disponíveis em sua instância do Clarizen, pode ser necessário aguardar um momento para que eles sejam carregados. Você também pode inserir um nome de objeto no campo Filtro. Tente o botão Atualizar se os resultados não forem o que você espera.

   

4. O Jitterbit então prosseguirá com a criação de uma estrutura de solicitação e resposta da API do Clarizen que permitirá que os dados sejam atualizados dentro de sua instância conectada do Clarizen. Uma nova aba deve aparecer no Studio chamada Atividades de Atualização do Clarizen. Você pode renomear sua atividade de atualização aqui, se desejar; no exemplo, a nossa é chamada "Exemplo de Atualização de Tarefa do Clarizen." Você também pode usar os botões + - ou setas para expandir todos os elementos dentro de cada estrutura.

   

5. Em seguida, na mesma tela, clique no botão Criar Operação localizado em Usar em uma Integração no canto superior direito. Isso criará a operação do Jitterbit que atualizará a tarefa existente no Clarizen.

6. Uma nova aba deve abrir no Studio chamada Operações, contendo uma representação gráfica da atividade de atualização.

   

   Nota

   Os ícones para Source, Request, Response e Target na imagem acima são marcadores para os componentes da operação, que definiremos na próxima seção.

   Salve sua operação clicando no ícone de disco único para salvar apenas esta operação ou no ícone de discos múltiplos para salvar todas as alterações em seu projeto de integração. Você deve ver o asterisco na aba Operations e o título da operação desaparecer à medida que sua nova atividade de atualização é criada e salva em seu projeto.

Definindo os componentes da operação

A seguir, precisamos definir os outros componentes da operação que aparecem na representação gráfica, incluindo Source, Request, Response e Target.

Para cada um, as instruções abaixo orientam você a retornar à representação gráfica da operação que você criou e clicar duas vezes em cada ícone para configurar cada componente. Como alternativa, você também pode criar o Source, Request, Response e Target separadamente e, em seguida, arrastá-los da árvore à esquerda diretamente para os ícones na representação visual da sua operação.

Para fins deste guia, fornecemos os seguintes exemplos para referência acima: Jitterpak ClarizenExample.jpk e arquivos acompanhantes em ClarizenSampleFiles.zip. Muitos tipos diferentes de dados podem ser usados para cada componente da operação. Para saber mais sobre opções adicionais de personalização, consulte a seção Design Studio de nossa documentação.

• Source: No exemplo, usamos um arquivo XML como a solicitação de entrada para atualizar uma tarefa existente com os valores de campo fornecidos abaixo. Um ID deve ser incluído na fonte para uma atividade de atualização e pode ser o ID externo ou ID interno (ID completo) no formato /\<object_type>/\<external_id>.

  <ns:INPUT xmlns:ns="urn:czoln:document:czoln:oln:entities">
      <Task>
          <id>jw47joqmno25rh7l5azcmo3o26</id>
          <Name>Testing 123</Name>
          <Description>This is my updated task.</Description>
          </Task>
  </ns:INPUT>
  

  Nota

  Uma atividade de atualização do Clarizen deve usar o ID interno ou externo da entidade dentro do Clarizen para associar a atualização ao objeto correto. O ID interno completo do Clarizen inclui o nome da entidade no formato /\<object_type>/\<external_id> (por exemplo, /Task/jw47joqmno25rh7l5azcmo3o26), enquanto o ID externo do Clarizen será apenas o ID, por exemplo, jw47joqmno25rh7l5azcmo3o26.

  Nota

  No exemplo, usamos o ID do Clarizen retornado na resposta do exemplo utilizado em criação do conector Clarizen onde criamos o Task1. Se você estiver acompanhando o exemplo, precisará substituir este ID pelo específico da tarefa em sua instância do Clarizen. A atualização renomeará 'Task1' para 'Testing 123' e atualizará a descrição.

  Nota

  Uma variedade de tipos de fonte estão disponíveis no Jitterbit. Veja Fontes para mais informações.

  Para usar o arquivo XML, primeiro clique duas vezes no ícone Fonte, em seguida, clique no botão Criar Nova Fonte e dê um Nome à sua fonte (por exemplo, ClarizenUpdate_Task_Request.xml). Em seguida, para este exemplo, estamos usando um agente privado com arquivos locais habilitados, e assim selecione um Tipo de "Arquivo Local" e depois Navegar até a localização. Se você estiver usando os arquivos de exemplo, a Pasta é 'C:\ClarizenSampleFiles' e o Obter Arquivos é 'ClarizenUpdate_Task_Request.xml'.

• Destino: Clique duas vezes no ícone Destino. No exemplo, iremos exportar o ID e o status da nova tarefa no Clarizen para um arquivo XML para garantir que foi criada. Clique no botão Criar Novo Destino, dê um Nome ao seu destino (por exemplo, ClarizenUpdate_Task_Response.xml), e novamente selecione um Tipo de "Arquivo Local" e Navegar até um local no agente privado onde queremos salvar os dados. No exemplo, a Pasta é 'C:\ClarizenSampleFiles' e o Nome do Arquivo é 'ClarizenUpdate_Task_Response.xml'.

  Nota

  Você também pode exportar para uma variedade de tipos de destino diferentes. O tipo não precisa ser o mesmo que o tipo de origem. Veja Destinos para opções.

• Solicitação: Clique duas vezes no ícone Solicitação e selecione Criar Nova Transformação. Isso abrirá o Assistente de Transformação, que o guiará na criação da solicitação.

  Nota

  Informações adicionais sobre estruturas de solicitação estão disponíveis em Transformações.

  1. Na primeira tela, Nome, forneça um Nome para sua transformação ou deixe como o padrão. Em seguida, use o menu suspenso Fonte para selecionar "Solicitação de Função Clarizen." Clique em Próximo para continuar.

  2. Na próxima tela, Fonte, selecione o botão de opção para Atualizar, e clique em Próximo. Na tela seguinte, use o menu suspenso para selecionar a operação de atualização (por exemplo, "Exemplo de Atualização de Tarefa Clarizen"), e clique em Concluir.

  3. A aba Transformações deve abrir, onde você pode completar seu mapeamento. Use o + para expandir os itens de origem e destino em cada árvore. Em seguida, arraste e solte cada campo que você gostaria de mapear de uma árvore para a outra. Como um atalho para este exemplo, você pode clicar no ícone de mapeamento automático que aparece abaixo do lado de destino da árvore:

     

     Seu mapeamento de transformação deve se parecer com o mostrado abaixo:

     

• Resposta: Clique duas vezes no ícone Resposta e selecione Criar Nova Transformação. Isso abrirá o Assistente de Transformação, que o guiará na criação da resposta.

  Nota

  Informações adicionais sobre estruturas de resposta estão disponíveis em Transformações.

  1. Na primeira tela, Nome, forneça um Nome para sua transformação ou deixe como o padrão. Em seguida, use o menu suspenso Destino para selecionar "Resposta de Função Clarizen." Clique em Próximo para continuar.

  2. Na próxima tela, Destino, selecione o botão de opção para Atualizar, e clique em Próximo. Na tela seguinte, use o menu suspenso para selecionar a operação de atualização (por exemplo, "Exemplo de Atualização de Tarefa Clarizen"), e clique em Concluir.

  3. A aba Transformações deve abrir, onde você pode completar seu mapeamento. Use o + para expandir os lados de origem e destino. Neste exemplo, criaremos a resposta de saída para que inclua o ID, status e quaisquer mensagens de erro na resposta. Clique e arraste a pasta "OUTPUT" do lado esquerdo (lado de origem) para a pasta "OUTPUT" do lado direito (lado de destino). Sua tela de mapeamento deve agora parecer semelhante à abaixo.

     

Implantando e executando a operação

Com a atividade de atualização do Clarizen totalmente configurada, estamos prontos para implantar e executar a operação.

1. Na aba Operações, clique no ícone de implantar .

2. Em seguida, clique no ícone de executar para colocar a operação na fila para execução.

3. Na parte inferior da tela, o Monitor de Operações deve indicar que sua operação foi executada com sucesso. Se não, você pode clicar duas vezes no ícone de Status para visualizar quaisquer mensagens de log.

   

4. Você também deve ver agora a resposta de saída que foi mapeada para seu arquivo de destino. No exemplo, o arquivo agora é criado em 'C:\ClarizenSampleFiles\ClarizenUpdate_Task_Response.xml'. Como a operação foi executada com sucesso, vemos o ID da tarefa no Clarizen e um status de '1' indicando sucesso.

   <ns:OUTPUT xmlns:ns="urn:czoln-res:document:czoln:oln:entities">
       <Task>
           <id>jw47joqmno25rh7l5azcmo3o26</id>
           <status>1</status>
       </Task>
   </ns:OUTPUT>
   

5. Além disso, ao verificar sua instância do Clarizen, você deve encontrar que 'Task1' criada durante criação do conector Clarizen agora é chamada 'Testing 123' e a descrição foi atualizada.