Atualização do conector Four51 no Jitterbit Design Studio

A atividade de atualização do Four51 disponível dentro do conector Four51 permite criar novos dados ou substituir dados existentes no Four51 via API do OrderCloud. Um ID único deve ser fornecido.

Com uma atividade de atualização do Four51, todos os campos do objeto associado serão criados ou substituídos. Se houver campos obrigatórios, será necessário fornecer um valor para esses campos, mesmo que já existam dados nesses campos obrigatórios. O motivo para isso é que uma atividade de atualização do Four51 atualiza completamente ou substitui quaisquer dados existentes para o objeto.

Atualizar completamente ou parcialmente os campos do objeto é uma diferença importante entre as atividades de atualização do Four51 e de patch do Four51. Se você deseja atualizar apenas campos especificados para o objeto associado, consulte atualização de patch do conector Four51.

Esta página descreve como criar novos dados ou substituir dados existentes no Four51 usando um exemplo de substituição de um endereço de comprador existente usando o Jitterbit. Este exemplo substitui o mesmo endereço de comprador que foi criado como exemplo dentro do criar conector Four51.

As seções a seguir estão divididas em início da atividade de atualização, definição dos componentes da operação e implantação e execução da operação.

Criando uma operação de atualização Four51

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

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

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

   

3. As próximas telas do Assistente de Atualização Four51 ajudam você a detalhar o objeto específico no qual deseja atualizar os dados. A primeira dessas telas, Seção, pede que você selecione uma das categorias de nível superior listadas dentro do Four51: "Autenticação", "Comprador", "Pedido", "Organização" ou "Perspectiva do Usuário".

   Nota

   Você pode descobrir quais seleções fazer consultando a API do OrderCloud. Por exemplo, essas cinco categorias de nível superior correspondem diretamente às listadas no lado esquerdo do Console da API do OrderCloud. As telas restantes de seleção de objetos também seguem a organização da API do OrderCloud.

   No exemplo, queremos substituir completamente um endereço de comprador existente, então selecionamos a seção "Comprador" e clicamos em Próximo para continuar.

   

4. A próxima tela no Assistente de Atualização Four51, chamada Recurso, exibe os recursos disponíveis dentro da seção selecionada. No exemplo, como queremos substituir um endereço existente, selecionamos "Endereços" e clicamos em Próximo para continuar.

   

5. A tela de seleção final no Assistente de Atualização Four51, chamada Endpoint de Recurso, exibe os objetos finais disponíveis para o recurso selecionado. No exemplo, para substituir um endereço existente, selecionamos a opção "Criar ou Atualizar Endereço". Clique em Concluir para continuar.

   Nota

   Os endpoints de recurso disponíveis para cada recurso de seção dependem do tipo de atividade Four51 selecionada para a operação (ou seja, criar, ler, atualizar, atualizar patch ou excluir atividade).

   

6. O Jitterbit então prosseguirá com a criação de uma estrutura de solicitação e resposta da API que permitirá que os dados sejam criados ou substituídos via a API OrderCloud. Uma nova aba deve aparecer no Studio chamada Atividades de Atualização Four51. Você pode renomear sua atividade de atualização aqui, se desejar; no exemplo, a nossa é chamada "Atualização Four51 - Comprador > Endereços > Criar ou Atualizar Endereço." Você também pode usar os botões + - ou setas para expandir todos os elementos dentro de cada estrutura.

   

   Nota

   O "xp" na estrutura acima significa "Propriedades Estendidas" e é parte da API OrderCloud. Esta propriedade permite que você adicione campos personalizados à maioria dos objetos. Para saber mais sobre como usar a propriedade XP, veja conector Four51 avançado.

7. 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 criará um novo ou substituirá um endereço de comprador existente no Four51.

8. 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 Fonte, Requisição, Resposta e Alvo 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 Operações 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 Fonte, Requisição, Resposta e Alvo.

Você pode retornar à representação gráfica da operação que criou e clicar duas vezes em cada ícone para configurar cada componente, ou pode criar a Fonte, Requisição, Resposta e Alvo separadamente e, em seguida, arrastá-los e soltá-los da árvore à esquerda diretamente sobre os ícones na representação visual da sua operação.

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.

• Fonte: Para simplificar este exemplo, a fonte será codificada. Portanto, removeremos a fonte clicando com o botão direito no ícone da fonte no gráfico da operação e selecionando Remover do Gráfico.

  Nota

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

• Alvo: Clique duas vezes no ícone Alvo. No exemplo, registraremos a resposta da API OrderCloud em um arquivo de texto temporário para fornecer informações sobre sucesso/falha. Clique no botão Criar Novo Alvo, dê um Nome ao seu alvo (por exemplo, 'Atualizar Alvo'). Em seguida, para este exemplo, queremos gravar no local de armazenamento temporário padrão em nosso agente privado, então selecionamos um Tipo de "Armazenamento Temporário" e inserimos um Nome do Arquivo de 'Update_File.txt' para o exemplo.

  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 dropdown Fonte para selecionar a fonte para a transformação. No exemplo, nossa fonte é codificada, então selecionaremos "Nenhum." Clique em Concluir para continuar.

  2. A aba Transformações deve abrir, onde você pode completar seu mapeamento. Use o + para expandir os itens na árvore de destino à direita. Em uma transformação padrão, você arrastaria e soltaria cada campo que gostaria de mapear de uma árvore para a outra. Para este exemplo, para codificar a fonte, clique duas vezes em cada campo no lado do destino e digite os seguintes valores usados no exemplo no script:

     DESTINO: INPUT > CreateorUpdateAddress > Parâmetros	Script
     buyerID	<trans> "TestBuyerID0001" </trans>
     addressID	<trans> "TestAddressID0000" </trans>

     Nota

     O buyerID acima é o ID existente da Organização Compradora à qual o endereço pertence, e o addressID acima é o ID existente do novo endereço que foi criado durante o exemplo de criação do conector Four51.

     DESTINO: ENTRADA > CriarOuAtualizarEndereco > ParâmetrosDeRequisição	Script
     ID	<trans> "TestAddressID0000" </trans>
     NomeDaEmpresa	<trans> "Test 2 Company" </trans>
     PrimeiroNome	<trans> "Replaced First" </trans>
     Sobrenome	<trans> "Replaced Last" </trans>
     Rua	<trans> "1234 Main Street" </trans>
     Cidade	<trans> "Los Angeles" </trans>
     Estado	<trans> "CA" </trans>
     CEP	<trans> "654321" </trans>
     País	<trans> "US" </trans>
     Telefone	<trans> "987654321" </trans>
     NomeDoEndereco	<trans> "Test_2_Address" </trans>

     Nota

     Os valores listados acima substituirão aqueles criados durante o exemplo de criação do conector Four51.

     Após codificar a origem, 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 dropdown Alvo para selecionar o alvo da transformação. No exemplo, queremos usar a resposta da API OrderCloud, então selecionamos "Resposta da Função Four51." Clique em Próximo para continuar.

  2. Na próxima tela, Alvo, selecione o botão de opção para o tipo de atividade da qual você deseja usar a resposta. Neste caso, queremos usar a resposta da atividade de atualização que acabamos de configurar, então escolha "Atualizar." Clique em Próximo para continuar.

  3. A tela Alvo agora exibirá um menu suspenso para selecionar a atividade. Escolha a atividade de atualização que você acabou de configurar. As estruturas de solicitação e resposta associadas à atividade de atualização selecionada devem aparecer agora. Clique em Concluir para continuar.

  4. A aba Transformações deve abrir onde você pode completar seu mapeamento. Use o + para expandir os lados de origem e destino. Clique e arraste a pasta "SAÍDA" do lado esquerdo (lado de origem) para a pasta "SAÍDA" do lado direito (lado de destino). Sua tela de mapeamento deve agora parecer semelhante à abaixo.

     

Sua operação configurada deve parecer semelhante ao exemplo mostrado abaixo.

Implantando e executando a operação

Com a atividade de atualização Four51 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 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 'Update_File.txt'. No exemplo, o arquivo agora é criado no armazenamento temporário no agente privado (ou seja, o padrão '/tmp/jitterbit/TemporaryStorage' para Linux ou 'C:\Windows\Temp\Jitterbit\' para Windows). O status de '1' indica que a operação foi bem-sucedida.

   <?xml version="1.0" encoding="UTF-8"?>
   <ns:OUTPUT xmlns:ns="urn:F51oln-res:document:F51oln:oln:entities">
       <CreateorUpdateAddress>
           <Status>1</Status>
           <Items>
               <Item>
                   <ID>TestAddressID0000</ID>
                   <CompanyName>Test 2 Company</CompanyName>
                   <FirstName>Replaced First</FirstName>
                   <LastName>Replaced Last</LastName>
                   <Street1>1234 Main Street</Street1>
                   <City>Los Angeles</City>
                   <State>CA</State>
                   <Zip>654321</Zip>
                   <Country>US</Country>
                   <Phone>987654321</Phone>
                   <AddressName>Test_2_Address</AddressName>
               </Item>
           </Items>
       </CreateorUpdateAddress>
   </ns:OUTPUT>
   

5. Além disso, ao verificar o Console da API OrderCloud em Comprador > Endereços, você deve encontrar o endereço do comprador substituído pelas novas informações.