Excluir Conector Clarizen

A atividade de exclusão do Clarizen disponível no Clarizen Connector permite excluir registros existentes em uma instância Clarizen conectada usando Jitterbit.

Esta página descreve como excluir registros existentes do Clarizen usando um exemplo de exclusão de uma tarefa existente por ID no Clarizen a partir de dados de origem fornecidos em um arquivo XML por meio do Jitterbit. Este exemplo exclui o mesmo arquivo de exemplo usado no Clarizen Connector Create e Atualização do conector Clarizen exemplos.

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

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

Criando uma Operação de Exclusão do Clarizen

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

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

2. A tela Endpoint do Clarizen Delete Wizard deverá abrir na visualização principal do Studio. Esta tela pede para selecionar o endpoint do qual você gostaria de excluir os registros. Você já deve ter configurado seu endpoint em Clarizen Connector Endpoint. Use o menu suspenso para selecionar o endpoint apropriado. Clique em Avançar quando terminar.

   

3. A tela Objeto do Assistente de exclusão do Clarizen solicita que você selecione o objeto do qual deseja excluir os registros. Neste exemplo queremos deletar uma tarefa existente no Clarizen, então selecionamos o objeto "Task" e clicamos em Finish para continuar.

   Nota

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

   

4. A Jitterbit prosseguirá com a criação de uma estrutura de solicitação e resposta da API Clarizen que permitirá que os registros sejam excluídos em sua instância Clarizen conectada. Uma nova aba deve aparecer no Studio chamada Clarizen Delete Activities. Você pode renomear sua atividade de exclusão aqui, se desejar; no exemplo, o nosso é chamado de "Exemplo de tarefa de exclusão 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 Jitterbit que excluirá a tarefa existente no Clarizen.

6. Uma nova aba deverá abrir no Studio chamada Operations, contendo uma representação gráfica da atividade de exclusão.

   

   Nota

   Os ícones de Origem, Solicitação, Resposta e Destino na imagem acima são espaços reservados 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 vários discos para salvar todas as alterações em seu projeto de integração. Você verá o asterisco na aba Operações e o título da operação desaparecerá à medida que sua nova atividade de atualização for criada e salva em seu projeto.

Definindo os Componentes da Operação

Em seguida, precisamos definir os outros componentes da operação que aparecem na representação gráfica, incluindo Origem, Solicitação, Resposta e Destino.

Para cada um, as instruções abaixo orientam você a retornar à representação gráfica da operação criada e clicar duas vezes em cada ícone para configurar cada componente. Como alternativa, você também pode criar Origem, Solicitação, Resposta e Destino separadamente e arrastá-los e soltá-los da árvore à esquerda diretamente nos ícones na representação visual da sua operação.

Para fins deste passo a passo, fornecemos os seguintes exemplos para referência acima: Jitterpak ClarizenExample.jpk e os arquivos que acompanham 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 o Design Studio seção de nossa documentação.

• Fonte: No exemplo, usamos um arquivo XML como solicitação de entrada para excluir uma tarefa existente com o ID fornecido abaixo. Um ID deve ser incluído na origem para uma atividade de exclusão e pode ser o ID externo ou o ID interno (ID completo) no formato de /\<object_type>/\<external_id>.

  <ns:INPUT xmlns:ns="urn:czoln:document:czoln:oln:entities">
      <Task>
          <id>jw47joqmno25rh7l5azcmo3o26</id>
      </Task>
  </ns:INPUT>
  

  Nota

  Uma atividade de exclusão do Clarizen deve utilizar o ID interno ou externo da entidade dentro do Clarizen para associar a exclusã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á padronizado apenas para o ID, por exemplo, jw47joqmno25rh7l5azcmo3o26.

  Nota

  No exemplo, usamos o ID Clarizen retornado na resposta do exemplo usado em Clarizen Connector Create e Atualização do conector Clarizen. Se você estiver seguindo o exemplo, precisará substituir esse ID pelo ID da tarefa específica em sua instância Clarizen.

  Nota

  Uma variedade de tipos de fontes estão disponíveis no Jitterbit. Veja Fontes para mais.

  Para usar o arquivo XML, primeiro clique duas vezes no ícone Fonte, depois clique no botão Criar Nova Fonte e dê um Nome à sua fonte (por exemplo, ClarizenDelete_Task_Request.xml). A seguir, para este exemplo, estamos usando um Agente Privado com arquivos locais habilitados e, portanto, selecione um Tipo de "Arquivo Local" e, em seguida, Procurar até o local. Se você estiver usando os arquivos de exemplo, Folder será 'C:\ClarizenSampleFiles' e Get Files será 'ClarizenDelete_Task_Request.xml'.

• Alvo: clique duas vezes no ícone Alvo. No exemplo, enviaremos o ID e o status para um arquivo XML para garantir que a operação foi bem-sucedida. Clique no botão Criar novo destino, dê um Nome ao seu destino (por exemplo, ClarizenDelete_Task_Response.xml) e selecione novamente um Tipo de "Arquivo local" e Procurar até um local no Agente Privado onde queremos salvar os dados. No exemplo, a Pasta é 'C:\ClarizenSampleFiles' e o Nome do arquivo é 'ClarizenDelete_Task_Response.xml'.

  Nota

  Você também pode enviar para uma variedade de tipos de destino diferentes. O tipo não precisa ser igual ao tipo de origem. Consulte Metas 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 orientará você na criação da solicitação.

  Nota

  Informações adicionais sobre estruturas de solicitação são fornecidas em Transformações.

  1. Na primeira tela, Nome, forneça um Nome para sua transformação ou deixe como 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 Excluir e clique em Avançar. Na tela seguinte, use o menu suspenso para selecionar a operação de exclusão (por exemplo, "Exemplo de tarefa de exclusão do 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 deseja mapear de uma árvore para outra. Arraste o campo 'id' no lado de entrada para o campo 'id' no lado de saída. Seu mapeamento de transformação deve ser semelhante ao mostrado abaixo:

     

• Resposta: Clique duas vezes no ícone Resposta e selecione Criar nova Transformação. Isso abrirá o Assistente de Transformação que orientará você na criação da resposta.

  Nota

  Informações adicionais sobre estruturas de resposta são fornecidas em Transformações.

  1. Na primeira tela, Nome, forneça um Nome para sua transformação ou deixe como padrão. Em seguida, use o menu suspenso Target para selecionar "Clarizen Function Response". Clique em próximo para continuar.

  2. Na próxima tela, Target, selecione o botão de opção para Delete e clique em Next. Na tela seguinte, use o menu suspenso para selecionar a operação de exclusão (por exemplo, "Exemplo de tarefa de exclusão do 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 de destino. Neste exemplo, criaremos a resposta de saída para incluir o ID, o 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 agora deve ser semelhante à mostrada 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 em implantar ícone.

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

3. Na parte inferior da tela, o Monitor de operação deverá indicar que sua operação foi executada com sucesso. Caso contrário, você pode clicar duas vezes no ícone Status para visualizar quaisquer mensagens de registro.

   

4. Agora você também deverá ver a resposta de saída que foi mapeada para seu arquivo de destino. No exemplo, o arquivo agora é criado em 'C:\ClarizenSampleFiles\ClarizenDelete_Task_Response.xml'. Como a operação foi executada com sucesso, vemos o ID da tarefa no Clarizen e um status ‘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ê descobrirá que a tarefa excluída não existe mais.